Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 84e4180c0b4b453ee9fc59f026e00631bc7af2d2 / . / docs / dyn / books.v1.mylibrary.annotations.html
blob: 43668b27707e8a1778d82f8a63fc31ff230748eb [file] [log] [blame]
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes&nbsp;an&nbsp;annotation.<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]20&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]22&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]23&nbsp;&nbsp;annotationId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;for&nbsp;the&nbsp;annotation&nbsp;to&nbsp;delete.&nbsp;(required)<br>
24&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
25&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter</tt></dd></dl>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]26
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]27<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;an&nbsp;annotation&nbsp;by&nbsp;its&nbsp;ID.<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]28&nbsp;<br>
29Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]30&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
31&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]32&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]33&nbsp;&nbsp;annotationId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;for&nbsp;the&nbsp;annotation&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]34&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
35&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]36&nbsp;<br>
37Returns:<br>
38&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
39&nbsp;<br>
40&nbsp;&nbsp;&nbsp;&nbsp;{<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotation",&nbsp;#&nbsp;Resource&nbsp;type.<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;annotation&nbsp;was&nbsp;modified.<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;created&nbsp;time&nbsp;of&nbsp;this&nbsp;annotation.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Indicates&nbsp;that&nbsp;this&nbsp;annotation&nbsp;is&nbsp;deleted.<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"beforeSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;before&nbsp;excerpt.<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currentVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;for&nbsp;the&nbsp;most&nbsp;recent&nbsp;content&nbsp;version.<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;applicable&nbsp;to&nbsp;ranges&nbsp;below.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
61&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
66&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"afterSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;after&nbsp;excerpt.<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clientVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;sent&nbsp;from&nbsp;the&nbsp;client.<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;the&nbsp;client&nbsp;sent&nbsp;in.<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
72&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
73&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
74&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
75&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
89&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;that&nbsp;this&nbsp;annotation&nbsp;belongs&nbsp;to.<br>
90&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pageIds":&nbsp;[&nbsp;#&nbsp;Pages&nbsp;that&nbsp;this&nbsp;annotation&nbsp;spans.<br>
91&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
92&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
93&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;layer&nbsp;this&nbsp;annotation&nbsp;is&nbsp;for.<br>
94&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Excerpt&nbsp;from&nbsp;the&nbsp;volume.<br>
95&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"highlightStyle":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;highlight&nbsp;style&nbsp;for&nbsp;this&nbsp;annotation.<br>
96&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;User-created&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation.<br>
97&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;annotation,&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;GUID.<br>
98&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
99&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
100
101<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts&nbsp;a&nbsp;new&nbsp;annotation.<br>
102&nbsp;<br>
103Args:<br>
104&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
105&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
106&nbsp;<br>
107{<br>
108&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotation",&nbsp;#&nbsp;Resource&nbsp;type.<br>
109&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;annotation&nbsp;was&nbsp;modified.<br>
110&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;created&nbsp;time&nbsp;of&nbsp;this&nbsp;annotation.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]111&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Indicates&nbsp;that&nbsp;this&nbsp;annotation&nbsp;is&nbsp;deleted.<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]112&nbsp;&nbsp;&nbsp;&nbsp;"beforeSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;before&nbsp;excerpt.<br>
113&nbsp;&nbsp;&nbsp;&nbsp;"currentVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;for&nbsp;the&nbsp;most&nbsp;recent&nbsp;content&nbsp;version.<br>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;applicable&nbsp;to&nbsp;ranges&nbsp;below.<br>
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
133&nbsp;&nbsp;&nbsp;&nbsp;},<br>
134&nbsp;&nbsp;&nbsp;&nbsp;"afterSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;after&nbsp;excerpt.<br>
135&nbsp;&nbsp;&nbsp;&nbsp;"clientVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;sent&nbsp;from&nbsp;the&nbsp;client.<br>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;the&nbsp;client&nbsp;sent&nbsp;in.<br>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
155&nbsp;&nbsp;&nbsp;&nbsp;},<br>
156&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;that&nbsp;this&nbsp;annotation&nbsp;belongs&nbsp;to.<br>
157&nbsp;&nbsp;&nbsp;&nbsp;"pageIds":&nbsp;[&nbsp;#&nbsp;Pages&nbsp;that&nbsp;this&nbsp;annotation&nbsp;spans.<br>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
159&nbsp;&nbsp;&nbsp;&nbsp;],<br>
160&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;layer&nbsp;this&nbsp;annotation&nbsp;is&nbsp;for.<br>
161&nbsp;&nbsp;&nbsp;&nbsp;"selectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Excerpt&nbsp;from&nbsp;the&nbsp;volume.<br>
162&nbsp;&nbsp;&nbsp;&nbsp;"highlightStyle":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;highlight&nbsp;style&nbsp;for&nbsp;this&nbsp;annotation.<br>
163&nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;User-created&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation.<br>
164&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;annotation,&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;GUID.<br>
165&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
166&nbsp;&nbsp;}<br>
167&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]168&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
169&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]170&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]171&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
172&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]173&nbsp;<br>
174Returns:<br>
175&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
176&nbsp;<br>
177&nbsp;&nbsp;&nbsp;&nbsp;{<br>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotation",&nbsp;#&nbsp;Resource&nbsp;type.<br>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;annotation&nbsp;was&nbsp;modified.<br>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;created&nbsp;time&nbsp;of&nbsp;this&nbsp;annotation.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Indicates&nbsp;that&nbsp;this&nbsp;annotation&nbsp;is&nbsp;deleted.<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"beforeSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;before&nbsp;excerpt.<br>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currentVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;for&nbsp;the&nbsp;most&nbsp;recent&nbsp;content&nbsp;version.<br>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;applicable&nbsp;to&nbsp;ranges&nbsp;below.<br>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
201&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"afterSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;after&nbsp;excerpt.<br>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clientVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;sent&nbsp;from&nbsp;the&nbsp;client.<br>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;the&nbsp;client&nbsp;sent&nbsp;in.<br>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
217&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
224&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
225&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;that&nbsp;this&nbsp;annotation&nbsp;belongs&nbsp;to.<br>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pageIds":&nbsp;[&nbsp;#&nbsp;Pages&nbsp;that&nbsp;this&nbsp;annotation&nbsp;spans.<br>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
229&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;layer&nbsp;this&nbsp;annotation&nbsp;is&nbsp;for.<br>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Excerpt&nbsp;from&nbsp;the&nbsp;volume.<br>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"highlightStyle":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;highlight&nbsp;style&nbsp;for&nbsp;this&nbsp;annotation.<br>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;User-created&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation.<br>
234&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;annotation,&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;GUID.<br>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
236&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
237
238<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;list&nbsp;of&nbsp;annotations,&nbsp;possibly&nbsp;filtered.<br>
239&nbsp;<br>
240Args:<br>
241&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;The&nbsp;value&nbsp;of&nbsp;the&nbsp;nextToken&nbsp;from&nbsp;the&nbsp;previous&nbsp;page.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]242&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
243&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]244&nbsp;&nbsp;updatedMax:&nbsp;string,&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp&nbsp;to&nbsp;restrict&nbsp;to&nbsp;items&nbsp;updated&nbsp;prior&nbsp;to&nbsp;this&nbsp;timestamp&nbsp;(exclusive).<br>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]245&nbsp;&nbsp;layerId:&nbsp;string,&nbsp;The&nbsp;layer&nbsp;ID&nbsp;to&nbsp;limit&nbsp;annotation&nbsp;by.<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]246&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;The&nbsp;volume&nbsp;to&nbsp;restrict&nbsp;annotations&nbsp;to.<br>
247&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]248&nbsp;&nbsp;showDeleted:&nbsp;boolean,&nbsp;Set&nbsp;to&nbsp;true&nbsp;to&nbsp;return&nbsp;deleted&nbsp;annotations.&nbsp;updatedMin&nbsp;must&nbsp;be&nbsp;in&nbsp;the&nbsp;request&nbsp;to&nbsp;use&nbsp;this.&nbsp;Defaults&nbsp;to&nbsp;false.<br>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]249&nbsp;&nbsp;pageIds:&nbsp;string,&nbsp;The&nbsp;page&nbsp;ID(s)&nbsp;for&nbsp;the&nbsp;volume&nbsp;that&nbsp;is&nbsp;being&nbsp;queried.&nbsp;(repeated)<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]250&nbsp;&nbsp;contentVersion:&nbsp;string,&nbsp;The&nbsp;content&nbsp;version&nbsp;for&nbsp;the&nbsp;requested&nbsp;volume.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]251&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]252&nbsp;&nbsp;updatedMin:&nbsp;string,&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp&nbsp;to&nbsp;restrict&nbsp;to&nbsp;items&nbsp;updated&nbsp;since&nbsp;this&nbsp;timestamp&nbsp;(inclusive).<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]253&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
254&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]255&nbsp;<br>
256Returns:<br>
257&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
258&nbsp;<br>
259&nbsp;&nbsp;&nbsp;&nbsp;{<br>
260&nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Token&nbsp;to&nbsp;pass&nbsp;in&nbsp;for&nbsp;pagination&nbsp;for&nbsp;the&nbsp;next&nbsp;page.&nbsp;This&nbsp;will&nbsp;not&nbsp;be&nbsp;present&nbsp;if&nbsp;this&nbsp;request&nbsp;does&nbsp;not&nbsp;have&nbsp;more&nbsp;results.<br>
261&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;annotations.<br>
262&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
263&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotation",&nbsp;#&nbsp;Resource&nbsp;type.<br>
264&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;annotation&nbsp;was&nbsp;modified.<br>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;created&nbsp;time&nbsp;of&nbsp;this&nbsp;annotation.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Indicates&nbsp;that&nbsp;this&nbsp;annotation&nbsp;is&nbsp;deleted.<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]267&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"beforeSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;before&nbsp;excerpt.<br>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currentVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;for&nbsp;the&nbsp;most&nbsp;recent&nbsp;content&nbsp;version.<br>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;applicable&nbsp;to&nbsp;ranges&nbsp;below.<br>
270&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
272&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
275&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
277&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
278&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
279&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
280&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
281&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
283&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
285&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
286&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
287&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
288&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
289&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"afterSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;after&nbsp;excerpt.<br>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clientVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;sent&nbsp;from&nbsp;the&nbsp;client.<br>
291&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;the&nbsp;client&nbsp;sent&nbsp;in.<br>
292&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
293&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
294&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
295&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
296&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
298&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
299&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
300&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
301&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
302&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
303&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
304&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
305&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
306&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
307&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
308&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
309&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
310&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
311&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;that&nbsp;this&nbsp;annotation&nbsp;belongs&nbsp;to.<br>
312&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pageIds":&nbsp;[&nbsp;#&nbsp;Pages&nbsp;that&nbsp;this&nbsp;annotation&nbsp;spans.<br>
313&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
315&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;layer&nbsp;this&nbsp;annotation&nbsp;is&nbsp;for.<br>
316&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Excerpt&nbsp;from&nbsp;the&nbsp;volume.<br>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"highlightStyle":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;highlight&nbsp;style&nbsp;for&nbsp;this&nbsp;annotation.<br>
318&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;User-created&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation.<br>
319&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;annotation,&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;GUID.<br>
320&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
321&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
322&nbsp;&nbsp;&nbsp;&nbsp;],<br>
323&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotations",&nbsp;#&nbsp;Resource&nbsp;type.<br>
324&nbsp;&nbsp;&nbsp;&nbsp;"totalItems":&nbsp;42,&nbsp;#&nbsp;Total&nbsp;number&nbsp;of&nbsp;annotations&nbsp;found.&nbsp;This&nbsp;may&nbsp;be&nbsp;greater&nbsp;than&nbsp;the&nbsp;number&nbsp;of&nbsp;notes&nbsp;returned&nbsp;in&nbsp;this&nbsp;response&nbsp;if&nbsp;results&nbsp;have&nbsp;been&nbsp;paginated.<br>
325&nbsp;&nbsp;}</tt></dd></dl>
326
327<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
328&nbsp;<br>
329Args:<br>
330&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
331&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
332&nbsp;<br>
333Returns:<br>
334&nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
335&nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</tt></dd></dl>
336
337<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;an&nbsp;existing&nbsp;annotation.<br>
338&nbsp;<br>
339Args:<br>
340&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
341&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
342&nbsp;<br>
343{<br>
344&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotation",&nbsp;#&nbsp;Resource&nbsp;type.<br>
345&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;annotation&nbsp;was&nbsp;modified.<br>
346&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;created&nbsp;time&nbsp;of&nbsp;this&nbsp;annotation.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]347&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Indicates&nbsp;that&nbsp;this&nbsp;annotation&nbsp;is&nbsp;deleted.<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]348&nbsp;&nbsp;&nbsp;&nbsp;"beforeSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;before&nbsp;excerpt.<br>
349&nbsp;&nbsp;&nbsp;&nbsp;"currentVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;for&nbsp;the&nbsp;most&nbsp;recent&nbsp;content&nbsp;version.<br>
350&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;applicable&nbsp;to&nbsp;ranges&nbsp;below.<br>
351&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
352&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
353&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
354&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
355&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
356&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
357&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
358&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
359&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
360&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
361&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
362&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
363&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
364&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
365&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
366&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
367&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
368&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
369&nbsp;&nbsp;&nbsp;&nbsp;},<br>
370&nbsp;&nbsp;&nbsp;&nbsp;"afterSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;after&nbsp;excerpt.<br>
371&nbsp;&nbsp;&nbsp;&nbsp;"clientVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;sent&nbsp;from&nbsp;the&nbsp;client.<br>
372&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;the&nbsp;client&nbsp;sent&nbsp;in.<br>
373&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
374&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
375&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
376&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
377&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
378&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
379&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
380&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
381&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
382&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
383&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
384&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
385&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
386&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
387&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
388&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
389&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
390&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
391&nbsp;&nbsp;&nbsp;&nbsp;},<br>
392&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;that&nbsp;this&nbsp;annotation&nbsp;belongs&nbsp;to.<br>
393&nbsp;&nbsp;&nbsp;&nbsp;"pageIds":&nbsp;[&nbsp;#&nbsp;Pages&nbsp;that&nbsp;this&nbsp;annotation&nbsp;spans.<br>
394&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
395&nbsp;&nbsp;&nbsp;&nbsp;],<br>
396&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;layer&nbsp;this&nbsp;annotation&nbsp;is&nbsp;for.<br>
397&nbsp;&nbsp;&nbsp;&nbsp;"selectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Excerpt&nbsp;from&nbsp;the&nbsp;volume.<br>
398&nbsp;&nbsp;&nbsp;&nbsp;"highlightStyle":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;highlight&nbsp;style&nbsp;for&nbsp;this&nbsp;annotation.<br>
399&nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;User-created&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation.<br>
400&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;annotation,&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;GUID.<br>
401&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
402&nbsp;&nbsp;}<br>
403&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]404&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
405&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]406&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]407&nbsp;&nbsp;annotationId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;for&nbsp;the&nbsp;annotation&nbsp;to&nbsp;update.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]408&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
409&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]410&nbsp;<br>
411Returns:<br>
412&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
413&nbsp;<br>
414&nbsp;&nbsp;&nbsp;&nbsp;{<br>
415&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotation",&nbsp;#&nbsp;Resource&nbsp;type.<br>
416&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;annotation&nbsp;was&nbsp;modified.<br>
417&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;created&nbsp;time&nbsp;of&nbsp;this&nbsp;annotation.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]418&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Indicates&nbsp;that&nbsp;this&nbsp;annotation&nbsp;is&nbsp;deleted.<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]419&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"beforeSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;before&nbsp;excerpt.<br>
420&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currentVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;for&nbsp;the&nbsp;most&nbsp;recent&nbsp;content&nbsp;version.<br>
421&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;applicable&nbsp;to&nbsp;ranges&nbsp;below.<br>
422&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
423&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
424&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
425&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
426&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
427&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
428&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
429&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
430&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
431&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
432&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
433&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
434&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;for&nbsp;version&nbsp;above.<br>
435&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
436&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
437&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
438&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
439&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
440&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
441&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"afterSelectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Anchor&nbsp;text&nbsp;after&nbsp;excerpt.<br>
442&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clientVersionRanges":&nbsp;{&nbsp;#&nbsp;Selection&nbsp;ranges&nbsp;sent&nbsp;from&nbsp;the&nbsp;client.<br>
443&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Content&nbsp;version&nbsp;the&nbsp;client&nbsp;sent&nbsp;in.<br>
444&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbTextRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;text&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
445&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
446&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
447&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
448&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
449&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
450&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cfiRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;CFI&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
451&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
452&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
453&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
454&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
455&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
456&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gbImageRange":&nbsp;{&nbsp;#&nbsp;Range&nbsp;in&nbsp;GB&nbsp;image&nbsp;format&nbsp;for&nbsp;this&nbsp;annotation&nbsp;sent&nbsp;by&nbsp;client.<br>
457&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;starting&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
458&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endPosition":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ending&nbsp;position&nbsp;for&nbsp;the&nbsp;range.<br>
459&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;starting&nbsp;position.<br>
460&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endOffset":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;offset&nbsp;from&nbsp;the&nbsp;ending&nbsp;position.<br>
461&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
462&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
463&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;that&nbsp;this&nbsp;annotation&nbsp;belongs&nbsp;to.<br>
464&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pageIds":&nbsp;[&nbsp;#&nbsp;Pages&nbsp;that&nbsp;this&nbsp;annotation&nbsp;spans.<br>
465&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
466&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
467&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;layer&nbsp;this&nbsp;annotation&nbsp;is&nbsp;for.<br>
468&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selectedText":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Excerpt&nbsp;from&nbsp;the&nbsp;volume.<br>
469&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"highlightStyle":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;highlight&nbsp;style&nbsp;for&nbsp;this&nbsp;annotation.<br>
470&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;User-created&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation.<br>
471&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;annotation,&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;GUID.<br>
472&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
473&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
474
475<hr>
476Data descriptors defined here:<br>
477<dl><dt><strong>__dict__</strong></dt>
478<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
479</dl>
480<dl><dt><strong>__weakref__</strong></dt>
481<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
482</dl>
483</td></tr></table>
484</body></html>