Export (0) Print
Expand All
Expand Minimize

GetListItemsBySharedList Service Operation

Gets the list items such as the negative keywords of a negative keyword list.

System_CLiX_note Note

The operation does not return negative keywords that are exclusively associated with one campaign or ad group.

Request | Response

Error Codes

Service: CampaignManagementService.svc v9 | Namespace: https://bingads.microsoft.com/CampaignManagement/v9

GetListItemsBySharedListRequest Message

Request Body

The GetListItemsBySharedListRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

Element

Description

Data Type

SharedList

The list within the account's shared library, from which to get the shared list items.

SharedList

Request Header

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

CustomerAccountId

The identifier of the account that owns the entities in the request.

string

CustomerId

The identifier of the customer that owns the account.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
    <Action mustUnderstand="1">GetListItemsBySharedList</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <CustomerAccountId i:nil="false"></CustomerAccountId>
    <CustomerId i:nil="false"></CustomerId>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <GetListItemsBySharedListRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <SharedList i:nil="false" i:type="-- specify derived type here with the appropriate prefix --">
        <ItemCount i:nil="false"></ItemCount>
        <!--Keep these fields if you set the i:type attribute to NegativeKeywordList-->
      </SharedList>
    </GetListItemsBySharedListRequest>
  </s:Body>
</s:Envelope>

GetListItemsBySharedListResponse Message

Response Body

Element

Description

Data Type

ListItems

An array of list items returned from the shared list, for example a list of negative keywords.

SharedListItem array

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains details about the API call.

string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetListItemsBySharedListResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <ListItems p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <SharedListItem p4:type="-- specify derived type here with the appropriate prefix --">
          <ForwardCompatibilityMap xmlns:e24="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e24:KeyValuePairOfstringstring>
              <e24:key p4:nil="false"></e24:key>
              <e24:value p4:nil="false"></e24:value>
            </e24:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Type p4:nil="false"></Type>
          <!--Keep these fields if you set the i:type attribute to NegativeKeyword-->
          <Id p4:nil="false"></Id>
          <MatchType></MatchType>
          <Text p4:nil="false"></Text>
        </SharedListItem>
      </ListItems>
    </GetListItemsBySharedListResponse>
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Campaign Management Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code

InvalidCredentials

Community Additions

ADD
Show:
© 2015 Microsoft