Package google.shopping.merchant.reviews.v1beta

Índice

MerchantReviewsService

Serviço para gerenciar avaliações de comerciantes.

DeleteMerchantReview

rpc DeleteMerchantReview(DeleteMerchantReviewRequest) returns (Empty)

Exclui a avaliação do comerciante.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.
GetMerchantReview

rpc GetMerchantReview(GetMerchantReviewRequest) returns (MerchantReview)

Recebe uma avaliação do comerciante.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.
InsertMerchantReview

rpc InsertMerchantReview(InsertMerchantReviewRequest) returns (MerchantReview)

Insere uma avaliação na sua conta do Merchant Center. Se a análise já existir, ela será substituída pela nova instância.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.
ListMerchantReviews

rpc ListMerchantReviews(ListMerchantReviewsRequest) returns (ListMerchantReviewsResponse)

Lista as avaliações do comerciante.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

ProductReviewsService

Serviço para gerenciar avaliações de produtos.

DeleteProductReview

rpc DeleteProductReview(DeleteProductReviewRequest) returns (Empty)

Exclui uma avaliação de produto.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.
GetProductReview

rpc GetProductReview(GetProductReviewRequest) returns (ProductReview)

Recebe uma avaliação do produto.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.
InsertProductReview

rpc InsertProductReview(InsertProductReviewRequest) returns (ProductReview)

Insere uma avaliação do produto.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.
ListProductReviews

rpc ListProductReviews(ListProductReviewsRequest) returns (ListProductReviewsResponse)

Lista as avaliações do produto.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

DeleteMerchantReviewRequest

Solicite mensagem para o método DeleteMerchantReview.

Campos
name

string

Obrigatório. O ID da avaliação do comerciante. Formato: accounts/{account}/merchantReviews/{merchantReview}

DeleteProductReviewRequest

Solicite mensagem para o método DeleteProductReview.

Campos
name

string

Obrigatório. O ID da avaliação do produto. Formato: accounts/{account}/productReviews/{productReview}

GetMerchantReviewRequest

Solicite mensagem para o método GetMerchantReview.

Campos
name

string

Obrigatório. O ID da avaliação do comerciante. Formato: accounts/{account}/merchantReviews/{merchantReview}

GetProductReviewRequest

Mensagem de solicitação para o método GetProductReview.

Campos
name

string

Obrigatório. O ID da avaliação do comerciante. Formato: accounts/{account}/productReviews/{productReview}

InsertMerchantReviewRequest

Solicite mensagem para o método InsertMerchantReview.

Campos
parent

string

Obrigatório. A conta em que a avaliação do comerciante será inserida. Formato: accounts/{account}
merchant_review

MerchantReview

Obrigatório. A avaliação do comerciante a ser inserida.
data_source

string

Obrigatório. A fonte de dados do formato merchantreview: accounts/{account}/dataSources/{datasource}.

InsertProductReviewRequest

Solicite mensagem para o método InsertProductReview.

Campos
parent

string

Obrigatório. A conta em que a avaliação do produto será inserida. Formato: accounts/{account}
product_review

ProductReview

Obrigatório. A avaliação do produto a ser inserida.
data_source

string

Obrigatório. Formato: accounts/{account}/dataSources/{datasource}.

ListMerchantReviewsRequest

Solicite mensagem para o método ListMerchantsReview.

Campos
parent

string

Obrigatório. A conta para listar as avaliações do comerciante. Formato: accounts/{account}
page_size

int32

Opcional. O número máximo de avaliações do comerciante a serem retornadas. O serviço pode retornar menos que esse valor. O valor máximo é 1.000. Valores acima disso são convertidos para 1.000. Se não for especificado, o número máximo de avaliações será retornado.
page_token

string

Opcional. Um token de página recebido de uma chamada ListMerchantReviews anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListMerchantReviews precisam corresponder à chamada que forneceu o token da página.

ListMerchantReviewsResponse

Mensagem de resposta para o método ListMerchantsReview.

Campos
merchant_reviews[]

MerchantReview

A avaliação do comerciante.
next_page_token

string

O token para recuperar a próxima página de resultados.

ListProductReviewsRequest

Mensagem de solicitação para o método ListProductReviews.

Campos
parent

string

Obrigatório. A conta para listar as avaliações do produto. Formato: accounts/{account}
page_size

int32

Opcional. O número máximo de produtos a serem retornados. O serviço pode retornar menos que esse valor.
page_token

string

Opcional. Um token de página recebido de uma chamada ListProductReviews anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListProductReviews precisam corresponder à chamada que forneceu o token da página.

ListProductReviewsResponse

Mensagem de resposta para o método ListProductReviews.

Campos
product_reviews[]

ProductReview

A avaliação do produto.
next_page_token

string

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

MerchantReview

Uma avaliação de um comerciante. Para mais informações, consulte Introdução aos feeds de avaliações do comerciante.

Campos
name

string

Identificador. O nome da avaliação do comerciante. Formato: "{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"
merchant_review_id

string

Obrigatório. O usuário forneceu o ID da avaliação do comerciante para identificar exclusivamente a avaliação.
attributes

MerchantReviewAttributes

Opcional. Uma lista de atributos de análise do comerciante.
custom_attributes[]

CustomAttribute

Obrigatório. Uma lista de atributos personalizados (fornecidos pelo comerciante). Ele também pode ser usado para enviar qualquer atributo da especificação de dados na forma genérica (por exemplo, { "name": "size type", "value": "regular" }). Isso é útil para enviar atributos não expostos explicitamente pela API, como atributos experimentais. O número máximo de caracteres permitido para cada atributo personalizado é 10240 (representa a soma de caracteres para nome e valor). É possível definir no máximo 2.500 atributos personalizados por produto, com tamanho total de 102,4 KB. Os sublinhados nos nomes de atributos personalizados são substituídos por espaços na inserção.
data_source

string

Apenas saída. A fonte de dados principal da avaliação do comerciante.
merchant_review_status

MerchantReviewStatus

Apenas saída. O status de uma avaliação do comerciante, problemas de validação de dados, ou seja, informações sobre uma avaliação do comerciante calculada de forma assíncrona.

MerchantReviewAttributes

Atributos.

Campos
merchant_id

string

Obrigatório. Precisa ser único e estável em todas as solicitações. Em outras palavras, se uma solicitação de hoje e outra de 90 dias atrás se referem ao mesmo comerciante, elas precisam ter o mesmo ID.
merchant_display_name

string

Opcional. Nome de exibição legível para o comerciante.
min_rating

int64

Opcional. O número mínimo possível para a classificação. Esse deve ser o pior valor possível e não pode ser um valor de nenhuma classificação.
max_rating

int64

Opcional. O número máximo possível para a classificação. O valor da nota máxima precisa ser maior que o valor da nota mínima.
rating

double

Opcional. A classificação geral do comerciante pelo autor da avaliação.
title

string

Opcional. O título da avaliação.
content

string

Obrigatório. Esse texto pode ser qualquer texto livre fornecido pelo usuário e não pode ser truncado. Se várias respostas a perguntas diferentes forem fornecidas, todas elas precisam ser incluídas, com o mínimo de contexto para que façam sentido. Não forneça contexto se as perguntas não foram respondidas.
reviewer_id

string

Opcional. Um identificador permanente e exclusivo do autor da avaliação no sistema do editor.
reviewer_username

string

Opcional. Nome de exibição do autor da avaliação.
is_anonymous

bool

Opcional. Defina como "true" se o avaliador precisar permanecer anônimo.
collection_method

CollectionMethod

Opcional. O método usado para coletar a avaliação.
review_time

Timestamp

Obrigatório. O carimbo de data/hora que indica quando a avaliação foi escrita.
review_language

string

Obrigatório. O idioma da avaliação definido pelo código de idioma BCP-47.
review_country

string

Opcional. O país em que o revisor fez o pedido, definido pelo código de país ISO 3166-1 Alfa-2.

CollectionMethod

O método usado para coletar a avaliação.

Enums
COLLECTION_METHOD_UNSPECIFIED O método de coleta não foi especificado.
MERCHANT_UNSOLICITED O usuário não estava respondendo a uma solicitação específica quando enviou a avaliação.
POINT_OF_SALE O usuário enviou a avaliação em resposta a uma solicitação depois de fazer um pedido.
AFTER_FULFILLMENT O usuário enviou a avaliação em resposta a uma solicitação após o cumprimento do pedido.

MerchantReviewStatus

O status de uma avaliação do comerciante, problemas de validação de dados, ou seja, informações sobre uma avaliação do comerciante calculada de forma assíncrona.

Campos
destination_statuses[]

MerchantReviewDestinationStatus

Apenas saída. Os destinos pretendidos da avaliação do comerciante.
item_level_issues[]

MerchantReviewItemLevelIssue

Apenas saída. Uma lista de todos os problemas associados à avaliação do comerciante.
create_time

Timestamp

Apenas saída. Data em que o item foi criado, no formato ISO 8601.
last_update_time

Timestamp

Apenas saída. Data da última atualização do item, no formato ISO 8601.

MerchantReviewDestinationStatus

O status de destino do status de avaliação do comerciante.

Campos
reporting_context

ReportingContextEnum

Apenas saída. O nome do contexto de relatórios.

MerchantReviewItemLevelIssue

O ItemLevelIssue do status da revisão do comerciante.

Campos
code

string

Apenas saída. O código de erro do problema.
severity

Severity

Apenas saída. Como esse problema afeta a veiculação da avaliação do comerciante.
resolution

string

Apenas saída. Se o problema pode ser resolvido pelo comerciante.
attribute

string

Apenas saída. O nome do atributo, se o problema for causado por um único atributo
reporting_context

ReportingContextEnum

Apenas saída. O contexto do relatório ao qual o problema se aplica.
description

string

Apenas saída. Uma breve descrição do problema em inglês.
detail

string

Apenas saída. Uma descrição detalhada do problema em inglês.
documentation

string

Apenas saída. O URL de uma página da Web para ajudar a resolver esse problema.

Gravidade

Como o problema afeta a veiculação da avaliação do comerciante.

Enums
SEVERITY_UNSPECIFIED Não especificado.
NOT_IMPACTED Esse problema representa um aviso e não tem um efeito direto na avaliação do comerciante.
DISAPPROVED O problema reprova a avaliação do comerciante.

ProductReview

Uma avaliação de um produto. Para mais informações, consulte Introdução aos feeds de avaliações de produtos.

Campos
name

string

Identificador. O nome da avaliação do produto. Formato: "{productreview.name=accounts/{account}/productReviews/{productReview}}"
product_review_id

string

Obrigatório. O identificador permanente e exclusivo da avaliação do produto no sistema do editor.
attributes

ProductReviewAttributes

Opcional. Uma lista de atributos de avaliação do produto.
custom_attributes[]

CustomAttribute

Opcional. Uma lista de atributos personalizados (fornecidos pelo comerciante).
data_source

string

Apenas saída. A principal fonte de dados da avaliação do produto.
product_review_status

ProductReviewStatus

Apenas saída. O status de uma avaliação do produto, problemas de validação de dados, ou seja, informações sobre uma avaliação do produto calculada de forma assíncrona.

ProductReviewAttributes

Atributos.

Campos
review_time

Timestamp

Obrigatório. O carimbo de data/hora que indica quando a avaliação foi escrita.
pros[]

string

Opcional. Contém as vantagens com base na opinião do revisor. Omita textos padrão, como "pro:", a menos que tenham sido escritos pelo avaliador.
cons[]

string

Opcional. Contém as desvantagens com base na opinião do avaliador. Omita textos padrão, como "con:", a menos que tenham sido escritos pelo avaliador.
product_names[]

string

Opcional. Nome descritivo de um produto.
asins[]

string

Opcional. Contém ASINs (números de identificação padrão da Amazon) associados a um produto.
gtins[]

string

Opcional. Contém GTINs (números globais de item comercial) associados a um produto. Subtipos de GTINs (por exemplo, UPC, EAN, ISBN, JAN) são aceitos.
mpns[]

string

Opcional. Contém MPNs (números de peça do fabricante) associados a um produto.
skus[]

string

Opcional. Contém SKUs (unidades de manutenção de estoque) associadas a um produto. Geralmente, ele corresponde ao ID da oferta de produto no feed de produtos.
brands[]

string

Opcional. Contém nomes de marcas associadas a um produto.
collection_method

CollectionMethod

Opcional. O método usado para coletar a avaliação.
transaction_id

string

Opcional. Um identificador permanente e exclusivo da transação associada à avaliação no sistema do editor. Esse ID pode ser usado para indicar que várias avaliações estão associadas à mesma transação.
aggregator_name

string

Opcional. O nome do agregador das avaliações do produto.

Um editor pode usar um agregador de avaliações para gerenciar avaliações e fornecer os feeds. Esse elemento indica o uso de um agregador e contém informações sobre ele.
subclient_name

string

Opcional. O nome do subcliente das avaliações do produto.

O subcliente é um identificador da origem da avaliação do produto. Ele precisa ser equivalente ao diretório fornecido no caminho da fonte de dados do arquivo.
publisher_name

string

Opcional. O nome do editor das avaliações do produto.

As informações sobre o editor, que pode ser um varejista, fabricante, empresa de serviços de avaliações ou qualquer entidade que publique avaliações de produtos.
publisher_favicon

string

Opcional. Um link para o ícone da empresa do editor. As dimensões da imagem precisam ser do tamanho de um ícone de favoritos: 16 x 16 pixels. O formato da imagem precisa ser GIF, JPG ou PNG.
reviewer_id

string

Opcional. O autor da avaliação do produto.

Um identificador permanente e exclusivo do autor da avaliação no sistema do editor.
reviewer_is_anonymous

bool

Opcional. Defina como "true" se o avaliador precisar permanecer anônimo.
reviewer_username

string

Opcional. O nome do usuário que fez a avaliação do produto.
review_language

string

Opcional. O idioma da avaliação definido pelo código de idioma BCP-47.
review_country

string

Opcional. O país da revisão definido pelo código de país ISO 3166-1 Alfa-2.
title

string

Opcional. O título da avaliação.
content

string

Obrigatório. O conteúdo da avaliação.
min_rating

int64

Opcional. Contém as classificações associadas à avaliação. O número mínimo possível para a classificação. Esse deve ser o pior valor possível e não pode ser um valor de nenhuma classificação.
max_rating

int64

Opcional. O número máximo possível para a classificação. O valor da classificação máxima precisa ser maior que o valor do atributo mínimo.
rating

double

Opcional. A classificação geral do produto pelo autor da avaliação.
is_spam

bool

Opcional. Indica se a avaliação está marcada como spam no sistema do editor.

CollectionMethod

O método usado para coletar a avaliação.

Enums
COLLECTION_METHOD_UNSPECIFIED O método de coleta não foi especificado.
UNSOLICITED O usuário não estava respondendo a uma solicitação específica quando enviou a avaliação.
POST_FULFILLMENT O usuário enviou a avaliação em resposta a uma solicitação após o cumprimento do pedido.

Tipo

Tipo do URI da análise.

Enums
TYPE_UNSPECIFIED Tipo não especificado.
SINGLETON A página de avaliações contém apenas esta avaliação.
GROUP A página de avaliações contém um grupo de avaliações, incluindo esta.

ProductReviewStatus

Status da análise do produto.

Campos
destination_statuses[]

ProductReviewDestinationStatus

Apenas saída. Os destinos pretendidos da avaliação do produto.
item_level_issues[]

ProductReviewItemLevelIssue

Apenas saída. Uma lista de todos os problemas associados à avaliação do produto.
create_time

Timestamp

Apenas saída. Data em que o item foi criado, no formato ISO 8601.
last_update_time

Timestamp

Apenas saída. Data da última atualização do item, no formato ISO 8601.

ProductReviewDestinationStatus

O status de destino da análise do produto.

Campos
reporting_context

ReportingContextEnum

Apenas saída. O nome do contexto de relatórios.

ProductReviewItemLevelIssue

O ItemLevelIssue do status de análise do produto.

Campos
code

string

Apenas saída. O código de erro do problema.
severity

Severity

Apenas saída. Como esse problema afeta a veiculação da avaliação do produto.
resolution

string

Apenas saída. Se o problema pode ser resolvido pelo comerciante.
attribute

string

Apenas saída. O nome do atributo, se o problema for causado por um único atributo
reporting_context

ReportingContextEnum

Apenas saída. O contexto do relatório ao qual o problema se aplica.
description

string

Apenas saída. Uma breve descrição do problema em inglês.
detail

string

Apenas saída. Uma descrição detalhada do problema em inglês.
documentation

string

Apenas saída. O URL de uma página da Web para ajudar a resolver esse problema.

Gravidade

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

Enums
SEVERITY_UNSPECIFIED Não especificado.
NOT_IMPACTED Esse problema representa um aviso e não tem um efeito direto na avaliação do produto.
DISAPPROVED O problema reprova a análise do produto.