blob: ab61b534484ed042cde3ca638c448f1d6201624c [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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 -070081 <code><a href="#search">search(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<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 -070087The caller must specify the spreadsheet ID and the developer metadata&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088unique 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 -0700109 &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 -0700115 # 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 -0700117 &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 -0700122 # 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 Kim4ed7d3f2020-05-27 12:20:54 -0700128 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim65020912020-05-20 12:08:20 -0700129 &quot;sheetId&quot;: 42, # The sheet this span is on.
130 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
131 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700132 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700134 }</pre>
135</div>
136
137<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700138 <code class="details" id="search">search(spreadsheetId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700139 <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 -0700147 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700148 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 -0700152 &quot;dataFilters&quot;: [ # The data filters describing the criteria used to determine which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700153 # DeveloperMetadata entries to return. DeveloperMetadata matching any of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700154 # specified filters are included in the response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700155 { # Filter that describes what data should be selected or returned from a
156 # request.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700157 &quot;developerMetadataLookup&quot;: { # 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 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
168 # associated with locations of the specified type. For example, when this
169 # field is specified as ROW this lookup
170 # only considers developer metadata associated on rows. If the field is left
171 # unspecified, all location types are considered. This field cannot be
172 # specified as SPREADSHEET when
173 # the locationMatchingStrategy
174 # is specified as INTERSECTING or when the
175 # metadataLocation is specified as a
176 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
177 # developer metadata location. This field also must be left unspecified when
178 # the locationMatchingStrategy
179 # is specified as EXACT.
180 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
181 # DeveloperMetadata.metadata_key.
182 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
183 # specified as EXACT, only developer metadata associated on the exact
184 # location specified is matched. If this field is specified to INTERSECTING,
185 # developer metadata associated on intersecting locations is also
186 # matched. If left unspecified, this field assumes a default value of
187 # INTERSECTING.
188 # If this field is specified, a metadataLocation
189 # must also be specified.
190 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
191 # the specified location. This field either matches exact locations or all
192 # intersecting locations according the specified
193 # locationMatchingStrategy.
194 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
195 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
196 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
197 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
198 # a dimension. The specified DimensionRange must represent a single row
199 # or column; it cannot be unbounded or span multiple rows or columns.
200 # All indexes are zero-based.
201 # Indexes are half open: the start index is inclusive
202 # and the end index is exclusive.
203 # Missing indexes indicate the range is unbounded on that side.
204 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
205 &quot;sheetId&quot;: 42, # The sheet this span is on.
206 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
207 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
208 },
209 },
210 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
211 # DeveloperMetadata.metadata_id.
212 &quot;visibility&quot;: &quot;A String&quot;, # 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 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
216 # DeveloperMetadata.metadata_value.
217 },
218 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Bu Sun Kim65020912020-05-20 12:08:20 -0700219 &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 -0700220 # 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 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700225 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700226 #
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!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700248 &quot;sheetId&quot;: 42, # The sheet this range is on.
249 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
250 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700251 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
252 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700253 },
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 -0700267 &quot;matchedDeveloperMetadata&quot;: [ # The metadata matching the criteria of the search request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700268 { # 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 -0700270 &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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700297 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim65020912020-05-20 12:08:20 -0700298 &quot;sheetId&quot;: 42, # The sheet this span is on.
299 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
300 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700301 },
302 },
303 },
304 &quot;dataFilters&quot;: [ # All filters matching the returned developer metadata.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700305 { # Filter that describes what data should be selected or returned from a
306 # request.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700307 &quot;developerMetadataLookup&quot;: { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
308 # described by this DeveloperMetadataLookup.
309 # example, if only a metadata ID is specified this considers the
310 # DeveloperMetadata with that particular unique ID. If a metadata key is
311 # specified, this considers all developer metadata with that key. If a
312 # key, visibility, and location type are all specified, this considers all
313 # developer metadata with that key and visibility that are associated with a
314 # location of that type. In general, this
315 # selects all DeveloperMetadata that matches the intersection of all the
316 # specified fields; any field or combination of fields may be specified.
317 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
318 # associated with locations of the specified type. For example, when this
319 # field is specified as ROW this lookup
320 # only considers developer metadata associated on rows. If the field is left
321 # unspecified, all location types are considered. This field cannot be
322 # specified as SPREADSHEET when
323 # the locationMatchingStrategy
324 # is specified as INTERSECTING or when the
325 # metadataLocation is specified as a
326 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
327 # developer metadata location. This field also must be left unspecified when
328 # the locationMatchingStrategy
329 # is specified as EXACT.
330 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
331 # DeveloperMetadata.metadata_key.
332 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
333 # specified as EXACT, only developer metadata associated on the exact
334 # location specified is matched. If this field is specified to INTERSECTING,
335 # developer metadata associated on intersecting locations is also
336 # matched. If left unspecified, this field assumes a default value of
337 # INTERSECTING.
338 # If this field is specified, a metadataLocation
339 # must also be specified.
340 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
341 # the specified location. This field either matches exact locations or all
342 # intersecting locations according the specified
343 # locationMatchingStrategy.
344 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
345 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
346 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
347 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
348 # a dimension. The specified DimensionRange must represent a single row
349 # or column; it cannot be unbounded or span multiple rows or columns.
350 # All indexes are zero-based.
351 # Indexes are half open: the start index is inclusive
352 # and the end index is exclusive.
353 # Missing indexes indicate the range is unbounded on that side.
354 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
355 &quot;sheetId&quot;: 42, # The sheet this span is on.
356 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
357 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
358 },
359 },
360 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
361 # DeveloperMetadata.metadata_id.
362 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
363 # DeveloperMetadata.visibility. If left unspecified, all developer
364 # metadata visibile to the requesting project is considered.
365 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
366 # DeveloperMetadata.metadata_value.
367 },
368 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Bu Sun Kim65020912020-05-20 12:08:20 -0700369 &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 -0700370 # All indexes are zero-based.
371 # Indexes are half open, e.g the start index is inclusive
372 # and the end index is exclusive -- [start_index, end_index).
373 # Missing indexes indicate the range is unbounded on that side.
374 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700375 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700376 #
377 # `Sheet1!A1:A1 == sheet_id: 0,
378 # start_row_index: 0, end_row_index: 1,
379 # start_column_index: 0, end_column_index: 1`
380 #
381 # `Sheet1!A3:B4 == sheet_id: 0,
382 # start_row_index: 2, end_row_index: 4,
383 # start_column_index: 0, end_column_index: 2`
384 #
385 # `Sheet1!A:B == sheet_id: 0,
386 # start_column_index: 0, end_column_index: 2`
387 #
388 # `Sheet1!A5:B == sheet_id: 0,
389 # start_row_index: 4,
390 # start_column_index: 0, end_column_index: 2`
391 #
392 # `Sheet1 == sheet_id:0`
393 #
394 # The start index must always be less than or equal to the end index.
395 # If the start index equals the end index, then the range is empty.
396 # Empty ranges are typically not meaningful and are usually rendered in the
397 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700398 &quot;sheetId&quot;: 42, # The sheet this range is on.
399 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
400 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700401 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
402 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700403 },
404 },
405 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700406 },
407 ],
408 }</pre>
409</div>
410
411</body></html>