รับข้อความ Push เกี่ยวกับการเปลี่ยนแปลงข้อมูลบัญชี

คุณใช้ Merchant Notifications API เพื่อรับข้อความ Push สำหรับการเปลี่ยนแปลงได้ กับข้อมูลบัญชี ตัวอย่างเช่น หากคุณสมัครรับข้อมูลการเปลี่ยนสถานะผลิตภัณฑ์ การแจ้งเตือน คุณจะได้รับการแจ้งเตือนแบบเรียลไทม์เมื่อผลิตภัณฑ์ไม่ได้รับอนุมัติ คุณสามารถสมัครรับการแจ้งเตือนสำหรับ บัญชีย่อยหรืออื่นๆ ที่ลิงก์ บัญชี

คู่มือนี้มีตัวอย่างวิธีจัดการการแจ้งเตือนสถานะผลิตภัณฑ์ การเปลี่ยนแปลง คุณสามารถใช้ตัวอย่างเหล่านี้เพื่อจัดการการแจ้งเตือนสำหรับกิจกรรมอื่นๆ โดยดำเนินการดังนี้ เปลี่ยนค่าของช่อง registeredEvent ในคำขอ แบบเต็ม โปรดดูรายการประเภทเหตุการณ์ที่หัวข้อ Merchant Notifications API ข้อมูลอ้างอิง

สมัครใช้บริการ

คุณต้องมี callBackUri จึงจะรับการแจ้งเตือนได้ URI ของ Callback ของคุณต้อง มีคุณสมบัติตรงตามข้อกำหนดต่อไปนี้

  • ต้องเป็นที่อยู่ HTTPS ที่เข้าถึงได้แบบสาธารณะและมีใบรับรอง SSL ที่ถูกต้อง ลงนามโดยผู้ออกใบรับรอง
  • ต้องยอมรับคำขอ HTTP POST ที่มีส่วนหัว Content-Type และ application/json
  • ต้องส่งคืนโค้ดตอบกลับรายการใดรายการหนึ่งต่อไปนี้เพื่อรับทราบว่า ได้รับการแจ้งเตือนแล้ว
    • 102
    • 200
    • 201
    • 202
    • 204

คุณใช้ URI ของ Callback เดียวกันสำหรับการสมัครใช้บริการหลายรายการได้ เราขอแนะนำให้ใช้ 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}"}}

ข้อมูลการแจ้งเตือนมีการเข้ารหัส คุณสามารถถอดรหัสข้อมูลให้เป็นข้อความที่อ่านได้ ที่จะนำมาใช้ในการติดตั้งใช้งาน นี่คือตัวอย่าง Spring Boot Controller ที่คุณ อาจใช้เพื่อประมวลผลข้อมูลที่เข้ารหัส

@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 ของ Callback และถอดรหัส

curl --header "Content-Type: application/json" --header "Accept: text/plain" --request POST --data '{"message":{"data":
"ImFjY291bnQiOiAiYWNjb3VudHMvMTIzNCIKIm1hbmFnaW5nX2FjY291bnQiOiAiYWNjb3VudHMvNTY3OCIKInJlc291cmNlX3R5cGUiOiBQUk9EVUNUCiJhdHRyaWJ1dGUiOiBTVEFUVVMKImNoYW5nZXMiOiB7CiAgIm9sZF92YWx1ZSI6ICJlbGlnaWJsZSIKICAicmVnaW9uX2NvZGUiOiAiVVMiCiAgInJlcG9ydGluZ19jb250ZXh0IjogU0hPUFBJTkdfQURTCn0KInJlc291cmNlX2lkIjogIk9OTElORX5lbn5VU34wMDAwMDAwMDAwMDAiCiJyZXNvdXJjZSI6ICJhY2NvdW50cy8xMjM0L3Byb2R1Y3RzL09OTElORX5lbn5VU34wMDAwMDAwMDAwMDAi"}}' https://{callBackUri}

เพื่อตอบสนองการเรียกนี้ URI ของ Callback ควรส่งการตอบสนองที่สำเร็จ รหัส ข้อความที่ถอดรหัสควรมีค่าต่อไปนี้

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