View Source GoogleApi.Books.V1.Api.Promooffer (google_api_books v0.21.0)

API calls for all endpoints tagged Promooffer.

Summary

Functions

books_promooffer_accept(connection, optional_params \\ [], opts \\ [])

Accepts the promo offer.

books_promooffer_dismiss(connection, optional_params \\ [], opts \\ [])

Marks the promo offer as dismissed.

books_promooffer_get(connection, optional_params \\ [], opts \\ [])

Returns a list of promo offers available to the user

Functions

books_promooffer_accept(connection, optional_params \\ [], opts \\ [])

@spec books_promooffer_accept(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Accepts the promo offer.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
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").
- :androidId (type: String.t) - device android_id
- :device (type: String.t) - device device
- :manufacturer (type: String.t) - device manufacturer
- :model (type: String.t) - device model
- :offerId (type: String.t) -
- :product (type: String.t) - device product
- :serial (type: String.t) - device serial
- :volumeId (type: String.t) - Volume id to exercise the offer
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Empty{}} on success
{:error, info} on failure

books_promooffer_dismiss(connection, optional_params \\ [], opts \\ [])

@spec books_promooffer_dismiss(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Marks the promo offer as dismissed.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
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").
- :androidId (type: String.t) - device android_id
- :device (type: String.t) - device device
- :manufacturer (type: String.t) - device manufacturer
- :model (type: String.t) - device model
- :offerId (type: String.t) - Offer to dimiss
- :product (type: String.t) - device product
- :serial (type: String.t) - device serial
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Empty{}} on success
{:error, info} on failure

books_promooffer_get(connection, optional_params \\ [], opts \\ [])

@spec books_promooffer_get(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Offers.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a list of promo offers available to the user

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
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").
- :androidId (type: String.t) - device android_id
- :device (type: String.t) - device device
- :manufacturer (type: String.t) - device manufacturer
- :model (type: String.t) - device model
- :product (type: String.t) - device product
- :serial (type: String.t) - device serial
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Offers{}} on success
{:error, info} on failure