Method: accounts.reports.search

Recupera um relatório definido por uma consulta de pesquisa. A resposta pode conter menos linhas do que o especificado por pageSize. Use nextPageToken para determinar se há mais linhas a serem solicitadas.

Solicitação HTTP

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. ID da conta que está fazendo a chamada. Precisa ser uma conta independente ou uma subconta da MCA. Formato: accounts/{account}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Campos
query

string

Obrigatório. Consulta que define um relatório a ser recuperado.

Para detalhes sobre como construir sua consulta, consulte o guia Linguagem de consulta. Para obter a lista completa de tabelas e campos disponíveis, consulte os campos disponíveis.

pageSize

integer

Opcional. Número de ReportRows a serem recuperados em uma única página. O valor padrão é 1000. Valores acima de 5.000 são forçados para 5.000.

pageToken

string

Opcional. Token da página a ser recuperada. Se não for especificado, a primeira página de resultados será retornada. Para solicitar a próxima página de resultados, é necessário usar o valor recebido de nextPageToken na resposta anterior.

Corpo da resposta

Mensagem de resposta para o método ReportService.Search.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
Campos
results[]

object (ReportRow)

Linhas que correspondem à consulta de pesquisa.

nextPageToken

string

Token que pode ser enviado como pageToken para recuperar a próxima página. Se omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

ReportRow

Linha de resultado retornada da consulta de pesquisa.

Somente a mensagem correspondente à tabela consultada é preenchida na resposta. Na mensagem preenchida, apenas os campos explicitamente solicitados na consulta são preenchidos.

Representação JSON
{
  "productPerformanceView": {
    object (ProductPerformanceView)
  },
  "nonProductPerformanceView": {
    object (NonProductPerformanceView)
  },
  "productView": {
    object (ProductView)
  },
  "priceCompetitivenessProductView": {
    object (PriceCompetitivenessProductView)
  },
  "priceInsightsProductView": {
    object (PriceInsightsProductView)
  },
  "bestSellersProductClusterView": {
    object (BestSellersProductClusterView)
  },
  "bestSellersBrandView": {
    object (BestSellersBrandView)
  },
  "competitiveVisibilityCompetitorView": {
    object (CompetitiveVisibilityCompetitorView)
  },
  "competitiveVisibilityTopMerchantView": {
    object (CompetitiveVisibilityTopMerchantView)
  },
  "competitiveVisibilityBenchmarkView": {
    object (CompetitiveVisibilityBenchmarkView)
  }
}
Campos
productPerformanceView

object (ProductPerformanceView)

Campos disponíveis para consulta na tabela productPerformanceView.

nonProductPerformanceView

object (NonProductPerformanceView)

Campos disponíveis para consulta na tabela nonProductPerformanceView.

productView

object (ProductView)

Campos disponíveis para consulta na tabela productView.

priceCompetitivenessProductView

object (PriceCompetitivenessProductView)

Campos disponíveis para consulta na tabela priceCompetitivenessProductView.

priceInsightsProductView

object (PriceInsightsProductView)

Campos disponíveis para consulta na tabela priceInsightsProductView.

bestSellersProductClusterView

object (BestSellersProductClusterView)

Campos disponíveis para consulta na tabela bestSellersProductClusterView.

bestSellersBrandView

object (BestSellersBrandView)

Campos disponíveis para consulta na tabela bestSellersBrandView.

competitiveVisibilityCompetitorView

object (CompetitiveVisibilityCompetitorView)

Campos disponíveis para consulta na tabela competitiveVisibilityCompetitorView.

competitiveVisibilityTopMerchantView

object (CompetitiveVisibilityTopMerchantView)

Campos disponíveis para consulta na tabela competitiveVisibilityTopMerchantView.

competitiveVisibilityBenchmarkView

object (CompetitiveVisibilityBenchmarkView)

Campos disponíveis para consulta na tabela competitiveVisibilityBenchmarkView.

ProductPerformanceView

Campos disponíveis para consulta na tabela productPerformanceView.

Dados de performance do produto da sua conta, incluindo métricas de performance (por exemplo, clicks) e dimensões de acordo com as quais essas métricas são segmentadas (por exemplo, offerId). Os valores das dimensões do produto, como offerId, refletem o estado de um produto no momento da impressão.

Não é possível selecionar campos de segmento nas consultas sem selecionar também pelo menos um campo de métrica.

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "date": {
    object (Date)
  },
  "week": {
    object (Date)
  },
  "conversionValue": {
    object (Price)
  },
  "marketingMethod": enum (MarketingMethodEnum),
  "customerCountryCode": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "customLabel0": string,
  "customLabel1": string,
  "customLabel2": string,
  "customLabel3": string,
  "customLabel4": string,
  "clicks": string,
  "impressions": string,
  "clickThroughRate": number,
  "conversions": number,
  "conversionRate": number
}
Campos
date

object (Date)

Data no fuso horário do comerciante a que as métricas se aplicam. Segmento.

A condição em date é obrigatória na cláusula WHERE.

week

object (Date)

Primeiro dia da semana (segunda-feira) da data das métricas no fuso horário do comerciante. Segmento.

conversionValue

object (Price)

Valor das conversões atribuídas ao produto, informado na data de conversão. Métrica.

Disponível apenas para a origem de tráfego FREE.

marketingMethod

enum (MarketingMethodEnum)

Método de marketing ao qual as métricas se aplicam. Segmento.

customerCountryCode

string

Código do país em que o cliente está no momento do evento. Representado no formato ISO 3166. Segmento.

Se o país do cliente não puder ser determinado, será retornado um código "ZZ" especial.

offerId

string

ID do produto fornecido pelo comerciante. Segmento.

title

string

Título do produto. Segmento.

brand

string

Marca do produto. Segmento.

categoryL1

string

Categoria do produto (1o nível) na taxonomia de produtos do Google. Segmento.

categoryL2

string

Categoria do produto (2o nível) na taxonomia de produtos do Google. Segmento.

categoryL3

string

Categoria do produto (3o nível) na taxonomia de produtos do Google. Segmento.

categoryL4

string

Categoria do produto (4o nível) na taxonomia do produto do Google. Segmento.

categoryL5

string

Categoria do produto (5o nível) na taxonomia de produtos do Google. Segmento.

productTypeL1

string

Tipo de produto (1o nível) na taxonomia do produto do comerciante. Segmento.

productTypeL2

string

Tipo de produto (2o nível) na taxonomia do produto do comerciante. Segmento.

productTypeL3

string

Tipo de produto (3o nível) na taxonomia do produto do comerciante. Segmento.

productTypeL4

string

Tipo de produto (4o nível) na taxonomia do produto do comerciante. Segmento.

productTypeL5

string

Tipo de produto (5o nível) na taxonomia do produto do comerciante. Segmento.

customLabel0

string

Rótulo personalizado 0 para agrupamento personalizado de produtos. Segmento.

customLabel1

string

Rótulo personalizado 1 para agrupamento personalizado de produtos. Segmento.

customLabel2

string

Rótulo personalizado 2 para agrupamento personalizado de produtos. Segmento.

customLabel3

string

Rótulo personalizado 3 para agrupamento personalizado de produtos. Segmento.

customLabel4

string

Rótulo personalizado 4 para agrupamento personalizado de produtos. Segmento.

clicks

string (int64 format)

Número de cliques. Métrica.

impressions

string (int64 format)

Número de vezes que os produtos do comerciante são mostrados. Métrica.

clickThroughRate

number

Taxa de cliques: o número de cliques que os produtos do comerciante recebem (cliques) dividido pelo número de vezes que eles são exibidos (impressões). Métrica.

conversions

number

Número de conversões atribuídas ao produto, informadas na data de conversão. Dependendo do modelo de atribuição, uma conversão pode ser distribuída em vários cliques, e cada clique recebe seu próprio crédito. Essa métrica é a soma de todos esses créditos. Métrica.

Disponível apenas para a origem de tráfego FREE.

conversionRate

number

Número de conversões dividido pela quantidade de cliques, informado na data da impressão. Métrica.

Disponível apenas para a origem de tráfego FREE.

MarketingMethodEnum

Valores dos métodos de marketing.

Tipos enumerados
MARKETING_METHOD_ENUM_UNSPECIFIED Não especificado.
ORGANIC Marketing orgânico.
ADS Marketing baseado em anúncios.

NonProductPerformanceView

Campos disponíveis para consulta na tabela nonProductPerformanceView.

Dados de performance em imagens e links de lojas on-line que levam às páginas que não são de produtos. Isso inclui métricas de desempenho (por exemplo, clicks) e dimensões de acordo com as quais essas métricas são segmentadas (por exemplo, date).

Não é possível selecionar campos de segmento nas consultas sem selecionar também pelo menos um campo de métrica.

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "date": {
    object (Date)
  },
  "week": {
    object (Date)
  },
  "clicks": string,
  "impressions": string,
  "clickThroughRate": number
}
Campos
date

object (Date)

Data no fuso horário do comerciante a que as métricas se aplicam. Segmento.

A condição em date é obrigatória na cláusula WHERE.

week

object (Date)

Primeiro dia da semana (segunda-feira) da data das métricas no fuso horário do comerciante. Segmento.

clicks

string (int64 format)

Número de cliques em imagens e links de lojas on-line que levam a páginas que não são de produtos. Métrica.

impressions

string (int64 format)

Número de vezes que imagens e links de lojas on-line que direcionavam a páginas que não eram de produtos foram exibidos. Métrica.

clickThroughRate

number

Taxa de cliques: o número de cliques (clicks) dividido pelo número de impressões (impressions) de imagens e links de lojas on-line que levam às suas páginas que não são de produtos. Métrica.

ProductView

Campos disponíveis para consulta na tabela productView.

Produtos no inventário atual. Os produtos nesta tabela são os mesmos da subAPI Products, mas nem todos os atributos deles estão disponíveis para consulta nesta tabela. Diferente da subAPI Products, essa tabela permite filtrar a lista de produtos retornada por atributos do produto. Para extrair um único produto até id ou listar todos os produtos, use a subAPI Products.

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "price": {
    object (Price)
  },
  "gtin": [
    string
  ],
  "creationTime": string,
  "expirationDate": {
    object (Date)
  },
  "itemIssues": [
    {
      object (ItemIssue)
    }
  ],
  "clickPotential": enum (ClickPotential),
  "id": string,
  "channel": enum (ChannelEnum),
  "languageCode": string,
  "feedLabel": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "condition": string,
  "availability": string,
  "shippingLabel": string,
  "itemGroupId": string,
  "thumbnailLink": string,
  "aggregatedReportingContextStatus": enum (AggregatedReportingContextStatus),
  "clickPotentialRank": string
}
Campos
price

object (Price)

Preço do produto. Vai aparecer se as informações sobre o preço do produto não estiverem disponíveis.

gtin[]

string

Lista de Números globais de item comercial (GTINs, na sigla em inglês) do produto.

creationTime

string (Timestamp format)

A hora em que o comerciante criou o produto em segundos com carimbo de data/hora.

expirationDate

object (Date)

Data de validade do produto, especificada na inserção.

itemIssues[]

object (ItemIssue)

Lista de problemas dos itens do produto.

Esse campo não pode ser usado para classificar os resultados.

Apenas atributos selecionados nesse campo (por exemplo, itemIssues.severity.aggregated_severity) podem ser usados para filtrar os resultados.

clickPotential

enum (ClickPotential)

Potencial estimado de performance em comparação com os produtos de melhor performance do comerciante.

id

string

ID REST do produto, na forma de channel~languageCode~feedLabel~offerId. Os métodos da API do comerciante que operam em produtos usam isso como o parâmetro name.

Obrigatório na cláusula SELECT.

channel

enum (ChannelEnum)

Canal do produto. Pode ser ONLINE ou LOCAL.

languageCode

string

Código de idioma do produto no formato BCP 47.

feedLabel

string

Rótulo do feed do produto.

offerId

string

ID do produto fornecido pelo comerciante.

title

string

Título do produto.

brand

string

Marca do produto.

categoryL1

string

Categoria do produto (1o nível) na taxonomia do produto do Google.

categoryL2

string

Categoria do produto (2o nível) na taxonomia do produto do Google.

categoryL3

string

Categoria do produto (3o nível) na taxonomia do produto do Google.

categoryL4

string

Categoria do produto (4o nível) na taxonomia do produto do Google.

categoryL5

string

Categoria do produto (5o nível) na taxonomia do produto do Google.

productTypeL1

string

Tipo de produto (1o nível) na taxonomia do produto do comerciante.

productTypeL2

string

Tipo de produto (2o nível) na taxonomia do produto do próprio comerciante.

productTypeL3

string

Tipo de produto (3o nível) na taxonomia do produto do próprio comerciante.

productTypeL4

string

Tipo de produto (4o nível) na taxonomia do produto do próprio comerciante.

productTypeL5

string

Tipo de produto (5o nível) na taxonomia do produto do próprio comerciante.

condition

string

Estado do produto.

availability

string

Disponibilidade do produto.

shippingLabel

string

Rótulo para envio normalizado especificado na fonte de dados.

itemGroupId

string

Código do grupo de itens fornecido pelo comerciante para agrupar variantes.

aggregatedReportingContextStatus

enum (AggregatedReportingContextStatus)

Status agregado.

clickPotentialRank

string (int64 format)

Classificação do produto com base no potencial de cliques dele. Um produto com clickPotentialRank 1 tem o maior potencial de cliques entre os produtos do comerciante que atendem às condições da consulta de pesquisa.

AggregatedReportingContextStatus

Status do produto agregado para todos os contextos de relatório.

Confira um exemplo de como o status agregado é calculado:

Listagens sem custo financeiro Anúncios do Shopping Status
Approved Approved QUALIFICADA
Approved Pendente QUALIFICADA
Approved Reprovado ELIGIBLE_LIMITED
Pendente Pendente PENDENTE
Reprovado Reprovado NOT_ELIGIBLE_OR_DISAPPROVED
Tipos enumerados
AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED Não especificado.
NOT_ELIGIBLE_OR_DISAPPROVED O produto não está qualificado ou foi reprovado para todos os contextos de relatório.
PENDING O status do produto está pendente em todos os contextos de relatório.
ELIGIBLE_LIMITED O produto está qualificado para alguns (mas não todos) contextos de relatório.
ELIGIBLE O produto está qualificado para todos os contextos de relatório.

ItemIssue

Problema no item associado ao produto.

Representação JSON
{
  "type": {
    object (ItemIssueType)
  },
  "severity": {
    object (ItemIssueSeverity)
  },
  "resolution": enum (ItemIssueResolution)
}
Campos
type

object (ItemIssueType)

Tipo de problema do item.

severity

object (ItemIssueSeverity)

Gravidade do problema no item.

resolution

enum (ItemIssueResolution)

Resolução de problemas no item.

ItemIssueType

Tipo de problema.

Representação JSON
{
  "code": string,
  "canonicalAttribute": string
}
Campos
code

string

Código de erro do problema, equivalente a code de Problemas com o produto.

canonicalAttribute

string

Nome do atributo canônico para problemas específicos do atributo.

ItemIssueSeverity

Como o problema afeta a veiculação do produto.

Representação JSON
{
  "severityPerReportingContext": [
    {
      object (IssueSeverityPerReportingContext)
    }
  ],
  "aggregatedSeverity": enum (AggregatedIssueSeverity)
}
Campos
severityPerReportingContext[]

object (IssueSeverityPerReportingContext)

Gravidade do problema por contexto do relatório.

aggregatedSeverity

enum (AggregatedIssueSeverity)

Gravidade agregada do problema em todos os contextos de relatórios que ele afeta.

Esse campo pode ser usado para filtrar os resultados.

IssueSeverityPerReportingContext

Gravidade do problema por contexto do relatório.

Representação JSON
{
  "disapprovedCountries": [
    string
  ],
  "demotedCountries": [
    string
  ],
  "reportingContext": enum (ReportingContextEnum)
}
Campos
disapprovedCountries[]

string

Lista de países reprovados no contexto do relatório, representada no formato ISO 3166.

demotedCountries[]

string

Lista de países rebaixados no contexto do relatório, representada no formato ISO 3166.

reportingContext

enum (ReportingContextEnum)

Contexto do relatório em que o problema se aplica.

AggregatedIssueSeverity

Gravidade do problema agregada para todos os contextos de relatório.

Tipos enumerados
AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED Não especificado.
DISAPPROVED O problema reprova o produto em pelo menos um contexto de relatório.
DEMOTED O problema rebaixa o produto em todos os contextos de relatório que ele afeta.
PENDING A resolução do problema é PENDING_PROCESSING.

ItemIssueResolution

Como resolver o problema.

Tipos enumerados
ITEM_ISSUE_RESOLUTION_UNSPECIFIED Não especificado.
MERCHANT_ACTION O comerciante precisa corrigir o problema.
PENDING_PROCESSING O problema será resolvido automaticamente (por exemplo, rastreamento de imagens) ou por uma análise do Google. Nenhuma ação é necessária no momento. A resolução pode levar a outro problema (por exemplo, se o rastreamento falhar).

ClickPotential

O potencial de cliques de um produto estima o potencial de desempenho dele em comparação com os produtos de melhor performance do comerciante. Esse recurso ajuda os comerciantes a priorizar os itens que precisam ser corrigidos e a entender a performance dos itens em relação ao potencial.

Tipos enumerados
CLICK_POTENTIAL_UNSPECIFIED Impacto de cliques previstos desconhecido.
LOW potencial para receber poucos cliques em comparação com os produtos de melhor performance do comerciante;
MEDIUM potencial para receber um número moderado de cliques em comparação com os produtos de melhor performance do comerciante;
HIGH Potencial para receber um número de cliques semelhante ao dos produtos de melhor performance do comerciante.

PriceCompetitivenessProductView

Campos disponíveis para consulta na tabela priceCompetitivenessProductView.

Relatório de competitividade de preço.

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "price": {
    object (Price)
  },
  "benchmarkPrice": {
    object (Price)
  },
  "reportCountryCode": string,
  "id": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string
}
Campos
price

object (Price)

Preço atual do produto.

benchmarkPrice

object (Price)

O comparativo de mercado de preço mais recente disponível para o catálogo do produto no país do comparativo de mercado.

reportCountryCode

string

País do benchmark de preço. Representado no formato ISO 3166.

Obrigatório na cláusula SELECT.

id

string

ID REST do produto, na forma de channel~languageCode~feedLabel~offerId. Pode ser usado para mesclar dados com a tabela productView.

Obrigatório na cláusula SELECT.

offerId

string

ID do produto fornecido pelo comerciante.

title

string

Título do produto.

brand

string

Marca do produto.

categoryL1

string

Categoria do produto (1o nível) na taxonomia do produto do Google.

categoryL2

string

Categoria do produto (2o nível) na taxonomia do produto do Google.

categoryL3

string

Categoria do produto (3o nível) na taxonomia do produto do Google.

categoryL4

string

Categoria do produto (4o nível) na taxonomia do produto do Google.

categoryL5

string

Categoria do produto (5o nível) na taxonomia do produto do Google.

productTypeL1

string

Tipo de produto (1o nível) na taxonomia do produto do comerciante.

productTypeL2

string

Tipo de produto (2o nível) na taxonomia do produto do próprio comerciante.

productTypeL3

string

Tipo de produto (3o nível) na taxonomia do produto do próprio comerciante.

productTypeL4

string

Tipo de produto (4o nível) na taxonomia do produto do próprio comerciante.

productTypeL5

string

Tipo de produto (5o nível) na taxonomia do produto do próprio comerciante.

PriceInsightsProductView

Campos disponíveis para consulta na tabela priceInsightsProductView.

Relatório de informações de preços.

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "price": {
    object (Price)
  },
  "suggestedPrice": {
    object (Price)
  },
  "effectiveness": enum (Effectiveness),
  "id": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "predictedImpressionsChangeFraction": number,
  "predictedClicksChangeFraction": number,
  "predictedConversionsChangeFraction": number
}
Campos
price

object (Price)

Preço atual do produto.

suggestedPrice

object (Price)

Preço sugerido mais recente para o produto.

effectiveness

enum (Effectiveness)

A eficácia prevista de aplicar a sugestão de preço, agrupada em classes.

id

string

ID REST do produto, na forma de channel~languageCode~feedLabel~offerId. Pode ser usado para mesclar dados com a tabela productView.

Obrigatório na cláusula SELECT.

offerId

string

ID do produto fornecido pelo comerciante.

title

string

Título do produto.

brand

string

Marca do produto.

categoryL1

string

Categoria do produto (1o nível) na taxonomia do produto do Google.

categoryL2

string

Categoria do produto (2o nível) na taxonomia do produto do Google.

categoryL3

string

Categoria do produto (3o nível) na taxonomia do produto do Google.

categoryL4

string

Categoria do produto (4o nível) na taxonomia do produto do Google.

categoryL5

string

Categoria do produto (5o nível) na taxonomia do produto do Google.

productTypeL1

string

Tipo de produto (1o nível) na taxonomia do produto do comerciante.

productTypeL2

string

Tipo de produto (2o nível) na taxonomia do produto do próprio comerciante.

productTypeL3

string

Tipo de produto (3o nível) na taxonomia do produto do próprio comerciante.

productTypeL4

string

Tipo de produto (4o nível) na taxonomia do produto do próprio comerciante.

productTypeL5

string

Tipo de produto (5o nível) na taxonomia do produto do próprio comerciante.

predictedImpressionsChangeFraction

number

Mudança prevista nas impressões como uma fração após a introdução do preço sugerido em comparação com o preço ativo atual. Por exemplo, 0,05 é um aumento previsto de 5% nas impressões.

predictedClicksChangeFraction

number

Mudança prevista nos cliques como uma fração após a introdução do preço sugerido em comparação com o preço ativo atual. Por exemplo, 0,05 é um aumento previsto de 5% nos cliques.

predictedConversionsChangeFraction

number

Mudança prevista nas conversões como uma fração após a introdução do preço sugerido em comparação com o preço ativo atual. Por exemplo, 0,05 é um aumento previsto de 5% nas conversões).

Eficácia

Bucket de eficácia prevista.

A eficácia indica quais produtos se beneficiariam mais de mudanças de preço. Essa classificação considera o aumento da performance previsto pelo ajuste do preço promocional e a diferença entre o preço atual e o sugerido. As sugestões de preço com eficácia de HIGH têm previsão de gerar o maior aumento na performance.

Tipos enumerados
EFFECTIVENESS_UNSPECIFIED A eficácia é desconhecida.
LOW A eficácia é baixa.
MEDIUM A eficácia é média.
HIGH A eficácia é alta.

BestSellersProductClusterView

Campos disponíveis para consulta na tabela bestSellersProductClusterView.

Relatório Mais vendidos com os principais clusters de produtos. Um cluster de produtos é um agrupamento de diferentes ofertas e variantes que representam o mesmo produto, por exemplo, o Google Pixel 7.

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "reportDate": {
    object (Date)
  },
  "variantGtins": [
    string
  ],
  "reportGranularity": enum (ReportGranularityEnum),
  "reportCountryCode": string,
  "reportCategoryId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "inventoryStatus": enum (InventoryStatus),
  "brandInventoryStatus": enum (InventoryStatus),
  "rank": string,
  "previousRank": string,
  "relativeDemand": enum (RelativeDemandEnum),
  "previousRelativeDemand": enum (RelativeDemandEnum),
  "relativeDemandChange": enum (RelativeDemandChangeTypeEnum)
}
Campos
reportDate

object (Date)

Data do relatório. O valor desse campo só pode ser um dos seguintes:

  • O primeiro dia da semana (segunda-feira) para relatórios semanais,
  • O primeiro dia do mês para relatórios mensais.

Obrigatório na cláusula SELECT. Se uma condição WHERE em reportDate não for especificada na consulta, o relatório semanal ou mensal mais recente será retornado.

variantGtins[]

string

GTINs de exemplos de variantes do cluster de produtos.

reportGranularity

enum (ReportGranularityEnum)

Granularidade do relatório. A classificação pode ser feita ao longo de uma semana ou um mês.

Obrigatório na cláusula SELECT. A condição em reportGranularity é obrigatória na cláusula WHERE.

reportCountryCode

string

País onde a classificação é calculada. Representado no formato ISO 3166.

Obrigatório na cláusula SELECT. A condição em reportCountryCode é obrigatória na cláusula WHERE.

reportCategoryId

string (int64 format)

ID da categoria Google do produto para calcular a classificação, representado na taxonomia do produto do Google.

Obrigatório na cláusula SELECT. Se uma condição WHERE em reportCategoryId não for especificada na consulta, as classificações de todas as categorias de nível superior serão retornadas.

title

string

Título do cluster de produto.

brand

string

Marca do cluster de produtos.

categoryL1

string

Categoria dos produtos (1o nível) do cluster, representada na taxonomia do produto do Google.

categoryL2

string

Categoria dos produtos (2o nível) do cluster, representada na taxonomia do produto do Google.

categoryL3

string

Categoria do produto (3o nível) do cluster, representada na taxonomia do produto do Google.

categoryL4

string

Categoria dos produtos (4o nível) do cluster, representada na taxonomia do produto do Google.

categoryL5

string

Categoria dos produtos (5o nível) do cluster, representada na taxonomia do produto do Google.

inventoryStatus

enum (InventoryStatus)

Se o cluster de produtos está IN_STOCK na sua fonte de dados do produto em pelo menos um dos países, OUT_OF_STOCK na sua fonte de dados do produto em todos os países ou NOT_IN_INVENTORY.

O campo não considera o filtro de país do relatório "Mais vendidos".

brandInventoryStatus

enum (InventoryStatus)

Se há pelo menos um produto da marca IN_STOCK atualmente na sua fonte de dados do produto em pelo menos um dos países, todos os itens são OUT_OF_STOCK na fonte de dados do produto em todos os países ou NOT_IN_INVENTORY.

O campo não considera o filtro de país do relatório "Mais vendidos".

rank

string (int64 format)

A popularidade do cluster de produtos no Google Ads e em plataformas orgânicas, na categoria e no país selecionados, com base no número estimado de unidades vendidas.

previousRank

string (int64 format)

Classificação de popularidade na semana ou no mês anterior.

relativeDemand

enum (RelativeDemandEnum)

Demanda estimada em relação ao cluster de produtos com a classificação de popularidade mais alta na mesma categoria e país.

previousRelativeDemand

enum (RelativeDemandEnum)

Demanda estimada em relação ao cluster de produtos com a classificação de popularidade mais alta na mesma categoria e país na semana ou no mês anterior.

relativeDemandChange

enum (RelativeDemandChangeTypeEnum)

Alteração na demanda estimada. Se ela subiu, afundou ou permaneceu plana.

ReportGranularityEnum

Informe os valores de granularidade.

Tipos enumerados
REPORT_GRANULARITY_ENUM_UNSPECIFIED Não especificado.
WEEKLY O relatório é calculado com base em um período de uma semana.
MONTHLY O relatório é calculado com base em um período de mês.

InventoryStatus

Status do cluster de produtos ou da marca no seu inventário.

Tipos enumerados
INVENTORY_STATUS_UNSPECIFIED Não especificado.
IN_STOCK Você tem um produto em estoque para este cluster de produtos ou marca.
OUT_OF_STOCK Você tem um produto para este cluster de produtos ou marca no inventário, mas ele está esgotado no momento.
NOT_IN_INVENTORY Você não tem um produto para este cluster de produtos ou marca no inventário.

RelativeDemandEnum

Valores de demanda relativos.

Tipos enumerados
RELATIVE_DEMAND_ENUM_UNSPECIFIED Não especificado.
VERY_LOW A demanda representa de 0% a 5% da demanda da marca ou do cluster de produtos com a melhor classificação.
LOW A demanda representa de 6% a 10% da demanda da marca ou do cluster de produtos com a melhor classificação.
MEDIUM A demanda representa de 11% a 20% da demanda da marca ou do cluster de produtos com a melhor classificação.
HIGH A demanda representa de 21% a 50% da demanda da marca ou do cluster de produtos com a melhor classificação.
VERY_HIGH A demanda representa de 51% a 100% da demanda da marca ou do cluster de produtos com a melhor classificação.

RelativeDemandChangeTypeEnum

Valores do tipo de mudança da demanda relativa.

Tipos enumerados
RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED Não especificado.
SINKER A demanda relativa está menor que no período anterior.
FLAT A demanda relativa é igual ao período anterior.
RISER A demanda relativa está maior que no período anterior.

BestSellersBrandView

Campos disponíveis para consulta na tabela bestSellersBrandView.

Relatório Mais vendidos com as principais marcas.

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "reportDate": {
    object (Date)
  },
  "reportGranularity": enum (ReportGranularityEnum),
  "reportCountryCode": string,
  "reportCategoryId": string,
  "brand": string,
  "rank": string,
  "previousRank": string,
  "relativeDemand": enum (RelativeDemandEnum),
  "previousRelativeDemand": enum (RelativeDemandEnum),
  "relativeDemandChange": enum (RelativeDemandChangeTypeEnum)
}
Campos
reportDate

object (Date)

Data do relatório. O valor desse campo só pode ser um dos seguintes:

  • O primeiro dia da semana (segunda-feira) para relatórios semanais,
  • O primeiro dia do mês para relatórios mensais.

Obrigatório na cláusula SELECT. Se uma condição WHERE em reportDate não for especificada na consulta, o relatório semanal ou mensal mais recente será retornado.

reportGranularity

enum (ReportGranularityEnum)

Granularidade do relatório. A classificação pode ser feita ao longo de uma semana ou um mês.

Obrigatório na cláusula SELECT. A condição em reportGranularity é obrigatória na cláusula WHERE.

reportCountryCode

string

País onde a classificação é calculada. Representado no formato ISO 3166.

Obrigatório na cláusula SELECT. A condição em reportCountryCode é obrigatória na cláusula WHERE.

reportCategoryId

string (int64 format)

ID da categoria Google do produto para calcular a classificação, representado na taxonomia do produto do Google.

Obrigatório na cláusula SELECT. Se uma condição WHERE em reportCategoryId não for especificada na consulta, as classificações de todas as categorias de nível superior serão retornadas.

brand

string

Nome da marca.

rank

string (int64 format)

A popularidade da marca em anúncios e plataformas orgânicas, na categoria e no país selecionados, com base no número estimado de unidades vendidas.

previousRank

string (int64 format)

Classificação de popularidade na semana ou no mês anterior.

relativeDemand

enum (RelativeDemandEnum)

Demanda estimada em relação à marca com a classificação de popularidade mais alta na mesma categoria e país.

previousRelativeDemand

enum (RelativeDemandEnum)

Demanda estimada em relação à marca com a classificação de popularidade mais alta na mesma categoria e país na semana ou no mês anterior.

relativeDemandChange

enum (RelativeDemandChangeTypeEnum)

Alteração na demanda estimada. Se ela subiu, afundou ou permaneceu plana.

CompetitiveVisibilityCompetitorView

Campos disponíveis para consulta na tabela competitiveVisibilityCompetitorView.

Relatório de visibilidade competitiva com empresas com visibilidade semelhante

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "date": {
    object (Date)
  },
  "domain": string,
  "isYourDomain": boolean,
  "reportCountryCode": string,
  "reportCategoryId": string,
  "trafficSource": enum (TrafficSourceEnum),
  "rank": string,
  "adsOrganicRatio": number,
  "pageOverlapRate": number,
  "higherPositionRate": number,
  "relativeVisibility": number
}
Campos
date

object (Date)

É a data desta linha.

Uma condição em date é obrigatória na cláusula WHERE.

domain

string

O domínio do seu concorrente ou do seu domínio, caso "isYourDomain" seja verdadeiro.

Obrigatório na cláusula SELECT. Não pode ser filtrado na cláusula 'WHERE'.

isYourDomain

boolean

Verdadeiro se a linha tiver dados do seu domínio.

Não pode ser filtrado na cláusula 'WHERE'.

reportCountryCode

string

País onde as impressões apareceram.

Obrigatório na cláusula SELECT. Uma condição em reportCountryCode é obrigatória na cláusula WHERE.

reportCategoryId

string (int64 format)

ID da categoria Google do produto para calcular o relatório, representado na taxonomia do produto do Google.

Obrigatório na cláusula SELECT. Uma condição em reportCategoryId é obrigatória na cláusula WHERE.

trafficSource

enum (TrafficSourceEnum)

Origem do tráfego de impressões.

Obrigatório na cláusula SELECT.

rank

string (int64 format)

Posição do domínio nas empresas semelhantes classificadas para as chaves selecionadas (date, reportCategoryId, reportCountryCode, trafficSource) com base nas impressões. 1 é a maior.

Não pode ser filtrado na cláusula 'WHERE'.

adsOrganicRatio

number

A proporção anúncios / orgânicos mostra a frequência com que o domínio recebe impressões de anúncios do Shopping em comparação com o tráfego orgânico. O número é arredondado e dividido em classes.

Não pode ser filtrado na cláusula 'WHERE'.

pageOverlapRate

number

A taxa de sobreposição da página mostra a frequência com que as ofertas de varejistas concorrentes são exibidas com suas ofertas na mesma página.

Não pode ser filtrado na cláusula 'WHERE'.

higherPositionRate

number

Taxa de posição mais alta mostra com que frequência a oferta de um concorrente foi colocada em uma posição mais alta na página do que a oferta.

Não pode ser filtrado na cláusula 'WHERE'.

relativeVisibility

number

A visibilidade relativa mostra a frequência com que as ofertas dos concorrentes são mostradas em comparação com as suas. Em outras palavras, esse é o número de impressões exibidas de um varejista concorrente dividido pelo número de impressões exibidas durante um determinado período para uma categoria de produtos e um país selecionados.

Não pode ser filtrado na cláusula 'WHERE'.

TrafficSourceEnum

Valores de origem de tráfego.

Tipos enumerados
TRAFFIC_SOURCE_ENUM_UNSPECIFIED Não especificado.
ORGANIC Tráfego orgânico.
ADS Tráfego de anúncios.
ALL Tráfego orgânico e de anúncios.

CompetitiveVisibilityTopMerchantView

Campos disponíveis para consulta na tabela competitiveVisibilityTopMerchantView.

Relatório de visibilidade competitiva com as empresas com maior visibilidade.

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "date": {
    object (Date)
  },
  "domain": string,
  "isYourDomain": boolean,
  "reportCountryCode": string,
  "reportCategoryId": string,
  "trafficSource": enum (TrafficSourceEnum),
  "rank": string,
  "adsOrganicRatio": number,
  "pageOverlapRate": number,
  "higherPositionRate": number
}
Campos
date

object (Date)

É a data desta linha.

Não pode ser selecionado na cláusula SELECT. Uma condição em date é obrigatória na cláusula WHERE.

domain

string

O domínio do seu concorrente ou do seu domínio, caso "isYourDomain" seja verdadeiro.

Obrigatório na cláusula SELECT. Não pode ser filtrado na cláusula 'WHERE'.

isYourDomain

boolean

Verdadeiro se a linha tiver dados do seu domínio.

Não pode ser filtrado na cláusula 'WHERE'.

reportCountryCode

string

País onde as impressões apareceram.

Obrigatório na cláusula SELECT. Uma condição em reportCountryCode é obrigatória na cláusula WHERE.

reportCategoryId

string (int64 format)

ID da categoria Google do produto para calcular o relatório, representado na taxonomia do produto do Google.

Obrigatório na cláusula SELECT. Uma condição em reportCategoryId é obrigatória na cláusula WHERE.

trafficSource

enum (TrafficSourceEnum)

Origem do tráfego de impressões.

Obrigatório na cláusula SELECT.

rank

string (int64 format)

Posição do domínio na classificação dos principais comerciantes para as chaves selecionadas (date, reportCategoryId, reportCountryCode, trafficSource) com base nas impressões. 1 é a maior.

Não pode ser filtrado na cláusula 'WHERE'.

adsOrganicRatio

number

A proporção anúncios / orgânicos mostra a frequência com que o domínio recebe impressões de anúncios do Shopping em comparação com o tráfego orgânico. O número é arredondado e dividido em classes.

Não pode ser filtrado na cláusula 'WHERE'.

pageOverlapRate

number

A taxa de sobreposição da página mostra a frequência com que as ofertas de varejistas concorrentes são exibidas com suas ofertas na mesma página.

Não pode ser filtrado na cláusula 'WHERE'.

higherPositionRate

number

Taxa de posição mais alta mostra com que frequência a oferta de um concorrente foi colocada em uma posição mais alta na página do que a oferta.

Não pode ser filtrado na cláusula 'WHERE'.

CompetitiveVisibilityBenchmarkView

Campos disponíveis para consulta na tabela competitiveVisibilityBenchmarkView.

Relatório de visibilidade competitiva com o comparativo de mercado da categoria.

Os valores são definidos apenas para campos solicitados explicitamente na consulta de pesquisa da solicitação.

Representação JSON
{
  "date": {
    object (Date)
  },
  "reportCountryCode": string,
  "reportCategoryId": string,
  "trafficSource": enum (TrafficSourceEnum),
  "yourDomainVisibilityTrend": number,
  "categoryBenchmarkVisibilityTrend": number
}
Campos
date

object (Date)

É a data desta linha.

Obrigatório na cláusula SELECT. Uma condição em date é obrigatória na cláusula WHERE.

reportCountryCode

string

País onde as impressões apareceram.

Obrigatório na cláusula SELECT. Uma condição em reportCountryCode é obrigatória na cláusula WHERE.

reportCategoryId

string (int64 format)

ID da categoria Google do produto para calcular o relatório, representado na taxonomia do produto do Google.

Obrigatório na cláusula SELECT. Uma condição em reportCategoryId é obrigatória na cláusula WHERE.

trafficSource

enum (TrafficSourceEnum)

Origem do tráfego de impressões.

Obrigatório na cláusula SELECT.

yourDomainVisibilityTrend

number

Mudança na visibilidade com base nas impressões do seu domínio em relação ao início do período selecionado (ou o primeiro dia com impressões diferentes de zero).

Não pode ser filtrado na cláusula 'WHERE'.

categoryBenchmarkVisibilityTrend

number

Mudança na visibilidade com base nas impressões em relação ao início do período selecionado (ou primeiro dia com impressões diferentes de zero) para um conjunto combinado de comerciantes com maior visibilidade aproximada do mercado.

Não pode ser filtrado na cláusula 'WHERE'.