Muokkaa

Jaa

GetLabelAssociationsByEntityIds Service Operation - Campaign Management

  • Artikkeli

Gets label associations by entity identifiers.

Request Elements

The GetLabelAssociationsByEntityIdsRequest 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
EntityIds The list of entity identifiers used to request label associations.

The maximum size of the list is 100 items per service request.		 long array
EntityType Filters the returned associations by entity type.

The supported entity type values are Campaign, AdGroup, Ad, and Keyword.		 EntityType

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 GetLabelAssociationsByEntityIdsResponse 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
LabelAssociations An array of label associations.

For each entity identifier specified in the request, zero or more LabelAssociation objects are returned. Whereas the order of the returned LabelAssociation objects is guaranteed in the order of the requested entity identifiers, please note that multiple LabelAssociation objects can be returned for the same entity identifier.		 LabelAssociation array
PartialErrors An array of BatchError objects that contain details for any associations that were not successfully retrieved.

The list of errors corresponds directly to the list of associations in the request. Items of the list may be returned as null. For each list index where an association was successfully retrieved, the corresponding error element will be null. Ideally all associations are retrieved successfully and all elements in this list are null.		 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">GetLabelAssociationsByEntityIds</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>
    <GetLabelAssociationsByEntityIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </EntityIds>
      <EntityType>ValueHere</EntityType>
    </GetLabelAssociationsByEntityIdsRequest>
  </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>
    <GetLabelAssociationsByEntityIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <LabelAssociations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <LabelAssociation>
          <EntityId>ValueHere</EntityId>
          <LabelId>ValueHere</LabelId>
        </LabelAssociation>
      </LabelAssociations>
      <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:e329="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e329:KeyValuePairOfstringstring>
              <e329:key d4p1:nil="false">ValueHere</e329:key>
              <e329:value d4p1:nil="false">ValueHere</e329:value>
            </e329: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>
    </GetLabelAssociationsByEntityIdsResponse>
  </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<GetLabelAssociationsByEntityIdsResponse> GetLabelAssociationsByEntityIdsAsync(
	IList<long> entityIds,
	EntityType entityType)
{
	var request = new GetLabelAssociationsByEntityIdsRequest
	{
		EntityIds = entityIds,
		EntityType = entityType
	};

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

static GetLabelAssociationsByEntityIdsResponse getLabelAssociationsByEntityIds(
	ArrayOflong entityIds,
	EntityType entityType) throws RemoteException, Exception
{
	GetLabelAssociationsByEntityIdsRequest request = new GetLabelAssociationsByEntityIdsRequest();

	request.setEntityIds(entityIds);
	request.setEntityType(entityType);

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

static function GetLabelAssociationsByEntityIds(
	$entityIds,
	$entityType)
{

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

	$request = new GetLabelAssociationsByEntityIdsRequest();

	$request->EntityIds = $entityIds;
	$request->EntityType = $entityType;

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

response=campaignmanagement_service.GetLabelAssociationsByEntityIds(
	EntityIds=EntityIds,
	EntityType=EntityType)

Requirements

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

Request Url

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/LabelAssociations/QueryByEntityIds

Request Elements

The GetLabelAssociationsByEntityIdsRequest 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
EntityIds The list of entity identifiers used to request label associations.

The maximum size of the list is 100 items per service request.		 long array
EntityType Filters the returned associations by entity type.

The supported entity type values are Campaign, AdGroup, Ad, and Keyword.		 EntityType

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 GetLabelAssociationsByEntityIdsResponse 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
LabelAssociations An array of label associations.

For each entity identifier specified in the request, zero or more LabelAssociation objects are returned. Whereas the order of the returned LabelAssociation objects is guaranteed in the order of the requested entity identifiers, please note that multiple LabelAssociation objects can be returned for the same entity identifier.		 LabelAssociation array
PartialErrors An array of BatchError objects that contain details for any associations that were not successfully retrieved.

The list of errors corresponds directly to the list of associations in the request. Items of the list may be returned as null. For each list index where an association was successfully retrieved, the corresponding error element will be null. Ideally all associations are retrieved successfully and all elements in this list are null.		 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.

{
  "EntityIds": [
    "LongValueHere"
  ],
  "EntityType": "ValueHere"
}

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 BatchError is EditorialError.

{
  "LabelAssociations": [
    {
      "EntityId": "LongValueHere",
      "LabelId": "LongValueHere"
    }
  ],
  "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<GetLabelAssociationsByEntityIdsResponse> GetLabelAssociationsByEntityIdsAsync(
	IList<long> entityIds,
	EntityType entityType)
{
	var request = new GetLabelAssociationsByEntityIdsRequest
	{
		EntityIds = entityIds,
		EntityType = entityType
	};

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

static GetLabelAssociationsByEntityIdsResponse getLabelAssociationsByEntityIds(
	ArrayOflong entityIds,
	EntityType entityType) throws RemoteException, Exception
{
	GetLabelAssociationsByEntityIdsRequest request = new GetLabelAssociationsByEntityIdsRequest();

	request.setEntityIds(entityIds);
	request.setEntityType(entityType);

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

static function GetLabelAssociationsByEntityIds(
	$entityIds,
	$entityType)
{

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

	$request = new GetLabelAssociationsByEntityIdsRequest();

	$request->EntityIds = $entityIds;
	$request->EntityType = $entityType;

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

response=campaignmanagement_service.GetLabelAssociationsByEntityIds(
	EntityIds=EntityIds,
	EntityType=EntityType)