Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / sheets_v4.spreadsheets.developerMetadata.html
blob: 1b582c7e9ea06ac6d9059537d06b7e1f98deb648 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="sheets_v4.html">Google Sheets API</a> . <a href="sheets_v4.spreadsheets.html">spreadsheets</a> . <a href="sheets_v4.spreadsheets.developerMetadata.html">developerMetadata</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(spreadsheetId, metadataId, x__xgafv=None)</a></code></p>
79<p class="firstline">Returns the developer metadata with the specified ID.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#search">search(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Returns all developer metadata matching the specified DataFilter.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="get">get(spreadsheetId, metadataId, x__xgafv=None)</code>
86 <pre>Returns the developer metadata with the specified ID.
87The caller must specify the spreadsheet ID and the developer metadata's
88unique metadataId.
89
90Args:
91 spreadsheetId: string, The ID of the spreadsheet to retrieve metadata from. (required)
92 metadataId: integer, The ID of the developer metadata to retrieve. (required)
93 x__xgafv: string, V1 error format.
94 Allowed values
95 1 - v1 error format
96 2 - v2 error format
97
98Returns:
99 An object of the form:
100
101 { # Developer metadata associated with a location or object in a spreadsheet.
102 # Developer metadata may be used to associate arbitrary data with various
103 # parts of a spreadsheet and will remain associated at those locations as they
104 # move around and the spreadsheet is edited. For example, if developer
105 # metadata is associated with row 5 and another row is then subsequently
106 # inserted above row 5, that original metadata will still be associated with
107 # the row it was first associated with (what is now row 6). If the associated
108 # object is deleted its metadata is deleted too.
109 "metadataId": 42, # The spreadsheet-scoped unique ID that identifies the metadata. IDs may be
110 # specified when metadata is created, otherwise one will be randomly
111 # generated and assigned. Must be positive.
112 "metadataValue": "A String", # Data associated with the metadata's key.
113 "location": { # A location where metadata may be associated in a spreadsheet. # The location where the metadata is associated.
114 "locationType": "A String", # The type of location this object represents. This field is read-only.
115 "dimensionRange": { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
116 # a dimension. The specified DimensionRange must represent a single row
117 # or column; it cannot be unbounded or span multiple rows or columns.
118 # All indexes are zero-based.
119 # Indexes are half open: the start index is inclusive
120 # and the end index is exclusive.
121 # Missing indexes indicate the range is unbounded on that side.
122 "endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.
123 "startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.
124 "sheetId": 42, # The sheet this span is on.
125 "dimension": "A String", # The dimension of the span.
126 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 "sheetId": 42, # The ID of the sheet when metadata is associated with an entire sheet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]128 "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 },
130 "visibility": "A String", # The metadata visibility. Developer metadata must always have a visibility
131 # specified.
132 "metadataKey": "A String", # The metadata key. There may be multiple metadata in a spreadsheet with the
133 # same key. Developer metadata must always have a key specified.
134 }</pre>
135</div>
136
137<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]138 <code class="details" id="search">search(spreadsheetId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 <pre>Returns all developer metadata matching the specified DataFilter.
140If the provided DataFilter represents a DeveloperMetadataLookup object,
141this will return all DeveloperMetadata entries selected by it. If the
142DataFilter represents a location in a spreadsheet, this will return all
143developer metadata associated with locations intersecting that region.
144
145Args:
146 spreadsheetId: string, The ID of the spreadsheet to retrieve metadata from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 The object takes the form of:
149
150{ # A request to retrieve all developer metadata matching the set of specified
151 # criteria.
152 "dataFilters": [ # The data filters describing the criteria used to determine which
153 # DeveloperMetadata entries to return. DeveloperMetadata matching any of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]154 # specified filters are included in the response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 { # Filter that describes what data should be selected or returned from a
156 # request.
157 "developerMetadataLookup": { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
158 # described by this DeveloperMetadataLookup.
159 # example, if only a metadata ID is specified this considers the
160 # DeveloperMetadata with that particular unique ID. If a metadata key is
161 # specified, this considers all developer metadata with that key. If a
162 # key, visibility, and location type are all specified, this considers all
163 # developer metadata with that key and visibility that are associated with a
164 # location of that type. In general, this
165 # selects all DeveloperMetadata that matches the intersection of all the
166 # specified fields; any field or combination of fields may be specified.
167 "metadataLocation": { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
168 # the specified location. This field either matches exact locations or all
169 # intersecting locations according the specified
170 # locationMatchingStrategy.
171 "locationType": "A String", # The type of location this object represents. This field is read-only.
172 "dimensionRange": { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
173 # a dimension. The specified DimensionRange must represent a single row
174 # or column; it cannot be unbounded or span multiple rows or columns.
175 # All indexes are zero-based.
176 # Indexes are half open: the start index is inclusive
177 # and the end index is exclusive.
178 # Missing indexes indicate the range is unbounded on that side.
179 "endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.
180 "startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.
181 "sheetId": 42, # The sheet this span is on.
182 "dimension": "A String", # The dimension of the span.
183 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 "sheetId": 42, # The ID of the sheet when metadata is associated with an entire sheet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]185 "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 },
187 "metadataValue": "A String", # Limits the selected developer metadata to that which has a matching
188 # DeveloperMetadata.metadata_value.
189 "locationMatchingStrategy": "A String", # Determines how this lookup matches the location. If this field is
190 # specified as EXACT, only developer metadata associated on the exact
191 # location specified is matched. If this field is specified to INTERSECTING,
192 # developer metadata associated on intersecting locations is also
193 # matched. If left unspecified, this field assumes a default value of
194 # INTERSECTING.
195 # If this field is specified, a metadataLocation
196 # must also be specified.
197 "locationType": "A String", # Limits the selected developer metadata to those entries which are
198 # associated with locations of the specified type. For example, when this
199 # field is specified as ROW this lookup
200 # only considers developer metadata associated on rows. If the field is left
201 # unspecified, all location types are considered. This field cannot be
202 # specified as SPREADSHEET when
203 # the locationMatchingStrategy
204 # is specified as INTERSECTING or when the
205 # metadataLocation is specified as a
206 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
207 # developer metadata location. This field also must be left unspecified when
208 # the locationMatchingStrategy
209 # is specified as EXACT.
210 "metadataId": 42, # Limits the selected developer metadata to that which has a matching
211 # DeveloperMetadata.metadata_id.
212 "visibility": "A String", # Limits the selected developer metadata to that which has a matching
213 # DeveloperMetadata.visibility. If left unspecified, all developer
214 # metadata visibile to the requesting project is considered.
215 "metadataKey": "A String", # Limits the selected developer metadata to that which has a matching
216 # DeveloperMetadata.metadata_key.
217 },
218 "a1Range": "A String", # Selects data that matches the specified A1 range.
219 "gridRange": { # A range on a sheet. # Selects data that matches the range described by the GridRange.
220 # All indexes are zero-based.
221 # Indexes are half open, e.g the start index is inclusive
222 # and the end index is exclusive -- [start_index, end_index).
223 # Missing indexes indicate the range is unbounded on that side.
224 #
225 # For example, if `"Sheet1"` is sheet ID 0, then:
226 #
227 # `Sheet1!A1:A1 == sheet_id: 0,
228 # start_row_index: 0, end_row_index: 1,
229 # start_column_index: 0, end_column_index: 1`
230 #
231 # `Sheet1!A3:B4 == sheet_id: 0,
232 # start_row_index: 2, end_row_index: 4,
233 # start_column_index: 0, end_column_index: 2`
234 #
235 # `Sheet1!A:B == sheet_id: 0,
236 # start_column_index: 0, end_column_index: 2`
237 #
238 # `Sheet1!A5:B == sheet_id: 0,
239 # start_row_index: 4,
240 # start_column_index: 0, end_column_index: 2`
241 #
242 # `Sheet1 == sheet_id:0`
243 #
244 # The start index must always be less than or equal to the end index.
245 # If the start index equals the end index, then the range is empty.
246 # Empty ranges are typically not meaningful and are usually rendered in the
247 # UI as `#REF!`.
248 "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
249 "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
250 "sheetId": 42, # The sheet this range is on.
251 "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
252 "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
253 },
254 },
255 ],
256 }
257
258 x__xgafv: string, V1 error format.
259 Allowed values
260 1 - v1 error format
261 2 - v2 error format
262
263Returns:
264 An object of the form:
265
266 { # A reply to a developer metadata search request.
267 "matchedDeveloperMetadata": [ # The metadata matching the criteria of the search request.
268 { # A developer metadata entry and the data filters specified in the original
269 # request that matched it.
270 "dataFilters": [ # All filters matching the returned developer metadata.
271 { # Filter that describes what data should be selected or returned from a
272 # request.
273 "developerMetadataLookup": { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
274 # described by this DeveloperMetadataLookup.
275 # example, if only a metadata ID is specified this considers the
276 # DeveloperMetadata with that particular unique ID. If a metadata key is
277 # specified, this considers all developer metadata with that key. If a
278 # key, visibility, and location type are all specified, this considers all
279 # developer metadata with that key and visibility that are associated with a
280 # location of that type. In general, this
281 # selects all DeveloperMetadata that matches the intersection of all the
282 # specified fields; any field or combination of fields may be specified.
283 "metadataLocation": { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
284 # the specified location. This field either matches exact locations or all
285 # intersecting locations according the specified
286 # locationMatchingStrategy.
287 "locationType": "A String", # The type of location this object represents. This field is read-only.
288 "dimensionRange": { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
289 # a dimension. The specified DimensionRange must represent a single row
290 # or column; it cannot be unbounded or span multiple rows or columns.
291 # All indexes are zero-based.
292 # Indexes are half open: the start index is inclusive
293 # and the end index is exclusive.
294 # Missing indexes indicate the range is unbounded on that side.
295 "endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.
296 "startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.
297 "sheetId": 42, # The sheet this span is on.
298 "dimension": "A String", # The dimension of the span.
299 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 "sheetId": 42, # The ID of the sheet when metadata is associated with an entire sheet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]302 },
303 "metadataValue": "A String", # Limits the selected developer metadata to that which has a matching
304 # DeveloperMetadata.metadata_value.
305 "locationMatchingStrategy": "A String", # Determines how this lookup matches the location. If this field is
306 # specified as EXACT, only developer metadata associated on the exact
307 # location specified is matched. If this field is specified to INTERSECTING,
308 # developer metadata associated on intersecting locations is also
309 # matched. If left unspecified, this field assumes a default value of
310 # INTERSECTING.
311 # If this field is specified, a metadataLocation
312 # must also be specified.
313 "locationType": "A String", # Limits the selected developer metadata to those entries which are
314 # associated with locations of the specified type. For example, when this
315 # field is specified as ROW this lookup
316 # only considers developer metadata associated on rows. If the field is left
317 # unspecified, all location types are considered. This field cannot be
318 # specified as SPREADSHEET when
319 # the locationMatchingStrategy
320 # is specified as INTERSECTING or when the
321 # metadataLocation is specified as a
322 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
323 # developer metadata location. This field also must be left unspecified when
324 # the locationMatchingStrategy
325 # is specified as EXACT.
326 "metadataId": 42, # Limits the selected developer metadata to that which has a matching
327 # DeveloperMetadata.metadata_id.
328 "visibility": "A String", # Limits the selected developer metadata to that which has a matching
329 # DeveloperMetadata.visibility. If left unspecified, all developer
330 # metadata visibile to the requesting project is considered.
331 "metadataKey": "A String", # Limits the selected developer metadata to that which has a matching
332 # DeveloperMetadata.metadata_key.
333 },
334 "a1Range": "A String", # Selects data that matches the specified A1 range.
335 "gridRange": { # A range on a sheet. # Selects data that matches the range described by the GridRange.
336 # All indexes are zero-based.
337 # Indexes are half open, e.g the start index is inclusive
338 # and the end index is exclusive -- [start_index, end_index).
339 # Missing indexes indicate the range is unbounded on that side.
340 #
341 # For example, if `"Sheet1"` is sheet ID 0, then:
342 #
343 # `Sheet1!A1:A1 == sheet_id: 0,
344 # start_row_index: 0, end_row_index: 1,
345 # start_column_index: 0, end_column_index: 1`
346 #
347 # `Sheet1!A3:B4 == sheet_id: 0,
348 # start_row_index: 2, end_row_index: 4,
349 # start_column_index: 0, end_column_index: 2`
350 #
351 # `Sheet1!A:B == sheet_id: 0,
352 # start_column_index: 0, end_column_index: 2`
353 #
354 # `Sheet1!A5:B == sheet_id: 0,
355 # start_row_index: 4,
356 # start_column_index: 0, end_column_index: 2`
357 #
358 # `Sheet1 == sheet_id:0`
359 #
360 # The start index must always be less than or equal to the end index.
361 # If the start index equals the end index, then the range is empty.
362 # Empty ranges are typically not meaningful and are usually rendered in the
363 # UI as `#REF!`.
364 "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
365 "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
366 "sheetId": 42, # The sheet this range is on.
367 "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
368 "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
369 },
370 },
371 ],
372 "developerMetadata": { # Developer metadata associated with a location or object in a spreadsheet. # The developer metadata matching the specified filters.
373 # Developer metadata may be used to associate arbitrary data with various
374 # parts of a spreadsheet and will remain associated at those locations as they
375 # move around and the spreadsheet is edited. For example, if developer
376 # metadata is associated with row 5 and another row is then subsequently
377 # inserted above row 5, that original metadata will still be associated with
378 # the row it was first associated with (what is now row 6). If the associated
379 # object is deleted its metadata is deleted too.
380 "metadataId": 42, # The spreadsheet-scoped unique ID that identifies the metadata. IDs may be
381 # specified when metadata is created, otherwise one will be randomly
382 # generated and assigned. Must be positive.
383 "metadataValue": "A String", # Data associated with the metadata's key.
384 "location": { # A location where metadata may be associated in a spreadsheet. # The location where the metadata is associated.
385 "locationType": "A String", # The type of location this object represents. This field is read-only.
386 "dimensionRange": { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
387 # a dimension. The specified DimensionRange must represent a single row
388 # or column; it cannot be unbounded or span multiple rows or columns.
389 # All indexes are zero-based.
390 # Indexes are half open: the start index is inclusive
391 # and the end index is exclusive.
392 # Missing indexes indicate the range is unbounded on that side.
393 "endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.
394 "startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.
395 "sheetId": 42, # The sheet this span is on.
396 "dimension": "A String", # The dimension of the span.
397 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398 "sheetId": 42, # The ID of the sheet when metadata is associated with an entire sheet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]399 "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]400 },
401 "visibility": "A String", # The metadata visibility. Developer metadata must always have a visibility
402 # specified.
403 "metadataKey": "A String", # The metadata key. There may be multiple metadata in a spreadsheet with the
404 # same key. Developer metadata must always have a key specified.
405 },
406 },
407 ],
408 }</pre>
409</div>
410
411</body></html>