طرق واجهة برمجة التطبيقات

GetReader

تسمح الدالة GetReader للناشر بالتحقّق مما إذا كان أحد القرّاء قد ربط اشتراكه بـ Google، والذي لديه معرّف مستند إلى المعرّف المقدَّم من الناشر (PPID). باستخدام طلب 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"
      }
  ]
}

الرد

بعد عملية تصحيح ناجحة، سيتم تحويل الكائن entitlements المحفوظ. تم إرجاعها، بالتنسيق نفسه المستخدم في GetReaderEntitlements.

DeleteReader

تسمح السمة DeleteReader للناشر بحذف اشتراك القارئ المرتبط يدويًا. من خلال طلب DELETE، يرسل الناشر المعرّف المقدَّم من الناشر (PPID) لحذف معرّف جهة النشر.

الطلب

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

الرد

تؤدي عملية الحذف الناجحة إلى عرض النتيجة 200 التي تحتوي على كائن JSON فارغ {}.

{}