SetSharedEntityAssociations
TOC
Collapse the table of content
Expand the table of content

SetSharedEntityAssociations Service Operation

Sets the association between a campaign and a shared entity such as a negative keyword list.

Request | Response

Error Codes

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

Request Body

The SetSharedEntityAssociationsRequest 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

Associations

An array of objects that associate a campaign with a shared entity such as a negative keyword list.

This array can contain a maximum of 10,000 elements.

SharedEntityAssociation array

Request Headers

Set the required header elements for each service request. New customers are required to sign up for Bing Ads with a Microsoft Account, and to manage those accounts you must use OAuth. Existing users with legacy Bing Ads credentials may continue to specify the UserName and Password header elements. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account authentication. For more information, see Getting Started With the Bing Ads API.

OAuth Authentication

These request headers are required for Managing User Authentication with OAuth.

Element

Description

Data Type

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account.

string

CustomerAccountId

The identifier of the account that owns the entities in the request. This header element must have the same value as the AccountId body element when both are required.

Note: Required for service operations related to ad extensions. As a best practice you should always specify this element for operations limited in scope to a single account per service call.

string

CustomerId

The identifier of the customer that owns the account.

Note: Required for service operations related to targeting and editorial. As a best practice you should always specify this element.

string

DeveloperToken

The client application's developer access token.

string

Password Authentication

These request headers are required for legacy username and password authentication.

Element

Description

Data Type

CustomerAccountId

The identifier of the account that owns the entities in the request. This header element must have the same value as the AccountId body element when both are required.

Note: Required for service operations related to ad extensions. As a best practice you should always specify this element for operations limited in scope to a single account per service call.

string

CustomerId

The identifier of the customer that owns the account.

Note: Required for service operations related to targeting and editorial. As a best practice you should always specify this element.

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 or email address.

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/v10">
    <Action mustUnderstand="1">SetSharedEntityAssociations</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>
    <SetSharedEntityAssociationsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <Associations i:nil="false">
        <SharedEntityAssociation>
          <EntityId></EntityId>
          <EntityType i:nil="false"></EntityType>
          <SharedEntityId></SharedEntityId>
          <SharedEntityType i:nil="false"></SharedEntityType>
        </SharedEntityAssociation>
      </Associations>
    </SetSharedEntityAssociationsRequest>
  </s:Body>
</s:Envelope>

Response Body

Element

Description

Data Type

PartialErrors

An array of BatchError objects that contain details for any associations that were not successfully set.

The list of errors corresponds directly to the list of associations in the request. Items of the list may be returned as null. For each list index where an association was successfully set, the corresponding error element will be null. Ideally all associations are set successfully and all elements in this list are null.

BatchError 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/v10">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <SetSharedEntityAssociationsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <PartialErrors p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError p4:type="-- specify derived type here with the appropriate prefix --">
          <Code></Code>
          <Details p4:nil="false"></Details>
          <ErrorCode p4:nil="false"></ErrorCode>
          <FieldPath p4:nil="false"></FieldPath>
          <ForwardCompatibilityMap xmlns:e107="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e107:KeyValuePairOfstringstring>
              <e107:key p4:nil="false"></e107:key>
              <e107:value p4:nil="false"></e107:value>
            </e107:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index></Index>
          <Message p4:nil="false"></Message>
          <Type p4:nil="false"></Type>
          <!--Keep these fields if you set the i:type attribute to EditorialError-->
          <Appealable p4:nil="false"></Appealable>
          <DisapprovedText p4:nil="false"></DisapprovedText>
          <Location p4:nil="false"></Location>
          <PublisherCountry p4:nil="false"></PublisherCountry>
          <ReasonCode></ReasonCode>
        </BatchError>
      </PartialErrors>
    </SetSharedEntityAssociationsResponse>
  </s:Body>
</s:Envelope>

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:
© 2016 Microsoft