คุณสามารถใช้ Merchant Notifications API เพื่อรับข้อความ Push สำหรับการเปลี่ยนแปลงข้อมูลบัญชี เช่น หากสมัครรับการแจ้งเตือนการเปลี่ยนสถานะผลิตภัณฑ์ คุณก็จะได้รับการแจ้งเตือนแบบเรียลไทม์เมื่อผลิตภัณฑ์ไม่ได้รับอนุมัติ คุณสมัครรับการแจ้งเตือนสำหรับบัญชีย่อยหรือบัญชีที่ลิงก์อื่นๆ ได้
คู่มือนี้จะแสดงตัวอย่างวิธีจัดการการแจ้งเตือนการเปลี่ยนแปลงสถานะผลิตภัณฑ์ คุณใช้ตัวอย่างเหล่านี้เพื่อจัดการการแจ้งเตือนสำหรับกิจกรรมอื่นๆ ได้โดยเปลี่ยนค่าของช่อง registeredEvent
ในคำขอ ดูรายการประเภทเหตุการณ์ทั้งหมดได้ที่ข้อมูลอ้างอิงเกี่ยวกับ Merchant Notifications API
ติดตาม
คุณต้องมี callBackUri
จึงจะรับการแจ้งเตือนได้ URI โค้ดเรียกกลับต้องเป็นไปตามข้อกำหนดต่อไปนี้
- ต้องเป็นที่อยู่ HTTPS ที่เข้าถึงได้แบบสาธารณะและมีใบรับรอง SSL ที่ถูกต้องซึ่งลงนามโดยผู้ออกใบรับรอง
- ต้องยอมรับคำขอ HTTP
POST
ที่มีContent-Type
ส่วนหัวและapplication/json
ค่า - ต้องแสดงโค้ดตอบกลับรายการใดรายการหนึ่งต่อไปนี้เพื่อระบุว่าได้รับการแจ้งเตือนแล้ว
102
200
201
202
204
คุณใช้ URI โค้ดเรียกกลับเดียวกันสำหรับการสมัครใช้บริการหลายรายการได้ เราขอแนะนำให้ใช้ URI การเรียกกลับที่ไม่ซ้ำกันต่อบัญชีขั้นสูงต่อประเภทเหตุการณ์เพื่อลดภาระงานของคำขอพุชไปยัง URI เดียว
ต่อไปนี้คือตัวอย่างคำขอสมัครรับการแจ้งเตือนการเปลี่ยนแปลงสถานะผลิตภัณฑ์สำหรับบัญชีผู้ขายหนึ่งๆ ใช้รหัสผู้ขายของบัญชีที่ควรรับการแจ้งเตือนเป็น merchantId
ใน URL ของคำขอ และรหัสผู้ขายของบัญชีเพื่อรับการแจ้งเตือนในฐานะ targetMerchantId
ในเนื้อหาคำขอ หากบัญชีของคุณเป็นบัญชีแบบสแตนด์อโลนที่ไม่มีบัญชีที่ลิงก์ และคุณต้องการรับการแจ้งเตือนสำหรับบัญชีของตัวเอง ให้ใช้รหัสผู้ขายของคุณเองในทั้ง 2 ที่
POST https://merchantapi.googleapis.com/notifications/v1beta/accounts/merchantId/notificationsubscriptions/
{
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/targetMerchantId",
"callBackUri": "https://example.com"
}
การโทรที่สำเร็จจะส่งคืน name
สำหรับการสมัครใช้บริการของคุณ ซึ่งรวมถึงรหัสการสมัครใช้บริการ:
{
"name":"accounts/merchantId/notificationsubscriptions/subscriptionId",
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/targetMerchantId",
"callBackUri": "https://example.com"
}
คุณสามารถใช้ name
นี้ในการสมัครใช้บริการ GET
และ DELETE
แต่ละรายการได้
คุณสมัครรับการแจ้งเตือนการเปลี่ยนแปลงสถานะผลิตภัณฑ์ของบัญชีที่ลิงก์ทั้งหมดได้โดยรวม "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"