google_api_books v0.13.0 GoogleApi.Books.V1.Api.Myconfig View Source

API calls for all endpoints tagged Myconfig.

Link to this section Summary

Functions

Request concurrent and download access restrictions.

Request downloaded content access for specified volumes on the My eBooks shelf.

Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.

Link to this section Functions

Link to this function

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

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

Gets the current settings for 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").
    • :country (type: String.t) - Unused. Added only to workaround TEX mandatory request template requirement
  • opts (type: keyword()) - Call options

Returns

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

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

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

Release downloaded content access restriction.

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").
    • :cpksver (type: String.t) - The device/version ID from which to release the restriction.
    • :locale (type: String.t) - ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
    • :source (type: String.t) - String to identify the originator of this request.
    • :volumeIds (type: list(String.t)) - The volume(s) to release restrictions for.
  • opts (type: keyword()) - Call options

Returns

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

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

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

Request concurrent and download access restrictions.

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").
    • :cpksver (type: String.t) - The device/version ID from which to request the restrictions.
    • :licenseTypes (type: String.t) - The type of access license to request. If not specified, the default is BOTH.
    • :locale (type: String.t) - ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
    • :nonce (type: String.t) - The client nonce value.
    • :source (type: String.t) - String to identify the originator of this request.
    • :volumeId (type: String.t) - The volume to request concurrent/download restrictions for.
  • opts (type: keyword()) - Call options

Returns

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

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

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

Request downloaded content access for specified volumes on the My eBooks shelf.

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").
    • :cpksver (type: String.t) - The device/version ID from which to release the restriction.
    • :features (type: list(String.t)) - List of features supported by the client, i.e., 'RENTALS'
    • :includeNonComicsSeries (type: boolean()) - Set to true to include non-comics series. Defaults to false.
    • :locale (type: String.t) - ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
    • :nonce (type: String.t) - The client nonce value.
    • :showPreorders (type: boolean()) - Set to true to show pre-ordered books. Defaults to false.
    • :source (type: String.t) - String to identify the originator of this request.
    • :volumeIds (type: list(String.t)) - The volume(s) to request download restrictions for.
  • opts (type: keyword()) - Call options

Returns

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

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

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

Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.

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").
    • :body (type: GoogleApi.Books.V1.Model.Usersettings.t) -
  • opts (type: keyword()) - Call options

Returns

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