Operação do Serviço GetEstimatedPositionByKeywords - Ad Insight

Obtém a posição estimada nos resultados da pesquisa se o valor de licitação especificado for utilizado para as palavras-chave especificadas. Além disso, a operação fornece estimativas de cliques, custo médio por clique (CPC) e impressões de que as palavras-chave podem ser geradas com a oferta estimada.

As estimativas não são uma predição ou garantia de desempenho futuro.

Nota

Esta operação destina-se a campanhas de pesquisa com a estratégia de licitação cpc melhorada.

Elementos do Pedido

O objeto GetEstimatedPositionByKeywordsRequest 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 cujos dados de desempenho são utilizados para ajudar a determinar o desempenho da palavra-chave no contexto do grupo de anúncios. Especificar um grupo de anúncios ajuda a melhorar a precisão da posição sugerida. Se especificar um grupo de anúncios, tem de especificar a campanha à qual pertence.	Longo
CampaignId	O identificador da campanha que detém o grupo de anúncios especificado no AdGroupId. Se não especificar um grupo de anúncios, os dados de desempenho da campanha são utilizados para ajudar a determinar o desempenho da palavra-chave no contexto da campanha. Especificar uma campanha e um grupo de anúncios ajuda a melhorar a precisão da posição sugerida. Se não forem especificados AdGroupId ou CampaignId , a operação utiliza o elemento de cabeçalho CustomerAccountId especificado para ajudar a determinar o desempenho da palavra-chave no contexto da conta.	Longo
CurrencyCode	O código ISO da unidade monetária a utilizar para calcular as estimativas de custos e o valor de licitação sugerido. Se não estiver definido, o serviço determina a moeda da conta especificada no elemento de cabeçalho CustomerAccountId . Se nem Currency nem CustomerAccountId estiverem definidos, o serviço utiliza USD.	CurrencyCode
Palavras-chave	Uma matriz de palavras-chave para as quais pretende obter a posição estimada nos resultados da pesquisa, com base no valor de licitação especificado. Pode especificar 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 utilizado em paralelo com os identificadores de localização para estimar a posição. O idioma tem de ser suportado em cada uma das localizações que especificar em LocationIds. Para valores de idioma possíveis, veja Idiomas de Anúncios. Se não especificar o idioma, a operação de serviço utiliza o idioma do AdGroupId ou CampaignId especificado. Se nenhuma destas propriedades estiver definida, a en (inglês) é utilizada por predefinição.	cadeia
LocationIds	O identificador ou identificadores das localizações geográficas a utilizar para estimar a posição. Todas as localizações têm de suportar o idioma especificado no elemento Idioma . Embora possa especificar vários identificadores de localização, como melhor prática para as estimativas de posição mais precisas por localização, deve especificar apenas uma localização por chamada de serviço. Para obter possíveis identificadores de localização, veja Códigos de Localização Geográfica. Se não especificar nenhuma localização, a operação de serviço utiliza os critérios de localização do AdGroupId ou CampaignId especificados. Se nenhuma destas propriedades estiver definida, é utilizado 190 (Estados Unidos) por predefinição.	matriz longa
MatchTypes	Uma matriz de tipos de correspondência exclusivos para os quais pretende obter estimativas. Não pode especificar o Tipo de correspondência de conteúdo.	Matriz MatchType
MaxBid	O valor máximo da oferta a utilizar para determinar a posição estimada nos resultados da pesquisa.	duplo

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 GetEstimatedPositionByKeywordsResponse 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
KeywordEstimatedPositions	Uma matriz de objetos de dados KeywordEstimatedPosition . A matriz contém um item para cada palavra-chave especificada no pedido. Se a palavra-chave não for válida, o item correspondente na matriz será nulo. Se os dados estiverem disponíveis para a palavra-chave, o EstimatedPositionAndTraffic fornecerá a posição estimada nos resultados da pesquisa onde os anúncios podem aparecer, com base no valor de licitação especificado. Caso contrário, o elemento EstimatedPositions será definido como nulo.	Matriz KeywordEstimatedPosition

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">GetEstimatedPositionByKeywords</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>
    <GetEstimatedPositionByKeywordsRequest 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>
      <MaxBid>ValueHere</MaxBid>
      <Language i:nil="false">ValueHere</Language>
      <LocationIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </LocationIds>
      <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
      <MatchTypes i:nil="false">
        <MatchType>ValueHere</MatchType>
      </MatchTypes>
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
    </GetEstimatedPositionByKeywordsRequest>
  </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>
    <GetEstimatedPositionByKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedPositions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordEstimatedPosition>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <EstimatedPositions d4p1:nil="false">
            <EstimatedPositionAndTraffic>
              <MatchType>ValueHere</MatchType>
              <MinClicksPerWeek>ValueHere</MinClicksPerWeek>
              <MaxClicksPerWeek>ValueHere</MaxClicksPerWeek>
              <AverageCPC>ValueHere</AverageCPC>
              <MinImpressionsPerWeek>ValueHere</MinImpressionsPerWeek>
              <MaxImpressionsPerWeek>ValueHere</MaxImpressionsPerWeek>
              <CTR>ValueHere</CTR>
              <MinTotalCostPerWeek>ValueHere</MinTotalCostPerWeek>
              <MaxTotalCostPerWeek>ValueHere</MaxTotalCostPerWeek>
              <CurrencyCode>ValueHere</CurrencyCode>
              <EstimatedAdPosition>ValueHere</EstimatedAdPosition>
            </EstimatedPositionAndTraffic>
          </EstimatedPositions>
        </KeywordEstimatedPosition>
      </KeywordEstimatedPositions>
    </GetEstimatedPositionByKeywordsResponse>
  </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<GetEstimatedPositionByKeywordsResponse> GetEstimatedPositionByKeywordsAsync(
	IList<string> keywords,
	double maxBid,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	IList<MatchType> matchTypes,
	long? campaignId,
	long? adGroupId)
{
	var request = new GetEstimatedPositionByKeywordsRequest
	{
		Keywords = keywords,
		MaxBid = maxBid,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		MatchTypes = matchTypes,
		CampaignId = campaignId,
		AdGroupId = adGroupId
	};

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

static GetEstimatedPositionByKeywordsResponse getEstimatedPositionByKeywords(
	ArrayOfstring keywords,
	double maxBid,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	ArrayOfMatchType matchTypes,
	java.lang.Long campaignId,
	java.lang.Long adGroupId) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordsRequest request = new GetEstimatedPositionByKeywordsRequest();

	request.setKeywords(keywords);
	request.setMaxBid(maxBid);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setMatchTypes(matchTypes);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);

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

static function GetEstimatedPositionByKeywords(
	$keywords,
	$maxBid,
	$language,
	$locationIds,
	$currencyCode,
	$matchTypes,
	$campaignId,
	$adGroupId)
{

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

	$request = new GetEstimatedPositionByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->MaxBid = $maxBid;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->MatchTypes = $matchTypes;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;

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

response=adinsight_service.GetEstimatedPositionByKeywords(
	Keywords=Keywords,
	MaxBid=MaxBid,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	MatchTypes=MatchTypes,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId)

Requisitos

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

URL do Pedido

URL de Produção

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/EstimatedPosition/QueryByKeywords

Sandbox URL

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/EstimatedPosition/QueryByKeywords

Elementos do Pedido

O objeto GetEstimatedPositionByKeywordsRequest 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
AdGroupId	O identificador do grupo de anúncios cujos dados de desempenho são utilizados para ajudar a determinar o desempenho da palavra-chave no contexto do grupo de anúncios. Especificar um grupo de anúncios ajuda a melhorar a precisão da posição sugerida. Se especificar um grupo de anúncios, tem de especificar a campanha à qual pertence.	Longo
CampaignId	O identificador da campanha que detém o grupo de anúncios especificado no AdGroupId. Se não especificar um grupo de anúncios, os dados de desempenho da campanha são utilizados para ajudar a determinar o desempenho da palavra-chave no contexto da campanha. Especificar uma campanha e um grupo de anúncios ajuda a melhorar a precisão da posição sugerida. Se não forem especificados AdGroupId ou CampaignId , a operação utiliza o elemento de cabeçalho CustomerAccountId especificado para ajudar a determinar o desempenho da palavra-chave no contexto da conta.	Longo
CurrencyCode	O código ISO da unidade monetária a utilizar para calcular as estimativas de custos e o valor de licitação sugerido. Se não estiver definido, o serviço determina a moeda da conta especificada no elemento de cabeçalho CustomerAccountId . Se nem Currency nem CustomerAccountId estiverem definidos, o serviço utiliza USD.	CurrencyCode
Palavras-chave	Uma matriz de palavras-chave para as quais pretende obter a posição estimada nos resultados da pesquisa, com base no valor de licitação especificado. Pode especificar 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 utilizado em paralelo com os identificadores de localização para estimar a posição. O idioma tem de ser suportado em cada uma das localizações que especificar em LocationIds. Para valores de idioma possíveis, veja Idiomas de Anúncios. Se não especificar o idioma, a operação de serviço utiliza o idioma do AdGroupId ou CampaignId especificado. Se nenhuma destas propriedades estiver definida, a en (inglês) é utilizada por predefinição.	cadeia
LocationIds	O identificador ou identificadores das localizações geográficas a utilizar para estimar a posição. Todas as localizações têm de suportar o idioma especificado no elemento Idioma . Embora possa especificar vários identificadores de localização, como melhor prática para as estimativas de posição mais precisas por localização, deve especificar apenas uma localização por chamada de serviço. Para obter possíveis identificadores de localização, veja Códigos de Localização Geográfica. Se não especificar nenhuma localização, a operação de serviço utiliza os critérios de localização do AdGroupId ou CampaignId especificados. Se nenhuma destas propriedades estiver definida, é utilizado 190 (Estados Unidos) por predefinição.	matriz longa
MatchTypes	Uma matriz de tipos de correspondência exclusivos para os quais pretende obter estimativas. Não pode especificar o Tipo de correspondência de conteúdo.	Matriz MatchType
MaxBid	O valor máximo da oferta a utilizar para determinar a posição estimada nos resultados da pesquisa.	duplo

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 GetEstimatedPositionByKeywordsResponse 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
KeywordEstimatedPositions	Uma matriz de objetos de dados KeywordEstimatedPosition . A matriz contém um item para cada palavra-chave especificada no pedido. Se a palavra-chave não for válida, o item correspondente na matriz será nulo. Se os dados estiverem disponíveis para a palavra-chave, o EstimatedPositionAndTraffic fornecerá a posição estimada nos resultados da pesquisa onde os anúncios podem aparecer, com base no valor de licitação especificado. Caso contrário, o elemento EstimatedPositions será definido como nulo.	Matriz KeywordEstimatedPosition

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.

{
  "Keywords": [
    "ValueHere"
  ],
  "MaxBid": DoubleValueHere,
  "Language": "ValueHere",
  "LocationIds": [
    "LongValueHere"
  ],
  "CurrencyCode": "ValueHere",
  "MatchTypes": [
    "ValueHere"
  ],
  "CampaignId": "LongValueHere",
  "AdGroupId": "LongValueHere"
}

JSON de Resposta

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

{
  "KeywordEstimatedPositions": [
    {
      "EstimatedPositions": [
        {
          "AverageCPC": DoubleValueHere,
          "CTR": DoubleValueHere,
          "CurrencyCode": "ValueHere",
          "EstimatedAdPosition": DoubleValueHere,
          "MatchType": "ValueHere",
          "MaxClicksPerWeek": DoubleValueHere,
          "MaxImpressionsPerWeek": "LongValueHere",
          "MaxTotalCostPerWeek": DoubleValueHere,
          "MinClicksPerWeek": DoubleValueHere,
          "MinImpressionsPerWeek": "LongValueHere",
          "MinTotalCostPerWeek": DoubleValueHere
        }
      ],
      "Keyword": "ValueHere"
    }
  ]
}

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<GetEstimatedPositionByKeywordsResponse> GetEstimatedPositionByKeywordsAsync(
	IList<string> keywords,
	double maxBid,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	IList<MatchType> matchTypes,
	long? campaignId,
	long? adGroupId)
{
	var request = new GetEstimatedPositionByKeywordsRequest
	{
		Keywords = keywords,
		MaxBid = maxBid,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		MatchTypes = matchTypes,
		CampaignId = campaignId,
		AdGroupId = adGroupId
	};

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

static GetEstimatedPositionByKeywordsResponse getEstimatedPositionByKeywords(
	ArrayOfstring keywords,
	double maxBid,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	ArrayOfMatchType matchTypes,
	java.lang.Long campaignId,
	java.lang.Long adGroupId) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordsRequest request = new GetEstimatedPositionByKeywordsRequest();

	request.setKeywords(keywords);
	request.setMaxBid(maxBid);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setMatchTypes(matchTypes);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);

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

static function GetEstimatedPositionByKeywords(
	$keywords,
	$maxBid,
	$language,
	$locationIds,
	$currencyCode,
	$matchTypes,
	$campaignId,
	$adGroupId)
{

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

	$request = new GetEstimatedPositionByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->MaxBid = $maxBid;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->MatchTypes = $matchTypes;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;

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

response=adinsight_service.GetEstimatedPositionByKeywords(
	Keywords=Keywords,
	MaxBid=MaxBid,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	MatchTypes=MatchTypes,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId)