Operação de Serviço SuggestKeywordsFromExistingKeywords - Ad Insight

Artigo
12/21/2023

Sugere palavras-chave que podem ter um melhor desempenho do que as palavras-chave especificadas.

Elementos do Pedido

O objeto SuggestKeywordsFromExistingKeywordsRequest 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
AdGroupId	O identificador do grupo de anúncios para palavras-chave sugeridas. Este elemento ainda não é suportado e pode ser utilizado para influenciar sugestões de palavras-chave numa versão futura	long
CampaignId	O identificador da campanha para palavras-chave sugeridas. Este elemento ainda não é suportado e pode ser utilizado para influenciar sugestões de palavras-chave numa versão futura	long
ExcludeBrand	Um valor que determina se os resultados excluem palavras-chave da marca. Para excluir palavras-chave de marca no resultado, defina como verdadeiro. A predefinição é false.	booleano
Palavras-chave	Uma matriz de palavras-chave para as quais pretende obter palavras-chave sugeridas que poderiam ter um melhor desempenho. A matriz pode conter um máximo de 1000 palavras-chave e cada palavra-chave pode conter um máximo de 100 carateres.	matriz de cadeia
Idioma	O idioma no qual a palavra-chave é escrita. Os valores sensíveis às maiúsculas e minúsculas possíveis são inglês, francês e alemão. Veja a secção Observações abaixo para obter uma lista de fornecedores suportados para cada idioma. A predefinição é inglês.	cadeia
MaxSuggestionsPerKeyword	O número máximo de sugestões de palavras-chave a devolver por palavra-chave especificada. Se SuggestionType estiver definido como 4, pode pedir um máximo de 200 sugestões por palavra-chave; caso contrário, o máximo de sugestões que pode pedir é 100. A predefinição é 50.	int
PublisherCountries	Os códigos de país dos países/regiões a utilizar como origem de dados para determinar as palavras-chave sugeridas. Pode especificar um ou mais códigos de país. Cada país/região que especificar tem de suportar o idioma que especificou no elemento Idioma . Para obter os valores suportados, veja a secção Observações abaixo. A predefinição é todos os países/regiões que suportam o idioma especificado.	matriz de cadeia
RemoveDuplicates	Um valor booleano que determina se pretende remover palavras-chave duplicadas da lista de palavras-chave sugeridas. Para remover duplicados, defina como verdadeiro. A predefinição é false.	booleano
Tipo de Sugestão	O fornecedor a utilizar para gerar as sugestões de palavras-chave. Para obter uma lista de fornecedores possíveis, as restrições de idioma e país/região de cada fornecedor e o fornecedor predefinido por país/região, veja a secção Observações abaixo.	int

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 SuggestKeywordsFromExistingKeywordsResponse 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
Palavras-chaveSuggestions	Uma matriz de objetos de dados KeywordSuggestion . A matriz contém um item para cada palavra-chave especificada no pedido. O objeto contém uma lista de palavras-chave sugeridas que podem ter um melhor desempenho do que a palavra-chave especificada. Para cada palavra-chave sugerida, o objeto inclui uma classificação que indica a probabilidade de que a utilização da palavra-chave resulte na inclusão de um anúncio nos resultados de uma consulta de pesquisa. Se não existirem sugestões para uma palavra-chave, o elemento SuggestionsAndConfidence será nulo.	Matriz keywordSuggestion

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/AdInsight/v13">
    <Action mustUnderstand="1">SuggestKeywordsFromExistingKeywords</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>
    <SuggestKeywordsFromExistingKeywordsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Keywords i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Keywords>
      <Language i:nil="false">ValueHere</Language>
      <PublisherCountries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </PublisherCountries>
      <MaxSuggestionsPerKeyword i:nil="false">ValueHere</MaxSuggestionsPerKeyword>
      <SuggestionType i:nil="false">ValueHere</SuggestionType>
      <RemoveDuplicates i:nil="false">ValueHere</RemoveDuplicates>
      <ExcludeBrand i:nil="false">ValueHere</ExcludeBrand>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <CampaignId i:nil="false">ValueHere</CampaignId>
    </SuggestKeywordsFromExistingKeywordsRequest>
  </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/AdInsight/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <SuggestKeywordsFromExistingKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordSuggestions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordSuggestion>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <SuggestionsAndConfidence d4p1:nil="false">
            <KeywordAndConfidence>
              <SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
              <ConfidenceScore>ValueHere</ConfidenceScore>
            </KeywordAndConfidence>
          </SuggestionsAndConfidence>
        </KeywordSuggestion>
      </KeywordSuggestions>
    </SuggestKeywordsFromExistingKeywordsResponse>
  </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<SuggestKeywordsFromExistingKeywordsResponse> SuggestKeywordsFromExistingKeywordsAsync(
	IList<string> keywords,
	string language,
	IList<string> publisherCountries,
	int? maxSuggestionsPerKeyword,
	int? suggestionType,
	bool? removeDuplicates,
	bool? excludeBrand,
	long? adGroupId,
	long? campaignId)
{
	var request = new SuggestKeywordsFromExistingKeywordsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountries = publisherCountries,
		MaxSuggestionsPerKeyword = maxSuggestionsPerKeyword,
		SuggestionType = suggestionType,
		RemoveDuplicates = removeDuplicates,
		ExcludeBrand = excludeBrand,
		AdGroupId = adGroupId,
		CampaignId = campaignId
	};

	return (await AdInsightService.CallAsync((s, r) => s.SuggestKeywordsFromExistingKeywordsAsync(r), request));
}

static SuggestKeywordsFromExistingKeywordsResponse suggestKeywordsFromExistingKeywords(
	ArrayOfstring keywords,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	int maxSuggestionsPerKeyword,
	int suggestionType,
	boolean removeDuplicates,
	boolean excludeBrand,
	java.lang.Long adGroupId,
	java.lang.Long campaignId) throws RemoteException, Exception
{
	SuggestKeywordsFromExistingKeywordsRequest request = new SuggestKeywordsFromExistingKeywordsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setMaxSuggestionsPerKeyword(maxSuggestionsPerKeyword);
	request.setSuggestionType(suggestionType);
	request.setRemoveDuplicates(removeDuplicates);
	request.setExcludeBrand(excludeBrand);
	request.setAdGroupId(adGroupId);
	request.setCampaignId(campaignId);

	return AdInsightService.getService().suggestKeywordsFromExistingKeywords(request);
}

static function SuggestKeywordsFromExistingKeywords(
	$keywords,
	$language,
	$publisherCountries,
	$maxSuggestionsPerKeyword,
	$suggestionType,
	$removeDuplicates,
	$excludeBrand,
	$adGroupId,
	$campaignId)
{

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

	$request = new SuggestKeywordsFromExistingKeywordsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->MaxSuggestionsPerKeyword = $maxSuggestionsPerKeyword;
	$request->SuggestionType = $suggestionType;
	$request->RemoveDuplicates = $removeDuplicates;
	$request->ExcludeBrand = $excludeBrand;
	$request->AdGroupId = $adGroupId;
	$request->CampaignId = $campaignId;

	return $GLOBALS['AdInsightProxy']->GetService()->SuggestKeywordsFromExistingKeywords($request);
}

response=adinsight_service.SuggestKeywordsFromExistingKeywords(
	Keywords=Keywords,
	Language=Language,
	PublisherCountries=PublisherCountries,
	MaxSuggestionsPerKeyword=MaxSuggestionsPerKeyword,
	SuggestionType=SuggestionType,
	RemoveDuplicates=RemoveDuplicates,
	ExcludeBrand=ExcludeBrand,
	AdGroupId=AdGroupId,
	CampaignId=CampaignId)

Observações

Seguem-se os possíveis fornecedores de sugestões que pode especificar.

Tipo de Sugestão	Descrição
1	Devolve consultas de pesquisa que incluem a palavra-chave.
2	Devolve palavras-chave de outros grupos de anúncios que incluem a palavra-chave especificada.
3	Devolve consultas de pesquisa relacionadas com a palavra-chave especificada.
4	Devolve as melhores sugestões dos outros fornecedores.

Seguem-se os fornecedores suportados por cada país/região.

País/Região	Idioma	Tipos de Fornecedor Suportados	Tipo de Fornecedor Predefinido
Austrália (AU)	English	2,3,4	4
Canadá (AC)	English	2,3,4	4
França (FR)	French	2,3,4	4
Alemanha (DE)	German	1,2,3,4	4

Requisitos

Serviço: AdInsightService.svc v13
Espaço de nomes: https://bingads.microsoft.com/AdInsight/v13

Partilhar via