google_api_books v0.12.0 GoogleApi.Books.V1.Api.Myconfig View Source
API calls for all endpoints tagged Myconfig
.
Link to this section Summary
Functions
Gets the current settings for the user.
Release downloaded content access restriction.
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
books_myconfig_get_user_settings(connection, optional_params \\ [], opts \\ [])
View Sourcebooks_myconfig_get_user_settings(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Books.V1.Model.Usersettings.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the current settings for the user.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to serveroptional_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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.Usersettings{}}
on success{:error, info}
on failure
books_myconfig_release_download_access(connection, volume_ids, cpksver, optional_params \\ [], opts \\ [])
View Sourcebooks_myconfig_release_download_access( Tesla.Env.client(), [String.t()], String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Books.V1.Model.DownloadAccesses.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Release downloaded content access restriction.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to servervolume_ids
(type:list(String.t)
) - The volume(s) to release restrictions for.cpksver
(type:String.t
) - The device/version ID from which to release the restriction.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.: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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.DownloadAccesses{}}
on success{:error, info}
on failure
books_myconfig_request_access(connection, source, volume_id, nonce, cpksver, optional_params \\ [], opts \\ [])
View Sourcebooks_myconfig_request_access( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Books.V1.Model.RequestAccess.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Request concurrent and download access restrictions.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to serversource
(type:String.t
) - String to identify the originator of this request.volume_id
(type:String.t
) - The volume to request concurrent/download restrictions for.nonce
(type:String.t
) - The client nonce value.cpksver
(type:String.t
) - The device/version ID from which to request the restrictions.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.: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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.RequestAccess{}}
on success{:error, info}
on failure
books_myconfig_sync_volume_licenses(connection, source, nonce, cpksver, optional_params \\ [], opts \\ [])
View Sourcebooks_myconfig_sync_volume_licenses( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Books.V1.Model.Volumes.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Request downloaded content access for specified volumes on the My eBooks shelf.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to serversource
(type:String.t
) - String to identify the originator of this request.nonce
(type:String.t
) - The client nonce value.cpksver
(type:String.t
) - The device/version ID from which to release the restriction.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.: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.:showPreorders
(type:boolean()
) - Set to true to show pre-ordered books. Defaults to false.: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
books_myconfig_update_user_settings(connection, optional_params \\ [], opts \\ [])
View Sourcebooks_myconfig_update_user_settings(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Books.V1.Model.Usersettings.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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 serveroptional_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.: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