Merchant Notifications API を使用して、アカウント データの変更に関するプッシュ通知を受け取ることができます。たとえば、商品ステータスの変更通知に登録すると、商品が不承認になったときにリアルタイムで通知を受け取ることができます。任意のサブアカウントまたは他のリンクされたアカウントに関する通知を登録できます。
このガイドでは、商品ステータス変更の通知を管理する方法の例を示します。以下の例を使用して他のイベントの通知を管理するには、リクエストの registeredEvent フィールドの値を変更します。イベントタイプの一覧については、Merchant Notifications API リファレンスをご覧ください。
チャンネル登録
通知を受け取るには、callBackUri が必要です。コールバック URI は、次の要件を満たしている必要があります。
- 認証局によって署名された有効な SSL 証明書を使用して一般公開されている HTTPS アドレスである必要があります。
Content-Typeヘッダーとapplication/json値を使用して HTTPPOSTリクエストを受け入れる必要があります。- 通知が受信されたことを確認するには、次のいずれかのレスポンス コードを返す必要があります。
102200201202204
複数のサブスクリプションに同じコールバック URI を使用できます。単一の URI に対する push リクエストの負荷を最小限に抑えるため、イベントタイプごとに、アドバンス アカウントごとに一意のコールバック URI を使用することをおすすめします。
次に、特定の販売アカウントの商品ステータス変更の通知に登録するリクエストの例を示します。リクエスト URL の merchantId として通知を受け取るアカウントの販売者 ID と、リクエスト本文の targetMerchantId として通知を受け取るアカウントの販売者 ID を使用します。アカウントがリンクされたアカウントのない独立したアカウントであり、自身のアカウントの通知を受け取る場合は、両方の場所でご自身の販売者 ID を使用します。
POST https://merchantapi.googleapis.com/notifications/v1beta/accounts/merchantId/notificationsubscriptions/
{
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/targetMerchantId",
"callBackUri": "https://example.com"
}
呼び出しが成功すると、サブスクリプションの name がサブスクリプション ID とともに返されます。
{
"name":"accounts/merchantId/notificationsubscriptions/subscriptionId",
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/targetMerchantId",
"callBackUri": "https://example.com"
}
この name を使用して、個人の定期購入をGETやDELETEできます。
すべてのリンクされたアカウントで商品ステータスの変更の通知を受け取るには、リクエストに targetAccount ではなく "allManagedAccounts": true を含めます。
POST https://merchantapi.googleapis.com/notifications/v1beta/accounts/merchantId/notificationsubscriptions/
{
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"allManagedAccounts": true,
"callBackUri": "https://example.com"
}
既存のサブスクリプションを更新するには、PATCH と update_mask を使用して、更新するフィールドを指定し、JSON 本文で新しい値を指定します。
PATCH /notifications/v1beta/accounts/merchantId/notificationsubscriptions/subscriptionId?update_mask=callBackUri
{
"callBackUri": "https://my-own-personal-domain.com"
}
通知をデコードする
サブスクリプションを作成すると、指定した callBackUri に次の形式で通知が送信されます。
{"message":{"data":"{base64_encoded_string}"}}
通知データはエンコードされます。実装で使用するために、データを読み取り可能なテキスト形式にデコードできます。エンコードされたデータの処理に使用できる Spring Boot コントローラの例を次に示します。
@RestController
public class ExampleController {
@RequestMapping(value = "/push",
method = RequestMethod.POST,
consumes = {"application/json"},
produces = {"text/plain"})
@ResponseStatus(HttpStatus.OK)
public void doStuff(@RequestBody String message) {
//wrapped message
JSONObject jsonObject = new JSONObject(message);
JSONObject jsonMessage = jsonObject.getJSONObject("message");
message = jsonMessage.getString("data");
byte[] decodedBytes = Base64.getDecoder().decode(message);
String decodedMessage = new String(decodedBytes);
// Implement your business logic here
}
}
デコードされた base64_encoded_string の例を次に示します。
"account": "accounts/targetMerchantId"
"managing_account": "accounts/merchantId"
"resource_type": PRODUCT
"attribute": STATUS
"changes": {
"old_value": "eligible"
"new_value": "disapproved"
"region_code": "GE"
"reporting_context": SHOPPING_ADS
},
"changes" {
"old_value": "eligible"
"new_value": "disapproved"
"region_code": "JP"
"reporting_context": SHOPPING_ADS
},
changes {
"old_value": "eligible"
"new_value": "disapproved"
"region_code": "US"
"reporting_context": SHOPPING_ADS
}
resource_id: "ONLINE~en~US~1234"
resource: "accounts/targetMerchantId/products/ONLINE~en~US~1234"
実装をテストする
次のサンプル通知を使用して、コールバック URI とデコードをテストできます。
curl --header "Content-Type: application/json" --header "Accept: text/plain" --request POST --data '{"message":{"data":
"ImFjY291bnQiOiAiYWNjb3VudHMvMTIzNCIKIm1hbmFnaW5nX2FjY291bnQiOiAiYWNjb3VudHMvNTY3OCIKInJlc291cmNlX3R5cGUiOiBQUk9EVUNUCiJhdHRyaWJ1dGUiOiBTVEFUVVMKImNoYW5nZXMiOiB7CiAgIm9sZF92YWx1ZSI6ICJlbGlnaWJsZSIKICAicmVnaW9uX2NvZGUiOiAiVVMiCiAgInJlcG9ydGluZ19jb250ZXh0IjogU0hPUFBJTkdfQURTCn0KInJlc291cmNlX2lkIjogIk9OTElORX5lbn5VU34wMDAwMDAwMDAwMDAiCiJyZXNvdXJjZSI6ICJhY2NvdW50cy8xMjM0L3Byb2R1Y3RzL09OTElORX5lbn5VU34wMDAwMDAwMDAwMDAi"}}' https://{callBackUri}
この呼び出しに対して、コールバック URI は成功レスポンス コードを返します。デコードされたメッセージの値は次のとおりです。
"account": "accounts/1234"
"managing_account": "accounts/5678"
"resource_type": PRODUCT
"attribute": STATUS
"changes": {
"old_value": "eligible"
"region_code": "US"
"reporting_context": SHOPPING_ADS
}
"resource_id": "ONLINE~en~US~000000000000"
"resource": "accounts/1234/products/ONLINE~en~US~000000000000"