GetLabelAssociationsByLabelIds Service Operation - Campaign Management

Bài viết
03/20/2023

Gets label associations by label identifiers.

Request Elements

The GetLabelAssociationsByLabelIdsRequest 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
EntityType	Filters the returned associations by entity type. The supported entity type values are Campaign, AdGroup, Ad, and Keyword.	EntityType
LabelIds	The list of label identifiers used to request label associations. You must include exactly one label identifier in the list.	long array
PageInfo	Determines the index and size of label association results per page. Up to 1,000 label associations will be returned per page, so you might need to request multiple pages to get all of the label associations. If this element is not specified, the defaut page Index is 0 and the default Size is 1,000.	Paging

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 GetLabelAssociationsByLabelIdsResponse 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 label 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 label identifiers, please note that multiple LabelAssociation objects can be returned for the same label identifier. The entity identifiers are in ascending order for a given label's associations. It is possible to receive duplicate associations across multiple pages, so you should check for duplicate results.	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">GetLabelAssociationsByLabelIds</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>
    <GetLabelAssociationsByLabelIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityType>ValueHere</EntityType>
      <LabelIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </LabelIds>
      <PageInfo i:nil="false">
        <Index>ValueHere</Index>
        <Size>ValueHere</Size>
      </PageInfo>
    </GetLabelAssociationsByLabelIdsRequest>
  </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>
    <GetLabelAssociationsByLabelIdsResponse 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:e156="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e156:KeyValuePairOfstringstring>
              <e156:key d4p1:nil="false">ValueHere</e156:key>
              <e156:value d4p1:nil="false">ValueHere</e156:value>
            </e156: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>
    </GetLabelAssociationsByLabelIdsResponse>
  </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<GetLabelAssociationsByLabelIdsResponse> GetLabelAssociationsByLabelIdsAsync(
	EntityType entityType,
	IList<long> labelIds,
	Paging pageInfo)
{
	var request = new GetLabelAssociationsByLabelIdsRequest
	{
		EntityType = entityType,
		LabelIds = labelIds,
		PageInfo = pageInfo
	};

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

static GetLabelAssociationsByLabelIdsResponse getLabelAssociationsByLabelIds(
	EntityType entityType,
	ArrayOflong labelIds,
	Paging pageInfo) throws RemoteException, Exception
{
	GetLabelAssociationsByLabelIdsRequest request = new GetLabelAssociationsByLabelIdsRequest();

	request.setEntityType(entityType);
	request.setLabelIds(labelIds);
	request.setPageInfo(pageInfo);

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

static function GetLabelAssociationsByLabelIds(
	$entityType,
	$labelIds,
	$pageInfo)
{

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

	$request = new GetLabelAssociationsByLabelIdsRequest();

	$request->EntityType = $entityType;
	$request->LabelIds = $labelIds;
	$request->PageInfo = $pageInfo;

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

response=campaignmanagement_service.GetLabelAssociationsByLabelIds(
	EntityType=EntityType,
	LabelIds=LabelIds,
	PageInfo=PageInfo)

Requirements

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

Chia sẻ qua