REST Resource: accounts.merchantReviews

Recurso: MerchantReview

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

Representação JSON 
{
  "name": string,
  "merchantReviewId": string,
  "attributes": {
    object (MerchantReviewAttributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "dataSource": string,
  "merchantReviewStatus": {
    object (MerchantReviewStatus)
  }
}
Campos
name

string

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

string

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

object (MerchantReviewAttributes)

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

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

string

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

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

Representação JSON 
{
  "merchantId": string,
  "merchantDisplayName": string,
  "merchantLink": string,
  "merchantRatingLink": string,
  "minRating": string,
  "maxRating": string,
  "rating": number,
  "title": string,
  "content": string,
  "reviewerId": string,
  "reviewerUsername": string,
  "isAnonymous": boolean,
  "collectionMethod": enum (CollectionMethod),
  "reviewTime": string,
  "reviewLanguage": string,
  "reviewCountry": string
}
Campos
merchantId

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

string

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

string (int64 format)

Opcional. 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 nota máxima precisa ser maior que o valor da nota mínima.
rating

number

Opcional. A classificação geral do comerciante feita pelo usuário.
title

string

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

string

Obrigatório. Deve ser qualquer texto de formato livre fornecido pelo usuário e não deve 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.
reviewerId

string

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

string

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

boolean

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

enum (CollectionMethod)

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

string (Timestamp format)

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

string

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

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 quando fez 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.

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

object (MerchantReviewDestinationStatus)

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

object (MerchantReviewItemLevelIssue)

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

string (Timestamp format)

Apenas saída. 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.

MerchantReviewDestinationStatus

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

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

enum (ReportingContextEnum)

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

MerchantReviewItemLevelIssue

O ItemLevelIssue do status da revisão do comerciante.

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

Métodos

delete

 Exclui a avaliação do comerciante.

get

 Recebe uma avaliação do comerciante.

insert

 Insere uma avaliação na sua conta do Merchant Center.

list

 Lista as avaliações do comerciante.