GetAudienceGroupsByIds Service Operation - Campaign Management

Retrieves specified AudienceGroups.

Request Elements

The GetAudienceGroupsByIdsRequest 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
AudienceGroupIds	Array of audience group ids to get. The maximum size of the list is 100 items per service request. If you leave this element nil or empty, then the operation will return all audience groups in the account.	long array

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 GetAudienceGroupsByIdsResponse 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
AudienceGroups	Array of audience groups. The maximum size of the list is 100 items per service request.	AudienceGroup array
PartialErrors	An array of BatchError objects that contain details for any request items that were not successful.	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">GetAudienceGroupsByIds</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>
    <GetAudienceGroupsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AudienceGroupIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AudienceGroupIds>
    </GetAudienceGroupsByIdsRequest>
  </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>
    <GetAudienceGroupsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AudienceGroups d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <AudienceGroup>
          <AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
          <Description d4p1:nil="false">ValueHere</Description>
          <Dimensions d4p1:nil="false">
            <AudienceGroupDimension d4p1:type="-- derived type specified here with the appropriate prefix --">
              <Type>ValueHere</Type>
              <!--This field is applicable if the derived type attribute is set to AgeDimension-->
              <AgeRanges d4p1:nil="false">
                <AgeRange>ValueHere</AgeRange>
              </AgeRanges>
              <!--This field is applicable if the derived type attribute is set to GenderDimension-->
              <GenderTypes d4p1:nil="false">
                <GenderType>ValueHere</GenderType>
              </GenderTypes>
              <!--This field is applicable if the derived type attribute is set to AudienceDimension-->
              <Audiences d4p1:nil="false">
                <AudienceInfo>
                  <Id d4p1:nil="false">ValueHere</Id>
                  <Type>ValueHere</Type>
                </AudienceInfo>
              </Audiences>
            </AudienceGroupDimension>
          </Dimensions>
          <Id d4p1:nil="false">ValueHere</Id>
          <Name d4p1:nil="false">ValueHere</Name>
        </AudienceGroup>
      </AudienceGroups>
      <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:e263="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e263:KeyValuePairOfstringstring>
              <e263:key d4p1:nil="false">ValueHere</e263:key>
              <e263:value d4p1:nil="false">ValueHere</e263:value>
            </e263: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>
    </GetAudienceGroupsByIdsResponse>
  </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<GetAudienceGroupsByIdsResponse> GetAudienceGroupsByIdsAsync(
	IList<long> audienceGroupIds)
{
	var request = new GetAudienceGroupsByIdsRequest
	{
		AudienceGroupIds = audienceGroupIds
	};

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

static GetAudienceGroupsByIdsResponse getAudienceGroupsByIds(
	ArrayOflong audienceGroupIds) throws RemoteException, Exception
{
	GetAudienceGroupsByIdsRequest request = new GetAudienceGroupsByIdsRequest();

	request.setAudienceGroupIds(audienceGroupIds);

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

static function GetAudienceGroupsByIds(
	$audienceGroupIds)
{

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

	$request = new GetAudienceGroupsByIdsRequest();

	$request->AudienceGroupIds = $audienceGroupIds;

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

response=campaignmanagement_service.GetAudienceGroupsByIds(
	AudienceGroupIds=AudienceGroupIds)

Requirements

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

Request Url

Production URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AudienceGroups/QueryByIds

Sandbox URL

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/AudienceGroups/QueryByIds

Request Elements

The GetAudienceGroupsByIdsRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
AudienceGroupIds	Array of audience group ids to get. The maximum size of the list is 100 items per service request. If you leave this element nil or empty, then the operation will return all audience groups in the account.	long array

Request Header Elements

Element	Description	Data Type
Authorization	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. 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 GetAudienceGroupsByIdsResponse 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 JSON.

Response Body Elements

Element	Description	Data Type
AudienceGroups	Array of audience groups. The maximum size of the list is 100 items per service request.	AudienceGroup array
PartialErrors	An array of BatchError objects that contain details for any request items that were not successful.	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 JSON

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

{
  "AudienceGroupIds": [
    "LongValueHere"
  ]
}

Response JSON

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

Below is an example that is applicable if the type of AudienceGroupDimension is AgeDimension, BatchError is EditorialError.

{
  "AudienceGroups": [
    {
      "AssociationCount": IntValueHere,
      "Description": "ValueHere",
      "Dimensions": [
        {
          "Type": "Age",
          "AgeRanges": [
            "ValueHere"
          ]
        }
      ],
      "Id": "LongValueHere",
      "Name": "ValueHere"
    }
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetAudienceGroupsByIdsResponse> GetAudienceGroupsByIdsAsync(
	IList<long> audienceGroupIds)
{
	var request = new GetAudienceGroupsByIdsRequest
	{
		AudienceGroupIds = audienceGroupIds
	};

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

static GetAudienceGroupsByIdsResponse getAudienceGroupsByIds(
	ArrayOflong audienceGroupIds) throws RemoteException, Exception
{
	GetAudienceGroupsByIdsRequest request = new GetAudienceGroupsByIdsRequest();

	request.setAudienceGroupIds(audienceGroupIds);

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

static function GetAudienceGroupsByIds(
	$audienceGroupIds)
{

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

	$request = new GetAudienceGroupsByIdsRequest();

	$request->AudienceGroupIds = $audienceGroupIds;

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

response=campaignmanagement_service.GetAudienceGroupsByIds(
	AudienceGroupIds=AudienceGroupIds)