Métodos de la API

GetReader

GetReader permite que un editor valide si uno de sus lectores con un PPID conocido vinculó su suscripción a Google. Mediante una solicitud GET, el editor consulta un PPID que pertenece a un ID de publicación específico.

Solicitud

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

Respuesta

El extremo mostrará un código 200 con un cuerpo JSON que contiene el created_time de la suscripción vinculada o un error si no se encuentra un PPID para la publicación. Consulta la sección de errores para obtener más información.

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

GetReaderEntitlements

GetReaderEntitlements permite que un editor busque derechos para un PPID que el editor proporcionó anteriormente. Con una solicitud GET, el editor solicita los derechos proporcionando un PPID y un ID de publicación.

Solicitud

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

Respuesta

Para que se realice correctamente una solicitud, el formato que se muestra es idéntico al formato que se usa para almacenar derechos con la solicitud PATCH de 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"
      }
  ]
}

En el caso de los usuarios que no tienen derechos, pero que tienen un PPID vinculado (por ejemplo, un derecho que venció y se borró definitivamente), una solicitud de derechos mostrará un array de derechos vacío como parte del objeto de derechos estándar.

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

UpdateReaderEntitlements

UpdateReaderEntitlements se usa para crear y actualizar derechos para un lector, según su PPID.

Esta carga útil de muestra otorga al lector derechos de PPID 6789 a tres IDs de productos para The Daily Bugle: dailybugle.com:basic, dailybugle.com:premium y dailybugle.com:deluxe. Cuando el lector 6789 utilice posteriormente las plataformas de Google para la Búsqueda y Descubre, la lista "De tus suscripciones" mostrará todos los resultados relevantes de los artículos de Dailybugle.com etiquetados con cualquiera de estos ID de producto.

Solicitud

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

Respuesta

Cuando la operación PATCH se realice correctamente, se mostrará el objeto entitlements guardado, en el mismo formato que GetReaderEntitlements.

DeleteReader

DeleteReader permite que un editor borre de forma manual la suscripción vinculada de un lector. Mediante una solicitud DELETE, el editor envía un PPID para que se borre un ID de publicación.

Solicitud

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

Respuesta

Una eliminación correcta muestra un código de estado 200 con un objeto JSON vacío {}.

{}