リージョンの作成と更新

このガイドでは、accounts.products.regionalInventories リソースに関連するターゲット サービスとして使用できる地理的なリージョンについて説明します。地域は、郵便番号のコレクションとして定義できます。一部の国では、事前定義されたジオターゲットを使用して定義することもできます。詳細については、リージョンを設定するをご覧ください。

リージョンを作成および更新するには、次の方法を使用します。

• Get
• List
• Create
• Patch
• Delete

リージョンを取得する

Merchant Center アカウントで定義された地域を取得するには、accounts.regions.get メソッドを使用します。

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

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/125222396/regions/234567?key=[YOUR_API_KEY]

呼び出しが成功した場合のレスポンスの例を次に示します。

HTTP/1.1 200

{
  "name": "accounts/125222396/regions/234567",
  "displayName": "Canada",
  "postalCodeArea": {
    "regionCode": "CA",
    "postalCodes": [
      {
        "begin": "L6A"
      }
    ]
  }

すべてのリージョンを一覧表示する

Merchant Center アカウントの地域を一覧表示するには、accounts.regions.list メソッドを使用します。

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

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/125222396/regions?pageSize=100&key=[YOUR_API_KEY]

呼び出しが成功した場合のレスポンスの例を次に示します。

HTTP/1.1 200

{
  "regions": [
    {
      "name": "accounts/125222396/regions/234567",
      "displayName": "Canada",
      "postalCodeArea": {
        "regionCode": "CA",
        "postalCodes": [
          {
            "begin": "L6A"
          }
        ]
      },
      "regionalInventoryEligible": true,
      "shippingEligible": true
    },
    {
      "name": "accounts/125222396/regions/Inline region",
      "displayName": "Inline region",
      "postalCodeArea": {
        "regionCode": "CA",
        "postalCodes": [
          {
            "begin": "M7B"
          }
        ]
      },
      "regionalInventoryEligible": false,
      "shippingEligible": true
    },
  ]
}

リージョンを挿入する

Merchant Center アカウントに地域の定義を挿入するには、accounts.regions.create メソッドを使用します。このメソッドを実行するには、管理者権限が必要です。

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

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions?regionId=987654&key=[YOUR_API_KEY]

{
  "displayName": "TestRegion",
  "name": "987654",
  "postalCodeArea": {
    "postalCodes": [
      {
        "begin": "98109"
      }
    ],
    "regionCode": "US"
  }
}

呼び出しが成功した場合のレスポンスの例を次に示します。

{
     "name": "accounts/102959835/regions/987654",
  "displayName": "TestRegion",
  "postalCodeArea": {
    "regionCode": "US",
    "postalCodes": [
      {
        "begin": "98109"
      }
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": true
}

AreaCode を使用して新しいリージョンを作成するには:

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

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions?regionId=168888&key=[YOUR_API_KEY] HTTP/1.1

{
  "displayName": "WA_test",
  "name": "168888",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      20101
    ]
  }
}

呼び出しが成功した場合のレスポンスの例を次に示します。

{
  "name": "accounts/102959835/regions/168888",
  "displayName": "WA_test",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      "20101"
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": false
}

作成したリージョンの displayName と GeoTargetCriteriaIds を更新するには:

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

PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions/168888?updateMask=displayName%2CgeotargetArea&key=[YOUR_API_KEY] HTTP/1.1

{
  "displayName": "BR_test",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      20100
    ]
  }
}

呼び出しが成功した場合のレスポンスの例を次に示します。

HTTP/1.1 200

{
  "name": "accounts/102959835/regions/168888",
  "displayName": "BR_test",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      "20100"
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": false
}

リージョンを更新する

Merchant Center アカウントで地域の定義を更新するには、accounts.regions.patch メソッドを使用します。このメソッドを実行するには、管理者権限が必要です。

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

PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions/987654?updateMask=displayName%2CpostalCodeArea&key=[YOUR_API_KEY] HTTP/1.1

Authorization: Bearer [YOUR_ACCESS_TOKEN]
Accept: application/json
Content-Type: application/json

{
  "displayName": "Test",
  "postalCodeArea": {
    "postalCodes": [
      {
        "begin": "98108"
      }
    ],
    "regionCode": "US"
  }
}

呼び出しが成功した場合のレスポンスの例を次に示します。

{
  "name": "accounts/102959835/regions/987654",
  "displayName": "Test",
  "postalCodeArea": {
    "regionCode": "US",
    "postalCodes": [
      {
        "begin": "98108"
      }
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": true
}

地域を削除する

Merchant Center アカウントから地域定義を削除するには、accounts.regions.delete メソッドを使用します。このメソッドを実行するには、管理者権限が必要です。

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

DELETE https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions/987654?key=[YOUR_API_KEY] HTTP/1.1

呼び出しが成功した場合のレスポンスの例を次に示します。

HTTP/1.1 200
{}