API 메서드

GetReader

GetReader를 사용하면 알려진 PPID를 가진 독자 중 한 명이 구독을 Google에 연결했는지 확인할 수 있습니다. 게시자는 GET 요청을 사용하여 특정 간행물 ID에 속한 PPID를 쿼리합니다.

요청

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

응답

엔드포인트는 연결된 구독의 created_time가 포함된 JSON 본문이 포함된 200을 반환하거나 간행물의 PPID를 찾을 수 없는 경우 오류를 반환합니다. 자세한 내용은 오류 섹션을 참고하세요.

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

GetReaderEntitlements

GetReaderEntitlements를 사용하면 게시자가 이전에 제공한 PPID의 사용 권한을 쿼리할 수 있습니다. 게시자는 GET 요청을 사용하여 PPID와 간행물 ID를 제공하여 사용 권한을 요청합니다.

요청

//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에 따라 리더의 사용 권한을 만들고 업데이트하는 데 사용됩니다.

이 샘플 페이로드는 PPID 6789 권한이 있는 리더에 The Daily Bugle의 세 제품 ID(dailybugle.com:basic, dailybugle.com:premium, dailybugle.com:deluxe)에 대한 권한을 부여합니다. 이후에 독자 6789가 Google 검색 및 디스커버에 Google 플랫폼을 사용하면 '구독 중인 소식' 목록에 이러한 제품 ID로 태그가 지정된 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 요청을 사용하여 간행물 ID의 삭제를 위해 PPID를 제출합니다.

요청

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

응답

삭제에 성공하면 빈 JSON 객체 {}과 함께 200이 반환됩니다.

{}