Package google.shopping.merchant.reviews.v1beta

インデックス

MerchantReviewsService

販売者のレビューを管理するサービス。

DeleteMerchantReview

rpc DeleteMerchantReview(DeleteMerchantReviewRequest) returns (Empty)

販売者のクチコミを削除します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

GetMerchantReview

rpc GetMerchantReview(GetMerchantReviewRequest) returns (MerchantReview)

販売者のクチコミを取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

InsertMerchantReview

rpc InsertMerchantReview(InsertMerchantReviewRequest) returns (MerchantReview)

Merchant Center アカウントの審査結果を挿入します。レビューがすでに存在する場合は、レビューが新しいインスタンスに置き換えられます。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

ListMerchantReviews

rpc ListMerchantReviews(ListMerchantReviewsRequest) returns (ListMerchantReviewsResponse)

販売者のレビューを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

ProductReviewsService

商品レビューを管理するサービス。

DeleteProductReview

rpc DeleteProductReview(DeleteProductReviewRequest) returns (Empty)

商品レビューを削除します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

GetProductReview

rpc GetProductReview(GetProductReviewRequest) returns (ProductReview)

商品レビューを取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

InsertProductReview

rpc InsertProductReview(InsertProductReviewRequest) returns (ProductReview)

商品レビューを挿入します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

ListProductReviews

rpc ListProductReviews(ListProductReviewsRequest) returns (ListProductReviewsResponse)

商品レビューを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

DeleteMerchantReviewRequest

DeleteMerchantReview メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。販売者レビューの ID。形式: accounts/{account}/merchantReviews/{merchantReview}

DeleteProductReviewRequest

DeleteProductReview メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。商品レビューの ID。形式: accounts/{account}/productReviews/{productReview}

GetMerchantReviewRequest

GetMerchantReview メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。販売者レビューの ID。形式: accounts/{account}/merchantReviews/{merchantReview}

GetProductReviewRequest

GetProductReview メソッドのリクエスト メッセージ。

フィールド
name

string

必須。販売者レビューの ID。形式: accounts/{account}/productReviews/{productReview}

InsertMerchantReviewRequest

InsertMerchantReview メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。販売者のレビューが挿入されるアカウント。形式: accounts/{account}

merchant_review

MerchantReview

必須。挿入する販売者レビュー。

data_source

string

必須。merchantreview のデータソース。形式: accounts/{account}/dataSources/{datasource}

InsertProductReviewRequest

InsertProductReview メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。商品レビューが挿入されるアカウント。形式: accounts/{account}

product_review

ProductReview

必須。挿入する商品レビュー。

data_source

string

必須。形式: accounts/{account}/dataSources/{datasource}

ListMerchantReviewsRequest

ListMerchantsReview メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。販売者レビューを表示するアカウント。形式: accounts/{account}

page_size

int32

省略可。返される販売者のレビューの最大数。サービスが返す値はこれよりも少ないことがあります。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。指定されていない場合は、クチコミの最大数が返されます。

page_token

string

省略可。前回の ListMerchantReviews 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListMerchantReviews に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListMerchantReviewsResponse

ListMerchantsReview メソッドに対するレスポンス メッセージ。

フィールド
merchant_reviews[]

MerchantReview

販売者レビュー。

next_page_token

string

結果の次のページを取得するためのトークン。

ListProductReviewsRequest

ListProductReviews メソッドのリクエスト メッセージ。

フィールド
parent

string

必須。商品レビューを一覧表示するアカウント。形式: accounts/{account}

page_size

int32

省略可。返す商品の最大数。サービスが返す値はこれよりも少ないことがあります。

page_token

string

省略可。前回の ListProductReviews 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListProductReviews に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListProductReviewsResponse

ListProductReviews メソッドのレスポンス メッセージ。

フィールド
product_reviews[]

ProductReview

商品レビュー。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

MerchantReview

販売者のレビュー。詳しくは、販売者レビュー フィードの概要をご覧ください。

フィールド
name

string

ID。販売者レビューの名前。形式: "{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"

merchant_review_id

string

必須。販売者レビューを一意に識別するために、ユーザーが指定した販売者レビュー ID。

attributes

MerchantReviewAttributes

省略可。販売者のレビュー属性のリスト。

custom_attributes[]

CustomAttribute

必須。カスタム(販売者提供)属性のリスト。また、データ仕様の任意の属性を汎用形式({ "name": "size type", "value": "regular" } など)で送信する場合にも使用できます。これは、試験運用版の属性など、API で明示的に公開されていない属性を送信する場合に便利です。各カスタム属性の最大許容文字数は 10,240 文字です(名前と値の文字数の合計)。1 つの商品に設定できるカスタム属性は最大 2, 500 個で、合計サイズは 102.4 KB です。カスタム属性名のアンダースコアは、挿入時にスペースに置き換えられます。

data_source

string

出力専用。販売者レビューのメインのデータソース。

merchant_review_status

MerchantReviewStatus

出力専用。販売者のレビューのステータス、データ検証の問題、つまり非同期で計算された販売者のレビューに関する情報。

MerchantReviewAttributes

属性。

フィールド
merchant_id

string

必須。すべてのリクエストで一意で安定している必要があります。つまり、今日のリクエストと 90 日前のリクエストが同じ販売者を指す場合は、同じ ID を使用する必要があります。

merchant_display_name

string

省略可。販売者の表示名(人が読める形式)。

min_rating

int64

省略可。評価に使用できる最小値。これは、可能な限り低い評価である必要があります。評価なしの値ではありません。

max_rating

int64

省略可。評価の最大値。最大評価の値は最小評価の値よりも大きくする必要があります。

rating

double

省略可。販売者に対するレビューアーの総合評価。

title

string

省略可。レビューのタイトル。

content

string

必須。これは、ユーザーが指定する自由形式のテキストで、切り捨てられてはなりません。異なる質問に対する回答が複数ある場合は、すべての回答を含める必要があります。回答が理解できるように、最小限のコンテキストも含める必要があります。質問に回答が得られなかった場合は、コンテキストを提供しない。

reviewer_id

string

省略可。パブリッシャーのシステムにおけるレビューの作成者を示す永続的な一意の識別子。

reviewer_username

string

省略可。レビュー投稿者の表示名。

is_anonymous

bool

省略可。クチコミ投稿者を匿名のままにする場合は true に設定します。

collection_method

CollectionMethod

省略可。レビューの収集方法。

review_time

Timestamp

必須。クチコミが投稿されたときのタイムスタンプです。

review_language

string

必須。BCP-47 言語コードで定義されたレビューの言語。

review_country

string

省略可。レビュー担当者が注文した国(ISO 3166-1 alpha-2 国コードで定義)。

CollectionMethod

レビューの収集方法。

列挙型
COLLECTION_METHOD_UNSPECIFIED 収集方法が指定されていません。
MERCHANT_UNSOLICITED ユーザーは、特定の要請に応じるのではなく、自発的にレビューを送信しました。
POINT_OF_SALE 注文時に、要請に応じてレビューを送信しました。
AFTER_FULFILLMENT 注文の処理後に、ユーザーは要請に応じてレビューを送信しました。

MerchantReviewStatus

販売者のレビューのステータス、データ検証の問題、つまり非同期で計算された販売者のレビューに関する情報。

フィールド
destination_statuses[]

MerchantReviewDestinationStatus

出力専用。販売者レビューの対象となる国。

item_level_issues[]

MerchantReviewItemLevelIssue

出力専用。販売者レビューに関連するすべての問題のリスト。

create_time

Timestamp

出力専用。アイテムが作成された日付(ISO 8601 形式)。

last_update_time

Timestamp

出力専用。アイテムが最後に更新された日付(ISO 8601 形式)。

MerchantReviewDestinationStatus

販売者の審査ステータスの宛先ステータス。

フィールド
reporting_context

ReportingContextEnum

出力専用。レポート コンテキストの名前。

MerchantReviewItemLevelIssue

販売者の審査ステータスの ItemLevelIssue。

フィールド
code

string

出力専用。問題のエラーコード。

severity

Severity

出力専用。この問題による販売者レビューの掲載への影響。

resolution

string

出力専用。販売者側で問題が解決可能かどうか。

attribute

string

出力専用。属性名(問題の原因が単一属性の場合)。

reporting_context

ReportingContextEnum

出力専用。問題が適用されるレポート コンテキスト。

description

string

出力専用。問題の簡単な説明(英語)。

detail

string

出力専用。問題の詳しい説明(英語)。

documentation

string

出力専用。この問題の解決に役立つウェブページの URL。

重大度

この問題が販売者のレビューの掲載にどのように影響するか。

列挙型
SEVERITY_UNSPECIFIED 指定されていません。
NOT_IMPACTED この問題は警告であり、販売者のレビューには直接影響しません。
DISAPPROVED 問題が販売者レビューを不承認にする。

ProductReview

商品のレビュー。詳細については、商品レビュー フィードの概要をご覧ください。

フィールド
name

string

ID。商品レビューの名前。形式: "{productreview.name=accounts/{account}/productReviews/{productReview}}"

product_review_id

string

必須。パブリッシャーのシステム内の商品レビューの永続的な固有 ID。

attributes

ProductReviewAttributes

省略可。商品レビューの属性のリスト。

custom_attributes[]

CustomAttribute

省略可。カスタム(販売者提供)属性のリスト。

data_source

string

出力専用。商品レビューのメイン データソース。

product_review_status

ProductReviewStatus

出力専用。商品レビューのステータス、データ検証の問題、つまり非同期で計算された商品レビューに関する情報。

ProductReviewAttributes

属性。

フィールド
review_time

Timestamp

必須。クチコミが投稿されたときのタイムスタンプです。

pros[]

string

省略可。レビュー担当者の意見に基づくメリットが含まれます。「pro:」などのボイラープレート テキストは、レビュアーが書いたもの以外は省略します。

cons[]

string

省略可。レビュー投稿者の意見に基づくデメリットが含まれます。「con:」などのボイラープレート テキストは、レビュアーが書いたもの以外は省略します。

product_names[]

string

省略可。商品のわかりやすい名前。

asins[]

string

省略可。商品に関連付けられている ASIN(Amazon Standard Identification Number)が含まれます。

gtins[]

string

省略可。商品に関連付けられた GTIN(国際取引商品番号)が含まれます。GTIN のサブタイプ(UPC、EAN、ISBN、JAN など)がサポートされています。

mpns[]

string

省略可。商品に関連付けられた MPN(製造者が定める製品番号)が含まれます。

skus[]

string

省略可。商品に関連付けられた SKU(在庫管理単位)が含まれます。多くの場合、これは商品フィードの商品アイテム ID と一致します。

brands[]

string

省略可。商品に関連付けられているブランド名が含まれます。

collection_method

CollectionMethod

省略可。レビューの収集方法。

transaction_id

string

省略可。パブリッシャーのシステムでレビューに関連付けられた取引の永続的な一意の識別子。この ID は、複数のクチコミが同じ取引に関連付けられていることを示すために使用できます。

aggregator_name

string

省略可。商品レビューのアグリゲータの名前。

ニュース メディアは、レビュー アグリゲータを使用してレビューを管理し、フィードを提供できます。この要素は、アグリゲータの使用を示しており、アグリゲータに関する情報が含まれています。

subclient_name

string

省略可。商品レビューのサブクライアントの名前。

サブクライアントは、商品レビューのソースの識別子です。ファイル データソースのパスで指定されたディレクトリと同じである必要があります。

publisher_name

string

省略可。商品レビューの公開元の名前。

パブリッシャーに関する情報(販売店、メーカー、レビュー サービス会社、商品レビューを公開する事業体など)。

publisher_favicon

string

省略可。パブリッシャーの会社のファビコンへのリンク。画像のサイズは、ファビコンのサイズ(16 x 16 ピクセル)にする必要があります。画像形式は GIF、JPG、PNG のいずれかである必要があります。

reviewer_id

string

省略可。商品レビューの投稿者。

パブリッシャーのシステムにおけるレビューの作成者を示す永続的な一意の識別子。

reviewer_is_anonymous

bool

省略可。クチコミ投稿者を匿名のままにする場合は true に設定します。

reviewer_username

string

省略可。商品レビューの投稿者の名前。

review_language

string

省略可。BCP-47 言語コードで定義されたレビューの言語。

review_country

string

省略可。ISO 3166-1 alpha-2 国コードで定義されたレビューの国。

title

string

省略可。レビューのタイトル。

content

string

必須。レビューの内容。

min_rating

int64

省略可。レビューに関連付けられている評価が含まれます。評価に使用できる最小値。これは、可能な限り低い評価である必要があります。評価なしの値ではありません。

max_rating

int64

省略可。評価の最大値。最大評価の値は、最小属性の値よりも大きくする必要があります。

rating

double

省略可。レビュー投稿者による商品の総合評価。

is_spam

bool

省略可。レビューがパブリッシャーのシステムでスパムとしてマークされているかどうかを示します。

CollectionMethod

レビューの収集方法。

列挙型
COLLECTION_METHOD_UNSPECIFIED 収集方法が指定されていません。
UNSOLICITED ユーザーは、特定の要請に応じるのではなく、自発的にレビューを送信しました。
POST_FULFILLMENT 注文の処理後に、ユーザーは要請に応じてレビューを送信しました。

タイプ

レビュー URI のタイプ。

列挙型
TYPE_UNSPECIFIED 未指定
SINGLETON レビュー ページには、この 1 件のレビューのみが表示されます。
GROUP レビューページには、このレビューを含むレビューのグループが表示されます。

ProductReviewStatus

商品レビューのステータス。

フィールド
destination_statuses[]

ProductReviewDestinationStatus

出力専用。商品レビューの宛先。

item_level_issues[]

ProductReviewItemLevelIssue

出力専用。商品レビューに関連するすべての問題のリスト。

create_time

Timestamp

出力専用。アイテムが作成された日付(ISO 8601 形式)。

last_update_time

Timestamp

出力専用。アイテムが最後に更新された日付(ISO 8601 形式)。

ProductReviewDestinationStatus

商品レビューのステータスの宛先ステータス。

フィールド
reporting_context

ReportingContextEnum

出力専用。レポート コンテキストの名前。

ProductReviewItemLevelIssue

商品レビューのステータスの ItemLevelIssue。

フィールド
code

string

出力専用。問題のエラーコード。

severity

Severity

出力専用。この問題による商品レビューの掲載への影響。

resolution

string

出力専用。販売者側で問題が解決可能かどうか。

attribute

string

出力専用。属性名(問題の原因が単一属性の場合)。

reporting_context

ReportingContextEnum

出力専用。問題が適用されるレポート コンテキスト。

description

string

出力専用。問題の簡単な説明(英語)。

detail

string

出力専用。問題の詳しい説明(英語)。

documentation

string

出力専用。この問題の解決に役立つウェブページの URL。

重大度

この問題が商品レビューの配信にどのように影響するか。

列挙型
SEVERITY_UNSPECIFIED 指定されていません。
NOT_IMPACTED この問題は警告であり、商品のレビューには直接影響しません。
DISAPPROVED 問題により商品レビューが不承認となる。