1. class
  2. Google
  3. \
  4. Service
  5. \
  6. SubscriptionLinking
  7. \
  8. Resource
  9. \
  10. PublicationsReaders

PublicationsReaders

class PublicationsReaders extends Resource (View source)

The "readers" collection of methods.

Typical usage is:

 $readerrevenuesubscriptionlinkingService = new Google\Service\SubscriptionLinking(...);
 $readers = $readerrevenuesubscriptionlinkingService->publications_readers;

Methods

DeleteReaderResponse
delete(string $name, array $optParams = [])

Removes a publication reader, effectively severing the association with a Google user. If force is set to true, any entitlements for this reader will also be deleted. (Otherwise, the request will only work if the reader has no entitlements.) - If the reader does not exist, return NOT_FOUND. - Return FAILED_PRECONDITION if the force field is false (or unset) and entitlements are present. (readers.delete)

Reader
get(string $name, array $optParams = [])

Gets a reader of a publication. Returns NOT_FOUND if the reader does not exist. (readers.get)

ReaderEntitlements
getEntitlements(string $name, array $optParams = [])

Gets the reader entitlements for a publication reader. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist. (readers.getEntitlements)

ReaderEntitlements
updateEntitlements(string $name, ReaderEntitlements $postBody, array $optParams = [])

Updates the reader entitlements for a publication reader. The entire reader entitlements will be overwritten by the new reader entitlements in the payload, like a PUT. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.

Details

at line 51
DeleteReaderResponse delete(string $name, array $optParams = [])

Removes a publication reader, effectively severing the association with a Google user. If force is set to true, any entitlements for this reader will also be deleted. (Otherwise, the request will only work if the reader has no entitlements.) - If the reader does not exist, return NOT_FOUND. - Return FAILED_PRECONDITION if the force field is false (or unset) and entitlements are present. (readers.delete)

Parameters

string $name

Required. The resource name of the reader. Format: publications/{publication_id}/readers/{ppid}
array $optParams

Optional parameters.

Return Value

DeleteReaderResponse

Exceptions

Exception

at line 67
Reader get(string $name, array $optParams = [])

Gets a reader of a publication. Returns NOT_FOUND if the reader does not exist. (readers.get)

Parameters

string $name

Required. The resource name of the reader. Format: publications/{publication_id}/readers/{ppid}
array $optParams

Optional parameters.

Return Value

Reader

Exceptions

Exception

at line 85
ReaderEntitlements getEntitlements(string $name, array $optParams = [])

Gets the reader entitlements for a publication reader. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist. (readers.getEntitlements)

Parameters

string $name

Required. The name of the reader entitlements to retrieve. Format: publications/{publication_id}/readers/{reader_id}/entitlements
array $optParams

Optional parameters.

Return Value

ReaderEntitlements

Exceptions

Exception

at line 107
ReaderEntitlements updateEntitlements(string $name, ReaderEntitlements $postBody, array $optParams = [])

Updates the reader entitlements for a publication reader. The entire reader entitlements will be overwritten by the new reader entitlements in the payload, like a PUT. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.

(readers.updateEntitlements)

Parameters

string $name

Output only. The resource name of the singleton.
ReaderEntitlements $postBody
array $optParams

Optional parameters.

Return Value

ReaderEntitlements

Exceptions

Exception