MerchantReviewAttributes

import type { MerchantReviewAttributes } from "https://googleapis.deno.dev/v1/merchantapi:reviews_v1beta.ts";

Attributes.

interface MerchantReviewAttributes {

collectionMethod?:

| "COLLECTION_METHOD_UNSPECIFIED"

| "MERCHANT_UNSOLICITED"

| "POINT_OF_SALE"

| "AFTER_FULFILLMENT";

content?: string;

isAnonymous?: boolean;

maxRating?: bigint;

merchantDisplayName?: string;

merchantId?: string;

merchantLink?: string;

merchantRatingLink?: string;

minRating?: bigint;

rating?: number;

reviewCountry?: string;

reviewerId?: string;

reviewerUsername?: string;

reviewLanguage?: string;

reviewTime?: Date;

title?: string;

}

§Properties

collectionMethod?: "COLLECTION_METHOD_UNSPECIFIED" | "MERCHANT_UNSOLICITED" | "POINT_OF_SALE" | "AFTER_FULFILLMENT"

[src]

Optional. The method used to collect the review.

content?: string

[src]

Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered.

isAnonymous?: boolean

[src]

Optional. Set to true if the reviewer should remain anonymous.

maxRating?: bigint

[src]

Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.

merchantDisplayName?: string

[src]

Optional. Human-readable display name for the merchant.

merchantId?: string

[src]

Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.

merchantLink?: string

[src]

Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.

merchantRatingLink?: string

[src]

Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL.

minRating?: bigint

[src]

Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.

rating?: number

[src]

Optional. The reviewer's overall rating of the merchant.

reviewCountry?: string

[src]

Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.