docs/dyn/books_v1.mylibrary.annotations.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.mylibrary.html">mylibrary</a> . <a href="books_v1.mylibrary.annotations.html">annotations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#delete">delete(annotationId, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an annotation.</p>
<p class="toc_element">
  <code><a href="#insert">insert(annotationId=None, body=None, country=None, showOnlySummaryInResponse=None, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new annotation.</p>
<p class="toc_element">
  <code><a href="#list">list(contentVersion=None, layerId=None, layerIds=None, maxResults=None, pageToken=None, showDeleted=None, source=None, updatedMax=None, updatedMin=None, volumeId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of annotations, possibly filtered.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#summary">summary(layerIds, volumeId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the summary of specified layers.</p>
<p class="toc_element">
  <code><a href="#update">update(annotationId, body=None, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing annotation.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(annotationId, source=None, x__xgafv=None)</code>
  <pre>Deletes an annotation.

Args:
  annotationId: string, The ID for the annotation to delete. (required)
  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:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(annotationId=None, body=None, country=None, showOnlySummaryInResponse=None, source=None, x__xgafv=None)</code>
  <pre>Inserts a new annotation.

Args:
  body: object, The request body.
    The object takes the form of:

{
  &quot;afterSelectedText&quot;: &quot;A String&quot;, # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
  &quot;beforeSelectedText&quot;: &quot;A String&quot;, # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
  &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
    &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
  },
  &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
  &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
    &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
  },
  &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
  &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
  &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
  &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
  &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
  &quot;layerSummary&quot;: {
    &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
    &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
    &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
  },
  &quot;pageIds&quot;: [ # Pages that this annotation spans.
    &quot;A String&quot;,
  ],
  &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
  &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
  &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
  &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
}

  annotationId: string, The ID for the annotation to insert.
  country: string, ISO-3166-1 code to override the IP-based location.
  showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
  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:

    {
  &quot;afterSelectedText&quot;: &quot;A String&quot;, # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
  &quot;beforeSelectedText&quot;: &quot;A String&quot;, # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
  &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
    &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
  },
  &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
  &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
    &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
  },
  &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
  &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
  &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
  &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
  &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
  &quot;layerSummary&quot;: {
    &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
    &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
    &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
  },
  &quot;pageIds&quot;: [ # Pages that this annotation spans.
    &quot;A String&quot;,
  ],
  &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
  &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
  &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
  &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(contentVersion=None, layerId=None, layerIds=None, maxResults=None, pageToken=None, showDeleted=None, source=None, updatedMax=None, updatedMin=None, volumeId=None, x__xgafv=None)</code>
  <pre>Retrieves a list of annotations, possibly filtered.

Args:
  contentVersion: string, The content version for the requested volume.
  layerId: string, The layer ID to limit annotation by.
  layerIds: string, The layer ID(s) to limit annotation by. (repeated)
  maxResults: integer, Maximum number of results to return
  pageToken: string, 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, String to identify the originator of this request.
  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
  updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
  volumeId: string, The volume to restrict annotations to.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;items&quot;: [ # A list of annotations.
    {
      &quot;afterSelectedText&quot;: &quot;A String&quot;, # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
      &quot;beforeSelectedText&quot;: &quot;A String&quot;, # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
      &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
        &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
        },
        &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
        &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
        },
        &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
        },
        &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
        },
      },
      &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
      &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
        &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
        },
        &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
        &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
        },
        &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
        },
        &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
        },
      },
      &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
      &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
      &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
      &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
      &quot;kind&quot;: &quot;A String&quot;, # Resource type.
      &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
      &quot;layerSummary&quot;: {
        &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
        &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
        &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
      },
      &quot;pageIds&quot;: [ # Pages that this annotation spans.
        &quot;A String&quot;,
      ],
      &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
      &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
      &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
      &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
  &quot;totalItems&quot;: 42, # Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="summary">summary(layerIds, volumeId, x__xgafv=None)</code>
  <pre>Gets the summary of specified layers.

Args:
  layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
  volumeId: string, Volume id to get the summary for. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;kind&quot;: &quot;A String&quot;,
  &quot;layers&quot;: [
    {
      &quot;allowedCharacterCount&quot;: 42,
      &quot;layerId&quot;: &quot;A String&quot;,
      &quot;limitType&quot;: &quot;A String&quot;,
      &quot;remainingCharacterCount&quot;: 42,
      &quot;updated&quot;: &quot;A String&quot;,
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="update">update(annotationId, body=None, source=None, x__xgafv=None)</code>
  <pre>Updates an existing annotation.

Args:
  annotationId: string, The ID for the annotation to update. (required)
  body: object, The request body.
    The object takes the form of:

{
  &quot;afterSelectedText&quot;: &quot;A String&quot;, # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
  &quot;beforeSelectedText&quot;: &quot;A String&quot;, # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
  &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
    &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
  },
  &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
  &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
    &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
  },
  &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
  &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
  &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
  &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
  &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
  &quot;layerSummary&quot;: {
    &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
    &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
    &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
  },
  &quot;pageIds&quot;: [ # Pages that this annotation spans.
    &quot;A String&quot;,
  ],
  &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
  &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
  &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
  &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
}

  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:

    {
  &quot;afterSelectedText&quot;: &quot;A String&quot;, # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
  &quot;beforeSelectedText&quot;: &quot;A String&quot;, # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
  &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
    &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
  },
  &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
  &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
    &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
    },
  },
  &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
  &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
  &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
  &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
  &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
  &quot;layerSummary&quot;: {
    &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
    &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
    &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
  },
  &quot;pageIds&quot;: [ # Pages that this annotation spans.
    &quot;A String&quot;,
  ],
  &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
  &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
  &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
  &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
}</pre>
</div>

</body></html>