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

คุณสามารถใช้ 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 การเรียกกลับที่ไม่ซ้ำกันต่อบัญชีขั้นสูงต่อประเภทเหตุการณ์เพื่อลดภาระของคําขอ Push ไปยัง 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 ที่คุณอาจใช้ประมวลผลข้อมูลที่เข้ารหัสมีดังนี้

@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",
  "managingAccount": "accounts/merchantId",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "eligible",
    "newValue": "disapproved",
    "regionCode": "US",
    "reportingContext": "SHOPPING_ADS"
  }, {
    "oldValue": "eligible",
    "newValue": "disapproved",
    "regionCode": "JP",
    "reportingContext": "SHOPPING_ADS"
  },{
    "oldValue": "eligible",
    "newValue": "disapproved",
    "regionCode": "GE",
    "reportingContext": "SHOPPING_ADS"
  }],
  "resourceId": "ONLINE~en~US~1234",
  "resource": "accounts/targetMerchantId/products/ONLINE~en~US~1234",
  "expirationTime": "2024-10-22T02:43:47.461464Z"
}

หากไม่มีช่อง oldValue ในการแจ้งเตือน แสดงว่ามีการเพิ่มผลิตภัณฑ์ใหม่ลงในบัญชีของคุณ หากไม่มีช่อง newValue แสดงว่าระบบได้ลบผลิตภัณฑ์นั้นออกจากบัญชีของคุณแล้ว

ช่อง reportingContext รองรับเฉพาะ (SHOPPING_ADS, LOCAL_INVENTORY_ADS, YOUTUBE_SHOPPING, YOUTUBE_CHECKOUT) จากค่า enum ReportingContextEnum

ทดสอบการใช้งาน

ตัวอย่างการแจ้งเตือนที่คุณสามารถใช้ทดสอบ URI การโทรกลับและการถอดรหัสมีดังนี้

curl --header "Content-Type: application/json" --header "Accept: text/plain" --request POST --data '{"message":{"data":
"ewogICJhY2NvdW50IjogImFjY291bnRzLzEyMzQiLAogICJtYW5hZ2luZ0FjY291bnQiOiAiYWNjb3VudHMvNTY3OCIsCiAgInJlc291cmNlVHlwZSI6ICJQUk9EVUNUIiwKICAiYXR0cmlidXRlIjogIlNUQVRVUyIsCiAgImNoYW5nZXMiOiBbewogICAgIm9sZFZhbHVlIjogImVsaWdpYmxlIiwKICAgICJyZWdpb25Db2RlIjogIlVTIiwKICAgICJyZXBvcnRpbmdDb250ZXh0IjogIlNIT1BQSU5HX0FEUyIKICB9XSwKICAicmVzb3VyY2VJZCI6ICJPTkxJTkV+ZW5+VVN+MDAwMDAwMDAwMDAwIiwKICAicmVzb3VyY2UiOiAiYWNjb3VudHMvMTIzNC9wcm9kdWN0cy9PTkxJTkV+ZW5+VVN+MDAwMDAwMDAwMDAwIiwKICAiZXhwaXJhdGlvblRpbWUiOiAiMjAyNC0xMC0yMlQwMjo0Mzo0Ny40NjE0NjRaIgp9"}}' https://{callBackUri}

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

{
  "account": "accounts/1234",
  "managingAccount": "accounts/5678",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "eligible",
    "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"
}