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

API calls for all endpoints tagged Myconfig.

Link to this section Summary

Functions

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

Gets the current settings for the user.

Parameters

  • connection (GoogleApi.Books.V1.Connection): Connection to server
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

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

Link to this function

books_myconfig_release_download_access(connection, volume_ids, cpksver, optional_params \\ [], opts \\ []) View Source

Release downloaded content access restriction.

Parameters

  • connection (GoogleApi.Books.V1.Connection): Connection to server
  • volume_ids (list(String.t)): The volume(s) to release restrictions for.
  • cpksver (String.t): The device/version ID from which to release the restriction.
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :locale (String.t): ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
    • :source (String.t): String to identify the originator of this request.

Returns

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

Link to this function

books_myconfig_request_access(connection, source, volume_id, nonce, cpksver, optional_params \\ [], opts \\ []) View Source

Request concurrent and download access restrictions.

Parameters

  • connection (GoogleApi.Books.V1.Connection): Connection to server
  • source (String.t): String to identify the originator of this request.
  • volume_id (String.t): The volume to request concurrent/download restrictions for.
  • nonce (String.t): The client nonce value.
  • cpksver (String.t): The device/version ID from which to request the restrictions.
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :licenseTypes (String.t): The type of access license to request. If not specified, the default is BOTH.
    • :locale (String.t): ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

Returns

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

Link to this function

books_myconfig_sync_volume_licenses(connection, source, nonce, cpksver, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.Books.V1.Connection): Connection to server
  • source (String.t): String to identify the originator of this request.
  • nonce (String.t): The client nonce value.
  • cpksver (String.t): The device/version ID from which to release the restriction.
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :features (list(String.t)): List of features supported by the client, i.e., 'RENTALS'
    • :includeNonComicsSeries (boolean()): Set to true to include non-comics series. Defaults to false.
    • :locale (String.t): ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
    • :showPreorders (boolean()): Set to true to show pre-ordered books. Defaults to false.
    • :volumeIds (list(String.t)): The volume(s) to request download restrictions for.

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

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 (GoogleApi.Books.V1.Connection): Connection to server
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (GoogleApi.Books.V1.Model.Usersettings.t):

Returns

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