REST Resource: accounts.productReviews

Recurso: ProductReview

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

Representação JSON 
{
  "name": string,
  "productReviewId": string,
  "attributes": {
    object (ProductReviewAttributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "dataSource": string,
  "productReviewStatus": {
    object (ProductReviewStatus)
  }
}
Campos
name

string

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

string

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

object (ProductReviewAttributes)

Opcional. Uma lista de atributos de avaliações do produto.
customAttributes[]

object (CustomAttribute)

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

string

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

object (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.

Representação JSON 
{
  "reviewTime": string,
  "pros": [
    string
  ],
  "cons": [
    string
  ],
  "reviewLink": {
    object (ReviewLink)
  },
  "reviewerImageLinks": [
    string
  ],
  "productNames": [
    string
  ],
  "productLinks": [
    string
  ],
  "asins": [
    string
  ],
  "gtins": [
    string
  ],
  "mpns": [
    string
  ],
  "skus": [
    string
  ],
  "brands": [
    string
  ],
  "collectionMethod": enum (CollectionMethod),
  "transactionId": string,
  "aggregatorName": string,
  "subclientName": string,
  "publisherName": string,
  "publisherFavicon": string,
  "reviewerId": string,
  "reviewerIsAnonymous": boolean,
  "reviewerUsername": string,
  "reviewLanguage": string,
  "reviewCountry": string,
  "title": string,
  "content": string,
  "minRating": string,
  "maxRating": string,
  "rating": number,
  "isSpam": boolean
}
Campos
reviewTime

string (Timestamp format)

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 texto padrão como "pro:", a menos que tenha sido escrito 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.
productNames[]

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

enum (CollectionMethod)

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

string

Opcional. É um identificador permanente e exclusivo para a 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.
aggregatorName

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

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

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

string

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

string

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

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

boolean

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

string

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

string

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

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

string (int64 format)

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

string (int64 format)

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

number

Opcional. É a classificação geral do produto feita pelo revisor.
isSpam

boolean

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

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.

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.

ProductReviewStatus

Status da análise do produto.

Representação JSON 
{
  "destinationStatuses": [
    {
      object (ProductReviewDestinationStatus)
    }
  ],
  "itemLevelIssues": [
    {
      object (ProductReviewItemLevelIssue)
    }
  ],
  "createTime": string,
  "lastUpdateTime": string
}
Campos
destinationStatuses[]

object (ProductReviewDestinationStatus)

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

object (ProductReviewItemLevelIssue)

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

string (Timestamp format)

Apenas saída. É a data em que o item foi criado, no formato ISO 8601.
lastUpdateTime

string (Timestamp format)

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

ProductReviewDestinationStatus

O status de destino da análise do produto.

Representação JSON 
{
  "reportingContext": enum (ReportingContextEnum)
}
Campos
reportingContext

enum (ReportingContextEnum)

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

ProductReviewItemLevelIssue

O ItemLevelIssue do status da análise do produto.

Representação JSON 
{
  "code": string,
  "severity": enum (Severity),
  "resolution": string,
  "attribute": string,
  "reportingContext": enum (ReportingContextEnum),
  "description": string,
  "detail": string,
  "documentation": string
}
Campos
code

string

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

enum (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
reportingContext

enum (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 o 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 alerta e não tem efeito direto na avaliação do produto.
DISAPPROVED O problema reprova a análise do produto.

Métodos

delete

 Exclui uma avaliação do produto.

get

 Recebe uma avaliação do produto.

insert

 Insere uma avaliação do produto.

list

 Lista avaliações do produto.