คุณใช้ Merchant Notifications API เพื่อรับการแจ้งเตือนแบบพุชสำหรับการเปลี่ยนแปลง ข้อมูลผลิตภัณฑ์ได้ ตัวอย่างเช่น หากคุณสมัครรับการแจ้งเตือนการเปลี่ยนแปลงสถานะผลิตภัณฑ์ คุณจะได้รับการแจ้งเตือนแบบเรียลไทม์เมื่อผลิตภัณฑ์ไม่ได้รับอนุมัติ คุณสามารถสมัครรับการแจ้งเตือนสำหรับบัญชีย่อยหรือบัญชีที่ลิงก์อื่นๆ ได้
คู่มือนี้แสดงตัวอย่างวิธีจัดการการแจ้งเตือนเกี่ยวกับการเปลี่ยนแปลงสถานะผลิตภัณฑ์
คุณสามารถใช้ตัวอย่างเหล่านี้เพื่อจัดการการแจ้งเตือนสำหรับเหตุการณ์อื่นๆ ได้โดย
เปลี่ยนค่าของฟิลด์ registeredEvent
ในคำขอ ดูรายการประเภทเหตุการณ์ทั้งหมดได้ในเอกสารอ้างอิง API การแจ้งเตือนผู้ขาย
สมัครใช้บริการ
คุณต้องมี callBackUri
จึงจะรับการแจ้งเตือนได้ URI การเรียกกลับต้องเป็นไปตามข้อกำหนดต่อไปนี้
- ต้องเป็นที่อยู่ HTTPS ที่เข้าถึงได้แบบสาธารณะซึ่งมีใบรับรอง SSL ที่ถูกต้อง ซึ่งลงนามโดยผู้ออกใบรับรอง
- ต้องยอมรับคำขอ HTTP
POST
ที่มีส่วนหัวContent-Type
และค่าapplication/json
- ต้องแสดงรหัสการตอบกลับอย่างใดอย่างหนึ่งต่อไปนี้เพื่อรับทราบว่าได้รับ
การแจ้งเตือนแล้ว
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 เป็นบัญชีแบบสแตนด์อโลนที่ไม่มีบัญชีที่ลิงก์ และคุณต้องการรับการแจ้งเตือนสำหรับบัญชีของคุณเอง ให้แทนที่ตัวแปรทั้ง 2 รายการนี้ ด้วยรหัสบัญชีของคุณ
การเรียกที่สำเร็จจะแสดงผล name
สำหรับ
การสมัครใช้บริการ รวมถึงรหัสการสมัครใช้บริการ
{
"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
รองรับเฉพาะ (SHOPPING_ADS
, LOCAL_INVENTORY_ADS
, YOUTUBE_SHOPPING
, YOUTUBE_CHECKOUT
, YOUTUBE_AFFILIATE
) จากค่า Enum ReportingContextEnum
สำหรับเหตุการณ์การเปลี่ยนแปลงสถานะผลิตภัณฑ์ ฟิลด์ 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"
}