API yöntemleri

GetReader

GetReader, yayıncıların bilinen bir PPID'ye sahip okuyucularından birinin aboneliğini Google'a bağlayıp bağlamadığını doğrulamasına olanak tanır. Yayıncı, GET isteği kullanarak belirli bir Yayın Kimliği'ne ait bir PPID sorgulaması yapar.

İstek

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

Yanıt

Uç nokta, bağlı aboneliğin created_time değerini içeren bir JSON gövdesi ile 200 yanıtı veya yayın için PPID bulunamazsa hata yanıtı döndürür. Daha fazla bilgi için hatalara ilişkin bölüme bakın.

{
  "name": "publications/gtech-demo.appspot.com/readers/81112",  
  "create_time": "2022-04-19T04:53:40+00:00"
}

GetReaderEntitlements

GetReaderEntitlements, yayıncının daha önce sağladığı bir PPID için hak taleplerini sorgulamasına olanak tanır. Yayıncı, GET isteği kullanarak bir PPID ve Yayın Kimliği sağlayarak izinleri ister.

İstek

//GET /v1/publications/dailybugle.com/readers/6789/entitlements

Yanıt

Başarılı bir istek için döndürülen biçim, UpdateReaderEntitlements PATCH isteğiyle hak sahipliklerini depolamak için kullanılan biçimle aynıdır.

{ 
  "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"
      }
  ]
}

Yararlanma hakkı olmayan ancak bağlı bir PPID'si olan kullanıcılar (ör. süresi dolmuş ve temizlenmiş bir yararlanma hakkı) için yararlanma hakkı isteği, standart yararlanma hakları nesnesi kapsamında boş bir yararlanma hakları dizisi döndürür.

{ 
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "createTime": "2023-02-07T17:38:57.425577Z"
}

UpdateReaderEntitlements

UpdateReaderEntitlements, bir okuyucunun PPID'sine göre yetkilendirmeleri oluşturmak ve güncellemek için kullanılır.

Bu örnek yükü, PPID 6789 kimlikli okuyucuya The Daily Bugle için üç ürün kimliği (dailybugle.com:basic, dailybugle.com:premium ve dailybugle.com:deluxe) hakkı verir. 6789 numaralı okuyucu daha sonra Arama ve Keşfet için Google platformlarını kullandığında "Aboneliklerinizden" listesinde, bu ürün kimliklerinden herhangi biriyle etiketlenmiş dailybugle.com makalelerindeki alakalı sonuçlar yer alır.

İstek

//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"
      }
  ]
}

Yanıt

Başarılı bir PATCH işleminin ardından, kayıtlı entitlements nesnesi GetReaderEntitlements ile aynı biçimde döndürülür.

DeleteReader

DeleteReader, yayıncıların okuyucuların bağlı aboneliklerini manuel olarak silmesine olanak tanır. Yayıncı, DELETE isteği kullanarak silinecek bir Yayın Kimliği için PPID gönderir.

İstek

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

Yanıt

Başarılı bir silme işlemi, boş bir JSON nesnesi {} içeren 200 yanıtı döndürür.

{}