API yöntemleri

GetReader

GetReader, yayıncıların, bilinen PPID'ye sahip okuyucularından birinin aboneliklerini Google'a bağlayıp bağlamadığını doğrulamasını sağlar. Yayıncı, GET isteğini kullanarak belirli bir yayın kimliğine ait PPID'yi sorgular.

İstek

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

Yanıt

Uç nokta, bağlı aboneliğin created_time öğesini içeren JSON gövdesine sahip 200 değerini veya yayın için PPID bulunamazsa hata döndürür. Daha fazla bilgi için hatalar bölümüne 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ığı PPID için yararlanma haklarını sorgulamasına olanak tanır. Yayıncı, bir GET isteği kullanarak PPID ve Yayın Kimliği sağlayarak yararlanma haklarını ister.

İstek

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

Yanıt

Başarılı bir isteğin iadesi biçimi, UpdateReaderEntitlements PATCH isteği.

{ 
  "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 hakları olmayan ancak bağlı bir PPID'si olan (ör. süresi dolan ve kalıcı olarak silinen bir yararlanma hakkı) kullanıcılar için bir yararlanma hakkı isteği, standart yararlanma hakları nesnesinin bir parçası olarak boş bir entitlements dizisi döndürür.

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

UpdateReaderEntitlements

UpdateReaderEntitlements, PPID'lerine göre okuyucu için yararlanma haklarını oluşturmak ve güncellemek amacıyla kullanılır.

Bu örnek yük, okuyucuya Daily Bugle için üç Ürün Kimliği'ne PPID 6789 hakları verir: dailybugle.com:basic, dailybugle.com:premium ve dailybugle.com:deluxe. Reader 6789, daha sonra Arama ve Keşfet için Google yüzeylerini kullandığında, bu Ürün Kimliklerinden herhangi biriyle etiketlenmiş Dailybugle.com makalelerindeki tüm alakalı sonuçlar "Aboneliklerinizden" listesinde 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 YAMA işleminden sonra, kaydedilen entitlements nesnesi GetReaderEntitlements ile aynı biçimde döndürülür.

DeleteReader

DeleteReader, yayıncının bir okuyucunun bağlı aboneliğini manuel olarak silmesine olanak tanır. Yayıncı, DELETE isteği kullanarak yayın kimliğinin silinmesi için bir PPID gönderir.

İstek

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

Yanıt

Başarılı bir silme işlemi, boş bir JSON nesnesiyle ({}) sahip 200 hatası döndürür.

{}