Edit

GetAudiencesByIds Service Operation - Campaign Management

  • Article

Retrieves the specified audiences from the specified account.

Request Elements

The GetAudiencesByIdsRequest 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
AudienceIds A maximum of 100 identifiers of the requested audiences.

This request element is optional. If this element is null or empty, then you are effectively requesting all customer and account scoped audiences for the specified account.

If the audience identifiers do not match the requested audience types, then the operation will return a batch error for each requested audience ID.		 long array
ReturnAdditionalFields The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default.

This request element is optional.		 AudienceAdditionalField
Type The type of audiences to return.

You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <Type>RemarketingList SimilarRemarketingList</Type>.		 AudienceType

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts.

For more information see Authentication with OAuth.		 string
CustomerAccountId The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
CustomerId The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetAudiencesByIdsResponse 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
Audiences The list of audiences that corresponds directly to the audience identifiers that you specified in the request. Items of the list may be returned as null. For each list index where an audience was not retrieved, the corresponding element will be null. Audience 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

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

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">GetAudiencesByIds</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>
    <GetAudiencesByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AudienceIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AudienceIds>
      <Type>ValueHere</Type>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetAudiencesByIdsRequest>
  </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>
    <GetAudiencesByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Audiences d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Audience d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AudienceNetworkSize d4p1:nil="false">ValueHere</AudienceNetworkSize>
          <CustomerShare d4p1:nil="false">
            <CustomerAccountShares d4p1:nil="false">
              <CustomerAccountShare>
                <AccountId d4p1:nil="false">ValueHere</AccountId>
                <Associations d4p1:nil="false">
                  <CustomerAccountShareAssociation>
                    <AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
                    <UsageType d4p1:nil="false">ValueHere</UsageType>
                  </CustomerAccountShareAssociation>
                </Associations>
                <CustomerId d4p1:nil="false">ValueHere</CustomerId>
              </CustomerAccountShare>
            </CustomerAccountShares>
            <OwnerCustomerId d4p1:nil="false">ValueHere</OwnerCustomerId>
          </CustomerShare>
          <Description d4p1:nil="false">ValueHere</Description>
          <ForwardCompatibilityMap xmlns:e126="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e126:KeyValuePairOfstringstring>
              <e126:key d4p1:nil="false">ValueHere</e126:key>
              <e126:value d4p1:nil="false">ValueHere</e126:value>
            </e126:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id d4p1:nil="false">ValueHere</Id>
          <MembershipDuration d4p1:nil="false">ValueHere</MembershipDuration>
          <Name d4p1:nil="false">ValueHere</Name>
          <ParentId d4p1:nil="false">ValueHere</ParentId>
          <Scope d4p1:nil="false">ValueHere</Scope>
          <SearchSize d4p1:nil="false">ValueHere</SearchSize>
          <SupportedCampaignTypes d4p1: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 d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
            <Type d4p1:nil="false">ValueHere</Type>
            <!--These fields are applicable if the derived type attribute is set to PageVisitorsRule-->
            <NormalForm d4p1:nil="false">ValueHere</NormalForm>
            <RuleItemGroups d4p1:nil="false">
              <RuleItemGroup>
                <Items d4p1:nil="false">
                  <RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
                    <Type d4p1:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </RuleItemGroups>
            <!--These fields are applicable if the derived type attribute is set to PageVisitorsWhoVisitedAnotherPageRule-->
            <AnotherRuleItemGroups d4p1:nil="false">
              <RuleItemGroup>
                <Items d4p1:nil="false">
                  <RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
                    <Type d4p1:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </AnotherRuleItemGroups>
            <RuleItemGroups d4p1:nil="false">
              <RuleItemGroup>
                <Items d4p1:nil="false">
                  <RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
                    <Type d4p1:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </RuleItemGroups>
            <!--These fields are applicable if the derived type attribute is set to PageVisitorsWhoDidNotVisitAnotherPageRule-->
            <ExcludeRuleItemGroups d4p1:nil="false">
              <RuleItemGroup>
                <Items d4p1:nil="false">
                  <RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
                    <Type d4p1:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </ExcludeRuleItemGroups>
            <IncludeRuleItemGroups d4p1:nil="false">
              <RuleItemGroup>
                <Items d4p1:nil="false">
                  <RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
                    <Type d4p1:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand d4p1:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value d4p1:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </IncludeRuleItemGroups>
            <!--These fields are applicable if the derived type attribute is set to CustomEventsRule-->
            <Action d4p1:nil="false">ValueHere</Action>
            <ActionOperator>ValueHere</ActionOperator>
            <Category d4p1:nil="false">ValueHere</Category>
            <CategoryOperator>ValueHere</CategoryOperator>
            <Label d4p1:nil="false">ValueHere</Label>
            <LabelOperator>ValueHere</LabelOperator>
            <Value d4p1:nil="false">ValueHere</Value>
            <ValueOperator>ValueHere</ValueOperator>
          </Rule>
          <TagId d4p1: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 d4p1:nil="false">ValueHere</ProductAudienceType>
          <TagId d4p1: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 d4p1:nil="false">
            <CombinationRule>
              <AudienceIds d4p1: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>
      <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:e127="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e127:KeyValuePairOfstringstring>
              <e127:key d4p1:nil="false">ValueHere</e127:key>
              <e127:value d4p1:nil="false">ValueHere</e127:value>
            </e127: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>
    </GetAudiencesByIdsResponse>
  </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<GetAudiencesByIdsResponse> GetAudiencesByIdsAsync(
	IList<long> audienceIds,
	AudienceType type,
	AudienceAdditionalField? returnAdditionalFields)
{
	var request = new GetAudiencesByIdsRequest
	{
		AudienceIds = audienceIds,
		Type = type,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetAudiencesByIdsAsync(r), request));
}

static GetAudiencesByIdsResponse getAudiencesByIds(
	ArrayOflong audienceIds,
	ArrayList<AudienceType> type,
	ArrayList<AudienceAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAudiencesByIdsRequest request = new GetAudiencesByIdsRequest();

	request.setAudienceIds(audienceIds);
	request.setType(type);
	request.setReturnAdditionalFields(returnAdditionalFields);

	return CampaignManagementService.getService().getAudiencesByIds(request);
}

static function GetAudiencesByIds(
	$audienceIds,
	$type,
	$returnAdditionalFields)
{

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

	$request = new GetAudiencesByIdsRequest();

	$request->AudienceIds = $audienceIds;
	$request->Type = $type;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetAudiencesByIds($request);
}

response=campaignmanagement_service.GetAudiencesByIds(
	AudienceIds=AudienceIds,
	Type=Type,
	ReturnAdditionalFields=ReturnAdditionalFields)

Requirements

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