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

API calls for all endpoints tagged Series.

Link to this section Summary

Functions

Returns Series metadata for the given series ids.

Returns Series membership data given the series id.

Link to this section Functions

Link to this function

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

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

Returns Series metadata for the given series ids.

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").
    • :series_id (type: list(String.t)) - String that identifies the series
  • opts (type: keyword()) - Call options

Returns

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

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

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

Returns Series membership data given the series id.

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").
    • :page_size (type: integer()) - Number of maximum results per page to be included in the response.
    • :page_token (type: String.t) - The value of the nextToken from the previous page.
    • :series_id (type: String.t) - String that identifies the series
  • opts (type: keyword()) - Call options

Returns

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