Gets the volume annotations for a volume and layer.

Scopes

You will need authorization for the https://www.googleapis.com/auth/books scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/books. You can set the scope for this method like this: books1 --scope <scope> layers volume-annotations-list ...

Required Scalar Arguments

  • <volume-id> (string)
    • The volume to retrieve annotations for.
  • <layer-id> (string)
    • The ID for the layer to get the annotations.
  • <content-version> (string)
    • The content version for the requested volume.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p end-offset=string

    • The end offset to end retrieving data from.

  • -p end-position=string

    • The end position to end retrieving data from.

  • -p locale=string

    • The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

  • -p max-results=integer

    • Maximum number of results to return

  • -p page-token=string

    • The value of the nextToken from the previous page.

  • -p show-deleted=boolean

    • Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

  • -p source=string

    • String to identify the originator of this request.

  • -p start-offset=string

    • The start offset to start retrieving data from.

  • -p start-position=string

    • The start position to start retrieving data from.

  • -p updated-max=string

    • RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

  • -p updated-min=string

    • RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

  • -p volume-annotations-version=string

    • The version of the volume annotations that you are requesting.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • 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.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • 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.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").