שיטות 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 ריק {}.

{}