Method: accounts.promotions.list

Merchant Center アカウントのプロモーションが一覧表示されます。レスポンスに含まれるアイテムが pageSize で指定された数よりも少ない場合があります。pageToken を使用して、他にもリクエストする項目があるかどうかを判断します。

プロモーションを挿入または更新した後、更新された処理済みのプロモーションを取得できるようになるまでに数分かかることがあります。

HTTP リクエスト

GET https://merchantapi.googleapis.com/promotions/v1beta/{parent=accounts/*}/promotions

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。処理済みのプロモーションを一覧表示するアカウント。形式: accounts/{account}

クエリ パラメータ

パラメータ
pageSize

integer

出力専用。返されるプロモーションの最大数。サービスが返す値はこれよりも少ないことがあります。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。指定されていない場合は、プロモーションの最大数が返されます。

pageToken

string

出力専用。前回の promotions.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

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

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

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

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "nextPageToken": string
}
フィールド
promotions[]

object (Promotion)

指定したアカウントで処理されたプロモーション。

nextPageToken

string

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

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。