Operação de Serviço AddNegativeKeywordsToEntities - Gestão de Campanhas

Artigo
12/21/2023

Adiciona palavras-chave negativas à campanha ou grupo de anúncios especificado.

A operação não adiciona palavras-chave negativas a uma lista de palavras-chave negativas partilhadas. Veja AddListItemsToSharedList para obter mais informações.

Sugestão

Para obter uma descrição geral, veja o guia técnico Palavras-chave Negativas .

Elementos do Pedido

O objeto AddNegativeKeywordsToEntitiesRequest 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
EntityNegativeKeywords	Uma matriz de palavra-chave negativa com a entidade associada, como uma campanha ou grupo de anúncios. As palavras-chave negativas especificadas serão anexadas a quaisquer palavras-chave negativas existentes se o limite de 20 000 palavras-chave negativas por campanha ou grupo de anúncios associado não for excedido. O EntityType especificado em cada EntityNegativeKeyword tem de ser definido para o mesmo valor. Esta matriz pode conter um máximo de 1 elemento EntityNegativeKeyword , que contém até 20 000 palavras-chave negativas.	Matriz EntityNegativeKeyword

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 AddNegativeKeywordsToEntitiesResponse 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
NegativeKeywordIds	Uma lista de IdCollection correspondente às palavras-chave negativas que foram adicionadas para a entidade correspondente. Numa IdCollection, a lista de IDs corresponde diretamente à lista de palavras-chave negativas no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista onde não foi adicionada uma palavra-chave negativa, o elemento correspondente será nulo.	Matriz IdCollection
NestedPartialErrors	Uma matriz de objetos BatchErrorCollection que contêm detalhes para qualquer palavra-chave negativa que não tenha sido adicionada com êxito. O erro de nível superior em cada objeto BatchErrorCollection corresponde a potenciais erros de campanha ou grupo de anúncios. A lista aninhada de objetos BatchError incluiria quaisquer erros específicos das palavras-chave negativas que tentou adicionar à campanha ou ao grupo de anúncios. 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 BatchErrorCollection

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">AddNegativeKeywordsToEntities</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>
    <AddNegativeKeywordsToEntitiesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityNegativeKeywords i:nil="false">
        <EntityNegativeKeyword>
          <EntityId>ValueHere</EntityId>
          <EntityType i:nil="false">ValueHere</EntityType>
          <NegativeKeywords i:nil="false">
            <NegativeKeyword>
              <Id i:nil="false">ValueHere</Id>
              <MatchType i:nil="false">ValueHere</MatchType>
              <Text i:nil="false">ValueHere</Text>
            </NegativeKeyword>
          </NegativeKeywords>
        </EntityNegativeKeyword>
      </EntityNegativeKeywords>
    </AddNegativeKeywordsToEntitiesRequest>
  </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>
    <AddNegativeKeywordsToEntitiesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <NegativeKeywordIds d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <IdCollection>
          <Ids d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </Ids>
        </IdCollection>
      </NegativeKeywordIds>
      <NestedPartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchErrorCollection d4p1:type="-- derived type specified here with the appropriate prefix --">
          <BatchErrors d4p1:nil="false">
            <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:e54="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
                <e54:KeyValuePairOfstringstring>
                  <e54:key d4p1:nil="false">ValueHere</e54:key>
                  <e54:value d4p1:nil="false">ValueHere</e54:value>
                </e54: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>
          </BatchErrors>
          <Code d4p1:nil="false">ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e55="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e55:KeyValuePairOfstringstring>
              <e55:key d4p1:nil="false">ValueHere</e55:key>
              <e55:value d4p1:nil="false">ValueHere</e55:value>
            </e55: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 EditorialErrorCollection-->
          <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>
        </BatchErrorCollection>
      </NestedPartialErrors>
    </AddNegativeKeywordsToEntitiesResponse>
  </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<AddNegativeKeywordsToEntitiesResponse> AddNegativeKeywordsToEntitiesAsync(
	IList<EntityNegativeKeyword> entityNegativeKeywords)
{
	var request = new AddNegativeKeywordsToEntitiesRequest
	{
		EntityNegativeKeywords = entityNegativeKeywords
	};

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

static AddNegativeKeywordsToEntitiesResponse addNegativeKeywordsToEntities(
	ArrayOfEntityNegativeKeyword entityNegativeKeywords) throws RemoteException, Exception
{
	AddNegativeKeywordsToEntitiesRequest request = new AddNegativeKeywordsToEntitiesRequest();

	request.setEntityNegativeKeywords(entityNegativeKeywords);

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

static function AddNegativeKeywordsToEntities(
	$entityNegativeKeywords)
{

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

	$request = new AddNegativeKeywordsToEntitiesRequest();

	$request->EntityNegativeKeywords = $entityNegativeKeywords;

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

response=campaignmanagement_service.AddNegativeKeywordsToEntities(
	EntityNegativeKeywords=EntityNegativeKeywords)

Requisitos

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

Partilhar via