针对商品数据更改接收推送通知

您可以使用 Merchant Notifications API 获取有关商品数据更改的推送通知。例如,如果您订阅了商品状态更改通知,则可以在商品被拒批时实时收到通知。您可以订阅任何子账号或其他关联账号的通知。

本指南提供了有关如何管理产品状态变更通知的示例。您可以通过更改请求中 registeredEvent 字段的值,使用这些示例来管理其他事件的通知。如需查看事件类型的完整列表,请参阅 Merchant Notifications API 参考文档

订阅

如需接收通知,您需要拥有 callBackUri。您的回调 URI 必须满足以下要求:

  • 必须是可公开访问的 HTTPS 地址,且具有由证书授权机构签名的有效 SSL 证书。
  • 必须接受带有 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。

成功调用会返回订阅的 name,包括订阅 ID:

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

您可以使用此 nameGETDELETE 各个订阅。

您可以在请求中添加 "allManagedAccounts": true 而不是 targetAccount,以便订阅所有关联账号的产品状态变更通知:

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

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

如需更新现有订阅,请使用 PATCHupdate_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_ADSLOCAL_INVENTORY_ADSYOUTUBE_SHOPPINGYOUTUBE_CHECKOUTYOUTUBE_AFFILIATE)。

对于商品状态更改事件,oldValuenewValue 字段将具有以下值之一:(approvedpendingdisapproved、``)。

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