เมธอดของ 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 เมื่อ Reader 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"
      }
  ]
}

คำตอบ

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

DeleteReader

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

ส่งคำขอ

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

คำตอบ

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

{}