Partilhar via

Operação de Serviço GetLabelAssociationsByEntityIds – Gestão de Campanhas

  • Artigo

Obtém associações de etiquetas por identificadores de entidade.

Elementos do Pedido

O objeto GetLabelAssociationsByEntityIdsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento Descrição Tipo de Dados
EntityIds A lista de identificadores de entidade utilizados para pedir associações de etiquetas.

O tamanho máximo da lista é de 100 itens por pedido de serviço.		 matriz longa
EntityType Filtra as associações devolvidas por tipo de entidade.

Os valores de tipo de entidade suportados são Campaign, AdGroup, Ad e Keyword.		 EntityType

Elementos do Cabeçalho do Pedido

Elemento Descrição Tipo de Dados
AuthenticationToken O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising.

Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).		 cadeia
CustomerAccountId O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo.

Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.		 cadeia
CustomerId O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo.

Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.		 cadeia
DeveloperToken O token de programador utilizado para aceder à API de Anúncios do Bing.

Para obter mais informações, veja Obter um Token de Programador.		 cadeia
Palavra-passe Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia
Nome de Utilizador Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia

Elementos de Resposta

O objeto GetLabelAssociationsByEntityIdsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento Descrição Tipo de Dados
LabelAssociations Uma matriz de associações de etiquetas.

Para cada identificador de entidade especificado no pedido, são devolvidos zero ou mais objetos LabelAssociation . Enquanto a ordem dos objetos LabelAssociation devolvidos é garantida pela ordem dos identificadores de entidade pedidos, tenha em atenção que vários objetos LabelAssociation podem ser devolvidos para o mesmo identificador de entidade.		 Matriz LabelAssociation
PartialErrors Uma matriz de objetos BatchError que contêm detalhes para quaisquer associações que não tenham sido obtidas com êxito.

A lista de erros corresponde diretamente à lista de associações no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista onde uma associação foi obtida com êxito, o elemento de erro correspondente será nulo. Idealmente, todas as associações são obtidas com êxito e todos os elementos nesta lista são nulos.		 Matriz BatchError

Elementos do Cabeçalho de Resposta

Elemento Descrição Tipo de Dados
TrackingId O identificador da entrada de registo que contém os detalhes da chamada à API. cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

<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>

Soap de Resposta

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta SOAP.

<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:e475="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e475:KeyValuePairOfstringstring>
              <e475:key d4p1:nil="false">ValueHere</e475:key>
              <e475:value d4p1:nil="false">ValueHere</e475:value>
            </e475: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>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)

Requisitos

Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13

URL do Pedido

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

Elementos do Pedido

O objeto GetLabelAssociationsByEntityIdsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento Descrição Tipo de Dados
EntityIds A lista de identificadores de entidade utilizados para pedir associações de etiquetas.

O tamanho máximo da lista é de 100 itens por pedido de serviço.		 matriz longa
EntityType Filtra as associações devolvidas por tipo de entidade.

Os valores de tipo de entidade suportados são Campaign, AdGroup, Ad e Keyword.		 EntityType

Elementos do Cabeçalho do Pedido

Elemento Descrição Tipo de Dados
Autorização O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Certifique-se de que o token tem o prefixo "Portador", que é necessário para uma autenticação adequada.

Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).		 cadeia
CustomerAccountId O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo.

Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.		 cadeia
CustomerId O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo.

Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.		 cadeia
DeveloperToken O token de programador utilizado para aceder à API de Anúncios do Bing.

Para obter mais informações, veja Obter um Token de Programador.		 cadeia
Palavra-passe Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia
Nome de Utilizador Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia

Elementos de Resposta

O objeto GetLabelAssociationsByEntityIdsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no JSON de Resposta.

Elementos do Corpo da Resposta

Elemento Descrição Tipo de Dados
LabelAssociations Uma matriz de associações de etiquetas.

Para cada identificador de entidade especificado no pedido, são devolvidos zero ou mais objetos LabelAssociation . Enquanto a ordem dos objetos LabelAssociation devolvidos é garantida pela ordem dos identificadores de entidade pedidos, tenha em atenção que vários objetos LabelAssociation podem ser devolvidos para o mesmo identificador de entidade.		 Matriz LabelAssociation
PartialErrors Uma matriz de objetos BatchError que contêm detalhes para quaisquer associações que não tenham sido obtidas com êxito.

A lista de erros corresponde diretamente à lista de associações no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista onde uma associação foi obtida com êxito, o elemento de erro correspondente será nulo. Idealmente, todas as associações são obtidas com êxito e todos os elementos nesta lista são nulos.		 Matriz BatchError

Elementos do Cabeçalho de Resposta

Elemento Descrição Tipo de Dados
TrackingId O identificador da entrada de registo que contém os detalhes da chamada à API. cadeia

Pedir JSON

Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho do pedido JSON. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

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

JSON de Resposta

Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta JSON.

Segue-se um exemplo aplicável se o tipo de BatchError for 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
    }
  ]
}

Sintaxe de Código

Para chamar a API REST através de SDKs, tem de atualizar o SDK para uma determinada versão e configurar os parâmetros do sistema. A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)