接收帳戶資料變更的推播通知

你可以使用 Merchant 通知 API 接收變更的推播通知 才能根據帳戶資料例如,如果你訂閱了產品狀態變更 如果產品遭到拒登,系統會即時通知您。 你可以訂閱以下任一則通知: 子帳戶或其他連結的帳戶 帳戶

本指南提供範例,說明如何管理產品狀態通知 並輸入變更內容您可以用這些範例管理其他事件的通知: 變更要求中「registeredEvent」欄位的值。完整 事件類型清單,請參閱 Merchant Notifications API 參考資料

訂閱

若要接收通知,您需要 callBackUri。回呼 URI 必須 須符合下列條件:

  • 必須是可公開存取的 HTTPS 位址,並具備有效的 SSL 憑證, 簽署憑證。
  • 必須接受含有 Content-Type 標頭和 Content-Type 的 HTTP POST 要求, application/json 值。
  • 必須傳回下列其中一個回應代碼,以確認 收到通知。
    • 102
    • 200
    • 201
    • 202
    • 204

您可以針對多個訂閱項目使用相同的回呼 URI。為求明確,建議採用 不重複的回呼 URI 每 帳戶,按事件類型劃分 盡可能減少對單一 URI 的推送要求負載。

以下是訂閱產品狀態變更通知的範例 特定商家帳戶的資訊請使用要匯入哪個帳戶的商家 ID 以 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"
}

成功的呼叫會傳回 適用於你的 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"
}

如要更新現有訂閱項目,請使用 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}"}}

通知資料經過編碼。您可以將資料解碼為可讀取的文字 要使用的格式這是您適用的彈簧啟動控制器 可能用於處理編碼的資料:

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

測試實作成果

下方通知範例可用來測試回呼 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"