Export (0) Print
Expand All

SetExclusionsToAssociatedEntitiesRequest Message

Defines the request message that the client passes to the SetExclusionsToAssociatedEntities operation.

<wsdl:message name="SetExclusionsToAssociatedEntitiesRequest">
  <wsdl:part name="parameters" element="tns:SetExclusionsToAssociatedEntitiesRequest" />
</wsdl:message>

Body Elements

Element

Description

Data Type

ExclusionToEntityAssociations

A list of ExclusionToEntityAssociation objects. Each object identifies an entity and the exclusion to apply to the entity.

The list can contain only one association that specifies a target entity.

ExclusionToEntityAssociation[]

Header Elements

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 authentication token. This header element is not used and should be null.

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 caller's developer-access token.

string

Password

The user's sign-in password.

string

UserName

The user's sign-in user name. You cannot set this element to a Microsoft account (formerly known as Windows Live ID).

string

This operation overwrites the exclusion of the same type that is currently applied to the entity. To update an exclusion, you can call the GetExclusionsByAssociatedEntityIds operation and specify the type of exclusion that you want to update, update the exclusion as appropriate, and then call this operation to apply the update.

To remove exclusions, set the elements of the derived exclusion class to null. For example, to remove the location exclusion from a target entity, set the elements of the LocationExclusion object to null.

If you delete a location target, all exclusions that you have applied to that target are also deleted.

SOAP

The following example shows the complete SOAP envelope for a SetExclusionsToAssociatedEntitiesRequest request.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://adcenter.microsoft.com/v8">
    <Action mustUnderstand="1">SetExclusionsToAssociatedEntities</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>
    <SetExclusionsToAssociatedEntitiesRequest xmlns="https://adcenter.microsoft.com/v8">
      <ExclusionToEntityAssociations i:nil="false">
        <ExclusionToEntityAssociation>
          <AssociatedEntity i:nil="false">
            <EntityType></EntityType>
            <Id></Id>
          </AssociatedEntity>
          <Exclusion i:nil="false" i:type="-- specify derived type here with the appropriate prefix --">
            <Id i:nil="false"></Id>
            <Type i:nil="false"></Type>
            <!--Add LocationExclusion fields if you set the i:type attribute to LocationExclusion-->
          </Exclusion>
        </ExclusionToEntityAssociation>
      </ExclusionToEntityAssociations>
    </SetExclusionsToAssociatedEntitiesRequest>
  </s:Body>
</s:Envelope>

Requirements

CampaignManagementService.svc v8

Namespace: https://adcenter.microsoft.com/v8

Community Additions

Show:
© 2014 Microsoft