Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / sheets_v4.spreadsheets.developerMetadata.html
blob: cdad85ef987234ef59cb23da2fa5136c6a4f368e [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;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]110 # specified when metadata is created, otherwise one will be randomly
111 # generated and assigned. Must be positive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &quot;location&quot;: { # A location where metadata may be associated in a spreadsheet. # The location where the metadata is associated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
114 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
115 &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]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]122 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
125 &quot;sheetId&quot;: 42, # The sheet this span is on.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]127 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]129 &quot;visibility&quot;: &quot;A String&quot;, # The metadata visibility. Developer metadata must always have a visibility
130 # specified.
131 &quot;metadataKey&quot;: &quot;A String&quot;, # The metadata key. There may be multiple metadata in a spreadsheet with the
132 # same key. Developer metadata must always have a key specified.
133 &quot;metadataValue&quot;: &quot;A String&quot;, # Data associated with the metadata&#x27;s key.
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 Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]157 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]167 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
168 # specified as EXACT, only developer metadata associated on the exact
169 # location specified is matched. If this field is specified to INTERSECTING,
170 # developer metadata associated on intersecting locations is also
171 # matched. If left unspecified, this field assumes a default value of
172 # INTERSECTING.
173 # If this field is specified, a metadataLocation
174 # must also be specified.
175 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
176 # DeveloperMetadata.visibility. If left unspecified, all developer
177 # metadata visibile to the requesting project is considered.
178 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
179 # DeveloperMetadata.metadata_value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]180 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
181 # associated with locations of the specified type. For example, when this
182 # field is specified as ROW this lookup
183 # only considers developer metadata associated on rows. If the field is left
184 # unspecified, all location types are considered. This field cannot be
185 # specified as SPREADSHEET when
186 # the locationMatchingStrategy
187 # is specified as INTERSECTING or when the
188 # metadataLocation is specified as a
189 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
190 # developer metadata location. This field also must be left unspecified when
191 # the locationMatchingStrategy
192 # is specified as EXACT.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]193 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
194 # DeveloperMetadata.metadata_id.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]195 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
196 # the specified location. This field either matches exact locations or all
197 # intersecting locations according the specified
198 # locationMatchingStrategy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]199 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
200 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
201 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
202 # a dimension. The specified DimensionRange must represent a single row
203 # or column; it cannot be unbounded or span multiple rows or columns.
204 # All indexes are zero-based.
205 # Indexes are half open: the start index is inclusive
206 # and the end index is exclusive.
207 # Missing indexes indicate the range is unbounded on that side.
208 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]209 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]210 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
211 &quot;sheetId&quot;: 42, # The sheet this span is on.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]212 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]213 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]214 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]215 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
216 # DeveloperMetadata.metadata_key.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]217 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]218 &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]219 # All indexes are zero-based.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]220 # Indexes are half open, i.e. the start index is inclusive
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 # and the end index is exclusive -- [start_index, end_index).
222 # Missing indexes indicate the range is unbounded on that side.
223 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 #
226 # `Sheet1!A1:A1 == sheet_id: 0,
227 # start_row_index: 0, end_row_index: 1,
228 # start_column_index: 0, end_column_index: 1`
229 #
230 # `Sheet1!A3:B4 == sheet_id: 0,
231 # start_row_index: 2, end_row_index: 4,
232 # start_column_index: 0, end_column_index: 2`
233 #
234 # `Sheet1!A:B == sheet_id: 0,
235 # start_column_index: 0, end_column_index: 2`
236 #
237 # `Sheet1!A5:B == sheet_id: 0,
238 # start_row_index: 4,
239 # start_column_index: 0, end_column_index: 2`
240 #
241 # `Sheet1 == sheet_id:0`
242 #
243 # The start index must always be less than or equal to the end index.
244 # If the start index equals the end index, then the range is empty.
245 # Empty ranges are typically not meaningful and are usually rendered in the
246 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]247 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]248 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]249 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
250 &quot;sheetId&quot;: 42, # The sheet this range is on.
251 &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]252 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]278 &quot;metadataId&quot;: 42, # The spreadsheet-scoped unique ID that identifies the metadata. IDs may be
279 # specified when metadata is created, otherwise one will be randomly
280 # generated and assigned. Must be positive.
281 &quot;location&quot;: { # A location where metadata may be associated in a spreadsheet. # The location where the metadata is associated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]282 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
283 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
284 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
285 # a dimension. The specified DimensionRange must represent a single row
286 # or column; it cannot be unbounded or span multiple rows or columns.
287 # All indexes are zero-based.
288 # Indexes are half open: the start index is inclusive
289 # and the end index is exclusive.
290 # Missing indexes indicate the range is unbounded on that side.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]291 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]292 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]293 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
294 &quot;sheetId&quot;: 42, # The sheet this span is on.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]295 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]296 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]297 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]298 &quot;visibility&quot;: &quot;A String&quot;, # The metadata visibility. Developer metadata must always have a visibility
299 # specified.
300 &quot;metadataKey&quot;: &quot;A String&quot;, # The metadata key. There may be multiple metadata in a spreadsheet with the
301 # same key. Developer metadata must always have a key specified.
302 &quot;metadataValue&quot;: &quot;A String&quot;, # Data associated with the metadata&#x27;s key.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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 Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]307 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]317 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
318 # specified as EXACT, only developer metadata associated on the exact
319 # location specified is matched. If this field is specified to INTERSECTING,
320 # developer metadata associated on intersecting locations is also
321 # matched. If left unspecified, this field assumes a default value of
322 # INTERSECTING.
323 # If this field is specified, a metadataLocation
324 # must also be specified.
325 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
326 # DeveloperMetadata.visibility. If left unspecified, all developer
327 # metadata visibile to the requesting project is considered.
328 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
329 # DeveloperMetadata.metadata_value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]330 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
331 # associated with locations of the specified type. For example, when this
332 # field is specified as ROW this lookup
333 # only considers developer metadata associated on rows. If the field is left
334 # unspecified, all location types are considered. This field cannot be
335 # specified as SPREADSHEET when
336 # the locationMatchingStrategy
337 # is specified as INTERSECTING or when the
338 # metadataLocation is specified as a
339 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
340 # developer metadata location. This field also must be left unspecified when
341 # the locationMatchingStrategy
342 # is specified as EXACT.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]343 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
344 # DeveloperMetadata.metadata_id.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]345 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
346 # the specified location. This field either matches exact locations or all
347 # intersecting locations according the specified
348 # locationMatchingStrategy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]349 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
350 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
351 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
352 # a dimension. The specified DimensionRange must represent a single row
353 # or column; it cannot be unbounded or span multiple rows or columns.
354 # All indexes are zero-based.
355 # Indexes are half open: the start index is inclusive
356 # and the end index is exclusive.
357 # Missing indexes indicate the range is unbounded on that side.
358 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]359 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]360 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
361 &quot;sheetId&quot;: 42, # The sheet this span is on.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]362 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]363 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]364 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]365 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
366 # DeveloperMetadata.metadata_key.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]367 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]368 &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]369 # All indexes are zero-based.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]370 # Indexes are half open, i.e. the start index is inclusive
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]371 # and the end index is exclusive -- [start_index, end_index).
372 # Missing indexes indicate the range is unbounded on that side.
373 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]374 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375 #
376 # `Sheet1!A1:A1 == sheet_id: 0,
377 # start_row_index: 0, end_row_index: 1,
378 # start_column_index: 0, end_column_index: 1`
379 #
380 # `Sheet1!A3:B4 == sheet_id: 0,
381 # start_row_index: 2, end_row_index: 4,
382 # start_column_index: 0, end_column_index: 2`
383 #
384 # `Sheet1!A:B == sheet_id: 0,
385 # start_column_index: 0, end_column_index: 2`
386 #
387 # `Sheet1!A5:B == sheet_id: 0,
388 # start_row_index: 4,
389 # start_column_index: 0, end_column_index: 2`
390 #
391 # `Sheet1 == sheet_id:0`
392 #
393 # The start index must always be less than or equal to the end index.
394 # If the start index equals the end index, then the range is empty.
395 # Empty ranges are typically not meaningful and are usually rendered in the
396 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]397 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]398 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]399 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
400 &quot;sheetId&quot;: 42, # The sheet this range is on.
401 &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]402 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]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>