Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / sheets_v4.spreadsheets.developerMetadata.html
blob: 2103c3cd4b93b1fea3dac0bef2acbee882705538 [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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87The caller must specify the spreadsheet ID and the developer metadata&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;metadataKey&quot;: &quot;A String&quot;, # The metadata key. There may be multiple metadata in a spreadsheet with the
110 # same key. Developer metadata must always have a key specified.
111 &quot;metadataValue&quot;: &quot;A String&quot;, # Data associated with the metadata&#x27;s key.
112 &quot;visibility&quot;: &quot;A String&quot;, # The metadata visibility. Developer metadata must always have a visibility
113 # specified.
114 &quot;metadataId&quot;: 42, # The spreadsheet-scoped unique ID that identifies the metadata. IDs may be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 # specified when metadata is created, otherwise one will be randomly
116 # generated and assigned. Must be positive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;location&quot;: { # A location where metadata may be associated in a spreadsheet. # The location where the metadata is associated.
118 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
119 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
120 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
121 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 # a dimension. The specified DimensionRange must represent a single row
123 # or column; it cannot be unbounded or span multiple rows or columns.
124 # All indexes are zero-based.
125 # Indexes are half open: the start index is inclusive
126 # and the end index is exclusive.
127 # Missing indexes indicate the range is unbounded on that side.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;sheetId&quot;: 42, # The sheet this span is on.
129 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
130 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
131 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 &quot;dataFilters&quot;: [ # The data filters describing the criteria used to determine which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 &quot;gridRange&quot;: { # A range on a sheet. # Selects data that matches the range described by the GridRange.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 # All indexes are zero-based.
159 # Indexes are half open, e.g the start index is inclusive
160 # and the end index is exclusive -- [start_index, end_index).
161 # Missing indexes indicate the range is unbounded on that side.
162 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 #
165 # `Sheet1!A1:A1 == sheet_id: 0,
166 # start_row_index: 0, end_row_index: 1,
167 # start_column_index: 0, end_column_index: 1`
168 #
169 # `Sheet1!A3:B4 == sheet_id: 0,
170 # start_row_index: 2, end_row_index: 4,
171 # start_column_index: 0, end_column_index: 2`
172 #
173 # `Sheet1!A:B == sheet_id: 0,
174 # start_column_index: 0, end_column_index: 2`
175 #
176 # `Sheet1!A5:B == sheet_id: 0,
177 # start_row_index: 4,
178 # start_column_index: 0, end_column_index: 2`
179 #
180 # `Sheet1 == sheet_id:0`
181 #
182 # The start index must always be less than or equal to the end index.
183 # If the start index equals the end index, then the range is empty.
184 # Empty ranges are typically not meaningful and are usually rendered in the
185 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
187 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
188 &quot;sheetId&quot;: 42, # The sheet this range is on.
189 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
190 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 &quot;developerMetadataLookup&quot;: { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
193 # described by this DeveloperMetadataLookup.
194 # example, if only a metadata ID is specified this considers the
195 # DeveloperMetadata with that particular unique ID. If a metadata key is
196 # specified, this considers all developer metadata with that key. If a
197 # key, visibility, and location type are all specified, this considers all
198 # developer metadata with that key and visibility that are associated with a
199 # location of that type. In general, this
200 # selects all DeveloperMetadata that matches the intersection of all the
201 # specified fields; any field or combination of fields may be specified.
202 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
203 # the specified location. This field either matches exact locations or all
204 # intersecting locations according the specified
205 # locationMatchingStrategy.
206 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
207 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
208 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
209 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
210 # a dimension. The specified DimensionRange must represent a single row
211 # or column; it cannot be unbounded or span multiple rows or columns.
212 # All indexes are zero-based.
213 # Indexes are half open: the start index is inclusive
214 # and the end index is exclusive.
215 # Missing indexes indicate the range is unbounded on that side.
216 &quot;sheetId&quot;: 42, # The sheet this span is on.
217 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
218 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
219 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
220 },
221 },
222 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
223 # DeveloperMetadata.metadata_id.
224 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
225 # DeveloperMetadata.visibility. If left unspecified, all developer
226 # metadata visibile to the requesting project is considered.
227 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
228 # DeveloperMetadata.metadata_value.
229 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
230 # associated with locations of the specified type. For example, when this
231 # field is specified as ROW this lookup
232 # only considers developer metadata associated on rows. If the field is left
233 # unspecified, all location types are considered. This field cannot be
234 # specified as SPREADSHEET when
235 # the locationMatchingStrategy
236 # is specified as INTERSECTING or when the
237 # metadataLocation is specified as a
238 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
239 # developer metadata location. This field also must be left unspecified when
240 # the locationMatchingStrategy
241 # is specified as EXACT.
242 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
243 # specified as EXACT, only developer metadata associated on the exact
244 # location specified is matched. If this field is specified to INTERSECTING,
245 # developer metadata associated on intersecting locations is also
246 # matched. If left unspecified, this field assumes a default value of
247 # INTERSECTING.
248 # If this field is specified, a metadataLocation
249 # must also be specified.
250 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
251 # DeveloperMetadata.metadata_key.
252 },
253 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]267 &quot;matchedDeveloperMetadata&quot;: [ # The metadata matching the criteria of the search request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]268 { # A developer metadata entry and the data filters specified in the original
269 # request that matched it.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]270 &quot;developerMetadata&quot;: { # Developer metadata associated with a location or object in a spreadsheet. # The developer metadata matching the specified filters.
271 # Developer metadata may be used to associate arbitrary data with various
272 # parts of a spreadsheet and will remain associated at those locations as they
273 # move around and the spreadsheet is edited. For example, if developer
274 # metadata is associated with row 5 and another row is then subsequently
275 # inserted above row 5, that original metadata will still be associated with
276 # the row it was first associated with (what is now row 6). If the associated
277 # object is deleted its metadata is deleted too.
278 &quot;metadataKey&quot;: &quot;A String&quot;, # The metadata key. There may be multiple metadata in a spreadsheet with the
279 # same key. Developer metadata must always have a key specified.
280 &quot;metadataValue&quot;: &quot;A String&quot;, # Data associated with the metadata&#x27;s key.
281 &quot;visibility&quot;: &quot;A String&quot;, # The metadata visibility. Developer metadata must always have a visibility
282 # specified.
283 &quot;metadataId&quot;: 42, # The spreadsheet-scoped unique ID that identifies the metadata. IDs may be
284 # specified when metadata is created, otherwise one will be randomly
285 # generated and assigned. Must be positive.
286 &quot;location&quot;: { # A location where metadata may be associated in a spreadsheet. # The location where the metadata is associated.
287 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
288 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
289 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
290 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
291 # a dimension. The specified DimensionRange must represent a single row
292 # or column; it cannot be unbounded or span multiple rows or columns.
293 # All indexes are zero-based.
294 # Indexes are half open: the start index is inclusive
295 # and the end index is exclusive.
296 # Missing indexes indicate the range is unbounded on that side.
297 &quot;sheetId&quot;: 42, # The sheet this span is on.
298 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
299 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
300 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
301 },
302 },
303 },
304 &quot;dataFilters&quot;: [ # All filters matching the returned developer metadata.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 { # Filter that describes what data should be selected or returned from a
306 # request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]307 &quot;gridRange&quot;: { # A range on a sheet. # Selects data that matches the range described by the GridRange.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 # All indexes are zero-based.
309 # Indexes are half open, e.g the start index is inclusive
310 # and the end index is exclusive -- [start_index, end_index).
311 # Missing indexes indicate the range is unbounded on that side.
312 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]313 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314 #
315 # `Sheet1!A1:A1 == sheet_id: 0,
316 # start_row_index: 0, end_row_index: 1,
317 # start_column_index: 0, end_column_index: 1`
318 #
319 # `Sheet1!A3:B4 == sheet_id: 0,
320 # start_row_index: 2, end_row_index: 4,
321 # start_column_index: 0, end_column_index: 2`
322 #
323 # `Sheet1!A:B == sheet_id: 0,
324 # start_column_index: 0, end_column_index: 2`
325 #
326 # `Sheet1!A5:B == sheet_id: 0,
327 # start_row_index: 4,
328 # start_column_index: 0, end_column_index: 2`
329 #
330 # `Sheet1 == sheet_id:0`
331 #
332 # The start index must always be less than or equal to the end index.
333 # If the start index equals the end index, then the range is empty.
334 # Empty ranges are typically not meaningful and are usually rendered in the
335 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]336 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
337 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
338 &quot;sheetId&quot;: 42, # The sheet this range is on.
339 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
340 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]341 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]342 &quot;developerMetadataLookup&quot;: { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
343 # described by this DeveloperMetadataLookup.
344 # example, if only a metadata ID is specified this considers the
345 # DeveloperMetadata with that particular unique ID. If a metadata key is
346 # specified, this considers all developer metadata with that key. If a
347 # key, visibility, and location type are all specified, this considers all
348 # developer metadata with that key and visibility that are associated with a
349 # location of that type. In general, this
350 # selects all DeveloperMetadata that matches the intersection of all the
351 # specified fields; any field or combination of fields may be specified.
352 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
353 # the specified location. This field either matches exact locations or all
354 # intersecting locations according the specified
355 # locationMatchingStrategy.
356 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
357 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
358 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
359 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
360 # a dimension. The specified DimensionRange must represent a single row
361 # or column; it cannot be unbounded or span multiple rows or columns.
362 # All indexes are zero-based.
363 # Indexes are half open: the start index is inclusive
364 # and the end index is exclusive.
365 # Missing indexes indicate the range is unbounded on that side.
366 &quot;sheetId&quot;: 42, # The sheet this span is on.
367 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
368 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
369 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
370 },
371 },
372 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
373 # DeveloperMetadata.metadata_id.
374 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
375 # DeveloperMetadata.visibility. If left unspecified, all developer
376 # metadata visibile to the requesting project is considered.
377 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
378 # DeveloperMetadata.metadata_value.
379 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
380 # associated with locations of the specified type. For example, when this
381 # field is specified as ROW this lookup
382 # only considers developer metadata associated on rows. If the field is left
383 # unspecified, all location types are considered. This field cannot be
384 # specified as SPREADSHEET when
385 # the locationMatchingStrategy
386 # is specified as INTERSECTING or when the
387 # metadataLocation is specified as a
388 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
389 # developer metadata location. This field also must be left unspecified when
390 # the locationMatchingStrategy
391 # is specified as EXACT.
392 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
393 # specified as EXACT, only developer metadata associated on the exact
394 # location specified is matched. If this field is specified to INTERSECTING,
395 # developer metadata associated on intersecting locations is also
396 # matched. If left unspecified, this field assumes a default value of
397 # INTERSECTING.
398 # If this field is specified, a metadataLocation
399 # must also be specified.
400 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
401 # DeveloperMetadata.metadata_key.
402 },
403 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]404 },
405 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406 },
407 ],
408 }</pre>
409</div>
410
411</body></html>