你可以使用 Merchant Notifications API,接收產品資料變更的推播通知。舉例來說,如果訂閱產品狀態變更通知,當產品遭到拒登時,您就能收到即時通知。你可以為任何子帳戶或其他連結帳戶訂閱通知。
本指南提供範例,說明如何管理產品狀態變更的通知。您可以變更要求中的 registeredEvent
欄位值,使用這些範例管理其他事件的通知。如需事件類型的完整清單,請參閱商家通知 API 參考資料。
訂閱
如要接收通知,你必須擁有callBackUri
。回呼 URI 必須符合下列規定:
- 必須是可公開存取的 HTTPS 位址,且具有憑證授權單位簽署的有效 SSL 憑證。
- 必須接受含有
Content-Type
標頭和application/json
值的 HTTPPOST
要求。 - 必須傳回下列其中一個回應代碼,確認收到通知。
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:應接收通知的帳戶專屬 ID。
- TARGETACCOUNT_ID:您要接收通知的帳戶專屬 ID。
如果你的 Merchant Center 帳戶是獨立帳戶,沒有連結任何帳戶,且想接收自己帳戶的通知,請將這兩個變數都換成你的帳戶 ID。
如果呼叫成功,系統會傳回訂閱項目的 name
,包括訂閱 ID:
{
"name":"accounts/ACCOUNT_ID/notificationsubscriptions/subscriptionId",
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/TARGETACCOUNT_ID",
"callBackUri": "https://example.com"
}
你可以使用這個 name
來GET
和DELETE
個別訂閱項目。
如要訂閱所有已連結帳戶的產品狀態變更通知,請在要求中加入 "allManagedAccounts": true
,而非 targetAccount
:
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
)。
如果是產品狀態變更事件,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"
}