-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathschemas.pyi
2102 lines (1850 loc) · 61.6 KB
/
schemas.pyi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import typing
import typing_extensions
_list = list
@typing.type_check_only
class AddBandingRequest(typing_extensions.TypedDict, total=False):
bandedRange: BandedRange
@typing.type_check_only
class AddBandingResponse(typing_extensions.TypedDict, total=False):
bandedRange: BandedRange
@typing.type_check_only
class AddChartRequest(typing_extensions.TypedDict, total=False):
chart: EmbeddedChart
@typing.type_check_only
class AddChartResponse(typing_extensions.TypedDict, total=False):
chart: EmbeddedChart
@typing.type_check_only
class AddConditionalFormatRuleRequest(typing_extensions.TypedDict, total=False):
index: int
rule: ConditionalFormatRule
@typing.type_check_only
class AddDataSourceRequest(typing_extensions.TypedDict, total=False):
dataSource: DataSource
@typing.type_check_only
class AddDataSourceResponse(typing_extensions.TypedDict, total=False):
dataExecutionStatus: DataExecutionStatus
dataSource: DataSource
@typing.type_check_only
class AddDimensionGroupRequest(typing_extensions.TypedDict, total=False):
range: DimensionRange
@typing.type_check_only
class AddDimensionGroupResponse(typing_extensions.TypedDict, total=False):
dimensionGroups: _list[DimensionGroup]
@typing.type_check_only
class AddFilterViewRequest(typing_extensions.TypedDict, total=False):
filter: FilterView
@typing.type_check_only
class AddFilterViewResponse(typing_extensions.TypedDict, total=False):
filter: FilterView
@typing.type_check_only
class AddNamedRangeRequest(typing_extensions.TypedDict, total=False):
namedRange: NamedRange
@typing.type_check_only
class AddNamedRangeResponse(typing_extensions.TypedDict, total=False):
namedRange: NamedRange
@typing.type_check_only
class AddProtectedRangeRequest(typing_extensions.TypedDict, total=False):
protectedRange: ProtectedRange
@typing.type_check_only
class AddProtectedRangeResponse(typing_extensions.TypedDict, total=False):
protectedRange: ProtectedRange
@typing.type_check_only
class AddSheetRequest(typing_extensions.TypedDict, total=False):
properties: SheetProperties
@typing.type_check_only
class AddSheetResponse(typing_extensions.TypedDict, total=False):
properties: SheetProperties
@typing.type_check_only
class AddSlicerRequest(typing_extensions.TypedDict, total=False):
slicer: Slicer
@typing.type_check_only
class AddSlicerResponse(typing_extensions.TypedDict, total=False):
slicer: Slicer
@typing.type_check_only
class AppendCellsRequest(typing_extensions.TypedDict, total=False):
fields: str
rows: _list[RowData]
sheetId: int
@typing.type_check_only
class AppendDimensionRequest(typing_extensions.TypedDict, total=False):
dimension: typing_extensions.Literal["DIMENSION_UNSPECIFIED", "ROWS", "COLUMNS"]
length: int
sheetId: int
@typing.type_check_only
class AppendValuesResponse(typing_extensions.TypedDict, total=False):
spreadsheetId: str
tableRange: str
updates: UpdateValuesResponse
@typing.type_check_only
class AutoFillRequest(typing_extensions.TypedDict, total=False):
range: GridRange
sourceAndDestination: SourceAndDestination
useAlternateSeries: bool
@typing.type_check_only
class AutoResizeDimensionsRequest(typing_extensions.TypedDict, total=False):
dataSourceSheetDimensions: DataSourceSheetDimensionRange
dimensions: DimensionRange
@typing.type_check_only
class BandedRange(typing_extensions.TypedDict, total=False):
bandedRangeId: int
columnProperties: BandingProperties
range: GridRange
rowProperties: BandingProperties
@typing.type_check_only
class BandingProperties(typing_extensions.TypedDict, total=False):
firstBandColor: Color
firstBandColorStyle: ColorStyle
footerColor: Color
footerColorStyle: ColorStyle
headerColor: Color
headerColorStyle: ColorStyle
secondBandColor: Color
secondBandColorStyle: ColorStyle
@typing.type_check_only
class BaselineValueFormat(typing_extensions.TypedDict, total=False):
comparisonType: typing_extensions.Literal[
"COMPARISON_TYPE_UNDEFINED", "ABSOLUTE_DIFFERENCE", "PERCENTAGE_DIFFERENCE"
]
description: str
negativeColor: Color
negativeColorStyle: ColorStyle
position: TextPosition
positiveColor: Color
positiveColorStyle: ColorStyle
textFormat: TextFormat
@typing.type_check_only
class BasicChartAxis(typing_extensions.TypedDict, total=False):
format: TextFormat
position: typing_extensions.Literal[
"BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
"BOTTOM_AXIS",
"LEFT_AXIS",
"RIGHT_AXIS",
]
title: str
titleTextPosition: TextPosition
viewWindowOptions: ChartAxisViewWindowOptions
@typing.type_check_only
class BasicChartDomain(typing_extensions.TypedDict, total=False):
domain: ChartData
reversed: bool
@typing.type_check_only
class BasicChartSeries(typing_extensions.TypedDict, total=False):
color: Color
colorStyle: ColorStyle
dataLabel: DataLabel
lineStyle: LineStyle
pointStyle: PointStyle
series: ChartData
styleOverrides: _list[BasicSeriesDataPointStyleOverride]
targetAxis: typing_extensions.Literal[
"BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
"BOTTOM_AXIS",
"LEFT_AXIS",
"RIGHT_AXIS",
]
type: typing_extensions.Literal[
"BASIC_CHART_TYPE_UNSPECIFIED",
"BAR",
"LINE",
"AREA",
"COLUMN",
"SCATTER",
"COMBO",
"STEPPED_AREA",
]
@typing.type_check_only
class BasicChartSpec(typing_extensions.TypedDict, total=False):
axis: _list[BasicChartAxis]
chartType: typing_extensions.Literal[
"BASIC_CHART_TYPE_UNSPECIFIED",
"BAR",
"LINE",
"AREA",
"COLUMN",
"SCATTER",
"COMBO",
"STEPPED_AREA",
]
compareMode: typing_extensions.Literal[
"BASIC_CHART_COMPARE_MODE_UNSPECIFIED", "DATUM", "CATEGORY"
]
domains: _list[BasicChartDomain]
headerCount: int
interpolateNulls: bool
legendPosition: typing_extensions.Literal[
"BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
"BOTTOM_LEGEND",
"LEFT_LEGEND",
"RIGHT_LEGEND",
"TOP_LEGEND",
"NO_LEGEND",
]
lineSmoothing: bool
series: _list[BasicChartSeries]
stackedType: typing_extensions.Literal[
"BASIC_CHART_STACKED_TYPE_UNSPECIFIED",
"NOT_STACKED",
"STACKED",
"PERCENT_STACKED",
]
threeDimensional: bool
totalDataLabel: DataLabel
@typing.type_check_only
class BasicFilter(typing_extensions.TypedDict, total=False):
criteria: dict[str, typing.Any]
filterSpecs: _list[FilterSpec]
range: GridRange
sortSpecs: _list[SortSpec]
@typing.type_check_only
class BasicSeriesDataPointStyleOverride(typing_extensions.TypedDict, total=False):
color: Color
colorStyle: ColorStyle
index: int
pointStyle: PointStyle
@typing.type_check_only
class BatchClearValuesByDataFilterRequest(typing_extensions.TypedDict, total=False):
dataFilters: _list[DataFilter]
@typing.type_check_only
class BatchClearValuesByDataFilterResponse(typing_extensions.TypedDict, total=False):
clearedRanges: _list[str]
spreadsheetId: str
@typing.type_check_only
class BatchClearValuesRequest(typing_extensions.TypedDict, total=False):
ranges: _list[str]
@typing.type_check_only
class BatchClearValuesResponse(typing_extensions.TypedDict, total=False):
clearedRanges: _list[str]
spreadsheetId: str
@typing.type_check_only
class BatchGetValuesByDataFilterRequest(typing_extensions.TypedDict, total=False):
dataFilters: _list[DataFilter]
dateTimeRenderOption: typing_extensions.Literal["SERIAL_NUMBER", "FORMATTED_STRING"]
majorDimension: typing_extensions.Literal[
"DIMENSION_UNSPECIFIED", "ROWS", "COLUMNS"
]
valueRenderOption: typing_extensions.Literal[
"FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA"
]
@typing.type_check_only
class BatchGetValuesByDataFilterResponse(typing_extensions.TypedDict, total=False):
spreadsheetId: str
valueRanges: _list[MatchedValueRange]
@typing.type_check_only
class BatchGetValuesResponse(typing_extensions.TypedDict, total=False):
spreadsheetId: str
valueRanges: _list[ValueRange]
@typing.type_check_only
class BatchUpdateSpreadsheetRequest(typing_extensions.TypedDict, total=False):
includeSpreadsheetInResponse: bool
requests: _list[Request]
responseIncludeGridData: bool
responseRanges: _list[str]
@typing.type_check_only
class BatchUpdateSpreadsheetResponse(typing_extensions.TypedDict, total=False):
replies: _list[Response]
spreadsheetId: str
updatedSpreadsheet: Spreadsheet
@typing.type_check_only
class BatchUpdateValuesByDataFilterRequest(typing_extensions.TypedDict, total=False):
data: _list[DataFilterValueRange]
includeValuesInResponse: bool
responseDateTimeRenderOption: typing_extensions.Literal[
"SERIAL_NUMBER", "FORMATTED_STRING"
]
responseValueRenderOption: typing_extensions.Literal[
"FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA"
]
valueInputOption: typing_extensions.Literal[
"INPUT_VALUE_OPTION_UNSPECIFIED", "RAW", "USER_ENTERED"
]
@typing.type_check_only
class BatchUpdateValuesByDataFilterResponse(typing_extensions.TypedDict, total=False):
responses: _list[UpdateValuesByDataFilterResponse]
spreadsheetId: str
totalUpdatedCells: int
totalUpdatedColumns: int
totalUpdatedRows: int
totalUpdatedSheets: int
@typing.type_check_only
class BatchUpdateValuesRequest(typing_extensions.TypedDict, total=False):
data: _list[ValueRange]
includeValuesInResponse: bool
responseDateTimeRenderOption: typing_extensions.Literal[
"SERIAL_NUMBER", "FORMATTED_STRING"
]
responseValueRenderOption: typing_extensions.Literal[
"FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA"
]
valueInputOption: typing_extensions.Literal[
"INPUT_VALUE_OPTION_UNSPECIFIED", "RAW", "USER_ENTERED"
]
@typing.type_check_only
class BatchUpdateValuesResponse(typing_extensions.TypedDict, total=False):
responses: _list[UpdateValuesResponse]
spreadsheetId: str
totalUpdatedCells: int
totalUpdatedColumns: int
totalUpdatedRows: int
totalUpdatedSheets: int
@typing.type_check_only
class BigQueryDataSourceSpec(typing_extensions.TypedDict, total=False):
projectId: str
querySpec: BigQueryQuerySpec
tableSpec: BigQueryTableSpec
@typing.type_check_only
class BigQueryQuerySpec(typing_extensions.TypedDict, total=False):
rawQuery: str
@typing.type_check_only
class BigQueryTableSpec(typing_extensions.TypedDict, total=False):
datasetId: str
tableId: str
tableProjectId: str
@typing.type_check_only
class BooleanCondition(typing_extensions.TypedDict, total=False):
type: typing_extensions.Literal[
"CONDITION_TYPE_UNSPECIFIED",
"NUMBER_GREATER",
"NUMBER_GREATER_THAN_EQ",
"NUMBER_LESS",
"NUMBER_LESS_THAN_EQ",
"NUMBER_EQ",
"NUMBER_NOT_EQ",
"NUMBER_BETWEEN",
"NUMBER_NOT_BETWEEN",
"TEXT_CONTAINS",
"TEXT_NOT_CONTAINS",
"TEXT_STARTS_WITH",
"TEXT_ENDS_WITH",
"TEXT_EQ",
"TEXT_IS_EMAIL",
"TEXT_IS_URL",
"DATE_EQ",
"DATE_BEFORE",
"DATE_AFTER",
"DATE_ON_OR_BEFORE",
"DATE_ON_OR_AFTER",
"DATE_BETWEEN",
"DATE_NOT_BETWEEN",
"DATE_IS_VALID",
"ONE_OF_RANGE",
"ONE_OF_LIST",
"BLANK",
"NOT_BLANK",
"CUSTOM_FORMULA",
"BOOLEAN",
"TEXT_NOT_EQ",
"DATE_NOT_EQ",
"FILTER_EXPRESSION",
]
values: _list[ConditionValue]
@typing.type_check_only
class BooleanRule(typing_extensions.TypedDict, total=False):
condition: BooleanCondition
format: CellFormat
@typing.type_check_only
class Border(typing_extensions.TypedDict, total=False):
color: Color
colorStyle: ColorStyle
style: typing_extensions.Literal[
"STYLE_UNSPECIFIED",
"DOTTED",
"DASHED",
"SOLID",
"SOLID_MEDIUM",
"SOLID_THICK",
"NONE",
"DOUBLE",
]
width: int
@typing.type_check_only
class Borders(typing_extensions.TypedDict, total=False):
bottom: Border
left: Border
right: Border
top: Border
@typing.type_check_only
class BubbleChartSpec(typing_extensions.TypedDict, total=False):
bubbleBorderColor: Color
bubbleBorderColorStyle: ColorStyle
bubbleLabels: ChartData
bubbleMaxRadiusSize: int
bubbleMinRadiusSize: int
bubbleOpacity: float
bubbleSizes: ChartData
bubbleTextStyle: TextFormat
domain: ChartData
groupIds: ChartData
legendPosition: typing_extensions.Literal[
"BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
"BOTTOM_LEGEND",
"LEFT_LEGEND",
"RIGHT_LEGEND",
"TOP_LEGEND",
"NO_LEGEND",
"INSIDE_LEGEND",
]
series: ChartData
@typing.type_check_only
class CancelDataSourceRefreshRequest(typing_extensions.TypedDict, total=False):
dataSourceId: str
isAll: bool
references: DataSourceObjectReferences
@typing.type_check_only
class CancelDataSourceRefreshResponse(typing_extensions.TypedDict, total=False):
statuses: _list[CancelDataSourceRefreshStatus]
@typing.type_check_only
class CancelDataSourceRefreshStatus(typing_extensions.TypedDict, total=False):
reference: DataSourceObjectReference
refreshCancellationStatus: RefreshCancellationStatus
@typing.type_check_only
class CandlestickChartSpec(typing_extensions.TypedDict, total=False):
data: _list[CandlestickData]
domain: CandlestickDomain
@typing.type_check_only
class CandlestickData(typing_extensions.TypedDict, total=False):
closeSeries: CandlestickSeries
highSeries: CandlestickSeries
lowSeries: CandlestickSeries
openSeries: CandlestickSeries
@typing.type_check_only
class CandlestickDomain(typing_extensions.TypedDict, total=False):
data: ChartData
reversed: bool
@typing.type_check_only
class CandlestickSeries(typing_extensions.TypedDict, total=False):
data: ChartData
@typing.type_check_only
class CellData(typing_extensions.TypedDict, total=False):
dataSourceFormula: DataSourceFormula
dataSourceTable: DataSourceTable
dataValidation: DataValidationRule
effectiveFormat: CellFormat
effectiveValue: ExtendedValue
formattedValue: str
hyperlink: str
note: str
pivotTable: PivotTable
textFormatRuns: _list[TextFormatRun]
userEnteredFormat: CellFormat
userEnteredValue: ExtendedValue
@typing.type_check_only
class CellFormat(typing_extensions.TypedDict, total=False):
backgroundColor: Color
backgroundColorStyle: ColorStyle
borders: Borders
horizontalAlignment: typing_extensions.Literal[
"HORIZONTAL_ALIGN_UNSPECIFIED", "LEFT", "CENTER", "RIGHT"
]
hyperlinkDisplayType: typing_extensions.Literal[
"HYPERLINK_DISPLAY_TYPE_UNSPECIFIED", "LINKED", "PLAIN_TEXT"
]
numberFormat: NumberFormat
padding: Padding
textDirection: typing_extensions.Literal[
"TEXT_DIRECTION_UNSPECIFIED", "LEFT_TO_RIGHT", "RIGHT_TO_LEFT"
]
textFormat: TextFormat
textRotation: TextRotation
verticalAlignment: typing_extensions.Literal[
"VERTICAL_ALIGN_UNSPECIFIED", "TOP", "MIDDLE", "BOTTOM"
]
wrapStrategy: typing_extensions.Literal[
"WRAP_STRATEGY_UNSPECIFIED", "OVERFLOW_CELL", "LEGACY_WRAP", "CLIP", "WRAP"
]
@typing.type_check_only
class ChartAxisViewWindowOptions(typing_extensions.TypedDict, total=False):
viewWindowMax: float
viewWindowMin: float
viewWindowMode: typing_extensions.Literal[
"DEFAULT_VIEW_WINDOW_MODE", "VIEW_WINDOW_MODE_UNSUPPORTED", "EXPLICIT", "PRETTY"
]
@typing.type_check_only
class ChartCustomNumberFormatOptions(typing_extensions.TypedDict, total=False):
prefix: str
suffix: str
@typing.type_check_only
class ChartData(typing_extensions.TypedDict, total=False):
aggregateType: typing_extensions.Literal[
"CHART_AGGREGATE_TYPE_UNSPECIFIED",
"AVERAGE",
"COUNT",
"MAX",
"MEDIAN",
"MIN",
"SUM",
]
columnReference: DataSourceColumnReference
groupRule: ChartGroupRule
sourceRange: ChartSourceRange
@typing.type_check_only
class ChartDateTimeRule(typing_extensions.TypedDict, total=False):
type: typing_extensions.Literal[
"CHART_DATE_TIME_RULE_TYPE_UNSPECIFIED",
"SECOND",
"MINUTE",
"HOUR",
"HOUR_MINUTE",
"HOUR_MINUTE_AMPM",
"DAY_OF_WEEK",
"DAY_OF_YEAR",
"DAY_OF_MONTH",
"DAY_MONTH",
"MONTH",
"QUARTER",
"YEAR",
"YEAR_MONTH",
"YEAR_QUARTER",
"YEAR_MONTH_DAY",
]
@typing.type_check_only
class ChartGroupRule(typing_extensions.TypedDict, total=False):
dateTimeRule: ChartDateTimeRule
histogramRule: ChartHistogramRule
@typing.type_check_only
class ChartHistogramRule(typing_extensions.TypedDict, total=False):
intervalSize: float
maxValue: float
minValue: float
@typing.type_check_only
class ChartSourceRange(typing_extensions.TypedDict, total=False):
sources: _list[GridRange]
@typing.type_check_only
class ChartSpec(typing_extensions.TypedDict, total=False):
altText: str
backgroundColor: Color
backgroundColorStyle: ColorStyle
basicChart: BasicChartSpec
bubbleChart: BubbleChartSpec
candlestickChart: CandlestickChartSpec
dataSourceChartProperties: DataSourceChartProperties
filterSpecs: _list[FilterSpec]
fontName: str
hiddenDimensionStrategy: typing_extensions.Literal[
"CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
"SKIP_HIDDEN_ROWS_AND_COLUMNS",
"SKIP_HIDDEN_ROWS",
"SKIP_HIDDEN_COLUMNS",
"SHOW_ALL",
]
histogramChart: HistogramChartSpec
maximized: bool
orgChart: OrgChartSpec
pieChart: PieChartSpec
scorecardChart: ScorecardChartSpec
sortSpecs: _list[SortSpec]
subtitle: str
subtitleTextFormat: TextFormat
subtitleTextPosition: TextPosition
title: str
titleTextFormat: TextFormat
titleTextPosition: TextPosition
treemapChart: TreemapChartSpec
waterfallChart: WaterfallChartSpec
@typing.type_check_only
class ClearBasicFilterRequest(typing_extensions.TypedDict, total=False):
sheetId: int
@typing.type_check_only
class ClearValuesRequest(typing_extensions.TypedDict, total=False): ...
@typing.type_check_only
class ClearValuesResponse(typing_extensions.TypedDict, total=False):
clearedRange: str
spreadsheetId: str
@typing.type_check_only
class Color(typing_extensions.TypedDict, total=False):
alpha: float
blue: float
green: float
red: float
@typing.type_check_only
class ColorStyle(typing_extensions.TypedDict, total=False):
rgbColor: Color
themeColor: typing_extensions.Literal[
"THEME_COLOR_TYPE_UNSPECIFIED",
"TEXT",
"BACKGROUND",
"ACCENT1",
"ACCENT2",
"ACCENT3",
"ACCENT4",
"ACCENT5",
"ACCENT6",
"LINK",
]
@typing.type_check_only
class ConditionValue(typing_extensions.TypedDict, total=False):
relativeDate: typing_extensions.Literal[
"RELATIVE_DATE_UNSPECIFIED",
"PAST_YEAR",
"PAST_MONTH",
"PAST_WEEK",
"YESTERDAY",
"TODAY",
"TOMORROW",
]
userEnteredValue: str
@typing.type_check_only
class ConditionalFormatRule(typing_extensions.TypedDict, total=False):
booleanRule: BooleanRule
gradientRule: GradientRule
ranges: _list[GridRange]
@typing.type_check_only
class CopyPasteRequest(typing_extensions.TypedDict, total=False):
destination: GridRange
pasteOrientation: typing_extensions.Literal["NORMAL", "TRANSPOSE"]
pasteType: typing_extensions.Literal[
"PASTE_NORMAL",
"PASTE_VALUES",
"PASTE_FORMAT",
"PASTE_NO_BORDERS",
"PASTE_FORMULA",
"PASTE_DATA_VALIDATION",
"PASTE_CONDITIONAL_FORMATTING",
]
source: GridRange
@typing.type_check_only
class CopySheetToAnotherSpreadsheetRequest(typing_extensions.TypedDict, total=False):
destinationSpreadsheetId: str
@typing.type_check_only
class CreateDeveloperMetadataRequest(typing_extensions.TypedDict, total=False):
developerMetadata: DeveloperMetadata
@typing.type_check_only
class CreateDeveloperMetadataResponse(typing_extensions.TypedDict, total=False):
developerMetadata: DeveloperMetadata
@typing.type_check_only
class CutPasteRequest(typing_extensions.TypedDict, total=False):
destination: GridCoordinate
pasteType: typing_extensions.Literal[
"PASTE_NORMAL",
"PASTE_VALUES",
"PASTE_FORMAT",
"PASTE_NO_BORDERS",
"PASTE_FORMULA",
"PASTE_DATA_VALIDATION",
"PASTE_CONDITIONAL_FORMATTING",
]
source: GridRange
@typing.type_check_only
class DataExecutionStatus(typing_extensions.TypedDict, total=False):
errorCode: typing_extensions.Literal[
"DATA_EXECUTION_ERROR_CODE_UNSPECIFIED",
"TIMED_OUT",
"TOO_MANY_ROWS",
"TOO_MANY_COLUMNS",
"TOO_MANY_CELLS",
"ENGINE",
"PARAMETER_INVALID",
"UNSUPPORTED_DATA_TYPE",
"DUPLICATE_COLUMN_NAMES",
"INTERRUPTED",
"CONCURRENT_QUERY",
"OTHER",
"TOO_MANY_CHARS_PER_CELL",
"DATA_NOT_FOUND",
"PERMISSION_DENIED",
"MISSING_COLUMN_ALIAS",
"OBJECT_NOT_FOUND",
"OBJECT_IN_ERROR_STATE",
"OBJECT_SPEC_INVALID",
"DATA_EXECUTION_CANCELLED",
]
errorMessage: str
lastRefreshTime: str
state: typing_extensions.Literal[
"DATA_EXECUTION_STATE_UNSPECIFIED",
"NOT_STARTED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
]
@typing.type_check_only
class DataFilter(typing_extensions.TypedDict, total=False):
a1Range: str
developerMetadataLookup: DeveloperMetadataLookup
gridRange: GridRange
@typing.type_check_only
class DataFilterValueRange(typing_extensions.TypedDict, total=False):
dataFilter: DataFilter
majorDimension: typing_extensions.Literal[
"DIMENSION_UNSPECIFIED", "ROWS", "COLUMNS"
]
values: _list[_list[typing.Any]]
@typing.type_check_only
class DataLabel(typing_extensions.TypedDict, total=False):
customLabelData: ChartData
placement: typing_extensions.Literal[
"DATA_LABEL_PLACEMENT_UNSPECIFIED",
"CENTER",
"LEFT",
"RIGHT",
"ABOVE",
"BELOW",
"INSIDE_END",
"INSIDE_BASE",
"OUTSIDE_END",
]
textFormat: TextFormat
type: typing_extensions.Literal[
"DATA_LABEL_TYPE_UNSPECIFIED", "NONE", "DATA", "CUSTOM"
]
@typing.type_check_only
class DataSource(typing_extensions.TypedDict, total=False):
calculatedColumns: _list[DataSourceColumn]
dataSourceId: str
sheetId: int
spec: DataSourceSpec
@typing.type_check_only
class DataSourceChartProperties(typing_extensions.TypedDict, total=False):
dataExecutionStatus: DataExecutionStatus
dataSourceId: str
@typing.type_check_only
class DataSourceColumn(typing_extensions.TypedDict, total=False):
formula: str
reference: DataSourceColumnReference
@typing.type_check_only
class DataSourceColumnReference(typing_extensions.TypedDict, total=False):
name: str
@typing.type_check_only
class DataSourceFormula(typing_extensions.TypedDict, total=False):
dataExecutionStatus: DataExecutionStatus
dataSourceId: str
@typing.type_check_only
class DataSourceObjectReference(typing_extensions.TypedDict, total=False):
chartId: int
dataSourceFormulaCell: GridCoordinate
dataSourcePivotTableAnchorCell: GridCoordinate
dataSourceTableAnchorCell: GridCoordinate
sheetId: str
@typing.type_check_only
class DataSourceObjectReferences(typing_extensions.TypedDict, total=False):
references: _list[DataSourceObjectReference]
@typing.type_check_only
class DataSourceParameter(typing_extensions.TypedDict, total=False):
name: str
namedRangeId: str
range: GridRange
@typing.type_check_only
class DataSourceRefreshDailySchedule(typing_extensions.TypedDict, total=False):
startTime: TimeOfDay
@typing.type_check_only
class DataSourceRefreshMonthlySchedule(typing_extensions.TypedDict, total=False):
daysOfMonth: _list[int]
startTime: TimeOfDay
@typing.type_check_only
class DataSourceRefreshSchedule(typing_extensions.TypedDict, total=False):
dailySchedule: DataSourceRefreshDailySchedule
enabled: bool
monthlySchedule: DataSourceRefreshMonthlySchedule
nextRun: Interval
refreshScope: typing_extensions.Literal[
"DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED", "ALL_DATA_SOURCES"
]
weeklySchedule: DataSourceRefreshWeeklySchedule
@typing.type_check_only
class DataSourceRefreshWeeklySchedule(typing_extensions.TypedDict, total=False):
daysOfWeek: _list[
typing_extensions.Literal[
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY",
]
]
startTime: TimeOfDay
@typing.type_check_only
class DataSourceSheetDimensionRange(typing_extensions.TypedDict, total=False):
columnReferences: _list[DataSourceColumnReference]
sheetId: int
@typing.type_check_only
class DataSourceSheetProperties(typing_extensions.TypedDict, total=False):
columns: _list[DataSourceColumn]
dataExecutionStatus: DataExecutionStatus
dataSourceId: str
@typing.type_check_only
class DataSourceSpec(typing_extensions.TypedDict, total=False):
bigQuery: BigQueryDataSourceSpec
looker: LookerDataSourceSpec
parameters: _list[DataSourceParameter]
@typing.type_check_only
class DataSourceTable(typing_extensions.TypedDict, total=False):
columnSelectionType: typing_extensions.Literal[
"DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED", "SELECTED", "SYNC_ALL"
]
columns: _list[DataSourceColumnReference]
dataExecutionStatus: DataExecutionStatus
dataSourceId: str
filterSpecs: _list[FilterSpec]
rowLimit: int
sortSpecs: _list[SortSpec]
@typing.type_check_only
class DataValidationRule(typing_extensions.TypedDict, total=False):
condition: BooleanCondition
inputMessage: str
showCustomUi: bool
strict: bool
@typing.type_check_only
class DateTimeRule(typing_extensions.TypedDict, total=False):
type: typing_extensions.Literal[
"DATE_TIME_RULE_TYPE_UNSPECIFIED",
"SECOND",
"MINUTE",
"HOUR",
"HOUR_MINUTE",
"HOUR_MINUTE_AMPM",
"DAY_OF_WEEK",
"DAY_OF_YEAR",
"DAY_OF_MONTH",
"DAY_MONTH",
"MONTH",
"QUARTER",
"YEAR",
"YEAR_MONTH",
"YEAR_QUARTER",
"YEAR_MONTH_DAY",
]
@typing.type_check_only
class DeleteBandingRequest(typing_extensions.TypedDict, total=False):
bandedRangeId: int
@typing.type_check_only
class DeleteConditionalFormatRuleRequest(typing_extensions.TypedDict, total=False):
index: int
sheetId: int
@typing.type_check_only
class DeleteConditionalFormatRuleResponse(typing_extensions.TypedDict, total=False):
rule: ConditionalFormatRule
@typing.type_check_only
class DeleteDataSourceRequest(typing_extensions.TypedDict, total=False):
dataSourceId: str
@typing.type_check_only
class DeleteDeveloperMetadataRequest(typing_extensions.TypedDict, total=False):
dataFilter: DataFilter
@typing.type_check_only
class DeleteDeveloperMetadataResponse(typing_extensions.TypedDict, total=False):
deletedDeveloperMetadata: _list[DeveloperMetadata]
@typing.type_check_only
class DeleteDimensionGroupRequest(typing_extensions.TypedDict, total=False):
range: DimensionRange
@typing.type_check_only
class DeleteDimensionGroupResponse(typing_extensions.TypedDict, total=False):
dimensionGroups: _list[DimensionGroup]
@typing.type_check_only
class DeleteDimensionRequest(typing_extensions.TypedDict, total=False):
range: DimensionRange
@typing.type_check_only
class DeleteDuplicatesRequest(typing_extensions.TypedDict, total=False):
comparisonColumns: _list[DimensionRange]
range: GridRange
@typing.type_check_only
class DeleteDuplicatesResponse(typing_extensions.TypedDict, total=False):
duplicatesRemovedCount: int
@typing.type_check_only
class DeleteEmbeddedObjectRequest(typing_extensions.TypedDict, total=False):
objectId: int
@typing.type_check_only
class DeleteFilterViewRequest(typing_extensions.TypedDict, total=False):
filterId: int
@typing.type_check_only
class DeleteNamedRangeRequest(typing_extensions.TypedDict, total=False):
namedRangeId: str
@typing.type_check_only
class DeleteProtectedRangeRequest(typing_extensions.TypedDict, total=False):
protectedRangeId: int
@typing.type_check_only
class DeleteRangeRequest(typing_extensions.TypedDict, total=False):
range: GridRange
shiftDimension: typing_extensions.Literal[
"DIMENSION_UNSPECIFIED", "ROWS", "COLUMNS"
]
@typing.type_check_only
class DeleteSheetRequest(typing_extensions.TypedDict, total=False):
sheetId: int
@typing.type_check_only
class DeveloperMetadata(typing_extensions.TypedDict, total=False):
location: DeveloperMetadataLocation
metadataId: int
metadataKey: str
metadataValue: str
visibility: typing_extensions.Literal[
"DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED", "DOCUMENT", "PROJECT"
]