Class: Google::Apis::ReaderrevenuesubscriptionlinkingV1::SubscriptionLinkingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/readerrevenuesubscriptionlinking_v1/service.rb

Overview

Reader Revenue Subscription Linking API

readerrevenuesubscriptionlinking.googleapis.com API.

Examples:

require 'google/apis/readerrevenuesubscriptionlinking_v1'

Readerrevenuesubscriptionlinking = Google::Apis::ReaderrevenuesubscriptionlinkingV1 # Alias the module
service = Readerrevenuesubscriptionlinking::SubscriptionLinkingService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://readerrevenuesubscriptionlinking.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SubscriptionLinkingService

Returns a new instance of SubscriptionLinkingService.



47
48
49
50
51
52
 
# File 'lib/google/apis/readerrevenuesubscriptionlinking_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-readerrevenuesubscriptionlinking_v1',
        client_version: Google::Apis::ReaderrevenuesubscriptionlinkingV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/readerrevenuesubscriptionlinking_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/readerrevenuesubscriptionlinking_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#delete_publication_reader(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReaderrevenuesubscriptionlinkingV1::DeleteReaderResponse

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.

Parameters:

  • name (String) —

    Required. The resource name of the reader. Format: publications/ publication_id/readers/ppid

  • force (Boolean) (defaults to: nil) —

    If set to true, any entitlements under the reader will also be purged.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/google/apis/readerrevenuesubscriptionlinking_v1/service.rb', line 82

def delete_publication_reader(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ReaderrevenuesubscriptionlinkingV1::DeleteReaderResponse::Representation
  command.response_class = Google::Apis::ReaderrevenuesubscriptionlinkingV1::DeleteReaderResponse
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_publication_reader(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReaderrevenuesubscriptionlinkingV1::Reader

Gets a reader of a publication. Returns NOT_FOUND if the reader does not exist.

Parameters:

  • name (String) —

    Required. The resource name of the reader. Format: publications/ publication_id/readers/ppid

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



114
115
116
117
118
119
120
121
122
 
# File 'lib/google/apis/readerrevenuesubscriptionlinking_v1/service.rb', line 114

def get_publication_reader(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ReaderrevenuesubscriptionlinkingV1::Reader::Representation
  command.response_class = Google::Apis::ReaderrevenuesubscriptionlinkingV1::Reader
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_publication_reader_entitlements(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReaderrevenuesubscriptionlinkingV1::ReaderEntitlements

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.

Parameters:

  • name (String) —

    Required. The name of the reader entitlements to retrieve. Format: publications/publication_id/readers/reader_id/entitlements

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



147
148
149
150
151
152
153
154
155
 
# File 'lib/google/apis/readerrevenuesubscriptionlinking_v1/service.rb', line 147

def get_publication_reader_entitlements(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ReaderrevenuesubscriptionlinkingV1::ReaderEntitlements::Representation
  command.response_class = Google::Apis::ReaderrevenuesubscriptionlinkingV1::ReaderEntitlements
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_publication_reader_entitlements(name, reader_entitlements_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReaderrevenuesubscriptionlinkingV1::ReaderEntitlements

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.

Parameters:

  • name (String) —

    Output only. The resource name of the singleton.

  • reader_entitlements_object (Google::Apis::ReaderrevenuesubscriptionlinkingV1::ReaderEntitlements) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. The list of fields to update. Defaults to all fields.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/google/apis/readerrevenuesubscriptionlinking_v1/service.rb', line 183

def update_publication_reader_entitlements(name, reader_entitlements_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ReaderrevenuesubscriptionlinkingV1::ReaderEntitlements::Representation
  command.request_object = reader_entitlements_object
  command.response_representation = Google::Apis::ReaderrevenuesubscriptionlinkingV1::ReaderEntitlements::Representation
  command.response_class = Google::Apis::ReaderrevenuesubscriptionlinkingV1::ReaderEntitlements
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end