View Source GoogleApi.ReaderRevenueSubscriptionLinking.V1.Api.Publications (google_api_reader_revenue_subscription_linking v0.2.0)

API calls for all endpoints tagged Publications.

Summary

Functions

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.

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

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.

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.

Functions

Link to this function

readerrevenuesubscriptionlinking_publications_readers_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec readerrevenuesubscriptionlinking_publications_readers_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ReaderRevenueSubscriptionLinking.V1.Model.DeleteReaderResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.ReaderRevenueSubscriptionLinking.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the reader. Format: publications/{publication_id}/readers/{ppid}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :force (type: boolean()) - If set to true, any entitlements under the reader will also be purged.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ReaderRevenueSubscriptionLinking.V1.Model.DeleteReaderResponse{}} on success
  • {:error, info} on failure
Link to this function

readerrevenuesubscriptionlinking_publications_readers_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec readerrevenuesubscriptionlinking_publications_readers_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ReaderRevenueSubscriptionLinking.V1.Model.Reader.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.ReaderRevenueSubscriptionLinking.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the reader. Format: publications/{publication_id}/readers/{ppid}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ReaderRevenueSubscriptionLinking.V1.Model.Reader{}} on success
  • {:error, info} on failure
Link to this function

readerrevenuesubscriptionlinking_publications_readers_get_entitlements(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec readerrevenuesubscriptionlinking_publications_readers_get_entitlements(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ReaderRevenueSubscriptionLinking.V1.Model.ReaderEntitlements.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.ReaderRevenueSubscriptionLinking.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the reader entitlements to retrieve. Format: publications/{publication_id}/readers/{reader_id}/entitlements
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ReaderRevenueSubscriptionLinking.V1.Model.ReaderEntitlements{}} on success
  • {:error, info} on failure
Link to this function

readerrevenuesubscriptionlinking_publications_readers_update_entitlements(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec readerrevenuesubscriptionlinking_publications_readers_update_entitlements(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ReaderRevenueSubscriptionLinking.V1.Model.ReaderEntitlements.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.ReaderRevenueSubscriptionLinking.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. The resource name of the singleton.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. The list of fields to update. Defaults to all fields.
    • :body (type: GoogleApi.ReaderRevenueSubscriptionLinking.V1.Model.ReaderEntitlements.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ReaderRevenueSubscriptionLinking.V1.Model.ReaderEntitlements{}} on success
  • {:error, info} on failure