เมธอดของ API

GetReader

GetReader ช่วยให้ผู้เผยแพร่โฆษณาตรวจสอบได้ว่าผู้อ่านรายใดรายหนึ่งที่มี PPID ที่รู้จักได้ลิงก์การสมัครใช้บริการกับ Google หรือไม่ เมื่อใช้คําขอ GET ผู้เผยแพร่โฆษณาจะค้นหา PPID ของรหัสการเผยแพร่ที่เฉพาะเจาะจง

ส่งคำขอ

//GET /v1/publications/dailybugle.com/readers/6789

การตอบกลับ

ปลายทางจะแสดงผลเป็น 200 พร้อมเนื้อหา JSON ที่มี created_time ของการติดตามที่ลิงก์ หรือแสดงข้อผิดพลาดหากไม่พบ PPID ของสื่อเผยแพร่ ดูข้อมูลเพิ่มเติมได้ที่ส่วนข้อผิดพลาด

{
  "name": "publications/gtech-demo.appspot.com/readers/81112",  
  "create_time": "2022-04-19T04:53:40+00:00"
}

GetReaderEntitlements

GetReaderEntitlements ช่วยให้ผู้เผยแพร่โฆษณาสามารถค้นหาการให้สิทธิ์สําหรับ PPID ที่ผู้เผยแพร่โฆษณาระบุไว้ก่อนหน้านี้ ผู้เผยแพร่โฆษณาขอสิทธิ์โดยใช้คำขอ GET โดยระบุ PPID และรหัสการเผยแพร่

ส่งคำขอ

//GET /v1/publications/dailybugle.com/readers/6789/entitlements

การตอบกลับ

สำหรับคำขอที่สำเร็จ รูปแบบผลลัพธ์จะเหมือนกับรูปแบบที่ใช้จัดเก็บการให้สิทธิ์ด้วยคำขอ UpdateReaderEntitlements PATCH

{ 
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "entitlements": [  
      {
        "product_id": "dailybugle.com:basic",
        "subscription_token": "dnabhdufbwinkjanvejskenfw",
        "detail": "This is our basic plan",
        "expire_time": "2022-08-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:premium",
        "subscription_token": "wfwhddgdgnkhngfw",
        "detail": "This is our premium plan",
        "expire_time": "2022-07-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:deluxe",
        "subscription_token": "fefcbwinkjanvejfefw",
        "detail": "This is our deluxe plan",
        "expire_time": "2022-08-20T04:53:40+00:00"
      }
  ]
}

สําหรับผู้ใช้ที่ไม่มีการให้สิทธิ์ แต่มี PPID ที่ลิงก์ (เช่น การให้สิทธิ์ที่หมดอายุและถูกล้างออกแล้ว) คําขอการให้สิทธิ์จะแสดงผลอาร์เรย์การให้สิทธิ์ว่างเปล่าซึ่งเป็นส่วนหนึ่งของออบเจ็กต์การให้สิทธิ์มาตรฐาน

{ 
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "createTime": "2023-02-07T17:38:57.425577Z"
}

UpdateReaderEntitlements

UpdateReaderEntitlements ใช้สำหรับสร้างและอัปเดตการให้สิทธิ์แก่ผู้อ่านตาม PPID ของผู้อ่าน

ตัวอย่างเพย์โหลดนี้ให้สิทธิ์ผู้อ่านที่มี PPID 6789 เข้าถึงรหัสผลิตภัณฑ์ 3 รายการของ The Daily Bugle ได้แก่ dailybugle.com:basic, dailybugle.com:premium และ dailybugle.com:deluxe เมื่อผู้อ่าน 6789 ใช้แพลตฟอร์มของ Google สําหรับ Search และ Discover ในภายหลัง รายการ "จากการติดตามของคุณ" จะแสดงผลการค้นหาที่เกี่ยวข้องจากบทความของ dailybugle.com ที่ติดแท็กรหัสผลิตภัณฑ์เหล่านี้

ส่งคำขอ

//PATCH /v1/publications/dailybugle.com/readers/6789/entitlements

{
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "entitlements": [  
      {
        "product_id": "dailybugle.com:basic",
        "subscription_token": "dnabhdufbwinkjanvejskenfw",
        "detail": "This is our basic plan",
        "expire_time": "2022-08-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:premium",
        "subscription_token": "wfwhddgdgnkhngfw",
        "detail": "This is our premium plan",
        "expire_time": "2022-07-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:deluxe",
        "subscription_token": "fefcbwinkjanvejfefw",
        "detail": "This is our deluxe plan",
        "expire_time": "2022-08-20T04:53:40+00:00"
      }
  ]
}

การตอบกลับ

เมื่อดำเนินการ PATCH สำเร็จ ระบบจะแสดงผลออบเจ็กต์ entitlements ที่บันทึกไว้ในรูปแบบเดียวกับ GetReaderEntitlements

DeleteReader

DeleteReader ช่วยให้ผู้เผยแพร่โฆษณาลบการสมัครใช้บริการที่ลิงก์ของผู้อ่านด้วยตนเองได้ เมื่อใช้คําขอ DELETE ผู้เผยแพร่โฆษณาจะส่ง PPID สําหรับรหัสการเผยแพร่ที่จะลบ

ส่งคำขอ

//DELETE /v1/publications/dailybugle.com/readers/6789

การตอบกลับ

การลบที่สำเร็จจะแสดงผลเป็น 200 พร้อมออบเจ็กต์ JSON ว่าง {}

{}