روش های 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 را برای سه شناسه محصول برای The Daily Bugle می دهد: dailybugle.com:basic ، dailybugle.com:premium ، و dailybugle.com:deluxe . هنگامی که خواننده 6789 متعاقباً از سطوح Google برای جستجو و کاوش استفاده می‌کند، فهرست «از اشتراک‌های شما» نتایج مرتبط از مقالات 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 خالی {} برمی گرداند.

{}