google_api_books v0.12.0 GoogleApi.Books.V1.Api.Promooffer View Source

API calls for all endpoints tagged Promooffer.

Link to this section Summary

Functions

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

Returns a list of promo offers available to the user

Link to this section Functions

Link to this function

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

View Source
books_promooffer_accept(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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, %{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
books_promooffer_dismiss(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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, %{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
books_promooffer_get(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Offers.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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