Books API . layers

close()

Close httplib2 connections.

get(volumeId, summaryId, contentVersion=None, source=None, x__xgafv=None)

Gets the layer summary for a volume.

Args:
  volumeId: string, The volume to retrieve layers for. (required)
  summaryId: string, The ID for the layer to get the summary for. (required)
  contentVersion: string, The content version for the requested volume.
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "annotationCount": 42, # The number of annotations for this layer.
  "annotationTypes": [ # The list of annotation types contained for this layer.
    "A String",
  ],
  "annotationsDataLink": "A String", # Link to get data for this annotation.
  "annotationsLink": "A String", # The link to get the annotations for this layer.
  "contentVersion": "A String", # The content version this resource is for.
  "dataCount": 42, # The number of data items for this layer.
  "id": "A String", # Unique id of this layer summary.
  "kind": "A String", # Resource Type
  "layerId": "A String", # The layer id for this summary.
  "selfLink": "A String", # URL to this resource.
  "updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
  "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
  "volumeId": "A String", # The volume id this resource is for.
}

list(volumeId, contentVersion=None, maxResults=None, pageToken=None, source=None, x__xgafv=None)

List the layer summaries for a volume.

Args:
  volumeId: string, The volume to retrieve layers for. (required)
  contentVersion: string, The content version for the requested volume.
  maxResults: integer, Maximum number of results to return
  pageToken: string, The value of the nextToken from the previous page.
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "items": [ # A list of layer summary items.
    {
      "annotationCount": 42, # The number of annotations for this layer.
      "annotationTypes": [ # The list of annotation types contained for this layer.
        "A String",
      ],
      "annotationsDataLink": "A String", # Link to get data for this annotation.
      "annotationsLink": "A String", # The link to get the annotations for this layer.
      "contentVersion": "A String", # The content version this resource is for.
      "dataCount": 42, # The number of data items for this layer.
      "id": "A String", # Unique id of this layer summary.
      "kind": "A String", # Resource Type
      "layerId": "A String", # The layer id for this summary.
      "selfLink": "A String", # URL to this resource.
      "updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
      "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
      "volumeId": "A String", # The volume id this resource is for.
    },
  ],
  "kind": "A String", # Resource type.
  "totalItems": 42, # The total number of layer summaries found.
}