接收关于账号数据更改的推送通知

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

本指南举例说明了如何管理商品状态通知 更改。您可以使用这些示例管理其他事件的通知,具体方法是: 更改请求中 registeredEvent 字段的值。有关 事件类型列表,请参阅 Merchant Notifications API 参考

订阅

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

  • 必须是带有有效 SSL 证书且可公开访问的 HTTPS 地址; 由证书授权机构签名
  • 必须接受包含 Content-Type 标头和POST application/json 值。
  • 必须返回以下响应代码之一,以确认 已收到一条通知。
    • 102
    • 200
    • 201
    • 202
    • 204

您可以为多个订阅使用相同的回调 URI。我们建议使用 每个高级高级回调 URI 账号 最大程度减少对单个 URI 的推送请求的负载。

以下是订阅商品状态变化通知的示例请求 。使用应该 在请求网址中以 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"
}

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

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

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

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

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

通知数据已经过编码。您可以将数据解码为可读文本 以便在实现过程中使用这是一个弹簧启动控制器示例 可能用来处理编码数据:

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

如果通知中没有“old_value”字段,则说明出现了新产品 已添加到您的账号。如果没有 new_value 字段,则表示商品已被删除 。

reporting_context 字段仅支持枚举值 ReportingContextEnum 中的 (SHOPPING_ADSLOCAL_INVENTORY_ADSYOUTUBE_SHOPPING)。

测试实现效果

您可以使用以下示例通知来测试回调 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"