שיטות 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 שלהם.

המטען הייעודי (payload) לדוגמה הזה מעניק לקורא הרשאות PPID 6789 לשלושה מזהי מוצרים עבור The Daily Bugle: dailybugle.com:basic, dailybugle.com:premium ו-dailybugle.com:deluxe. כשלאחר מכן קורא 6789 ישתמש בפלטפורמות של Google לחיפוש ול-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 ריק {}.

{}