GetAssetGroupListingGroupsByIds Service Operation - Campaign Management

Retrieves the specified AssetGroupListingGroups.

Request Elements

The GetAssetGroupListingGroupsByIdsRequest 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
AssetGroupId	The ID of the AssetGroup.	long
AssetGroupListingGroupIds	A list of identifiers that identify the listing groups that had the action applied. The list of identifiers corresponds directly to the list of listing groups in the request. If any listing group action failed, then all remaining listing group actions will fail, and all elements in this list will be null.	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 GetAssetGroupListingGroupsByIdsResponse 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
AssetGroupListingGroups	The list of listing groups that correspond directly to the identifiers specified in the request. If an identifier in the list is not valid, the corresponding item in the response is set to null.	AssetGroupListingGroup 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">GetAssetGroupListingGroupsByIds</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>
    <GetAssetGroupListingGroupsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AssetGroupId>ValueHere</AssetGroupId>
      <AssetGroupListingGroupIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AssetGroupListingGroupIds>
    </GetAssetGroupListingGroupsByIdsRequest>
  </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>
    <GetAssetGroupListingGroupsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AssetGroupListingGroups d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <AssetGroupListingGroup>
          <AssetGroupId>ValueHere</AssetGroupId>
          <AssetGroupListingType>ValueHere</AssetGroupListingType>
          <Dimension d4p1:nil="false">
            <Attribute d4p1:nil="false">ValueHere</Attribute>
            <Operand d4p1:nil="false">ValueHere</Operand>
            <Operator d4p1:nil="false">ValueHere</Operator>
          </Dimension>
          <Id d4p1:nil="false">ValueHere</Id>
          <IsExcluded>ValueHere</IsExcluded>
          <ParentListingGroupId d4p1:nil="false">ValueHere</ParentListingGroupId>
        </AssetGroupListingGroup>
      </AssetGroupListingGroups>
    </GetAssetGroupListingGroupsByIdsResponse>
  </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<GetAssetGroupListingGroupsByIdsResponse> GetAssetGroupListingGroupsByIdsAsync(
	long assetGroupId,
	IList<long> assetGroupListingGroupIds)
{
	var request = new GetAssetGroupListingGroupsByIdsRequest
	{
		AssetGroupId = assetGroupId,
		AssetGroupListingGroupIds = assetGroupListingGroupIds
	};

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

static GetAssetGroupListingGroupsByIdsResponse getAssetGroupListingGroupsByIds(
	java.lang.Long assetGroupId,
	ArrayOflong assetGroupListingGroupIds) throws RemoteException, Exception
{
	GetAssetGroupListingGroupsByIdsRequest request = new GetAssetGroupListingGroupsByIdsRequest();

	request.setAssetGroupId(assetGroupId);
	request.setAssetGroupListingGroupIds(assetGroupListingGroupIds);

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

static function GetAssetGroupListingGroupsByIds(
	$assetGroupId,
	$assetGroupListingGroupIds)
{

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

	$request = new GetAssetGroupListingGroupsByIdsRequest();

	$request->AssetGroupId = $assetGroupId;
	$request->AssetGroupListingGroupIds = $assetGroupListingGroupIds;

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

response=campaignmanagement_service.GetAssetGroupListingGroupsByIds(
	AssetGroupId=AssetGroupId,
	AssetGroupListingGroupIds=AssetGroupListingGroupIds)

Requirements

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

Request Url

Production URL

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

Sandbox URL

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

Request Elements

The GetAssetGroupListingGroupsByIdsRequest 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
AssetGroupId	The ID of the AssetGroup.	long
AssetGroupListingGroupIds	A list of identifiers that identify the listing groups that had the action applied. The list of identifiers corresponds directly to the list of listing groups in the request. If any listing group action failed, then all remaining listing group actions will fail, and all elements in this list will be null.	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 GetAssetGroupListingGroupsByIdsResponse 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
AssetGroupListingGroups	The list of listing groups that correspond directly to the identifiers specified in the request. If an identifier in the list is not valid, the corresponding item in the response is set to null.	AssetGroupListingGroup 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.

{
  "AssetGroupId": "LongValueHere",
  "AssetGroupListingGroupIds": [
    "LongValueHere"
  ]
}

Response JSON

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

{
  "AssetGroupListingGroups": [
    {
      "AssetGroupId": "LongValueHere",
      "AssetGroupListingType": "ValueHere",
      "Dimension": {
        "Attribute": "ValueHere",
        "Operand": "ValueHere",
        "Operator": "ValueHere"
      },
      "Id": "LongValueHere",
      "IsExcluded": "ValueHere",
      "ParentListingGroupId": "LongValueHere"
    }
  ]
}

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<GetAssetGroupListingGroupsByIdsResponse> GetAssetGroupListingGroupsByIdsAsync(
	long assetGroupId,
	IList<long> assetGroupListingGroupIds)
{
	var request = new GetAssetGroupListingGroupsByIdsRequest
	{
		AssetGroupId = assetGroupId,
		AssetGroupListingGroupIds = assetGroupListingGroupIds
	};

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

static GetAssetGroupListingGroupsByIdsResponse getAssetGroupListingGroupsByIds(
	java.lang.Long assetGroupId,
	ArrayOflong assetGroupListingGroupIds) throws RemoteException, Exception
{
	GetAssetGroupListingGroupsByIdsRequest request = new GetAssetGroupListingGroupsByIdsRequest();

	request.setAssetGroupId(assetGroupId);
	request.setAssetGroupListingGroupIds(assetGroupListingGroupIds);

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

static function GetAssetGroupListingGroupsByIds(
	$assetGroupId,
	$assetGroupListingGroupIds)
{

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

	$request = new GetAssetGroupListingGroupsByIdsRequest();

	$request->AssetGroupId = $assetGroupId;
	$request->AssetGroupListingGroupIds = $assetGroupListingGroupIds;

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

response=campaignmanagement_service.GetAssetGroupListingGroupsByIds(
	AssetGroupId=AssetGroupId,
	AssetGroupListingGroupIds=AssetGroupListingGroupIds)