Metode API

GetReader

GetReader memungkinkan penerbit memvalidasi apakah salah satu pembaca dengan PPID yang diketahui telah menautkan langganannya ke Google. Dengan permintaan GET, penayang mengajukan kueri untuk PPID yang dimiliki oleh ID Publikasi tertentu.

Permintaan

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

Respons

Endpoint akan menampilkan error 200 dengan isi JSON yang berisi created_time dari langganan yang ditautkan, atau error jika tidak ada PPID yang ditemukan untuk publikasi. Lihat bagian error untuk informasi selengkapnya.

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

GetReaderEntitlements

GetReaderEntitlements memungkinkan penayang membuat kueri hak untuk PPID yang sebelumnya diberikan penayang. Dengan permintaan GET, penayang meminta hak dengan memberikan PPID dan ID Publikasi.

Permintaan

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

Respons

Agar permintaan berhasil, format nilai yang ditampilkan sama dengan format yang digunakan untuk menyimpan hak dengan permintaan 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"
      }
  ]
}

Untuk pengguna yang tidak memiliki hak, tetapi memiliki PPID tertaut (misalnya, hak yang telah habis masa berlakunya dan telah dihapus permanen), permintaan hak akan menampilkan array hak kosong sebagai bagian dari objek hak standar.

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

UpdateReaderEntitlements

UpdateReaderEntitlements digunakan untuk membuat dan memperbarui hak bagi pembaca, berdasarkan PPID-nya.

Contoh payload ini memberi pembaca hak PPID 6789 ke tiga ID Produk untuk The Daily Bugle: dailybugle.com:basic, dailybugle.com:premium, dan dailybugle.com:deluxe. Saat pembaca 6789 kemudian menggunakan platform Google untuk Penelusuran dan Discover, daftar “Dari langganan Anda” akan menampilkan hasil yang relevan dari artikel dailybugle.com yang diberi tag dengan salah satu ID Produk ini.

Permintaan

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

Respons

Setelah operasi PATCH berhasil, objek entitlements yang disimpan akan ditampilkan, dalam format yang sama seperti GetReaderEntitlements.

DeleteReader

DeleteReader memungkinkan penerbit menghapus langganan yang ditautkan kepada pembaca secara manual. Dengan permintaan DELETE, penayang mengirimkan PPID untuk ID Publikasi agar dihapus.

Permintaan

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

Respons

Jika penghapusan berhasil, nilai 200 dengan objek JSON kosong {}.

{}