Merchant API では、
リソースに関連するサービスのターゲットとして地理的地域を使用できます。accounts.products.regionalInventories地域は、郵便番号のコレクションとして定義することも、一部の国では事前定義された地域ターゲティングを使用して定義することもできます。詳細については、
地域を設定するをご覧ください。
地域を作成して更新するには、次の方法を使用します。
リージョンを取得する
Merchant Center アカウントで定義されている地域を取得するには、
accounts.regions.get
メソッドを使用します。
以下はリクエストのサンプルです。
GET https://merchantapi.googleapis.com/accounts/v1/accounts/125222396/regions/234567
以下は、 呼び出しによる回答の成功例です。
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/v1/accounts/125222396/regions?pageSize=100
以下は、 呼び出しによる回答の成功例です。
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/v1/accounts/102959835/regions?regionId=987654
{
"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/v1/accounts/102959835/regions?regionId=168888 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/v1/accounts/102959835/regions/168888?updateMask=displayName%2CgeotargetArea 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/v1/accounts/102959835/regions/987654?updateMask=displayName%2CpostalCodeArea 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/v1/accounts/102959835/regions/987654 HTTP/1.1
以下は、 呼び出しによる回答の成功例です。
HTTP/1.1 200
{}
バッチ オペレーション
複数の地域を管理している場合、Merchant API には、1 回の呼び出しで最大 100 個の地域を作成、更新、削除できるバッチ エンドポイントが用意されています。詳細については、リージョンのバッチ処理を管理するをご覧ください。