google_api_books v0.2.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, series_id, optional_params \\ [], opts \\ [])
View Source
Returns Series metadata for the given series ids.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- series_id ([String.t]): String that identifies the series
optional_params (KeywordList): [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.Series{}} on success {:error, info} on failure
Link to this function
books_series_membership_get(connection, series_id, optional_params \\ [], opts \\ [])
View Source
Returns Series membership data given the series id.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- series_id (String.t): String that identifies the series
optional_params (KeywordList): [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.
- :page_size (integer()): Number of maximum results per page to be included in the response.
- :page_token (String.t): The value of the nextToken from the previous page.
Returns
{:ok, %GoogleApi.Books.V1.Model.Seriesmembership{}} on success {:error, info} on failure