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

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

الإجابة

بالنسبة إلى الطلب الناجح، يكون تنسيق الإرجاع مطابقًا للتنسيق المستخدَم لتخزين الاستحقاقات في طلب PATCH UpdateReaderEntitlements.

{ 
  "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 لخدمة "بحث 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 لحذف معرّف جهة النشر.

ملاحظة: يجب ألا يكون للقرّاء أي استحقاقات حالية ليتم حذفهم. في حال الحاجة إلى حذف قارئ لديه استحقاقات حالية، يجب أولاً حذف استحقاقاته مع إدراج UpdateReaderEntitlements في مصفوفة فارغة، وبعد ذلك قد يتم حذف القارئ.

الطلب

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

الإجابة

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

{}