google_api_books v0.2.0 GoogleApi.Books.V1.Api.Layers View Source
API calls for all endpoints tagged Layers
.
Link to this section Summary
Functions
Gets the annotation data
Gets the annotation data for a volume and layer
Gets the layer summary for a volume
List the layer summaries for a volume
Gets the volume annotation
Gets the volume annotations for a volume and layer
Link to this section Functions
Gets the annotation data.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- volume_id (String.t): The volume to retrieve annotations for.
- layer_id (String.t): The ID for the layer to get the annotations.
- annotation_data_id (String.t): The ID of the annotation data to retrieve.
- content_version (String.t): The content version for the volume you are trying to retrieve.
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.
- :allowWebDefinitions (boolean()): For the dictionary layer. Whether or not to allow web definitions.
- :h (integer()): The requested pixel height for any images. If height is provided width must also be provided.
- :locale (String.t): The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- :scale (integer()): The requested scale for the image.
- :source (String.t): String to identify the originator of this request.
- :w (integer()): The requested pixel width for any images. If width is provided height must also be provided.
Returns
{:ok, %GoogleApi.Books.V1.Model.Annotationdata{}} on success {:error, info} on failure
Gets the annotation data for a volume and layer.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- volume_id (String.t): The volume to retrieve annotation data for.
- layer_id (String.t): The ID for the layer to get the annotation data.
- content_version (String.t): The content version for the requested volume.
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.
- :annotationDataId ([String.t]): The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.
- :h (integer()): The requested pixel height for any images. If height is provided width must also be provided.
- :locale (String.t): The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- :maxResults (integer()): Maximum number of results to return
- :pageToken (String.t): The value of the nextToken from the previous page.
- :scale (integer()): The requested scale for the image.
- :source (String.t): String to identify the originator of this request.
- :updatedMax (String.t): RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- :updatedMin (String.t): RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
- :w (integer()): The requested pixel width for any images. If width is provided height must also be provided.
Returns
{:ok, %GoogleApi.Books.V1.Model.Annotationsdata{}} on success {:error, info} on failure
Gets the layer summary for a volume.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- volume_id (String.t): The volume to retrieve layers for.
- summary_id (String.t): The ID for the layer to get the summary for.
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.
- :contentVersion (String.t): The content version for the requested volume.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %GoogleApi.Books.V1.Model.Layersummary{}} on success {:error, info} on failure
List the layer summaries for a volume.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- volume_id (String.t): The volume to retrieve layers for.
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.
- :contentVersion (String.t): The content version for the requested volume.
- :maxResults (integer()): Maximum number of results to return
- :pageToken (String.t): The value of the nextToken from the previous page.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %GoogleApi.Books.V1.Model.Layersummaries{}} on success {:error, info} on failure
Gets the volume annotation.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- volume_id (String.t): The volume to retrieve annotations for.
- layer_id (String.t): The ID for the layer to get the annotations.
- annotation_id (String.t): The ID of the volume annotation to retrieve.
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.
- :locale (String.t): The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %GoogleApi.Books.V1.Model.Volumeannotation{}} on success {:error, info} on failure
Gets the volume annotations for a volume and layer.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- volume_id (String.t): The volume to retrieve annotations for.
- layer_id (String.t): The ID for the layer to get the annotations.
- content_version (String.t): The content version for the requested volume.
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.
- :endOffset (String.t): The end offset to end retrieving data from.
- :endPosition (String.t): The end position to end retrieving data from.
- :locale (String.t): The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- :maxResults (integer()): Maximum number of results to return
- :pageToken (String.t): The value of the nextToken from the previous page.
- :showDeleted (boolean()): Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
- :source (String.t): String to identify the originator of this request.
- :startOffset (String.t): The start offset to start retrieving data from.
- :startPosition (String.t): The start position to start retrieving data from.
- :updatedMax (String.t): RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- :updatedMin (String.t): RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
- :volumeAnnotationsVersion (String.t): The version of the volume annotations that you are requesting.
Returns
{:ok, %GoogleApi.Books.V1.Model.Volumeannotations{}} on success {:error, info} on failure