Programs API の概要

プログラムを使用すると、商品の宣伝を管理し、さまざまな Google サービスでアカウントの機能を強化できます。

典型的な例が、無料商品リスティング プログラムです。このプログラムでは、オンライン ショップの商品を Google の各種サービスに無料で掲載できます。

Programs API を使用すると、利用可能なすべてのショッピング プログラムへの参加状況を取得して更新できます。

プログラムの取得、有効化、無効化には、次の方法を使用します。

すべてのプログラムを一覧表示する

アカウントのすべてのプログラムを取得するには、accounts.programs.list メソッドを使用します。

リクエストの例を次に示します。

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}/programs

成功したリクエストからのレスポンスの例を次に示します。

{
  "programs": [
    {
      "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
      "documentationUri": "{URI}",
      "state": "{ACCOUNT_STATE}",
      "unmetRequirements": [
        {
          "title": "{TITLE}",
          "documentationUri": "{URI}",
          "affectedRegionCodes": [
            "{REGION_CODE}"
          ]
        }
      ]
    }
  ]
}

単一のプログラムを取得する

特定のプログラムを取得するには、accounts.programs.get メソッドを使用します。

リクエストの例を次に示します。

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}/programs/free-listings

成功したリクエストからのレスポンスの例を次に示します。

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}",
  "unmetRequirements": [
    {
      "title": "{TITLE}",
      "documentationUri": "{URI}",
      "affectedRegionCodes": [
        "{REGION_CODE}"
      ]
    }
  ]
}

プログラムを有効にする

アカウントで指定されたプログラムへの参加を有効にするには、accounts.programs.enable メソッドを使用します。この権限を実行するには、管理者権限が必要です。

リクエストの例を次に示します。

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}/programs/free-listings:enable

成功したリクエストからのレスポンスの例を次に示します。

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}",
  "unmetRequirements": [
    {
      "title": "{TITLE}",
      "documentationUri": "{URI}",
      "affectedRegionCodes": [
        "{REGION_CODE}"
      ]
    }
  ]
}

プログラムを無効にする

アカウントの指定したプログラムへの参加を無効にするには、accounts.programs.disable メソッドを使用します。この権限を実行するには、管理者権限が必要です。

リクエストの例を次に示します。

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}/programs/free-listings:disable

成功したリクエストからのレスポンスの例を次に示します。

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}"
}