A API Search Ads 360 Reporting anterior será desativada em 30 de junho de 2024. A API Search Ads 360 Conversion não foi afetada e vai continuar compatível. Todo novo desenvolvimento de relatórios precisa usar a nova API Search Ads 360 Reporting.

A partir de abril de 2024, um erro supportedApiVersion será retornado ao solicitar um relatório. Veja os detalhes aqui.

Também é altamente recomendável migrar as implementações atuais do Search Ads 360 para a nova API. Consulte o Guia de introdução e o Guia de migração da nova API Search Ads 360 Reporting para saber mais informações.

Esta página foi traduzida pela API Cloud Translation.

Tipo de relatório: palavra-chave

Métricas de desempenho e atributos de configuração para palavras-chave.

Esse relatório só pode ser retornado por uma solicitação assíncrona (ou seja, pelo método Reports.request()).

Trecho de solicitação

Envie um corpo de solicitação Reports.request(), mas especifique "reportType": "keyword".

{
...
  "reportType": "keyword",
  "columns": [
    {
      "columnName": string,
      "headerText": string,
      "startDate": string,
      "endDate": string
    }
  ],
  "filters": [
    {
      "column": {
        "columnName": string,
      },
      ...
    },
    ...
  ],
...
}

Para cada coluna que você quer retornar ou filtrar no relatório, especifique o columnName listado na tabela abaixo. Também é possível especificar headerText, startDate e endDate. Algumas colunas não podem ser filtradas. Consulte "Filtrável" na tabela abaixo.

`columnName`	Descrição	Comportamento	Tipo	Filtrável
`status`	É o status da palavra-chave: `Active`, `Paused` ou `Removed`. Tanto campanhas, grupos de anúncios, palavras-chave quanto anúncios têm o próprio status. Consulte o status.	atributo	`Status`	Sim
`engineStatus`	Status adicional da palavra-chave na conta de mecanismo externo. Os status possíveis (dependendo do tipo de conta externa) incluem `criterion rarely served`, `criterion below first page bid`, `criterion low quality score`, `review`, `campaign paused` etc.	atributo	`String`	Sim
`creationTimestamp`	Carimbo de data/hora da criação da palavra-chave no formato ISO 8601.	atributo	`Timestamp`	Sim
`lastModifiedTimestamp`	Carimbo de data/hora da modificação mais recente da palavra-chave no formato ISO 8601.	atributo	`Timestamp`	Sim
`agency`	Nome da agência.	atributo	`String`	Sim
`agencyId`	ID da agência do DS.	atributo	`ID`	Sim
`advertiser`	Nome do anunciante.	atributo	`String`	Sim
`advertiserId`	ID do anunciante do DS.	atributo	`ID`	Sim
`account`	Nome da conta de mecanismo.	atributo	`String`	Sim
`accountId`	ID da conta de mecanismo do DS.	atributo	`ID`	Sim
`accountEngineId`	ID da conta externa.	atributo	`String`	Sim
`accountType`	Tipo de conta de mecanismo: `Google AdWords`, `Bing Ads`, `Yahoo Japan Listing Ads`, `Yahoo Search Marketing`, `Yahoo Gemini`, `Baidu` ou `Comparison Shopping`.	atributo	`Engine type`	Sim
`campaign`	Nome da campanha.	atributo	`String`	Sim
`campaignId`	ID da campanha do DS.	atributo	`ID`	Sim
`campaignStatus`	Status da campanha que contém este item.	atributo	`Status`	Sim
`adGroup`	Nome do grupo de anúncios.	atributo	`String`	Sim
`adGroupId`	ID do grupo de anúncios do DS.	atributo	`ID`	Sim
`adGroupStatus`	Status do grupo de anúncios que contém esse item.	atributo	`Status`	Sim
`keywordId`	ID de palavra-chave do DS Um valor de 0 indica que a palavra-chave não está atribuída.	atributo	`ID`	Sim
`keywordMatchType`	Tipo de correspondência de palavra-chave: `Broad`, `Exact`, `Phrase` ou `Content`.	atributo	`Match type`	Sim
`keywordText`	O texto da palavra-chave.	atributo	`String`	Sim
`keywordEngineId`	ID da palavra-chave na conta de mecanismo externo.	atributo	`ID`	Sim
`keywordMaxCpc`	Substitui o CPC máximo do grupo de anúncios e define o valor máximo que você quer pagar se alguém clicar em um anúncio dessa palavra-chave específica. Se esse campo estiver vazio, a palavra-chave usará o CPC máximo do grupo de anúncios.	atributo	`Money`	Sim
`effectiveKeywordMaxCpc`	O CPC máximo (custo máximo por clique) que está em vigor para esta palavra-chave. Ele terá o mesmo valor que o CPC máximo do grupo de anúncios ou, se a palavra-chave estiver substituindo a configuração do grupo de anúncios, o próprio CPC máximo.	atributo	`Money`	Sim
`keywordLandingPage`	O URL final que um usuário visitaria após clicar no seu anúncio. Consulte URLs da página de destino e do servidor de cliques.	atributo	`String`	Sim
`keywordClickserverUrl`	O URL usado pelo DS para rastrear a atividade. O usuário que clica em um anúncio acessa primeiro o URL do servidor de cliques e, em seguida, é redirecionado para a página de destino final. Consulte URLs da página de destino e do servidor de cliques.	atributo	`String`	Sim
`isDisplayKeyword`	Indica se esta é uma palavra-chave de marcador usada para relatórios de exibição e de veiculação.	atributo	`Boolean`	Sim
`keywordMaxBid`	Se essa palavra-chave for gerenciada por uma estratégia de lances do DS, ela nunca aumentará os lances acima desse limite. Consulte Aplicar uma estratégia de lances a palavras-chave.	atributo	`Money`	Sim
`keywordMinBid`	Se essa palavra-chave for gerenciada por uma estratégia de lances do DS, ela nunca diminuirá os lances abaixo desse limite. Consulte Aplicar uma estratégia de lances a palavras-chave.	atributo	`Money`	Sim
`keywordUrlParams`	Parâmetros de URL extras adicionados à página de destino. Consulte Adicionar parâmetros de URL.	atributo	`String`	Sim
`bingKeywordParam2`	Parâmetro 2 de uma palavra-chave do Bing Ads.	atributo	`String`	Sim
`bingKeywordParam3`	Parâmetro 3 de uma palavra-chave do Bing Ads.	atributo	`String`	Sim
`keywordLabels`	Nomes dos rótulos atribuídos diretamente a essa palavra-chave. Os rótulos herdados não estão incluídos.	atributo	`String list`	Sim
`qualityScoreCurrent`	Somente Google Ads e Bing Ads O valor mais recente do Índice de qualidade (QS) do mecanismo para uma palavra-chave. Essa coluna sempre informa o QS mais recente de uma palavra-chave, independentemente do período do relatório.	atributo	`Integer`	Sim
`topOfPageBidCurrent`	Somente Google Ads Aproxima o lance de CPC atual necessário para que seu anúncio seja exibido regularmente nas primeiras posições acima dos resultados da pesquisa. Essa coluna sempre informa o CPC necessário atualmente, independentemente do período do relatório.	atributo	`Money`	Sim
`effectiveBidStrategyId`	ID do DS da estratégia de lances atribuída a esta entidade ou herdada por ela.	atributo	`ID`	Sim
`effectiveBidStrategy`	É o nome da estratégia de lances atribuída a essa entidade ou herdada por ela.	atributo	`String`	Sim
`bidStrategyInherited`	Indica se a estratégia de lances dessa entidade é herdada.	atributo	`Boolean`	Sim
`effectiveLabels`	Nomes de todos os rótulos herdados ou atribuídos diretamente a essa palavra-chave.	atributo	`String list`	Sim
`dfaActions`	O número total de ações do Campaign Manager.	métrica	`Integer`	Sim
`dfaRevenue`	Receita agregada gerada por transações do Campaign Manager.	métrica	`Money`	Sim
`dfaTransactions`	O número total de transações do Campaign Manager.	métrica	`Integer`	Sim
`dfaWeightedActions`	Soma das ações do Campaign Manager.	métrica	`Number`	Sim
`dfaActionsCrossEnv`	O número total de ações do Campaign Manager em vários ambientes.	métrica	`Number`	Sim
`dfaRevenueCrossEnv`	Receita agregada gerada por transações do Campaign Manager em vários ambientes.	métrica	`Money`	Sim
`dfaTransactionsCrossEnv`	O número total de transações do Campaign Manager em vários ambientes.	métrica	`Number`	Sim
`dfaWeightedActionsCrossEnv`	Soma das ações do Campaign Manager em vários ambientes.	métrica	`Number`	Sim
`avgCpc`	Custo médio por clique.	métrica	`Money`	Sim
`avgCpm`	Custo médio por mil impressões.	métrica	`Money`	Sim
`avgPos`	Posição média.	métrica	`Number`	Sim
`clicks`	Cliques agregados.	métrica	`Integer`	Sim
`cost`	Custo agregado pago às contas de mecanismo.	métrica	`Money`	Sim
`ctr`	Taxa de cliques média.	métrica	`Number`	Sim
`impr`	É o número total de impressões.	métrica	`Integer`	Sim
`adWordsConversions`	Os dados que o anunciante configurou para serem informados na coluna "Conversões do Google Ads". Quando uma ação de conversão do Google Ads é criada, o anunciante pode escolher se quer contabilizar essas conversões na coluna "Relatórios de conversões".	métrica	`Number`	Sim
`adWordsConversionValue`	Valor agregado das conversões do Google Ads.	métrica	`Number`	Sim
`adWordsViewThroughConversions`	O número total de conversões de visualização do Google Ads.	métrica	`Integer`	Sim
`visits`	O número total de visitas do DS.	métrica	`Integer`	Sim
`qualityScoreAvg`	Somente Google Ads e Bing Ads A média ponderada do número de impressões do Índice de qualidade (QS) do mecanismo em todos os dias e todas as palavras-chave no escopo do relatório.	métrica	`Number`	Sim
`topOfPageBidAvg`	Somente Google Ads Aproxima o lance de CPC médio necessário durante o período do relatório para que seus anúncios sejam exibidos regularmente nas primeiras posições acima dos resultados da pesquisa.	métrica	`Money`	Sim
`date`	Segmenta o relatório por dias. Cada linha e suas métricas agregadas são divididas em várias linhas, uma para cada dia. Essa coluna retorna a data de cada linha.	segmentar	`Date`	Sim
`monthStart`	Segmenta o relatório por mês. Cada linha e suas métricas agregadas são divididas em várias linhas, uma para cada mês. Essa coluna retorna o primeiro dia do mês de cada linha.	segmentar	`Date`	Sim
`monthEnd`	Segmenta o relatório por mês. Cada linha e suas métricas agregadas são divididas em várias linhas, uma para cada mês. Essa coluna retorna o último dia do mês de cada linha.	segmentar	`Date`	Sim
`quarterStart`	Segmenta o relatório por trimestre. Cada linha e suas métricas agregadas são divididas em várias linhas, uma para cada trimestre. Essa coluna retorna o primeiro dia do trimestre de cada linha.	segmentar	`Date`	Sim
`quarterEnd`	Segmenta o relatório por trimestre. Cada linha e suas métricas agregadas são divididas em várias linhas, uma para cada trimestre. Essa coluna retorna o último dia do trimestre de cada linha.	segmentar	`Date`	Sim
`weekStart`	Segmenta o relatório por semanas (de domingo a sábado), e cada linha e as métricas agregadas dela são divididas em várias linhas, uma para cada semana. Essa coluna retorna o primeiro dia (domingo) de cada linha.	segmentar	`Date`	Sim
`weekEnd`	Segmenta o relatório por semanas (de domingo a sábado), e cada linha e as métricas agregadas dela são divididas em várias linhas, uma para cada semana. Essa coluna retorna o último dia (sábado) de cada linha.	segmentar	`Date`	Sim
`yearStart`	Segmenta o relatório por anos. Cada linha e suas métricas agregadas são divididas em várias linhas, uma para cada ano. Essa coluna retorna o primeiro dia do ano de cada linha.	segmentar	`Date`	Sim
`yearEnd`	Segmenta o relatório por anos. Cada linha e suas métricas agregadas são divididas em várias linhas, uma para cada ano. Essa coluna retorna o último dia do ano de cada linha.	segmentar	`Date`	Sim
`deviceSegment`	Segmenta o relatório por dispositivo. Cada linha e as respectivas métricas agregadas são divididas em várias linhas, até uma para cada segmento de dispositivo. Essa coluna retorna o segmento do dispositivo de cada linha.	segmentar	`Device segment`	Sim
`floodlightGroup`	Segmenta o relatório por grupos do Floodlight. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada grupo do Floodlight. Essa coluna retorna o nome do grupo do Floodlight de cada linha. Algumas métricas não têm valores segmentados do Floodlight, como cliques e visitas.	segmentar	`String`	Sim
`floodlightGroupId`	Segmenta o relatório por grupos do Floodlight. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada grupo do Floodlight. Essa coluna retorna o código do grupo do DS de cada linha. Algumas métricas não têm valores segmentados do Floodlight, como cliques e visitas.	segmentar	`ID`	Sim
`floodlightGroupTag`	Segmenta o relatório por grupos do Floodlight. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada grupo do Floodlight. Essa coluna retorna a tag do grupo do Floodlight de cada linha. Algumas métricas não têm valores segmentados do Floodlight, como cliques e visitas.	segmentar	`String`	Sim
`floodlightActivity`	Segmenta o relatório por atividades do Floodlight. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada atividade do Floodlight. Essa coluna retorna o nome da atividade do Floodlight de cada linha. Algumas métricas não têm valores segmentados do Floodlight, como cliques e visitas.	segmentar	`String`	Sim
`floodlightActivityId`	Segmenta o relatório por atividades do Floodlight. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada atividade do Floodlight. Esta coluna retorna o ID da atividade do Floodlight do DS de cada linha. Algumas métricas não têm valores segmentados do Floodlight, como cliques e visitas.	segmentar	`ID`	Sim
`floodlightActivityTag`	Segmenta o relatório por atividades do Floodlight. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada atividade do Floodlight. Essa coluna retorna a tag de atividade do Floodlight de cada linha. Algumas métricas não têm valores segmentados do Floodlight, como cliques e visitas.	segmentar	`String`	Sim
`ad`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna o nome do anúncio em cada linha.	segmentar	`String`	Sim
`adId`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna o ID do DS do anúncio em cada linha.	segmentar	`ID`	Sim
`isUnattributedAd`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna indica se as métricas nessa linha não são atribuíveis a um anúncio específico.	segmentar	`Boolean`	Sim
`adHeadline`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna o título do anúncio em cada linha.	segmentar	`String`	Sim
`adHeadline2`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna o título 2 do anúncio em cada linha. Não está disponível para alguns mecanismos.	segmentar	`String`	Sim
`adHeadline3`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna o título 3 do anúncio em cada linha. Não está disponível para alguns mecanismos.	segmentar	`String`	Sim
`adDescription1`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna a linha de descrição 1 do anúncio em cada linha.	segmentar	`String`	Sim
`adDescription2`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna a linha de descrição 2 do anúncio em cada linha.	segmentar	`String`	Sim
`adDisplayUrl`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna o URL de visualização do anúncio em cada linha.	segmentar	`String`	Sim
`adLandingPage`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna a página de destino do anúncio em cada linha.	segmentar	`String`	Sim
`adType`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna o tipo de anúncio em cada linha: `Text` ou `Product`.	segmentar	`Ad type`	Sim
`adPromotionLine`	Segmenta o relatório por anúncios. Cada linha e suas métricas agregadas são divididas em várias linhas, até uma para cada anúncio. Essa coluna retorna a linha de promoção do anúncio do produto em cada linha.	segmentar	`String`	Sim