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

API calls for all endpoints tagged Onboarding.

Link to this section Summary

Link to this section Functions

Link to this function

books_onboarding_list_categories(connection, optional_params \\ [], opts \\ []) View Source

List categories for onboarding experience.

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.
    • :locale (String.t): ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.

Returns

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

Link to this function

books_onboarding_list_category_volumes(connection, optional_params \\ [], opts \\ []) View Source

List available volumes under categories for onboarding experience.

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.
    • :categoryId (list(String.t)): List of category ids requested.
    • :locale (String.t): ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
    • :maxAllowedMaturityRating (String.t): The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.
    • :pageSize (integer()): Number of maximum results per page to be included in the response.
    • :pageToken (String.t): The value of the nextToken from the previous page.

Returns

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