Package google.shopping.merchant.reports.v1beta

Índice

ReportService

Serviço para extrair relatórios e insights sobre seus produtos, a performance deles e o ambiente competitivo no Google.

Pesquisar

rpc Search(SearchRequest) returns (SearchResponse)

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

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.

BestSellersBrandView

Campos disponíveis para consulta na tabela best_sellers_brand_view.

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.

Campos
report_date

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 report_date não for especificada na consulta, o relatório semanal ou mensal mais recente disponível será retornado.
report_granularity

ReportGranularityEnum

Granularidade do relatório. A classificação pode ser feita em um período de uma semana ou um mês.

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

string

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

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

int64

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

Obrigatório na cláusula SELECT. Se uma condição WHERE em report_category_id 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

int64

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.
previous_rank

int64

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

RelativeDemandEnum

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

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.
relative_demand_change

RelativeDemandChangeTypeEnum

Mudança na demanda estimada. Se ele aumentou, diminuiu ou permaneceu estável.

BestSellersProductClusterView

Campos disponíveis para consulta na tabela best_sellers_product_cluster_view.

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, Google Pixel 7.

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

Campos
report_date

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 report_date não for especificada na consulta, o relatório semanal ou mensal mais recente disponível será retornado.
variant_gtins[]

string

GTINs de exemplos de variantes do cluster de produtos.
report_granularity

ReportGranularityEnum

Granularidade do relatório. A classificação pode ser feita em um período de uma semana ou um mês.

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

string

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

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

int64

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

Obrigatório na cláusula SELECT. Se uma condição WHERE em report_category_id 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 produtos.
brand

string

Marca do cluster de produtos.
category_l1

string

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

string

Categoria do produto (segundo nível) do cluster de produtos, representada na taxonomia de produtos do Google.
category_l3

string

Categoria do produto (terceiro nível) do cluster de produtos, representada na taxonomia de produtos do Google.
category_l4

string

Categoria do produto (quarto nível) do cluster de produtos, representada na taxonomia de produtos do Google.
category_l5

string

Categoria do produto (quinto nível) do cluster de produtos, representada na taxonomia de produtos do Google.
inventory_status

InventoryStatus

Indica se o cluster de produtos é IN_STOCK na sua fonte de dados de produtos em pelo menos um dos países, OUT_OF_STOCK na fonte de dados de produtos em todos os países ou NOT_IN_INVENTORY.

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

InventoryStatus

Se há pelo menos um produto da marca IN_STOCK na sua fonte de dados de produtos em pelo menos um dos países, se todos os produtos são OUT_OF_STOCK na fonte de dados de produtos 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

int64

Popularidade do cluster de produtos em anúncios e plataformas orgânicas, na categoria e no país selecionados, com base no número estimado de unidades vendidas.
previous_rank

int64

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

RelativeDemandEnum

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

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.
relative_demand_change

RelativeDemandChangeTypeEnum

Mudança na demanda estimada. Se ele aumentou, diminuiu ou permaneceu estável.

InventoryStatus

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

Enums
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 ou marca no inventário, mas ele está em falta.
NOT_IN_INVENTORY Você não tem um produto para este cluster ou marca no inventário.

CompetitiveVisibilityBenchmarkView

Campos disponíveis para consulta na tabela competitive_visibility_benchmark_view.

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.

Campos
date

Date

Data desta linha.

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

string

País em que as impressões apareceram.

Obrigatório na cláusula SELECT. Uma condição em report_country_code é necessária na cláusula WHERE.
report_category_id

int64

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

Obrigatório na cláusula SELECT. Uma condição em report_category_id é necessária na cláusula WHERE.
traffic_source

TrafficSourceEnum

Origem do tráfego das impressões.

Obrigatório na cláusula SELECT.
your_domain_visibility_trend

double

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'.
category_benchmark_visibility_trend

double

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

Não é possível filtrar na cláusula "WHERE".

CompetitiveVisibilityCompetitorView

Campos disponíveis para consulta na tabela competitive_visibility_competitor_view.

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.

Campos
date

Date

Data desta linha.

Uma condição em date é necessária na cláusula WHERE.
domain

string

Domínio do seu concorrente ou seu domínio, se "is_your_domain" for verdadeiro.

Obrigatório na cláusula SELECT. Não é possível filtrar na cláusula "WHERE".
is_your_domain

bool

Verdadeiro se a linha contém dados do seu domínio.

Não é possível filtrar na cláusula "WHERE".
report_country_code

string

País em que as impressões apareceram.

Obrigatório na cláusula SELECT. Uma condição em report_country_code é necessária na cláusula WHERE.
report_category_id

int64

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

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

TrafficSourceEnum

Origem do tráfego das impressões.

Obrigatório na cláusula SELECT.
rank

int64

Posição do domínio nas empresas semelhantes classificadas para as chaves selecionadas (date, report_category_id, report_country_code, traffic_source) com base nas impressões. 1 é o mais alto.

Não é possível filtrar na cláusula "WHERE".
ads_organic_ratio

double

A proporção de 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 agrupado.

Não é possível filtrar na cláusula "WHERE".
page_overlap_rate

double

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 é possível filtrar na cláusula "WHERE".
higher_position_rate

double

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 é possível filtrar na cláusula "WHERE".
relative_visibility

double

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

Não é possível filtrar na cláusula "WHERE".

CompetitiveVisibilityTopMerchantView

Campos disponíveis para consulta na tabela competitive_visibility_top_merchant_view.

Relatório de visibilidade competitiva com a empresa com maior visibilidade.

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

Campos
date

Date

Data desta linha.

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

string

Domínio do seu concorrente ou seu domínio, se "is_your_domain" for verdadeiro.

Obrigatório na cláusula SELECT. Não é possível filtrar na cláusula "WHERE".
is_your_domain

bool

Verdadeiro se a linha contém dados do seu domínio.

Não é possível filtrar na cláusula "WHERE".
report_country_code

string

País em que as impressões apareceram.

Obrigatório na cláusula SELECT. Uma condição em report_country_code é necessária na cláusula WHERE.
report_category_id

int64

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

Obrigatório na cláusula SELECT. Uma condição em report_category_id é necessária na cláusula WHERE.
traffic_source

TrafficSourceEnum

Origem do tráfego das impressões.

Obrigatório na cláusula SELECT.
rank

int64

Posição do domínio na classificação dos principais comerciantes para as chaves selecionadas (date, report_category_id, report_country_code, traffic_source) com base nas impressões. Um é o maior.

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

double

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 agrupado.

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

double

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 é possível filtrar na cláusula "WHERE".
higher_position_rate

double

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

Não é possível filtrar na cláusula "WHERE".

MarketingMethod

Esse tipo não tem campos.

Método de marketing usado para promover seus produtos no Google (orgânico x anúncios).

MarketingMethodEnum

Valores do método de marketing.

Enums
MARKETING_METHOD_ENUM_UNSPECIFIED Não especificado.
ORGANIC Marketing orgânico.
ADS Marketing com base em anúncios.

NonProductPerformanceView

Campos disponíveis para consulta na tabela non_product_performance_view.

Dados de performance de imagens e links da loja on-line que levam às suas 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 em consultas sem selecionar pelo menos um campo de métrica.

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

Campos
date

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

Date

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

int64

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

int64

Número de vezes que as imagens e os links da loja on-line que levam às suas páginas que não são de produtos foram mostrados. Métrica.
click_through_rate

double

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

PriceCompetitivenessProductView

Campos disponíveis para consulta na tabela price_competitiveness_product_view.

Relatório de competitividade de preço.

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

Campos
price

Price

Preço atual do produto.
benchmark_price

Price

Preço de mercado mais recente disponível para o catálogo do produto no país de comparação.
report_country_code

string

País do comparativo de mercado. Representado no formato ISO 3166.

Obrigatório na cláusula SELECT.
id

string

ID REST do produto no formato channel~languageCode~feedLabel~offerId. Pode ser usado para mesclar dados com a tabela product_view.

Obrigatório na cláusula SELECT.
offer_id

string

ID do produto fornecido pelo comerciante.
title

string

Título do produto.
brand

string

Marca do produto.
category_l1

string

Categoria do produto (primeiro nível) na taxonomia de produtos do Google.
category_l2

string

Categoria do produto (segundo nível) na taxonomia de produtos do Google.
category_l3

string

Categoria do produto (terceiro nível) na taxonomia de produtos do Google.
category_l4

string

Categoria do produto (quarto nível) na taxonomia de produtos do Google.
category_l5

string

Categoria do produto (quinto nível) na taxonomia de produtos do Google.
product_type_l1

string

Tipo de produto (primeiro nível) na taxonomia de produtos do comerciante.
product_type_l2

string

Tipo de produto (2º nível) na taxonomia de produtos do comerciante.
product_type_l3

string

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

string

Tipo de produto (4º nível) na taxonomia de produtos do comerciante.
product_type_l5

string

Tipo de produto (5º nível) na taxonomia de produtos do comerciante.

PriceInsightsProductView

Campos disponíveis para consulta na tabela price_insights_product_view.

Relatório Informações de preço.

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

Campos
price

Price

Preço atual do produto.
suggested_price

Price

Preço sugerido mais recente para o produto.
effectiveness

Effectiveness

A eficácia prevista da aplicação da sugestão de preço, agrupada.
id

string

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

Obrigatório na cláusula SELECT.
offer_id

string

ID do produto fornecido pelo comerciante.
title

string

Título do produto.
brand

string

Marca do produto.
category_l1

string

Categoria do produto (primeiro nível) na taxonomia de produtos do Google.
category_l2

string

Categoria do produto (segundo nível) na taxonomia de produtos do Google.
category_l3

string

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

string

Categoria do produto (quarto nível) na taxonomia de produtos do Google.
category_l5

string

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

string

Tipo de produto (primeiro nível) na taxonomia de produtos do comerciante.
product_type_l2

string

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

string

Tipo de produto (3º nível) na taxonomia de produtos do comerciante.
product_type_l4

string

Tipo de produto (4º nível) na taxonomia de produtos do comerciante.
product_type_l5

string

Tipo de produto (5º nível) na taxonomia de produtos do comerciante.
predicted_impressions_change_fraction

double

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.
predicted_clicks_change_fraction

double

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.
predicted_conversions_change_fraction

double

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 HIGH têm previsão de gerar o maior aumento na performance.

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

ProductPerformanceView

Campos disponíveis para consulta na tabela product_performance_view.

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

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

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

Campos
date

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

Date

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

Price

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

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

MarketingMethodEnum

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

string

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

Se não for possível determinar o país do cliente, um código especial "ZZ" será retornado.
offer_id

string

ID do produto fornecido pelo comerciante. Segmento.
title

string

Título do produto. Segmento.
brand

string

Marca do produto. Segmento.
category_l1

string

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

string

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

string

Categoria do produto (terceiro nível) na taxonomia de produtos do Google. Segmento.
category_l4

string

Categoria do produto (quarto nível) na taxonomia de produtos do Google. Segmento.
category_l5

string

Categoria do produto (quinto nível) na taxonomia de produtos do Google. Segmento.
product_type_l1

string

Tipo de produto (1º nível) na própria taxonomia de produtos do comerciante. Segmento.
product_type_l2

string

Tipo de produto (2º nível) na própria taxonomia de produtos do comerciante. Segmento.
product_type_l3

string

Tipo de produto (3º nível) na taxonomia de produtos do comerciante. Segmento.
product_type_l4

string

Tipo de produto (4º nível) na taxonomia de produtos do comerciante. Segmento.
product_type_l5

string

Tipo de produto (5º nível) na taxonomia de produtos do comerciante. Segmento.
custom_label0

string

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

string

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

string

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

string

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

string

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

int64

Número de cliques. Métrica.
impressions

int64

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

double

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

double

Número de conversões atribuídas ao produto, informadas na data da conversão. Dependendo do modelo de atribuição, uma conversão pode ser distribuída entre vários cliques, e cada clique recebe o 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.
conversion_rate

double

É o número de conversões dividido pelo número de cliques, informado na data da impressão. Métrica.

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

ProductView

Campos disponíveis para consulta na tabela product_view.

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, esta 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.

Campos
price

Price

Preço do produto. Ausente 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.
creation_time

Timestamp

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

Date

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

ItemIssue

Lista de problemas dos itens do produto.

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

Apenas alguns atributos deste campo (por exemplo, item_issues.severity.aggregated_severity) podem ser usados para filtrar os resultados.
click_potential

ClickPotential

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

string

ID REST do produto no formato channel~languageCode~feedLabel~offerId. Os métodos da API Merchant que operam em produtos usam isso como parâmetro name.

Obrigatório na cláusula SELECT.
channel

ChannelEnum

Canal do produto. Pode ser ONLINE ou LOCAL.
language_code

string

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

string

Rótulo do feed do produto.
offer_id

string

ID do produto fornecido pelo comerciante.
title

string

Título do produto.
brand

string

Marca do produto.
category_l1

string

Categoria do produto (primeiro nível) na taxonomia de produtos do Google.
category_l2

string

Categoria do produto (segundo nível) na taxonomia de produtos do Google.
category_l3

string

Categoria do produto (terceiro nível) na taxonomia de produtos do Google.
category_l4

string

Categoria do produto (quarto nível) na taxonomia de produtos do Google.
category_l5

string

Categoria do produto (quinto nível) na taxonomia de produtos do Google.
product_type_l1

string

Tipo de produto (primeiro nível) na taxonomia de produtos do comerciante.
product_type_l2

string

Tipo de produto (2º nível) na taxonomia de produtos do comerciante.
product_type_l3

string

Tipo de produto (3º nível) na taxonomia de produtos do comerciante.
product_type_l4

string

Tipo de produto (4º nível) na taxonomia de produtos do comerciante.
product_type_l5

string

Tipo de produto (5º nível) na taxonomia de produtos do comerciante.
condition

string

Condição do produto.
availability

string

Disponibilidade do produto.
shipping_label

string

Etiqueta para envio normalizada especificada na fonte de dados.
item_group_id

string

ID do grupo de itens fornecido pelo comerciante para agrupar variantes.
aggregated_reporting_context_status

AggregatedReportingContextStatus

Status agregado.
click_potential_rank

int64

Classificação do produto com base no potencial de cliques. Um produto com click_potential_rank 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 gratuitas Anúncios do Shopping Status
Aprovado Aprovado QUALIFICADA
Aprovado Pendente QUALIFICADA
Aprovado Reprovado ELIGIBLE_LIMITED
Pendente Pendente PENDENTE
Reprovado Reprovado NOT_ELIGIBLE_OR_DISAPPROVED
Enums
AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED Não especificado.
NOT_ELIGIBLE_OR_DISAPPROVED O produto não está qualificado ou foi reprovado em todos os contextos de relatórios.
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órios.
ELIGIBLE O produto está qualificado para todos os contextos de relatório.

ClickPotential

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

Enums
CLICK_POTENTIAL_UNSPECIFIED Impacto de cliques previstos desconhecidos.
LOW Potencial para receber um número baixo de cliques em comparação com os produtos de melhor desempenho do comerciante.
MEDIUM Potencial para receber um número moderado de cliques em comparação com os produtos de melhor desempenho do comerciante.
HIGH Potencial para receber um número de cliques semelhante ao dos produtos com a melhor performance do comerciante.

ItemIssue

Problema do item associado ao produto.

Campos
type

ItemIssueType

Tipo de problema do item.
severity

ItemIssueSeverity

Gravidade do problema do item.
resolution

ItemIssueResolution

Resolução do problema do item.

ItemIssueResolution

Como resolver o problema.

Enums
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 do comerciante é necessária no momento. A resolução pode levar a outro problema (por exemplo, se o rastreamento falhar).

ItemIssueSeverity

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

Campos
severity_per_reporting_context[]

IssueSeverityPerReportingContext

Gravidade do problema por contexto do relatório.
aggregated_severity

AggregatedIssueSeverity

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

Esse campo pode ser usado para filtrar os resultados.

AggregatedIssueSeverity

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

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

IssueSeverityPerReportingContext

Gravidade do problema por contexto de relatório.

Campos
disapproved_countries[]

string

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

string

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

ReportingContextEnum

Contexto do relatório ao qual o problema se aplica.

ItemIssueType

Tipo de problema.

Campos
code

string

Código de erro do problema, equivalente ao code de Problemas no produto.
canonical_attribute

string

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

RelativeDemand

Esse tipo não tem campos.

Demanda relativa de um cluster de produtos ou marca no relatório "Mais vendidos".

RelativeDemandEnum

Valores de demanda relativa.

Enums
RELATIVE_DEMAND_ENUM_UNSPECIFIED Não especificado.
VERY_LOW A demanda é de 0 a 5% da demanda do cluster ou da marca de produto com a melhor classificação.
LOW A demanda é de 6 a 10% da demanda do cluster ou da marca de produto 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 é de 21% a 50% da demanda do cluster ou da marca de produto com a melhor classificação.
VERY_HIGH A demanda é de 51% a 100% da demanda do cluster ou da marca de produto com a melhor classificação.

RelativeDemandChangeType

Esse tipo não tem campos.

Demanda relativa de um cluster de produtos ou de uma marca no relatório "Mais vendidos" em comparação com o período anterior.

RelativeDemandChangeTypeEnum

Valores do tipo de mudança na demanda relativa.

Enums
RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED Não especificado.
SINKER A demanda relativa é menor do 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.

ReportGranularity

Esse tipo não tem campos.

Granularidade do relatório "Mais vendidos". Os relatórios de mais vendidos são calculados em um período de uma semana e um mês.

ReportGranularityEnum

Informe os valores de granularidade.

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

ReportRow

Linha de resultado retornada pela 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.

Campos
product_performance_view

ProductPerformanceView

Campos disponíveis para consulta na tabela product_performance_view.
non_product_performance_view

NonProductPerformanceView

Campos disponíveis para consulta na tabela non_product_performance_view.
product_view

ProductView

Campos disponíveis para consulta na tabela product_view.
price_competitiveness_product_view

PriceCompetitivenessProductView

Campos disponíveis para consulta na tabela price_competitiveness_product_view.
price_insights_product_view

PriceInsightsProductView

Campos disponíveis para consulta na tabela price_insights_product_view.
best_sellers_product_cluster_view

BestSellersProductClusterView

Campos disponíveis para consulta na tabela best_sellers_product_cluster_view.
best_sellers_brand_view

BestSellersBrandView

Campos disponíveis para consulta na tabela best_sellers_brand_view.
competitive_visibility_competitor_view

CompetitiveVisibilityCompetitorView

Campos disponíveis para consulta na tabela competitive_visibility_competitor_view.
competitive_visibility_top_merchant_view

CompetitiveVisibilityTopMerchantView

Campos disponíveis para consulta na tabela competitive_visibility_top_merchant_view.
competitive_visibility_benchmark_view

CompetitiveVisibilityBenchmarkView

Campos disponíveis para consulta na tabela competitive_visibility_benchmark_view.

SearchRequest

Solicite mensagem para o método ReportService.Search.

Campos
parent

string

Obrigatório. ID da conta que fez a chamada. Precisa ser uma conta independente ou uma subconta de MCA. Formato: accounts/{account}
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 conferir a lista completa de tabelas e campos disponíveis, consulte os campos disponíveis.
page_size

int32

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 5000.
page_token

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 next_page_token na resposta anterior.

SearchResponse

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

Campos
results[]

ReportRow

Linhas que correspondem à consulta de pesquisa.
next_page_token

string

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

TrafficSource

Esse tipo não tem campos.

Origem do tráfego das impressões no Relatório de visibilidade competitiva.

TrafficSourceEnum

Valores da origem do tráfego.

Enums
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.