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

Artigo
12/21/2023

Obtém etiquetas por identificadores de etiqueta.

Elementos do Pedido

O objeto GetLabelsByIdsRequest 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
LabelIds	Os identificadores das etiquetas a obter. O tamanho máximo da lista é de 1000 itens por pedido de serviço. Se este elemento não for especificado, a operação devolverá todas as etiquetas ativas na conta (1000 resultados por página).	matriz longa
PageInfo	Determina o índice e o tamanho dos resultados da etiqueta por página. Este elemento de pedido é opcional. Se este elemento não for especificado, o Índice da página de desfasamento é 0 e o Tamanho predefinido é 1000.	Paginação

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 GetLabelsByIdsResponse 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
Etiquetas	Uma matriz de objetos de Etiqueta que corresponde diretamente aos identificadores de etiqueta que especificou no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista em que uma etiqueta não foi obtida, o elemento correspondente será nulo.	Matriz de etiquetas
PartialErrors	Uma matriz de objetos BatchError que contêm detalhes para quaisquer itens de pedido que não tenham sido bem-sucedidos. A lista de erros não corresponde diretamente à lista de itens no pedido. A lista pode estar vazia se não existirem erros ou pode incluir um ou mais objetos de erro correspondentes a cada item de lista sem êxito no pedido.	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">GetLabelsByIds</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>
    <GetLabelsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <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>
    </GetLabelsByIdsRequest>
  </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>
    <GetLabelsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Labels d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Label>
          <ColorCode d4p1:nil="false">ValueHere</ColorCode>
          <Description d4p1:nil="false">ValueHere</Description>
          <Id d4p1:nil="false">ValueHere</Id>
          <Name d4p1:nil="false">ValueHere</Name>
        </Label>
      </Labels>
      <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:e157="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e157:KeyValuePairOfstringstring>
              <e157:key d4p1:nil="false">ValueHere</e157:key>
              <e157:value d4p1:nil="false">ValueHere</e157:value>
            </e157: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>
    </GetLabelsByIdsResponse>
  </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<GetLabelsByIdsResponse> GetLabelsByIdsAsync(
	IList<long> labelIds,
	Paging pageInfo)
{
	var request = new GetLabelsByIdsRequest
	{
		LabelIds = labelIds,
		PageInfo = pageInfo
	};

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

static GetLabelsByIdsResponse getLabelsByIds(
	ArrayOflong labelIds,
	Paging pageInfo) throws RemoteException, Exception
{
	GetLabelsByIdsRequest request = new GetLabelsByIdsRequest();

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

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

static function GetLabelsByIds(
	$labelIds,
	$pageInfo)
{

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

	$request = new GetLabelsByIdsRequest();

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

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

response=campaignmanagement_service.GetLabelsByIds(
	LabelIds=LabelIds,
	PageInfo=PageInfo)

Requisitos

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

Partilhar via