アカウント データの変更に関するプッシュ通知を受け取る

Merchant Notifications API を使用すると、アカウントデータの変更に関するプッシュ通知を受け取ることができます。たとえば、商品ステータスの変更通知に登録すると、商品が不承認となったときにリアルタイムで通知を受け取ることができます。サブアカウントや他のリンクされたアカウントの通知を登録できます。

このガイドでは、商品のステータス変更の通知を管理する方法の例を紹介します。これらの例を使用して、リクエストの registeredEvent フィールドの値を変更することで、他のイベントの通知を管理できます。イベントタイプの完全なリストについては、Merchant Notifications API リファレンスをご覧ください。

登録

通知を受け取るには、callBackUri が必要です。コールバック URI は、次の要件を満たしている必要があります。

• 認証局によって署名された有効な SSL 証明書を持つ、一般公開された HTTPS アドレスである必要があります。
• Content-Type ヘッダーと application/json 値を含む HTTP POST リクエストを受け入れる必要があります。
• 通知が受信されたことを確認するには、次のいずれかのレスポンス コードを返す必要があります。
  • 102
  • 200
  • 201
  • 202
  • 204

複数の定期購入に同じコールバック URI を使用できます。単一の URI への push リクエストの負荷を最小限に抑えるため、上級者向けアカウントごとに、またはイベントタイプごとに一意のコールバック URI を使用することをおすすめします。

特定の販売者のアカウントの商品ステータスの変更に関する通知を定期購入するリクエストの例を次に示します。通知を受け取るアカウントの販売者 ID をリクエスト URL の merchantId として使用し、通知を受け取るアカウントの販売者 ID をリクエスト本文の targetMerchantId として使用します。アカウントがリンクされたアカウントのないスタンドアロン アカウントで、自分のアカウントの通知を受け取る場合は、両方の場所で自分の販売者 ID を使用します。

POST https://merchantapi.googleapis.com/notifications/v1beta/accounts/merchantId/notificationsubscriptions/

{
  "registeredEvent": "PRODUCT_STATUS_CHANGE",
  "targetAccount": "accounts/targetMerchantId",
  "callBackUri": "https://example.com"
}

呼び出しが成功すると、サブスクリプション ID を含むサブスクリプションの name が返されます。

{
  "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",
  "managingAccount": "accounts/merchantId",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "eligible",
    "newValue": "disapproved",
    "regionCode": "US",
    "reportingContext": "SHOPPING_ADS"
  }, {
    "oldValue": "eligible",
    "newValue": "disapproved",
    "regionCode": "JP",
    "reportingContext": "SHOPPING_ADS"
  },{
    "oldValue": "eligible",
    "newValue": "disapproved",
    "regionCode": "GE",
    "reportingContext": "SHOPPING_ADS"
  }],
  "resourceId": "ONLINE~en~US~1234",
  "resource": "accounts/targetMerchantId/products/ONLINE~en~US~1234",
  "expirationTime": "2024-10-22T02:43:47.461464Z"
}

通知に oldValue フィールドがない場合は、新しい商品がアカウントに追加されています。newValue フィールドがない場合は、商品がアカウントから削除されています。

reportingContext フィールドは、列挙型値 ReportingContextEnum の（SHOPPING_ADS、LOCAL_INVENTORY_ADS、YOUTUBE_SHOPPING、YOUTUBE_CHECKOUT）のみをサポートします。

実装をテストする

コールバック URI とデコードのテストに使用できる通知の例を次に示します。

curl --header "Content-Type: application/json" --header "Accept: text/plain" --request POST --data '{"message":{"data":
"ewogICJhY2NvdW50IjogImFjY291bnRzLzEyMzQiLAogICJtYW5hZ2luZ0FjY291bnQiOiAiYWNjb3VudHMvNTY3OCIsCiAgInJlc291cmNlVHlwZSI6ICJQUk9EVUNUIiwKICAiYXR0cmlidXRlIjogIlNUQVRVUyIsCiAgImNoYW5nZXMiOiBbewogICAgIm9sZFZhbHVlIjogImVsaWdpYmxlIiwKICAgICJyZWdpb25Db2RlIjogIlVTIiwKICAgICJyZXBvcnRpbmdDb250ZXh0IjogIlNIT1BQSU5HX0FEUyIKICB9XSwKICAicmVzb3VyY2VJZCI6ICJPTkxJTkV+ZW5+VVN+MDAwMDAwMDAwMDAwIiwKICAicmVzb3VyY2UiOiAiYWNjb3VudHMvMTIzNC9wcm9kdWN0cy9PTkxJTkV+ZW5+VVN+MDAwMDAwMDAwMDAwIiwKICAiZXhwaXJhdGlvblRpbWUiOiAiMjAyNC0xMC0yMlQwMjo0Mzo0Ny40NjE0NjRaIgp9"}}' https://{callBackUri}

この呼び出しに応答して、コールバック URI は成功レスポンス コードを返す必要があります。デコードされたメッセージの値は次のようになります。

{
  "account": "accounts/1234",
  "managingAccount": "accounts/5678",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "eligible",
    "regionCode": "US",
    "reportingContext": "SHOPPING_ADS"
  }],
  "resourceId": "ONLINE~en~US~000000000000",
  "resource": "accounts/1234/products/ONLINE~en~US~000000000000",
  "expirationTime": "2024-10-22T02:43:47.461464Z"
}