商品データの変更に関するプッシュ通知を受け取る

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

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

登録

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

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

同じコールバック URI を複数の登録に使用できます。単一の URI へのプッシュ リクエストの負荷を最小限に抑えるため、高度な アカウントごと、イベントタイプごとに一意のコールバック URI を使用することをおすすめします。

特定の販売アカウントの商品ステータスの変更に関する通知に登録するリクエストの例を次に示します。

POST https://merchantapi.googleapis.com/notifications/v1/accounts/ACCOUNT_ID/notificationsubscriptions/

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

次のように置き換えます。

  • ACCOUNT_ID: 通知を受け取るアカウントの一意の識別子。
  • TARGETACCOUNT_ID: 通知を受け取るアカウントの一意の識別子 。

Merchant Center アカウントがリンク済みアカウントのないスタンドアロン アカウントで、自分のアカウントの通知を受け取る場合は、これらの変数を両方ともアカウント ID に置き換えます。

呼び出しが成功すると、登録 ID を含む登録の nameが返されます。

{
  "name":"accounts/ACCOUNT_ID/notificationsubscriptions/subscriptionId",
  "registeredEvent": "PRODUCT_STATUS_CHANGE",
  "targetAccount": "accounts/TARGETACCOUNT_ID",
  "callBackUri": "https://example.com"
}

この name を使用して、個々の登録を GET および DELETE できます。

リクエストに targetAccountの代わりに"allManagedAccounts": trueを含めることで、 リンク済みアカウントすべての商品ステータスの変更に関する通知に登録できます。

POST https://merchantapi.googleapis.com/notifications/v1/accounts/ACCOUNT_ID/notificationsubscriptions/

{
  "registeredEvent": "PRODUCT_STATUS_CHANGE",
  "allManagedAccounts": true,
  "callBackUri": "https://example.com"
}

既存の登録を更新するには、PATCH と update_mask を使用して、更新するフィールドと JSON 本文の新しい値を指定します。

PATCH https://merchantapi.googleapis.com/notifications/v1/accounts/ACCOUNT_ID/notificationsubscriptions/SUBSCRIPTION_ID?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/TARGETACCOUNT_ID",
  "managingAccount": "accounts/ACCOUNT_ID",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "approved",
    "newValue": "disapproved",
    "regionCode": "US",
    "reportingContext": "SHOPPING_ADS"
  }, {
    "oldValue": "approved",
    "newValue": "disapproved",
    "regionCode": "JP",
    "reportingContext": "SHOPPING_ADS"
  },{
    "oldValue": "approved",
    "newValue": "disapproved",
    "regionCode": "GE",
    "reportingContext": "SHOPPING_ADS"
  }],
  "resourceId": "ONLINE~en~US~1234",
  "resource": "accounts/TARGETACCOUNT_ID/products/ONLINE~en~US~1234",
  "expirationTime": "2024-10-22T02:43:47.461464Z",
  "eventTime": "2024-03-21T02:43:47.461464Z"
}

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

商品が削除された場合、expirationTime フィールドは存在しません。

reportingContext フィールドは、列挙値 ReportingContextEnum の (SHOPPING_ADS, LOCAL_INVENTORY_ADS, YOUTUBE_SHOPPING, YOUTUBE_CHECKOUT, YOUTUBE_AFFILIATE, FREE_LISTINGS_UCP_CHECKOUT) のみをサポートしています。

商品ステータスの変更イベントの場合、oldValue および newValue フィールドには、(approved, pending, disapproved, ``) のいずれかの値が設定されます。

eventTime フィールドにはイベント自体の作成時刻が格納されます。メッセージの順序付けを行う場合は、このフィールドの値を使用し、メッセージの受信順序に依存しないでください。

詳しくは、ProductStatusChangeMessage の形式を ご覧ください。

実装をテストする

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

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

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

{
  "account": "accounts/1234",
  "managingAccount": "accounts/5678",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "approved",
    "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",
  "eventTime": "2024-03-21T02:43:47.461464Z"
}
前へ
Control access to your account
次へ
Enable automatic improvements