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

PRODUCT_STATUS_CHANGE 通知を購読すると、Merchant Center アカウントで商品の承認ステータスが変更されるたびにリアルタイムでアラートを受け取ることができます。たとえば、商品アイテムが不承認になったときに検出して、データ品質の問題を修正できます。

始める前に、通知サブ API の概要で説明されている要件に従ってコールバック URI が構成されていることを確認してください。

商品ステータスの変更をサブスクライブする

商品のステータスの変更を購読するには、registeredEvent を PRODUCT_STATUS_CHANGE に設定して、notificationsubscriptions リソースに POST リクエストを送信します。

特定のターゲット アカウントを登録する

次のサンプル リクエストは、特定の販売アカウントの商品ステータスの変更をサブスクライブします。

POST https://merchantapi.googleapis.com/notifications/v1/accounts/{ACCOUNT_ID}/notificationsubscriptions/
{
  "registeredEvent": "PRODUCT_STATUS_CHANGE",
  "targetAccount": "accounts/{TARGETACCOUNT_ID}",
  "callBackUri": "https://example.com/callback"
}

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

  • ACCOUNT_ID: サブスクリプションを所有し、通知を受信するアカウントの識別子。
  • TARGETACCOUNT_ID: 通知を受け取るアカウントの識別子。

Merchant Center アカウントがリンクされたアカウントのない独立アカウントの場合は、両方の変数に独自のアカウント ID を使用します。

すべての子アカウントで登録する

複数のアカウント(サブアカウントを含むアドバンス アカウントなど)を管理している場合は、allManagedAccounts: true を設定することで、管理対象のすべてのアカウントで商品ステータスの変更を購読できます。

POST https://merchantapi.googleapis.com/notifications/v1/accounts/{ACCOUNT_ID}/notificationsubscriptions/
{
  "registeredEvent": "PRODUCT_STATUS_CHANGE",
  "allManagedAccounts": true,
  "callBackUri": "https://example.com/callback"
}

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

{
  "name":"accounts/{ACCOUNT_ID}/notificationsubscriptions/{SUBSCRIPTION_ID}",
  "registeredEvent": "PRODUCT_STATUS_CHANGE",
  "allManagedAccounts": true,
  "callBackUri": "https://example.com/callback"
}

商品ステータスの変更ペイロードをデコードする

商品のステータスが変更されると、コールバック URI は base64 でエンコードされたメッセージを受信します。デコードされたペイロードは ProductStatusChangeMessage 形式に準拠しています。

{
  "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: 更新前と更新後のステータスを表します。有効な値は approved、pending、disapproved、または空の文字列('')です。
    • oldValue が省略された場合、商品は新規に作成されます。
    • newValue が省略されている場合、商品は削除されています。
  • expirationTime: 商品の特典の有効期限を示します。商品が削除されると、このフィールドは省略されます。
  • reportingContext: ステータスが変更された広告または無料リスティングのサーフェス。サポートされている値には、ReportingContextEnum の SHOPPING_ADS、LOCAL_INVENTORY_ADS、YOUTUBE_SHOPPING、YOUTUBE_CHECKOUT、YOUTUBE_AFFILIATE、FREE_LISTINGS_UCP_CHECKOUT があります。
  • eventTime: イベントが生成された時点のタイムスタンプ。このタイムスタンプを使用して、イベントの順序が正しくなるようにします。

テスト商品のステータス変更通知

次のサンプル リクエストを使用して、コールバック エンドポイントが商品ステータス変更メッセージを正しく受信、確認、デコードするかどうかをテストします。

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

この呼び出しに応答して、コールバック URI は許容可能な HTTP ステータス コード(200 OK など)を返す必要があります。デコードされたメッセージには次の内容が含まれます。

{
  "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"
}