Blame - docs/dyn/books_v1.layers.volumeAnnotations.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame^]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

81

<code><a href="#get">get(volumeId, layerId, annotationId, source=None, locale=None, x__xgafv=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

82

<p class="firstline">Gets the volume annotation.</p>

83

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

84

<code><a href="#list">list(volumeId, layerId, startOffset=None, locale=None, endOffset=None, source=None, contentVersion=None, startPosition=None, showDeleted=None, volumeAnnotationsVersion=None, endPosition=None, updatedMin=None, updatedMax=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

85

<p class="firstline">Gets the volume annotations for a volume and layer.</p>

86

87

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

<h3>Method Details</h3>

90

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

91

<code class="details" id="close">close()</code>

92

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

96

<code class="details" id="get">get(volumeId, layerId, annotationId, source=None, locale=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

97

<pre>Gets the volume annotation.

98

99

Args:

100

volumeId: string, The volume to retrieve annotations for. (required)

101

layerId: string, The ID for the layer to get the annotations. (required)

102

annotationId: string, The ID of the volume annotation to retrieve. (required)

103

source: string, String to identify the originator of this request.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

104

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

105

x__xgafv: string, V1 error format.

106

Allowed values

107

1 - v1 error format

108

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

109

110

Returns:

111

An object of the form:

112

113

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

114

"annotationType": "A String", # The type of annotation this is.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

115

"selfLink": "A String", # URL to this resource.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

116

"pageIds": [ # Pages the annotation spans.

117

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

118

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

119

"contentRanges": { # The content ranges to identify the selected text.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

120

"cfiRange": { # Range in CFI format for this annotation for version above.

121

"endPosition": "A String", # The ending position for the range.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

122

"startPosition": "A String", # The starting position for the range.

123

"endOffset": "A String", # The offset from the ending position.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

124

"startOffset": "A String", # The offset from the starting position.

125

},

126

"gbImageRange": { # Range in GB image format for this annotation for version above.

127

"endPosition": "A String", # The ending position for the range.

128

"startPosition": "A String", # The starting position for the range.

129

"endOffset": "A String", # The offset from the ending position.

130

"startOffset": "A String", # The offset from the starting position.

131

},

132

"contentVersion": "A String", # Content version applicable to ranges below.

133

"gbTextRange": { # Range in GB text format for this annotation for version above.

134

"endPosition": "A String", # The ending position for the range.

135

"startPosition": "A String", # The starting position for the range.

136

"endOffset": "A String", # The offset from the ending position.

137

"startOffset": "A String", # The offset from the starting position.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

138

},

139

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

140

"updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).

141

"annotationDataId": "A String", # The annotation data id for this volume annotation.

142

"kind": "A String", # Resource Type

143

"layerId": "A String", # The Layer this annotation is for.

144

"selectedText": "A String", # Excerpt from the volume.

145

"id": "A String", # Unique id of this volume annotation.

146

"volumeId": "A String", # The Volume this annotation is for.

147

"annotationDataLink": "A String", # Link to get data for this annotation.

148

"data": "A String", # Data for this annotation.

149

"deleted": True or False, # Indicates that this annotation is deleted.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

154

<code class="details" id="list">list(volumeId, layerId, startOffset=None, locale=None, endOffset=None, source=None, contentVersion=None, startPosition=None, showDeleted=None, volumeAnnotationsVersion=None, endPosition=None, updatedMin=None, updatedMax=None, maxResults=None, pageToken=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

155

<pre>Gets the volume annotations for a volume and layer.

156

157

Args:

158

volumeId: string, The volume to retrieve annotations for. (required)

159

layerId: string, The ID for the layer to get the annotations. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

160

startOffset: string, The start offset to start retrieving data from.

161

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

162

endOffset: string, The end offset to end retrieving data from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

163

source: string, String to identify the originator of this request.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

164

contentVersion: string, The content version for the requested volume.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

165

startPosition: string, The start position to start retrieving data from.

166

showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

167

volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting.

168

endPosition: string, The end position to end retrieving data from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

169

updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

170

updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

171

maxResults: integer, Maximum number of results to return

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

172

pageToken: string, The value of the nextToken from the previous page.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

173

x__xgafv: string, V1 error format.

174

Allowed values

175

1 - v1 error format

176

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

177

178

Returns:

179

An object of the form:

180

181

{

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

182

"items": [ # A list of volume annotations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

183

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

184

"annotationType": "A String", # The type of annotation this is.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

185

"selfLink": "A String", # URL to this resource.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

186

"pageIds": [ # Pages the annotation spans.

187

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

188

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

189

"contentRanges": { # The content ranges to identify the selected text.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

190

"cfiRange": { # Range in CFI format for this annotation for version above.

191

"endPosition": "A String", # The ending position for the range.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

192

"startPosition": "A String", # The starting position for the range.

193

"endOffset": "A String", # The offset from the ending position.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

194

"startOffset": "A String", # The offset from the starting position.

195

},

196

"gbImageRange": { # Range in GB image format for this annotation for version above.

197

"endPosition": "A String", # The ending position for the range.

198

"startPosition": "A String", # The starting position for the range.

199

"endOffset": "A String", # The offset from the ending position.

200

"startOffset": "A String", # The offset from the starting position.

201

},

202

"contentVersion": "A String", # Content version applicable to ranges below.

203

"gbTextRange": { # Range in GB text format for this annotation for version above.

204

"endPosition": "A String", # The ending position for the range.

205

"startPosition": "A String", # The starting position for the range.

206

"endOffset": "A String", # The offset from the ending position.

207

"startOffset": "A String", # The offset from the starting position.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

208

},

209

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

210

"updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).

211

"annotationDataId": "A String", # The annotation data id for this volume annotation.

212

"kind": "A String", # Resource Type

213

"layerId": "A String", # The Layer this annotation is for.

214

"selectedText": "A String", # Excerpt from the volume.

215

"id": "A String", # Unique id of this volume annotation.

216

"volumeId": "A String", # The Volume this annotation is for.

217

"annotationDataLink": "A String", # Link to get data for this annotation.

218

"data": "A String", # Data for this annotation.

219

"deleted": True or False, # Indicates that this annotation is deleted.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

220

},

221

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

222

"totalItems": 42, # The total number of volume annotations found.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

223

"version": "A String", # The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

224

"nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

225

"kind": "A String", # Resource type

John Asmuth