Operação do Serviço GetHistoricalKeywordPerformance – Ad Insight
Obtém o desempenho histórico do termo de pesquisa normalizado. Os resultados são agregados por tipo de dispositivo.
Elementos do Pedido
O objeto GetHistoricalKeywordPerformanceRequest 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 |
|---|---|---|
| Dispositivos | Uma lista de um ou mais dos seguintes tipos de dispositivo: Computadores, NãoArtphones, Smartphones, Tablets. A predefinição é Computadores. A resposta inclui dados de desempenho de palavras-chave para os tipos de dispositivo que especificar apenas, se disponíveis. Utilizado para determinar o desempenho de uma palavra-chave nos tipos de dispositivo especificados. |
matriz de cadeia |
| Palavras-chave | Uma matriz de palavras-chave para as quais pretende obter estatísticas de desempenho históricas. 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 as palavras-chave são escritas. Os países/regiões que especificar no elemento PublisherCountries têm de suportar o idioma especificado. Os valores possíveis incluem dinamarquês, neerlandês, inglês, finlandês, francês, alemão, italiano, norueguês, português, espanhol, sueco e tradicionalchinês. |
cadeia |
| MatchTypes | Os tipos de correspondência para os quais pretende obter dados históricos. Não pode especificar o Tipo de correspondência de conteúdo. |
Matriz MatchType |
| PublisherCountries | Os códigos de país dos países/regiões a utilizar como origem dos dados históricos. Pode especificar um ou mais códigos de país. Cada país/região que especificar tem de suportar o idioma especificado no elemento Idioma . São suportadas as seguintes combinações de idioma e país/região: Dinamarquês: DK Neerlandês: NL Inglês: AU, CA, GB, ID, IN, MY, PH, SG, TH, US, VN Finlandês: FI Francês: CA, FR Alemão: AT, CH, DE Italiano: TI Norueguês: NB Português: BR Espanhol: AR, CL, CO, ES, MX, PE, VE Sueco: SE TradicionalChinês: HK, TW Se este elemento for nulo, por predefinição, o serviço inclui todos os países/regiões que suportam o idioma especificado. |
matriz de cadeia |
| TargetAdPosition | A posição dos resultados da pesquisa para os quais pretende obter dados de desempenho. Por exemplo, para obter dados de desempenho quando os anúncios aparecem na primeira posição da linha principal com a palavra-chave e o tipo de correspondência, defina este elemento como MainLine1. Para obter dados de desempenho quando os anúncios aparecem em qualquer posição dos resultados da pesquisa com a palavra-chave e o tipo de correspondência, defina este elemento como Todos. O valor predefinido é Tudo. Se especificar Tudo para este elemento, o serviço devolverá vários resultados por palavra-chave para cada posição de anúncio suportada. Se especificar Agregar, o serviço devolverá um resultado agregado. Os anúncios na barra lateral já não servem em sites pertencentes ao Bing e operados no Estados Unidos. Se apenas pedir dados da primeira página, por exemplo, FirstPage1 para o Estados Unidos (E.U.A.), o elemento KeywordKPIs no resultado será nulo/vazio. Se incluir países/regiões adicionais, por exemplo, E.U.A. e AC no mesmo pedido, os resultados da primeira página só são atribuídos a países/regiões fora do Estados Unidos. |
AdPosition |
| TimeInterval | O período de tempo que identifica os dados a utilizar para determinar o índice de desempenho chave das palavras-chave especificadas. Por exemplo, utilize dados dos sete dias anteriores ou dos 30 dias anteriores para determinar o desempenho da palavra-chave. O valor predefinido é LastDay. |
TimeInterval |
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 GetHistoricalKeywordPerformanceResponse 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 |
|---|---|---|
| KeywordHistoricalPerformances | Uma matriz de objetos de dados KeywordHistoricalPerformance . A matriz contém um item para cada palavra-chave, dispositivo, tipo de correspondência e posição de anúncio especificada no pedido. Se a palavra-chave não for válida ou não tiver dados disponíveis, o item correspondente na matriz será nulo. | Matriz KeywordHistoricalPerformance |
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">GetHistoricalKeywordPerformance</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>
<GetHistoricalKeywordPerformanceRequest 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>
<TimeInterval i:nil="false">ValueHere</TimeInterval>
<TargetAdPosition i:nil="false">ValueHere</TargetAdPosition>
<MatchTypes i:nil="false">
<MatchType>ValueHere</MatchType>
</MatchTypes>
<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>
<Devices i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Devices>
</GetHistoricalKeywordPerformanceRequest>
</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>
<GetHistoricalKeywordPerformanceResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordHistoricalPerformances d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordHistoricalPerformance>
<Keyword d4p1:nil="false">ValueHere</Keyword>
<KeywordKPIs d4p1:nil="false">
<KeywordKPI>
<Device d4p1:nil="false">ValueHere</Device>
<MatchType>ValueHere</MatchType>
<AdPosition>ValueHere</AdPosition>
<Clicks>ValueHere</Clicks>
<Impressions>ValueHere</Impressions>
<AverageCPC>ValueHere</AverageCPC>
<CTR>ValueHere</CTR>
<TotalCost>ValueHere</TotalCost>
<AverageBid>ValueHere</AverageBid>
</KeywordKPI>
</KeywordKPIs>
</KeywordHistoricalPerformance>
</KeywordHistoricalPerformances>
</GetHistoricalKeywordPerformanceResponse>
</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<GetHistoricalKeywordPerformanceResponse> GetHistoricalKeywordPerformanceAsync(
IList<string> keywords,
TimeInterval? timeInterval,
AdPosition? targetAdPosition,
IList<MatchType> matchTypes,
string language,
IList<string> publisherCountries,
IList<string> devices)
{
var request = new GetHistoricalKeywordPerformanceRequest
{
Keywords = keywords,
TimeInterval = timeInterval,
TargetAdPosition = targetAdPosition,
MatchTypes = matchTypes,
Language = language,
PublisherCountries = publisherCountries,
Devices = devices
};
return (await AdInsightService.CallAsync((s, r) => s.GetHistoricalKeywordPerformanceAsync(r), request));
}
static GetHistoricalKeywordPerformanceResponse getHistoricalKeywordPerformance(
ArrayOfstring keywords,
TimeInterval timeInterval,
AdPosition targetAdPosition,
ArrayOfMatchType matchTypes,
java.lang.String language,
ArrayOfstring publisherCountries,
ArrayOfstring devices) throws RemoteException, Exception
{
GetHistoricalKeywordPerformanceRequest request = new GetHistoricalKeywordPerformanceRequest();
request.setKeywords(keywords);
request.setTimeInterval(timeInterval);
request.setTargetAdPosition(targetAdPosition);
request.setMatchTypes(matchTypes);
request.setLanguage(language);
request.setPublisherCountries(publisherCountries);
request.setDevices(devices);
return AdInsightService.getService().getHistoricalKeywordPerformance(request);
}
static function GetHistoricalKeywordPerformance(
$keywords,
$timeInterval,
$targetAdPosition,
$matchTypes,
$language,
$publisherCountries,
$devices)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetHistoricalKeywordPerformanceRequest();
$request->Keywords = $keywords;
$request->TimeInterval = $timeInterval;
$request->TargetAdPosition = $targetAdPosition;
$request->MatchTypes = $matchTypes;
$request->Language = $language;
$request->PublisherCountries = $publisherCountries;
$request->Devices = $devices;
return $GLOBALS['AdInsightProxy']->GetService()->GetHistoricalKeywordPerformance($request);
}
response=adinsight_service.GetHistoricalKeywordPerformance(
Keywords=Keywords,
TimeInterval=TimeInterval,
TargetAdPosition=TargetAdPosition,
MatchTypes=MatchTypes,
Language=Language,
PublisherCountries=PublisherCountries,
Devices=Devices)
Requisitos
Serviço: AdInsightService.svc v13
Espaço de nomes: https://bingads.microsoft.com/AdInsight/v13
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários