รับข้อความ Push สำหรับการเปลี่ยนแปลงข้อมูลผลิตภัณฑ์

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

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

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

หากต้องการรับการแจ้งเตือน คุณต้องมี 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 เพื่อระบุช่องที่คุณต้องการอัปเดต และค่าใหม่ในเนื้อหา HTTP

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, FREE_LISTINGS_UCP_CHECKOUT) จากค่า 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"
}