Skip to content

Latest commit

 

History

History
310 lines (287 loc) · 16.1 KB

addaudiences.md

File metadata and controls

310 lines (287 loc) · 16.1 KB
Raw
title ms.service ms.subservice ms.topic author ms.author description dev_langs
AddAudiences Service Operation - Campaign Management
bing-ads
campaign-management-api
article
jonmeyers
jonmeyers
Adds one or more audiences.
csharp
java
php
python

AddAudiences Service Operation - Campaign Management

Adds one or more audiences.

Request Elements

The AddAudiencesRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
Audiences The list of audiences to add.

The maximum size of the list is 100.

You cannot add CustomAudience, InMarketAudience, or SimilarRemarketingList objects.		 Audience array

Request Header Elements

[!INCLUDErequest-header]

Response Elements

The AddAudiencesResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
AudienceIds A list of unique system identifiers corresponding to the audiences that were added.

The list of identifiers corresponds directly to the list of audiences in the request. Items of the list may be returned as null. For each list index where an audience was not added, the corresponding element will be null.		 long array
PartialErrors An array of BatchError objects that contain details for any request items that were not successful.

The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.		 BatchError array

Response Header Elements

[!INCLUDEresponse-header]

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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/v13">
    <Action mustUnderstand="1">AddAudiences</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <AddAudiencesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Audiences i:nil="false">
        <Audience i:type="-- derived type specified here with the appropriate prefix --">
          <AudienceNetworkSize i:nil="false">ValueHere</AudienceNetworkSize>
          <CustomerShare i:nil="false">
            <CustomerAccountShares i:nil="false">
              <CustomerAccountShare>
                <AccountId i:nil="false">ValueHere</AccountId>
                <Associations i:nil="false">
                  <CustomerAccountShareAssociation>
                    <AssociationCount i:nil="false">ValueHere</AssociationCount>
                    <UsageType i:nil="false">ValueHere</UsageType>
                  </CustomerAccountShareAssociation>
                </Associations>
                <CustomerId i:nil="false">ValueHere</CustomerId>
              </CustomerAccountShare>
            </CustomerAccountShares>
            <OwnerCustomerId i:nil="false">ValueHere</OwnerCustomerId>
          </CustomerShare>
          <Description i:nil="false">ValueHere</Description>
          <ForwardCompatibilityMap xmlns:e33="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e33:KeyValuePairOfstringstring>
              <e33:key i:nil="false">ValueHere</e33:key>
              <e33:value i:nil="false">ValueHere</e33:value>
            </e33:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id i:nil="false">ValueHere</Id>
          <MembershipDuration i:nil="false">ValueHere</MembershipDuration>
          <Name i:nil="false">ValueHere</Name>
          <ParentId i:nil="false">ValueHere</ParentId>
          <Scope i:nil="false">ValueHere</Scope>
          <SearchSize i:nil="false">ValueHere</SearchSize>
          <SupportedCampaignTypes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </SupportedCampaignTypes>
          <Type>ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to RemarketingList-->
          <Rule i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
            <Type i:nil="false">ValueHere</Type>
            <!--These fields are applicable if the derived type attribute is set to PageVisitorsRule-->
            <NormalForm i:nil="false">ValueHere</NormalForm>
            <RuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </RuleItemGroups>
            <!--These fields are applicable if the derived type attribute is set to PageVisitorsWhoVisitedAnotherPageRule-->
            <AnotherRuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </AnotherRuleItemGroups>
            <RuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </RuleItemGroups>
            <!--These fields are applicable if the derived type attribute is set to PageVisitorsWhoDidNotVisitAnotherPageRule-->
            <ExcludeRuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </ExcludeRuleItemGroups>
            <IncludeRuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </IncludeRuleItemGroups>
            <!--These fields are applicable if the derived type attribute is set to CustomEventsRule-->
            <Action i:nil="false">ValueHere</Action>
            <ActionOperator>ValueHere</ActionOperator>
            <Category i:nil="false">ValueHere</Category>
            <CategoryOperator>ValueHere</CategoryOperator>
            <Label i:nil="false">ValueHere</Label>
            <LabelOperator>ValueHere</LabelOperator>
            <Value i:nil="false">ValueHere</Value>
            <ValueOperator>ValueHere</ValueOperator>
          </Rule>
          <TagId i:nil="false">ValueHere</TagId>
          <!--No additional fields are applicable if the derived type attribute is set to CustomAudience-->
          <!--No additional fields are applicable if the derived type attribute is set to InMarketAudience-->
          <!--These fields are applicable if the derived type attribute is set to ProductAudience-->
          <ProductAudienceType i:nil="false">ValueHere</ProductAudienceType>
          <TagId i:nil="false">ValueHere</TagId>
          <!--This field is applicable if the derived type attribute is set to SimilarRemarketingList-->
          <SourceId>ValueHere</SourceId>
          <!--This field is applicable if the derived type attribute is set to CombinedList-->
          <CombinationRules i:nil="false">
            <CombinationRule>
              <AudienceIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:long>ValueHere</a1:long>
              </AudienceIds>
              <Operator>ValueHere</Operator>
            </CombinationRule>
          </CombinationRules>
          <!--No additional fields are applicable if the derived type attribute is set to CustomerList-->
        </Audience>
      </Audiences>
    </AddAudiencesRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <AddAudiencesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AudienceIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </AudienceIds>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e34="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e34:KeyValuePairOfstringstring>
              <e34:key d4p1:nil="false">ValueHere</e34:key>
              <e34:value d4p1:nil="false">ValueHere</e34:value>
            </e34:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </AddAudiencesResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<AddAudiencesResponse> AddAudiencesAsync(
	IList<Audience> audiences)
{
	var request = new AddAudiencesRequest
	{
		Audiences = audiences
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddAudiencesAsync(r), request));
}
static AddAudiencesResponse addAudiences(
	ArrayOfAudience audiences) throws RemoteException, Exception
{
	AddAudiencesRequest request = new AddAudiencesRequest();

	request.setAudiences(audiences);

	return CampaignManagementService.getService().addAudiences(request);
}
static function AddAudiences(
	$audiences)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddAudiencesRequest();

	$request->Audiences = $audiences;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddAudiences($request);
}
response=campaignmanagement_service.AddAudiences(
	Audiences=Audiences)

Requirements

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