Documentation ¶
Overview ¶
Package sheets provides access to the Google Sheets API.
For product documentation, see: https://developers.google.com/sheets/
Creating a client ¶
Usage example:
import "google.golang.org/api/sheets/v4" ... ctx := context.Background() sheetsService, err := sheets.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
sheetsService, err := sheets.NewService(ctx, option.WithScopes(sheets.SpreadsheetsReadonlyScope))
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
sheetsService, err := sheets.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) sheetsService, err := sheets.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type AddBandingRequest
- type AddBandingResponse
- type AddChartRequest
- type AddChartResponse
- type AddConditionalFormatRuleRequest
- type AddDataSourceRequest
- type AddDataSourceResponse
- type AddDimensionGroupRequest
- type AddDimensionGroupResponse
- type AddFilterViewRequest
- type AddFilterViewResponse
- type AddNamedRangeRequest
- type AddNamedRangeResponse
- type AddProtectedRangeRequest
- type AddProtectedRangeResponse
- type AddSheetRequest
- type AddSheetResponse
- type AddSlicerRequest
- type AddSlicerResponse
- type AppendCellsRequest
- type AppendDimensionRequest
- type AppendValuesResponse
- type AutoFillRequest
- type AutoResizeDimensionsRequest
- type BandedRange
- type BandingProperties
- type BaselineValueFormat
- type BasicChartAxis
- type BasicChartDomain
- type BasicChartSeries
- type BasicChartSpec
- type BasicFilter
- type BasicSeriesDataPointStyleOverride
- type BatchClearValuesByDataFilterRequest
- type BatchClearValuesByDataFilterResponse
- type BatchClearValuesRequest
- type BatchClearValuesResponse
- type BatchGetValuesByDataFilterRequest
- type BatchGetValuesByDataFilterResponse
- type BatchGetValuesResponse
- type BatchUpdateSpreadsheetRequest
- type BatchUpdateSpreadsheetResponse
- type BatchUpdateValuesByDataFilterRequest
- type BatchUpdateValuesByDataFilterResponse
- type BatchUpdateValuesRequest
- type BatchUpdateValuesResponse
- type BigQueryDataSourceSpec
- type BigQueryQuerySpec
- type BigQueryTableSpec
- type BooleanCondition
- type BooleanRule
- type Border
- type Borders
- type BubbleChartSpec
- type CandlestickChartSpec
- type CandlestickData
- type CandlestickDomain
- type CandlestickSeries
- type CellData
- type CellFormat
- type ChartAxisViewWindowOptions
- type ChartCustomNumberFormatOptions
- type ChartData
- type ChartDateTimeRule
- type ChartGroupRule
- type ChartHistogramRule
- type ChartSourceRange
- type ChartSpec
- type ClearBasicFilterRequest
- type ClearValuesRequest
- type ClearValuesResponse
- type Color
- type ColorStyle
- type ConditionValue
- type ConditionalFormatRule
- type CopyPasteRequest
- type CopySheetToAnotherSpreadsheetRequest
- type CreateDeveloperMetadataRequest
- type CreateDeveloperMetadataResponse
- type CutPasteRequest
- type DataExecutionStatus
- type DataFilter
- type DataFilterValueRange
- type DataLabel
- type DataSource
- type DataSourceChartProperties
- type DataSourceColumn
- type DataSourceColumnReference
- type DataSourceFormula
- type DataSourceObjectReference
- type DataSourceObjectReferences
- type DataSourceParameter
- type DataSourceRefreshDailySchedule
- type DataSourceRefreshMonthlySchedule
- type DataSourceRefreshSchedule
- type DataSourceRefreshWeeklySchedule
- type DataSourceSheetDimensionRange
- type DataSourceSheetProperties
- type DataSourceSpec
- type DataSourceTable
- type DataValidationRule
- type DateTimeRule
- type DeleteBandingRequest
- type DeleteConditionalFormatRuleRequest
- type DeleteConditionalFormatRuleResponse
- type DeleteDataSourceRequest
- type DeleteDeveloperMetadataRequest
- type DeleteDeveloperMetadataResponse
- type DeleteDimensionGroupRequest
- type DeleteDimensionGroupResponse
- type DeleteDimensionRequest
- type DeleteDuplicatesRequest
- type DeleteDuplicatesResponse
- type DeleteEmbeddedObjectRequest
- type DeleteFilterViewRequest
- type DeleteNamedRangeRequest
- type DeleteProtectedRangeRequest
- type DeleteRangeRequest
- type DeleteSheetRequest
- type DeveloperMetadata
- type DeveloperMetadataLocation
- type DeveloperMetadataLookup
- type DimensionGroup
- type DimensionProperties
- type DimensionRange
- type DuplicateFilterViewRequest
- type DuplicateFilterViewResponse
- type DuplicateSheetRequest
- type DuplicateSheetResponse
- type Editors
- type EmbeddedChart
- type EmbeddedObjectBorder
- type EmbeddedObjectPosition
- type ErrorValue
- type ExtendedValue
- type FilterCriteria
- type FilterSpec
- type FilterView
- type FindReplaceRequest
- type FindReplaceResponse
- type GetSpreadsheetByDataFilterRequest
- type GradientRule
- type GridCoordinate
- type GridData
- type GridProperties
- type GridRange
- type HistogramChartSpec
- type HistogramRule
- type HistogramSeries
- type InsertDimensionRequest
- type InsertRangeRequest
- type InterpolationPoint
- type Interval
- type IterativeCalculationSettings
- type KeyValueFormat
- type LineStyle
- type Link
- type ManualRule
- type ManualRuleGroup
- type MatchedDeveloperMetadata
- type MatchedValueRange
- type MergeCellsRequest
- type MoveDimensionRequest
- type NamedRange
- type NumberFormat
- type OrgChartSpec
- type OverlayPosition
- type Padding
- type PasteDataRequest
- type PieChartSpec
- type PivotFilterCriteria
- type PivotFilterSpec
- type PivotGroup
- type PivotGroupLimit
- type PivotGroupRule
- type PivotGroupSortValueBucket
- type PivotGroupValueMetadata
- type PivotTable
- type PivotValue
- type PointStyle
- type ProtectedRange
- type RandomizeRangeRequest
- type RefreshDataSourceObjectExecutionStatus
- type RefreshDataSourceRequest
- type RefreshDataSourceResponse
- type RepeatCellRequest
- type Request
- type Response
- type RowData
- type ScorecardChartSpec
- type SearchDeveloperMetadataRequest
- type SearchDeveloperMetadataResponse
- type Service
- type SetBasicFilterRequest
- type SetDataValidationRequest
- type Sheet
- type SheetProperties
- type Slicer
- type SlicerSpec
- type SortRangeRequest
- type SortSpec
- type SourceAndDestination
- type Spreadsheet
- type SpreadsheetProperties
- type SpreadsheetTheme
- type SpreadsheetsBatchUpdateCall
- func (c *SpreadsheetsBatchUpdateCall) Context(ctx context.Context) *SpreadsheetsBatchUpdateCall
- func (c *SpreadsheetsBatchUpdateCall) Do(opts ...googleapi.CallOption) (*BatchUpdateSpreadsheetResponse, error)
- func (c *SpreadsheetsBatchUpdateCall) Fields(s ...googleapi.Field) *SpreadsheetsBatchUpdateCall
- func (c *SpreadsheetsBatchUpdateCall) Header() http.Header
- type SpreadsheetsCreateCall
- func (c *SpreadsheetsCreateCall) Context(ctx context.Context) *SpreadsheetsCreateCall
- func (c *SpreadsheetsCreateCall) Do(opts ...googleapi.CallOption) (*Spreadsheet, error)
- func (c *SpreadsheetsCreateCall) Fields(s ...googleapi.Field) *SpreadsheetsCreateCall
- func (c *SpreadsheetsCreateCall) Header() http.Header
- type SpreadsheetsDeveloperMetadataGetCall
- func (c *SpreadsheetsDeveloperMetadataGetCall) Context(ctx context.Context) *SpreadsheetsDeveloperMetadataGetCall
- func (c *SpreadsheetsDeveloperMetadataGetCall) Do(opts ...googleapi.CallOption) (*DeveloperMetadata, error)
- func (c *SpreadsheetsDeveloperMetadataGetCall) Fields(s ...googleapi.Field) *SpreadsheetsDeveloperMetadataGetCall
- func (c *SpreadsheetsDeveloperMetadataGetCall) Header() http.Header
- func (c *SpreadsheetsDeveloperMetadataGetCall) IfNoneMatch(entityTag string) *SpreadsheetsDeveloperMetadataGetCall
- type SpreadsheetsDeveloperMetadataSearchCall
- func (c *SpreadsheetsDeveloperMetadataSearchCall) Context(ctx context.Context) *SpreadsheetsDeveloperMetadataSearchCall
- func (c *SpreadsheetsDeveloperMetadataSearchCall) Do(opts ...googleapi.CallOption) (*SearchDeveloperMetadataResponse, error)
- func (c *SpreadsheetsDeveloperMetadataSearchCall) Fields(s ...googleapi.Field) *SpreadsheetsDeveloperMetadataSearchCall
- func (c *SpreadsheetsDeveloperMetadataSearchCall) Header() http.Header
- type SpreadsheetsDeveloperMetadataService
- type SpreadsheetsGetByDataFilterCall
- func (c *SpreadsheetsGetByDataFilterCall) Context(ctx context.Context) *SpreadsheetsGetByDataFilterCall
- func (c *SpreadsheetsGetByDataFilterCall) Do(opts ...googleapi.CallOption) (*Spreadsheet, error)
- func (c *SpreadsheetsGetByDataFilterCall) Fields(s ...googleapi.Field) *SpreadsheetsGetByDataFilterCall
- func (c *SpreadsheetsGetByDataFilterCall) Header() http.Header
- type SpreadsheetsGetCall
- func (c *SpreadsheetsGetCall) Context(ctx context.Context) *SpreadsheetsGetCall
- func (c *SpreadsheetsGetCall) Do(opts ...googleapi.CallOption) (*Spreadsheet, error)
- func (c *SpreadsheetsGetCall) Fields(s ...googleapi.Field) *SpreadsheetsGetCall
- func (c *SpreadsheetsGetCall) Header() http.Header
- func (c *SpreadsheetsGetCall) IfNoneMatch(entityTag string) *SpreadsheetsGetCall
- func (c *SpreadsheetsGetCall) IncludeGridData(includeGridData bool) *SpreadsheetsGetCall
- func (c *SpreadsheetsGetCall) Ranges(ranges ...string) *SpreadsheetsGetCall
- type SpreadsheetsService
- func (r *SpreadsheetsService) BatchUpdate(spreadsheetId string, ...) *SpreadsheetsBatchUpdateCall
- func (r *SpreadsheetsService) Create(spreadsheet *Spreadsheet) *SpreadsheetsCreateCall
- func (r *SpreadsheetsService) Get(spreadsheetId string) *SpreadsheetsGetCall
- func (r *SpreadsheetsService) GetByDataFilter(spreadsheetId string, ...) *SpreadsheetsGetByDataFilterCall
- type SpreadsheetsSheetsCopyToCall
- func (c *SpreadsheetsSheetsCopyToCall) Context(ctx context.Context) *SpreadsheetsSheetsCopyToCall
- func (c *SpreadsheetsSheetsCopyToCall) Do(opts ...googleapi.CallOption) (*SheetProperties, error)
- func (c *SpreadsheetsSheetsCopyToCall) Fields(s ...googleapi.Field) *SpreadsheetsSheetsCopyToCall
- func (c *SpreadsheetsSheetsCopyToCall) Header() http.Header
- type SpreadsheetsSheetsService
- type SpreadsheetsValuesAppendCall
- func (c *SpreadsheetsValuesAppendCall) Context(ctx context.Context) *SpreadsheetsValuesAppendCall
- func (c *SpreadsheetsValuesAppendCall) Do(opts ...googleapi.CallOption) (*AppendValuesResponse, error)
- func (c *SpreadsheetsValuesAppendCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesAppendCall
- func (c *SpreadsheetsValuesAppendCall) Header() http.Header
- func (c *SpreadsheetsValuesAppendCall) IncludeValuesInResponse(includeValuesInResponse bool) *SpreadsheetsValuesAppendCall
- func (c *SpreadsheetsValuesAppendCall) InsertDataOption(insertDataOption string) *SpreadsheetsValuesAppendCall
- func (c *SpreadsheetsValuesAppendCall) ResponseDateTimeRenderOption(responseDateTimeRenderOption string) *SpreadsheetsValuesAppendCall
- func (c *SpreadsheetsValuesAppendCall) ResponseValueRenderOption(responseValueRenderOption string) *SpreadsheetsValuesAppendCall
- func (c *SpreadsheetsValuesAppendCall) ValueInputOption(valueInputOption string) *SpreadsheetsValuesAppendCall
- type SpreadsheetsValuesBatchClearByDataFilterCall
- func (c *SpreadsheetsValuesBatchClearByDataFilterCall) Context(ctx context.Context) *SpreadsheetsValuesBatchClearByDataFilterCall
- func (c *SpreadsheetsValuesBatchClearByDataFilterCall) Do(opts ...googleapi.CallOption) (*BatchClearValuesByDataFilterResponse, error)
- func (c *SpreadsheetsValuesBatchClearByDataFilterCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesBatchClearByDataFilterCall
- func (c *SpreadsheetsValuesBatchClearByDataFilterCall) Header() http.Header
- type SpreadsheetsValuesBatchClearCall
- func (c *SpreadsheetsValuesBatchClearCall) Context(ctx context.Context) *SpreadsheetsValuesBatchClearCall
- func (c *SpreadsheetsValuesBatchClearCall) Do(opts ...googleapi.CallOption) (*BatchClearValuesResponse, error)
- func (c *SpreadsheetsValuesBatchClearCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesBatchClearCall
- func (c *SpreadsheetsValuesBatchClearCall) Header() http.Header
- type SpreadsheetsValuesBatchGetByDataFilterCall
- func (c *SpreadsheetsValuesBatchGetByDataFilterCall) Context(ctx context.Context) *SpreadsheetsValuesBatchGetByDataFilterCall
- func (c *SpreadsheetsValuesBatchGetByDataFilterCall) Do(opts ...googleapi.CallOption) (*BatchGetValuesByDataFilterResponse, error)
- func (c *SpreadsheetsValuesBatchGetByDataFilterCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesBatchGetByDataFilterCall
- func (c *SpreadsheetsValuesBatchGetByDataFilterCall) Header() http.Header
- type SpreadsheetsValuesBatchGetCall
- func (c *SpreadsheetsValuesBatchGetCall) Context(ctx context.Context) *SpreadsheetsValuesBatchGetCall
- func (c *SpreadsheetsValuesBatchGetCall) DateTimeRenderOption(dateTimeRenderOption string) *SpreadsheetsValuesBatchGetCall
- func (c *SpreadsheetsValuesBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetValuesResponse, error)
- func (c *SpreadsheetsValuesBatchGetCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesBatchGetCall
- func (c *SpreadsheetsValuesBatchGetCall) Header() http.Header
- func (c *SpreadsheetsValuesBatchGetCall) IfNoneMatch(entityTag string) *SpreadsheetsValuesBatchGetCall
- func (c *SpreadsheetsValuesBatchGetCall) MajorDimension(majorDimension string) *SpreadsheetsValuesBatchGetCall
- func (c *SpreadsheetsValuesBatchGetCall) Ranges(ranges ...string) *SpreadsheetsValuesBatchGetCall
- func (c *SpreadsheetsValuesBatchGetCall) ValueRenderOption(valueRenderOption string) *SpreadsheetsValuesBatchGetCall
- type SpreadsheetsValuesBatchUpdateByDataFilterCall
- func (c *SpreadsheetsValuesBatchUpdateByDataFilterCall) Context(ctx context.Context) *SpreadsheetsValuesBatchUpdateByDataFilterCall
- func (c *SpreadsheetsValuesBatchUpdateByDataFilterCall) Do(opts ...googleapi.CallOption) (*BatchUpdateValuesByDataFilterResponse, error)
- func (c *SpreadsheetsValuesBatchUpdateByDataFilterCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesBatchUpdateByDataFilterCall
- func (c *SpreadsheetsValuesBatchUpdateByDataFilterCall) Header() http.Header
- type SpreadsheetsValuesBatchUpdateCall
- func (c *SpreadsheetsValuesBatchUpdateCall) Context(ctx context.Context) *SpreadsheetsValuesBatchUpdateCall
- func (c *SpreadsheetsValuesBatchUpdateCall) Do(opts ...googleapi.CallOption) (*BatchUpdateValuesResponse, error)
- func (c *SpreadsheetsValuesBatchUpdateCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesBatchUpdateCall
- func (c *SpreadsheetsValuesBatchUpdateCall) Header() http.Header
- type SpreadsheetsValuesClearCall
- func (c *SpreadsheetsValuesClearCall) Context(ctx context.Context) *SpreadsheetsValuesClearCall
- func (c *SpreadsheetsValuesClearCall) Do(opts ...googleapi.CallOption) (*ClearValuesResponse, error)
- func (c *SpreadsheetsValuesClearCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesClearCall
- func (c *SpreadsheetsValuesClearCall) Header() http.Header
- type SpreadsheetsValuesGetCall
- func (c *SpreadsheetsValuesGetCall) Context(ctx context.Context) *SpreadsheetsValuesGetCall
- func (c *SpreadsheetsValuesGetCall) DateTimeRenderOption(dateTimeRenderOption string) *SpreadsheetsValuesGetCall
- func (c *SpreadsheetsValuesGetCall) Do(opts ...googleapi.CallOption) (*ValueRange, error)
- func (c *SpreadsheetsValuesGetCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesGetCall
- func (c *SpreadsheetsValuesGetCall) Header() http.Header
- func (c *SpreadsheetsValuesGetCall) IfNoneMatch(entityTag string) *SpreadsheetsValuesGetCall
- func (c *SpreadsheetsValuesGetCall) MajorDimension(majorDimension string) *SpreadsheetsValuesGetCall
- func (c *SpreadsheetsValuesGetCall) ValueRenderOption(valueRenderOption string) *SpreadsheetsValuesGetCall
- type SpreadsheetsValuesService
- func (r *SpreadsheetsValuesService) Append(spreadsheetId string, range_ string, valuerange *ValueRange) *SpreadsheetsValuesAppendCall
- func (r *SpreadsheetsValuesService) BatchClear(spreadsheetId string, batchclearvaluesrequest *BatchClearValuesRequest) *SpreadsheetsValuesBatchClearCall
- func (r *SpreadsheetsValuesService) BatchClearByDataFilter(spreadsheetId string, ...) *SpreadsheetsValuesBatchClearByDataFilterCall
- func (r *SpreadsheetsValuesService) BatchGet(spreadsheetId string) *SpreadsheetsValuesBatchGetCall
- func (r *SpreadsheetsValuesService) BatchGetByDataFilter(spreadsheetId string, ...) *SpreadsheetsValuesBatchGetByDataFilterCall
- func (r *SpreadsheetsValuesService) BatchUpdate(spreadsheetId string, batchupdatevaluesrequest *BatchUpdateValuesRequest) *SpreadsheetsValuesBatchUpdateCall
- func (r *SpreadsheetsValuesService) BatchUpdateByDataFilter(spreadsheetId string, ...) *SpreadsheetsValuesBatchUpdateByDataFilterCall
- func (r *SpreadsheetsValuesService) Clear(spreadsheetId string, range_ string, clearvaluesrequest *ClearValuesRequest) *SpreadsheetsValuesClearCall
- func (r *SpreadsheetsValuesService) Get(spreadsheetId string, range_ string) *SpreadsheetsValuesGetCall
- func (r *SpreadsheetsValuesService) Update(spreadsheetId string, range_ string, valuerange *ValueRange) *SpreadsheetsValuesUpdateCall
- type SpreadsheetsValuesUpdateCall
- func (c *SpreadsheetsValuesUpdateCall) Context(ctx context.Context) *SpreadsheetsValuesUpdateCall
- func (c *SpreadsheetsValuesUpdateCall) Do(opts ...googleapi.CallOption) (*UpdateValuesResponse, error)
- func (c *SpreadsheetsValuesUpdateCall) Fields(s ...googleapi.Field) *SpreadsheetsValuesUpdateCall
- func (c *SpreadsheetsValuesUpdateCall) Header() http.Header
- func (c *SpreadsheetsValuesUpdateCall) IncludeValuesInResponse(includeValuesInResponse bool) *SpreadsheetsValuesUpdateCall
- func (c *SpreadsheetsValuesUpdateCall) ResponseDateTimeRenderOption(responseDateTimeRenderOption string) *SpreadsheetsValuesUpdateCall
- func (c *SpreadsheetsValuesUpdateCall) ResponseValueRenderOption(responseValueRenderOption string) *SpreadsheetsValuesUpdateCall
- func (c *SpreadsheetsValuesUpdateCall) ValueInputOption(valueInputOption string) *SpreadsheetsValuesUpdateCall
- type TextFormat
- type TextFormatRun
- type TextPosition
- type TextRotation
- type TextToColumnsRequest
- type ThemeColorPair
- type TimeOfDay
- type TreemapChartColorScale
- type TreemapChartSpec
- type TrimWhitespaceRequest
- type TrimWhitespaceResponse
- type UnmergeCellsRequest
- type UpdateBandingRequest
- type UpdateBordersRequest
- type UpdateCellsRequest
- type UpdateChartSpecRequest
- type UpdateConditionalFormatRuleRequest
- type UpdateConditionalFormatRuleResponse
- type UpdateDataSourceRequest
- type UpdateDataSourceResponse
- type UpdateDeveloperMetadataRequest
- type UpdateDeveloperMetadataResponse
- type UpdateDimensionGroupRequest
- type UpdateDimensionPropertiesRequest
- type UpdateEmbeddedObjectBorderRequest
- type UpdateEmbeddedObjectPositionRequest
- type UpdateEmbeddedObjectPositionResponse
- type UpdateFilterViewRequest
- type UpdateNamedRangeRequest
- type UpdateProtectedRangeRequest
- type UpdateSheetPropertiesRequest
- type UpdateSlicerSpecRequest
- type UpdateSpreadsheetPropertiesRequest
- type UpdateValuesByDataFilterResponse
- type UpdateValuesResponse
- type ValueRange
- type WaterfallChartColumnStyle
- type WaterfallChartCustomSubtotal
- type WaterfallChartDomain
- type WaterfallChartSeries
- type WaterfallChartSpec
Constants ¶
const ( // See, edit, create, and delete all of your Google Drive files DriveScope = "https://www.googleapis.com/auth/drive" // See, edit, create, and delete only the specific Google Drive files // you use with this app DriveFileScope = "https://www.googleapis.com/auth/drive.file" // See and download all your Google Drive files DriveReadonlyScope = "https://www.googleapis.com/auth/drive.readonly" // See, edit, create, and delete all your Google Sheets spreadsheets SpreadsheetsScope = "https://www.googleapis.com/auth/spreadsheets" // See all your Google Sheets spreadsheets SpreadsheetsReadonlyScope = "https://www.googleapis.com/auth/spreadsheets.readonly" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddBandingRequest ¶
type AddBandingRequest struct { // BandedRange: The banded range to add. The bandedRangeId field is // optional; if one is not set, an id will be randomly generated. (It is // an error to specify the ID of a range that already exists.) BandedRange *BandedRange `json:"bandedRange,omitempty"` // ForceSendFields is a list of field names (e.g. "BandedRange") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BandedRange") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddBandingRequest: Adds a new banded range to the spreadsheet.
func (*AddBandingRequest) MarshalJSON ¶
func (s *AddBandingRequest) MarshalJSON() ([]byte, error)
type AddBandingResponse ¶
type AddBandingResponse struct { // BandedRange: The banded range that was added. BandedRange *BandedRange `json:"bandedRange,omitempty"` // ForceSendFields is a list of field names (e.g. "BandedRange") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BandedRange") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddBandingResponse: The result of adding a banded range.
func (*AddBandingResponse) MarshalJSON ¶
func (s *AddBandingResponse) MarshalJSON() ([]byte, error)
type AddChartRequest ¶
type AddChartRequest struct { // Chart: The chart that should be added to the spreadsheet, including // the position where it should be placed. The chartId field is // optional; if one is not set, an id will be randomly generated. (It is // an error to specify the ID of an embedded object that already // exists.) Chart *EmbeddedChart `json:"chart,omitempty"` // ForceSendFields is a list of field names (e.g. "Chart") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Chart") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddChartRequest: Adds a chart to a sheet in the spreadsheet.
func (*AddChartRequest) MarshalJSON ¶
func (s *AddChartRequest) MarshalJSON() ([]byte, error)
type AddChartResponse ¶
type AddChartResponse struct { // Chart: The newly added chart. Chart *EmbeddedChart `json:"chart,omitempty"` // ForceSendFields is a list of field names (e.g. "Chart") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Chart") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddChartResponse: The result of adding a chart to a spreadsheet.
func (*AddChartResponse) MarshalJSON ¶
func (s *AddChartResponse) MarshalJSON() ([]byte, error)
type AddConditionalFormatRuleRequest ¶
type AddConditionalFormatRuleRequest struct { // Index: The zero-based index where the rule should be inserted. Index int64 `json:"index,omitempty"` // Rule: The rule to add. Rule *ConditionalFormatRule `json:"rule,omitempty"` // ForceSendFields is a list of field names (e.g. "Index") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Index") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddConditionalFormatRuleRequest: Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented.
func (*AddConditionalFormatRuleRequest) MarshalJSON ¶
func (s *AddConditionalFormatRuleRequest) MarshalJSON() ([]byte, error)
type AddDataSourceRequest ¶ added in v0.31.0
type AddDataSourceRequest struct { // DataSource: The data source to add. DataSource *DataSource `json:"dataSource,omitempty"` // ForceSendFields is a list of field names (e.g. "DataSource") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataSource") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddDataSourceRequest: Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope.
func (*AddDataSourceRequest) MarshalJSON ¶ added in v0.31.0
func (s *AddDataSourceRequest) MarshalJSON() ([]byte, error)
type AddDataSourceResponse ¶ added in v0.31.0
type AddDataSourceResponse struct { // DataExecutionStatus: The data execution status. DataExecutionStatus *DataExecutionStatus `json:"dataExecutionStatus,omitempty"` // DataSource: The data source that was created. DataSource *DataSource `json:"dataSource,omitempty"` // ForceSendFields is a list of field names (e.g. "DataExecutionStatus") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataExecutionStatus") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
AddDataSourceResponse: The result of adding a data source.
func (*AddDataSourceResponse) MarshalJSON ¶ added in v0.31.0
func (s *AddDataSourceResponse) MarshalJSON() ([]byte, error)
type AddDimensionGroupRequest ¶
type AddDimensionGroupRequest struct { // Range: The range over which to create a group. Range *DimensionRange `json:"range,omitempty"` // ForceSendFields is a list of field names (e.g. "Range") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Range") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddDimensionGroupRequest: Creates a group over the specified range. If the requested range is a superset of the range of an existing group G, then the depth of G is incremented and this new group G' has the depth of that group. For example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range is a subset of the range of an existing group G, then the depth of the new group G' becomes one greater than the depth of G. For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range starts before and ends within, or starts within and ends after, the range of an existing group G, then the range of the existing group G becomes the union of the ranges, and the new group G' has depth one greater than the depth of G and range as the intersection of the ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, depth 2].
func (*AddDimensionGroupRequest) MarshalJSON ¶
func (s *AddDimensionGroupRequest) MarshalJSON() ([]byte, error)
type AddDimensionGroupResponse ¶
type AddDimensionGroupResponse struct { // DimensionGroups: All groups of a dimension after adding a group to // that dimension. DimensionGroups []*DimensionGroup `json:"dimensionGroups,omitempty"` // ForceSendFields is a list of field names (e.g. "DimensionGroups") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DimensionGroups") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
AddDimensionGroupResponse: The result of adding a group.
func (*AddDimensionGroupResponse) MarshalJSON ¶
func (s *AddDimensionGroupResponse) MarshalJSON() ([]byte, error)
type AddFilterViewRequest ¶
type AddFilterViewRequest struct { // Filter: The filter to add. The filterViewId field is optional; if one // is not set, an id will be randomly generated. (It is an error to // specify the ID of a filter that already exists.) Filter *FilterView `json:"filter,omitempty"` // ForceSendFields is a list of field names (e.g. "Filter") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Filter") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddFilterViewRequest: Adds a filter view.
func (*AddFilterViewRequest) MarshalJSON ¶
func (s *AddFilterViewRequest) MarshalJSON() ([]byte, error)
type AddFilterViewResponse ¶
type AddFilterViewResponse struct { // Filter: The newly added filter view. Filter *FilterView `json:"filter,omitempty"` // ForceSendFields is a list of field names (e.g. "Filter") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Filter") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddFilterViewResponse: The result of adding a filter view.
func (*AddFilterViewResponse) MarshalJSON ¶
func (s *AddFilterViewResponse) MarshalJSON() ([]byte, error)
type AddNamedRangeRequest ¶
type AddNamedRangeRequest struct { // NamedRange: The named range to add. The namedRangeId field is // optional; if one is not set, an id will be randomly generated. (It is // an error to specify the ID of a range that already exists.) NamedRange *NamedRange `json:"namedRange,omitempty"` // ForceSendFields is a list of field names (e.g. "NamedRange") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NamedRange") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddNamedRangeRequest: Adds a named range to the spreadsheet.
func (*AddNamedRangeRequest) MarshalJSON ¶
func (s *AddNamedRangeRequest) MarshalJSON() ([]byte, error)
type AddNamedRangeResponse ¶
type AddNamedRangeResponse struct { // NamedRange: The named range to add. NamedRange *NamedRange `json:"namedRange,omitempty"` // ForceSendFields is a list of field names (e.g. "NamedRange") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NamedRange") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddNamedRangeResponse: The result of adding a named range.
func (*AddNamedRangeResponse) MarshalJSON ¶
func (s *AddNamedRangeResponse) MarshalJSON() ([]byte, error)
type AddProtectedRangeRequest ¶
type AddProtectedRangeRequest struct { // ProtectedRange: The protected range to be added. The protectedRangeId // field is optional; if one is not set, an id will be randomly // generated. (It is an error to specify the ID of a range that already // exists.) ProtectedRange *ProtectedRange `json:"protectedRange,omitempty"` // ForceSendFields is a list of field names (e.g. "ProtectedRange") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ProtectedRange") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
AddProtectedRangeRequest: Adds a new protected range.
func (*AddProtectedRangeRequest) MarshalJSON ¶
func (s *AddProtectedRangeRequest) MarshalJSON() ([]byte, error)
type AddProtectedRangeResponse ¶
type AddProtectedRangeResponse struct { // ProtectedRange: The newly added protected range. ProtectedRange *ProtectedRange `json:"protectedRange,omitempty"` // ForceSendFields is a list of field names (e.g. "ProtectedRange") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ProtectedRange") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
AddProtectedRangeResponse: The result of adding a new protected range.
func (*AddProtectedRangeResponse) MarshalJSON ¶
func (s *AddProtectedRangeResponse) MarshalJSON() ([]byte, error)
type AddSheetRequest ¶
type AddSheetRequest struct { // Properties: The properties the new sheet should have. All properties // are optional. The sheetId field is optional; if one is not set, an id // will be randomly generated. (It is an error to specify the ID of a // sheet that already exists.) Properties *SheetProperties `json:"properties,omitempty"` // ForceSendFields is a list of field names (e.g. "Properties") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Properties") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddSheetRequest: Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet.
func (*AddSheetRequest) MarshalJSON ¶
func (s *AddSheetRequest) MarshalJSON() ([]byte, error)
type AddSheetResponse ¶
type AddSheetResponse struct { // Properties: The properties of the newly added sheet. Properties *SheetProperties `json:"properties,omitempty"` // ForceSendFields is a list of field names (e.g. "Properties") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Properties") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddSheetResponse: The result of adding a sheet.
func (*AddSheetResponse) MarshalJSON ¶
func (s *AddSheetResponse) MarshalJSON() ([]byte, error)
type AddSlicerRequest ¶ added in v0.14.0
type AddSlicerRequest struct { // Slicer: The slicer that should be added to the spreadsheet, including // the position where it should be placed. The slicerId field is // optional; if one is not set, an id will be randomly generated. (It is // an error to specify the ID of a slicer that already exists.) Slicer *Slicer `json:"slicer,omitempty"` // ForceSendFields is a list of field names (e.g. "Slicer") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Slicer") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddSlicerRequest: Adds a slicer to a sheet in the spreadsheet.
func (*AddSlicerRequest) MarshalJSON ¶ added in v0.14.0
func (s *AddSlicerRequest) MarshalJSON() ([]byte, error)
type AddSlicerResponse ¶ added in v0.14.0
type AddSlicerResponse struct { // Slicer: The newly added slicer. Slicer *Slicer `json:"slicer,omitempty"` // ForceSendFields is a list of field names (e.g. "Slicer") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Slicer") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddSlicerResponse: The result of adding a slicer to a spreadsheet.
func (*AddSlicerResponse) MarshalJSON ¶ added in v0.14.0
func (s *AddSlicerResponse) MarshalJSON() ([]byte, error)
type AppendCellsRequest ¶
type AppendCellsRequest struct { // Fields: The fields of CellData that should be updated. At least one // field must be specified. The root is the CellData; 'row.values.' // should not be specified. A single "*" can be used as short-hand for // listing every field. Fields string `json:"fields,omitempty"` // Rows: The data to append. Rows []*RowData `json:"rows,omitempty"` // SheetId: The sheet ID to append the data to. SheetId int64 `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "Fields") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Fields") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AppendCellsRequest: Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.
func (*AppendCellsRequest) MarshalJSON ¶
func (s *AppendCellsRequest) MarshalJSON() ([]byte, error)
type AppendDimensionRequest ¶
type AppendDimensionRequest struct { // Dimension: Whether rows or columns should be appended. // // Possible values: // "DIMENSION_UNSPECIFIED" - The default value, do not use. // "ROWS" - Operates on the rows of a sheet. // "COLUMNS" - Operates on the columns of a sheet. Dimension string `json:"dimension,omitempty"` // Length: The number of rows or columns to append. Length int64 `json:"length,omitempty"` // SheetId: The sheet to append rows or columns to. SheetId int64 `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "Dimension") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Dimension") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AppendDimensionRequest: Appends rows or columns to the end of a sheet.
func (*AppendDimensionRequest) MarshalJSON ¶
func (s *AppendDimensionRequest) MarshalJSON() ([]byte, error)
type AppendValuesResponse ¶
type AppendValuesResponse struct { // SpreadsheetId: The spreadsheet the updates were applied to. SpreadsheetId string `json:"spreadsheetId,omitempty"` // TableRange: The range (in A1 notation) of the table that values are // being appended to (before the values were appended). Empty if no // table was found. TableRange string `json:"tableRange,omitempty"` // Updates: Information about the updates that were applied. Updates *UpdateValuesResponse `json:"updates,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "SpreadsheetId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "SpreadsheetId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AppendValuesResponse: The response when updating a range of values in a spreadsheet.
func (*AppendValuesResponse) MarshalJSON ¶
func (s *AppendValuesResponse) MarshalJSON() ([]byte, error)
type AutoFillRequest ¶
type AutoFillRequest struct { // Range: The range to autofill. This will examine the range and detect // the location that has data and automatically fill that data in to the // rest of the range. Range *GridRange `json:"range,omitempty"` // SourceAndDestination: The source and destination areas to autofill. // This explicitly lists the source of the autofill and where to extend // that data. SourceAndDestination *SourceAndDestination `json:"sourceAndDestination,omitempty"` // UseAlternateSeries: True if we should generate data with the // "alternate" series. This differs based on the type and amount of // source data. UseAlternateSeries bool `json:"useAlternateSeries,omitempty"` // ForceSendFields is a list of field names (e.g. "Range") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Range") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AutoFillRequest: Fills in more data based on existing data.
func (*AutoFillRequest) MarshalJSON ¶
func (s *AutoFillRequest) MarshalJSON() ([]byte, error)
type AutoResizeDimensionsRequest ¶
type AutoResizeDimensionsRequest struct { // DataSourceSheetDimensions: The dimensions on a data source sheet to // automatically resize. DataSourceSheetDimensions *DataSourceSheetDimensionRange `json:"dataSourceSheetDimensions,omitempty"` // Dimensions: The dimensions to automatically resize. Dimensions *DimensionRange `json:"dimensions,omitempty"` // ForceSendFields is a list of field names (e.g. // "DataSourceSheetDimensions") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "DataSourceSheetDimensions") to include in API requests with the JSON // null value. By default, fields with empty values are omitted from API // requests. However, any field with an empty value appearing in // NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
AutoResizeDimensionsRequest: Automatically resizes one or more dimensions based on the contents of the cells in that dimension.
func (*AutoResizeDimensionsRequest) MarshalJSON ¶
func (s *AutoResizeDimensionsRequest) MarshalJSON() ([]byte, error)
type BandedRange ¶
type BandedRange struct { // BandedRangeId: The id of the banded range. BandedRangeId int64 `json:"bandedRangeId,omitempty"` // ColumnProperties: Properties for column bands. These properties are // applied on a column- by-column basis throughout all the columns in // the range. At least one of row_properties or column_properties must // be specified. ColumnProperties *BandingProperties `json:"columnProperties,omitempty"` // Range: The range over which these properties are applied. Range *GridRange `json:"range,omitempty"` // RowProperties: Properties for row bands. These properties are applied // on a row-by-row basis throughout all the rows in the range. At least // one of row_properties or column_properties must be specified. RowProperties *BandingProperties `json:"rowProperties,omitempty"` // ForceSendFields is a list of field names (e.g. "BandedRangeId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BandedRangeId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BandedRange: A banded (alternating colors) range in a sheet.
func (*BandedRange) MarshalJSON ¶
func (s *BandedRange) MarshalJSON() ([]byte, error)
type BandingProperties ¶
type BandingProperties struct { // FirstBandColor: The first color that is alternating. (Required) // Deprecated: Use first_band_color_style. FirstBandColor *Color `json:"firstBandColor,omitempty"` // FirstBandColorStyle: The first color that is alternating. (Required) // If first_band_color is also set, this field takes precedence. FirstBandColorStyle *ColorStyle `json:"firstBandColorStyle,omitempty"` // not set, the last row or column is filled with either // first_band_color or second_band_color, depending on the color of the // previous row or column. Deprecated: Use footer_color_style. FooterColor *Color `json:"footerColor,omitempty"` // is not set, the last row or column is filled with either // first_band_color or second_band_color, depending on the color of the // previous row or column. If footer_color is also set, this field takes // precedence. FooterColorStyle *ColorStyle `json:"footerColorStyle,omitempty"` // HeaderColor: The color of the first row or column. If this field is // set, the first row or column is filled with this color and the colors // alternate between first_band_color and second_band_color starting // from the second row or column. Otherwise, the first row or column is // filled with first_band_color and the colors proceed to alternate as // they normally would. Deprecated: Use header_color_style. HeaderColor *Color `json:"headerColor,omitempty"` // HeaderColorStyle: The color of the first row or column. If this field // is set, the first row or column is filled with this color and the // colors alternate between first_band_color and second_band_color // starting from the second row or column. Otherwise, the first row or // column is filled with first_band_color and the colors proceed to // alternate as they normally would. If header_color is also set, this // field takes precedence. HeaderColorStyle *ColorStyle `json:"headerColorStyle,omitempty"` // SecondBandColor: The second color that is alternating. (Required) // Deprecated: Use second_band_color_style. SecondBandColor *Color `json:"secondBandColor,omitempty"` // SecondBandColorStyle: The second color that is alternating. // (Required) If second_band_color is also set, this field takes // precedence. SecondBandColorStyle *ColorStyle `json:"secondBandColorStyle,omitempty"` // ForceSendFields is a list of field names (e.g. "FirstBandColor") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FirstBandColor") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
BandingProperties: Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.
func (*BandingProperties) MarshalJSON ¶
func (s *BandingProperties) MarshalJSON() ([]byte, error)
type BaselineValueFormat ¶ added in v0.12.0
type BaselineValueFormat struct { // ComparisonType: The comparison type of key value with baseline value. // // Possible values: // "COMPARISON_TYPE_UNDEFINED" - Default value, do not use. // "ABSOLUTE_DIFFERENCE" - Use absolute difference between key and // baseline value. // "PERCENTAGE_DIFFERENCE" - Use percentage difference between key and // baseline value. ComparisonType string `json:"comparisonType,omitempty"` // Description: Description which is appended after the baseline value. // This field is optional. Description string `json:"description,omitempty"` // NegativeColor: Color to be used, in case baseline value represents a // negative change for key value. This field is optional. Deprecated: // Use negative_color_style. NegativeColor *Color `json:"negativeColor,omitempty"` // NegativeColorStyle: Color to be used, in case baseline value // represents a negative change for key value. This field is optional. // If negative_color is also set, this field takes precedence. NegativeColorStyle *ColorStyle `json:"negativeColorStyle,omitempty"` // Position: Specifies the horizontal text positioning of baseline // value. This field is optional. If not specified, default positioning // is used. Position *TextPosition `json:"position,omitempty"` // PositiveColor: Color to be used, in case baseline value represents a // positive change for key value. This field is optional. Deprecated: // Use positive_color_style. PositiveColor *Color `json:"positiveColor,omitempty"` // PositiveColorStyle: Color to be used, in case baseline value // represents a positive change for key value. This field is optional. // If positive_color is also set, this field takes precedence. PositiveColorStyle *ColorStyle `json:"positiveColorStyle,omitempty"` // TextFormat: Text formatting options for baseline value. The link // field is not supported. TextFormat *TextFormat `json:"textFormat,omitempty"` // ForceSendFields is a list of field names (e.g. "ComparisonType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ComparisonType") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
BaselineValueFormat: Formatting options for baseline value.
func (*BaselineValueFormat) MarshalJSON ¶ added in v0.12.0
func (s *BaselineValueFormat) MarshalJSON() ([]byte, error)
type BasicChartAxis ¶
type BasicChartAxis struct { // Format: The format of the title. Only valid if the axis is not // associated with the domain. The link field is not supported. Format *TextFormat `json:"format,omitempty"` // Position: The position of this axis. // // Possible values: // "BASIC_CHART_AXIS_POSITION_UNSPECIFIED" - Default value, do not // use. // "BOTTOM_AXIS" - The axis rendered at the bottom of a chart. For // most charts, this is the standard major axis. For bar charts, this is // a minor axis. // "LEFT_AXIS" - The axis rendered at the left of a chart. For most // charts, this is a minor axis. For bar charts, this is the standard // major axis. // "RIGHT_AXIS" - The axis rendered at the right of a chart. For most // charts, this is a minor axis. For bar charts, this is an unusual // major axis. Position string `json:"position,omitempty"` // Title: The title of this axis. If set, this overrides any title // inferred from headers of the data. Title string `json:"title,omitempty"` // TitleTextPosition: The axis title text position. TitleTextPosition *TextPosition `json:"titleTextPosition,omitempty"` // ViewWindowOptions: The view window options for this axis. ViewWindowOptions *ChartAxisViewWindowOptions `json:"viewWindowOptions,omitempty"` // ForceSendFields is a list of field names (e.g. "Format") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Format") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BasicChartAxis: An axis of the chart. A chart may not have more than one axis per axis position.
func (*BasicChartAxis) MarshalJSON ¶
func (s *BasicChartAxis) MarshalJSON() ([]byte, error)
type BasicChartDomain ¶
type BasicChartDomain struct { // Domain: The data of the domain. For example, if charting stock prices // over time, this is the data representing the dates. Domain *ChartData `json:"domain,omitempty"` // Reversed: True to reverse the order of the domain values (horizontal // axis). Reversed bool `json:"reversed,omitempty"` // ForceSendFields is a list of field names (e.g. "Domain") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Domain") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BasicChartDomain: The domain of a chart. For example, if charting stock prices over time, this would be the date.
func (*BasicChartDomain) MarshalJSON ¶
func (s *BasicChartDomain) MarshalJSON() ([]byte, error)
type BasicChartSeries ¶
type BasicChartSeries struct { // Color: The color for elements (such as bars, lines, and points) // associated with this series. If empty, a default color is used. // Deprecated: Use color_style. Color *Color `json:"color,omitempty"` // ColorStyle: The color for elements (such as bars, lines, and points) // associated with this series. If empty, a default color is used. If // color is also set, this field takes precedence. ColorStyle *ColorStyle `json:"colorStyle,omitempty"` // DataLabel: Information about the data labels for this series. DataLabel *DataLabel `json:"dataLabel,omitempty"` // LineStyle: The line style of this series. Valid only if the chartType // is AREA, LINE, or SCATTER. COMBO charts are also supported if the // series chart type is AREA or LINE. LineStyle *LineStyle `json:"lineStyle,omitempty"` // PointStyle: The style for points associated with this series. Valid // only if the chartType is AREA, LINE, or SCATTER. COMBO charts are // also supported if the series chart type is AREA, LINE, or SCATTER. If // empty, a default point style is used. PointStyle *PointStyle `json:"pointStyle,omitempty"` // Series: The data being visualized in this chart series. Series *ChartData `json:"series,omitempty"` // StyleOverrides: Style override settings for series data points. StyleOverrides []*BasicSeriesDataPointStyleOverride `json:"styleOverrides,omitempty"` // TargetAxis: The minor axis that will specify the range of values for // this series. For example, if charting stocks over time, the "Volume" // series may want to be pinned to the right with the prices pinned to // the left, because the scale of trading volume is different than the // scale of prices. It is an error to specify an axis that isn't a valid // minor axis for the chart's type. // // Possible values: // "BASIC_CHART_AXIS_POSITION_UNSPECIFIED" - Default value, do not // use. // "BOTTOM_AXIS" - The axis rendered at the bottom of a chart. For // most charts, this is the standard major axis. For bar charts, this is // a minor axis. // "LEFT_AXIS" - The axis rendered at the left of a chart. For most // charts, this is a minor axis. For bar charts, this is the standard // major axis. // "RIGHT_AXIS" - The axis rendered at the right of a chart. For most // charts, this is a minor axis. For bar charts, this is an unusual // major axis. TargetAxis string `json:"targetAxis,omitempty"` // Type: The type of this series. Valid only if the chartType is COMBO. // Different types will change the way the series is visualized. Only // LINE, AREA, and COLUMN are supported. // // Possible values: // "BASIC_CHART_TYPE_UNSPECIFIED" - Default value, do not use. // "BAR" - A bar chart. // "LINE" - A line chart. // "AREA" - An area chart. // "COLUMN" - A column chart. // "SCATTER" - A scatter chart. // "COMBO" - A combo chart. // "STEPPED_AREA" - A stepped area chart. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Color") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Color") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BasicChartSeries: A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price".
func (*BasicChartSeries) MarshalJSON ¶
func (s *BasicChartSeries) MarshalJSON() ([]byte, error)
type BasicChartSpec ¶
type BasicChartSpec struct { // Axis: The axis on the chart. Axis []*BasicChartAxis `json:"axis,omitempty"` // ChartType: The type of the chart. // // Possible values: // "BASIC_CHART_TYPE_UNSPECIFIED" - Default value, do not use. // "BAR" - A bar chart. // "LINE" - A line chart. // "AREA" - An area chart. // "COLUMN" - A column chart. // "SCATTER" - A scatter chart. // "COMBO" - A combo chart. // "STEPPED_AREA" - A stepped area chart. ChartType string `json:"chartType,omitempty"` // CompareMode: The behavior of tooltips and data highlighting when // hovering on data and chart area. // // Possible values: // "BASIC_CHART_COMPARE_MODE_UNSPECIFIED" - Default value, do not use. // "DATUM" - Only the focused data element is highlighted and shown in // the tooltip. // "CATEGORY" - All data elements with the same category (e.g., domain // value) are highlighted and shown in the tooltip. CompareMode string `json:"compareMode,omitempty"` // Domains: The domain of data this is charting. Only a single domain is // supported. Domains []*BasicChartDomain `json:"domains,omitempty"` // HeaderCount: The number of rows or columns in the data that are // "headers". If not set, Google Sheets will guess how many rows are // headers based on the data. (Note that BasicChartAxis.title may // override the axis title inferred from the header values.) HeaderCount int64 `json:"headerCount,omitempty"` // InterpolateNulls: If some values in a series are missing, gaps may // appear in the chart (e.g, segments of lines in a line chart will be // missing). To eliminate these gaps set this to true. Applies to Line, // Area, and Combo charts. InterpolateNulls bool `json:"interpolateNulls,omitempty"` // LegendPosition: The position of the chart legend. // // Possible values: // "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED" - Default value, do not // use. // "BOTTOM_LEGEND" - The legend is rendered on the bottom of the // chart. // "LEFT_LEGEND" - The legend is rendered on the left of the chart. // "RIGHT_LEGEND" - The legend is rendered on the right of the chart. // "TOP_LEGEND" - The legend is rendered on the top of the chart. // "NO_LEGEND" - No legend is rendered. LegendPosition string `json:"legendPosition,omitempty"` // LineSmoothing: Gets whether all lines should be rendered smooth or // straight by default. Applies to Line charts. LineSmoothing bool `json:"lineSmoothing,omitempty"` // Series: The data this chart is visualizing. Series []*BasicChartSeries `json:"series,omitempty"` // StackedType: The stacked type for charts that support vertical // stacking. Applies to Area, Bar, Column, Combo, and Stepped Area // charts. // // Possible values: // "BASIC_CHART_STACKED_TYPE_UNSPECIFIED" - Default value, do not use. // "NOT_STACKED" - Series are not stacked. // "STACKED" - Series values are stacked, each value is rendered // vertically beginning from the top of the value below it. // "PERCENT_STACKED" - Vertical stacks are stretched to reach the top // of the chart, with values laid out as percentages of each other. StackedType string `json:"stackedType,omitempty"` // ThreeDimensional: True to make the chart 3D. Applies to Bar and // Column charts. ThreeDimensional bool `json:"threeDimensional,omitempty"` // TotalDataLabel: Controls whether to display additional data labels on // stacked charts which sum the total value of all stacked values at // each value along the domain axis. These data labels can only be set // when chart_type is one of AREA, BAR, COLUMN, COMBO or STEPPED_AREA // and stacked_type is either STACKED or PERCENT_STACKED. In addition, // for COMBO, this will only be supported if there is only one type of // stackable series type or one type has more series than the others and // each of the other types have no more than one series. For example, if // a chart has two stacked bar series and one area series, the total // data labels will be supported. If it has three bar series and two // area series, total data labels are not allowed. Neither CUSTOM nor // placement can be set on the total_data_label. TotalDataLabel *DataLabel `json:"totalDataLabel,omitempty"` // ForceSendFields is a list of field names (e.g. "Axis") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Axis") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BasicChartSpec: The specification for a basic chart. See BasicChartType for the list of charts this supports.
func (*BasicChartSpec) MarshalJSON ¶
func (s *BasicChartSpec) MarshalJSON() ([]byte, error)
type BasicFilter ¶
type BasicFilter struct { // Criteria: The criteria for showing/hiding values per column. The // map's key is the column index, and the value is the criteria for that // column. This field is deprecated in favor of filter_specs. Criteria map[string]FilterCriteria `json:"criteria,omitempty"` // FilterSpecs: The filter criteria per column. Both criteria and // filter_specs are populated in responses. If both fields are specified // in an update request, this field takes precedence. FilterSpecs []*FilterSpec `json:"filterSpecs,omitempty"` // Range: The range the filter covers. Range *GridRange `json:"range,omitempty"` // SortSpecs: The sort order per column. Later specifications are used // when values are equal in the earlier specifications. SortSpecs []*SortSpec `json:"sortSpecs,omitempty"` // ForceSendFields is a list of field names (e.g. "Criteria") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Criteria") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BasicFilter: The default filter associated with a sheet.
func (*BasicFilter) MarshalJSON ¶
func (s *BasicFilter) MarshalJSON() ([]byte, error)
type BasicSeriesDataPointStyleOverride ¶ added in v0.36.0
type BasicSeriesDataPointStyleOverride struct { // Color: Color of the series data point. If empty, the series default // is used. Deprecated: Use color_style. Color *Color `json:"color,omitempty"` // ColorStyle: Color of the series data point. If empty, the series // default is used. If color is also set, this field takes precedence. ColorStyle *ColorStyle `json:"colorStyle,omitempty"` // Index: Zero based index of the series data point. Index int64 `json:"index,omitempty"` // PointStyle: Point style of the series data point. Valid only if the // chartType is AREA, LINE, or SCATTER. COMBO charts are also supported // if the series chart type is AREA, LINE, or SCATTER. If empty, the // series default is used. PointStyle *PointStyle `json:"pointStyle,omitempty"` // ForceSendFields is a list of field names (e.g. "Color") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Color") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BasicSeriesDataPointStyleOverride: Style override settings for a single series data point.
func (*BasicSeriesDataPointStyleOverride) MarshalJSON ¶ added in v0.36.0
func (s *BasicSeriesDataPointStyleOverride) MarshalJSON() ([]byte, error)
type BatchClearValuesByDataFilterRequest ¶
type BatchClearValuesByDataFilterRequest struct { // DataFilters: The DataFilters used to determine which ranges to clear. DataFilters []*DataFilter `json:"dataFilters,omitempty"` // ForceSendFields is a list of field names (e.g. "DataFilters") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataFilters") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchClearValuesByDataFilterRequest: The request for clearing more than one range selected by a DataFilter in a spreadsheet.
func (*BatchClearValuesByDataFilterRequest) MarshalJSON ¶
func (s *BatchClearValuesByDataFilterRequest) MarshalJSON() ([]byte, error)
type BatchClearValuesByDataFilterResponse ¶
type BatchClearValuesByDataFilterResponse struct { // ClearedRanges: The ranges that were cleared, in A1 notation // (/sheets/api/guides/concepts#cell). If the requests are for an // unbounded range or a ranger larger than the bounds of the sheet, this // is the actual ranges that were cleared, bounded to the sheet's // limits. ClearedRanges []string `json:"clearedRanges,omitempty"` // SpreadsheetId: The spreadsheet the updates were applied to. SpreadsheetId string `json:"spreadsheetId,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ClearedRanges") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClearedRanges") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchClearValuesByDataFilterResponse: The response when clearing a range of values selected with DataFilters in a spreadsheet.
func (*BatchClearValuesByDataFilterResponse) MarshalJSON ¶
func (s *BatchClearValuesByDataFilterResponse) MarshalJSON() ([]byte, error)
type BatchClearValuesRequest ¶
type BatchClearValuesRequest struct { // Ranges: The ranges to clear, in A1 notation or R1C1 notation // (/sheets/api/guides/concepts#cell). Ranges []string `json:"ranges,omitempty"` // ForceSendFields is a list of field names (e.g. "Ranges") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Ranges") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchClearValuesRequest: The request for clearing more than one range of values in a spreadsheet.
func (*BatchClearValuesRequest) MarshalJSON ¶
func (s *BatchClearValuesRequest) MarshalJSON() ([]byte, error)
type BatchClearValuesResponse ¶
type BatchClearValuesResponse struct { // ClearedRanges: The ranges that were cleared, in A1 notation. If the // requests are for an unbounded range or a ranger larger than the // bounds of the sheet, this is the actual ranges that were cleared, // bounded to the sheet's limits. ClearedRanges []string `json:"clearedRanges,omitempty"` // SpreadsheetId: The spreadsheet the updates were applied to. SpreadsheetId string `json:"spreadsheetId,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ClearedRanges") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClearedRanges") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchClearValuesResponse: The response when clearing a range of values in a spreadsheet.
func (*BatchClearValuesResponse) MarshalJSON ¶
func (s *BatchClearValuesResponse) MarshalJSON() ([]byte, error)
type BatchGetValuesByDataFilterRequest ¶
type BatchGetValuesByDataFilterRequest struct { // DataFilters: The data filters used to match the ranges of values to // retrieve. Ranges that match any of the specified data filters are // included in the response. DataFilters []*DataFilter `json:"dataFilters,omitempty"` // DateTimeRenderOption: How dates, times, and durations should be // represented in the output. This is ignored if value_render_option is // FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. // // Possible values: // "SERIAL_NUMBER" - Instructs date, time, datetime, and duration // fields to be output as doubles in "serial number" format, as // popularized by Lotus 1-2-3. The whole number portion of the value // (left of the decimal) counts the days since December 30th 1899. The // fractional portion (right of the decimal) counts the time as a // fraction of the day. For example, January 1st 1900 at noon would be // 2.5, 2 because it's 2 days after December 30th 1899, and .5 because // noon is half a day. February 1st 1900 at 3pm would be 33.625. This // correctly treats the year 1900 as not a leap year. // "FORMATTED_STRING" - Instructs date, time, datetime, and duration // fields to be output as strings in their given number format (which // depends on the spreadsheet locale). DateTimeRenderOption string `json:"dateTimeRenderOption,omitempty"` // MajorDimension: The major dimension that results should use. For // example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a // request that selects that range and sets `majorDimension=ROWS` // returns `[[1,2],[3,4]]`, whereas a request that sets // `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. // // Possible values: // "DIMENSION_UNSPECIFIED" - The default value, do not use. // "ROWS" - Operates on the rows of a sheet. // "COLUMNS" - Operates on the columns of a sheet. MajorDimension string `json:"majorDimension,omitempty"` // ValueRenderOption: How values should be represented in the output. // The default render option is FORMATTED_VALUE. // // Possible values: // "FORMATTED_VALUE" - Values will be calculated & formatted in the // reply according to the cell's formatting. Formatting is based on the // spreadsheet's locale, not the requesting user's locale. For example, // if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then // `A2` would return "$1.23". // "UNFORMATTED_VALUE" - Values will be calculated, but not formatted // in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and // formatted as currency, then `A2` would return the number `1.23`. // "FORMULA" - Values will not be calculated. The reply will include // the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and // formatted as currency, then A2 would return "=A1". ValueRenderOption string `json:"valueRenderOption,omitempty"` // ForceSendFields is a list of field names (e.g. "DataFilters") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataFilters") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchGetValuesByDataFilterRequest: The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.
func (*BatchGetValuesByDataFilterRequest) MarshalJSON ¶
func (s *BatchGetValuesByDataFilterRequest) MarshalJSON() ([]byte, error)
type BatchGetValuesByDataFilterResponse ¶
type BatchGetValuesByDataFilterResponse struct { // SpreadsheetId: The ID of the spreadsheet the data was retrieved from. SpreadsheetId string `json:"spreadsheetId,omitempty"` // ValueRanges: The requested values with the list of data filters that // matched them. ValueRanges []*MatchedValueRange `json:"valueRanges,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "SpreadsheetId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "SpreadsheetId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchGetValuesByDataFilterResponse: The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.
func (*BatchGetValuesByDataFilterResponse) MarshalJSON ¶
func (s *BatchGetValuesByDataFilterResponse) MarshalJSON() ([]byte, error)
type BatchGetValuesResponse ¶
type BatchGetValuesResponse struct { // SpreadsheetId: The ID of the spreadsheet the data was retrieved from. SpreadsheetId string `json:"spreadsheetId,omitempty"` // ValueRanges: The requested values. The order of the ValueRanges is // the same as the order of the requested ranges. ValueRanges []*ValueRange `json:"valueRanges,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "SpreadsheetId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "SpreadsheetId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchGetValuesResponse: The response when retrieving more than one range of values in a spreadsheet.
func (*BatchGetValuesResponse) MarshalJSON ¶
func (s *BatchGetValuesResponse) MarshalJSON() ([]byte, error)
type BatchUpdateSpreadsheetRequest ¶
type BatchUpdateSpreadsheetRequest struct { // IncludeSpreadsheetInResponse: Determines if the update response // should include the spreadsheet resource. IncludeSpreadsheetInResponse bool `json:"includeSpreadsheetInResponse,omitempty"` // Requests: A list of updates to apply to the spreadsheet. Requests // will be applied in the order they are specified. If any request is // not valid, no requests will be applied. Requests []*Request `json:"requests,omitempty"` // ResponseIncludeGridData: True if grid data should be returned. // Meaningful only if include_spreadsheet_in_response is 'true'. This // parameter is ignored if a field mask was set in the request. ResponseIncludeGridData bool `json:"responseIncludeGridData,omitempty"` // ResponseRanges: Limits the ranges included in the response // spreadsheet. Meaningful only if include_spreadsheet_in_response is // 'true'. ResponseRanges []string `json:"responseRanges,omitempty"` // ForceSendFields is a list of field names (e.g. // "IncludeSpreadsheetInResponse") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "IncludeSpreadsheetInResponse") to include in API requests with the // JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
BatchUpdateSpreadsheetRequest: The request for updating any aspect of a spreadsheet.
func (*BatchUpdateSpreadsheetRequest) MarshalJSON ¶
func (s *BatchUpdateSpreadsheetRequest) MarshalJSON() ([]byte, error)
type BatchUpdateSpreadsheetResponse ¶
type BatchUpdateSpreadsheetResponse struct { // Replies: The reply of the updates. This maps 1:1 with the updates, // although replies to some requests may be empty. Replies []*Response `json:"replies,omitempty"` // SpreadsheetId: The spreadsheet the updates were applied to. SpreadsheetId string `json:"spreadsheetId,omitempty"` // UpdatedSpreadsheet: The spreadsheet after updates were applied. This // is only set if // BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response is // `true`. UpdatedSpreadsheet *Spreadsheet `json:"updatedSpreadsheet,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Replies") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Replies") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchUpdateSpreadsheetResponse: The reply for batch updating a spreadsheet.
func (*BatchUpdateSpreadsheetResponse) MarshalJSON ¶
func (s *BatchUpdateSpreadsheetResponse) MarshalJSON() ([]byte, error)
type BatchUpdateValuesByDataFilterRequest ¶
type BatchUpdateValuesByDataFilterRequest struct { // Data: The new values to apply to the spreadsheet. If more than one // range is matched by the specified DataFilter the specified values are // applied to all of those ranges. Data []*DataFilterValueRange `json:"data,omitempty"` // IncludeValuesInResponse: Determines if the update response should // include the values of the cells that were updated. By default, // responses do not include the updated values. The `updatedData` field // within each of the BatchUpdateValuesResponse.responses contains the // updated values. If the range to write was larger than the range // actually written, the response includes all values in the requested // range (excluding trailing empty rows and columns). IncludeValuesInResponse bool `json:"includeValuesInResponse,omitempty"` // ResponseDateTimeRenderOption: Determines how dates, times, and // durations in the response should be rendered. This is ignored if // response_value_render_option is FORMATTED_VALUE. The default dateTime // render option is SERIAL_NUMBER. // // Possible values: // "SERIAL_NUMBER" - Instructs date, time, datetime, and duration // fields to be output as doubles in "serial number" format, as // popularized by Lotus 1-2-3. The whole number portion of the value // (left of the decimal) counts the days since December 30th 1899. The // fractional portion (right of the decimal) counts the time as a // fraction of the day. For example, January 1st 1900 at noon would be // 2.5, 2 because it's 2 days after December 30th 1899, and .5 because // noon is half a day. February 1st 1900 at 3pm would be 33.625. This // correctly treats the year 1900 as not a leap year. // "FORMATTED_STRING" - Instructs date, time, datetime, and duration // fields to be output as strings in their given number format (which // depends on the spreadsheet locale). ResponseDateTimeRenderOption string `json:"responseDateTimeRenderOption,omitempty"` // ResponseValueRenderOption: Determines how values in the response // should be rendered. The default render option is FORMATTED_VALUE. // // Possible values: // "FORMATTED_VALUE" - Values will be calculated & formatted in the // reply according to the cell's formatting. Formatting is based on the // spreadsheet's locale, not the requesting user's locale. For example, // if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then // `A2` would return "$1.23". // "UNFORMATTED_VALUE" - Values will be calculated, but not formatted // in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and // formatted as currency, then `A2` would return the number `1.23`. // "FORMULA" - Values will not be calculated. The reply will include // the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and // formatted as currency, then A2 would return "=A1". ResponseValueRenderOption string `json:"responseValueRenderOption,omitempty"` // ValueInputOption: How the input data should be interpreted. // // Possible values: // "INPUT_VALUE_OPTION_UNSPECIFIED" - Default input value. This value // must not be used. // "RAW" - The values the user has entered will not be parsed and will // be stored as-is. // "USER_ENTERED" - The values will be parsed as if the user typed // them into the UI. Numbers will stay as numbers, but strings may be // converted to numbers, dates, etc. following the same rules that are // applied when entering text into a cell via the Google Sheets UI. ValueInputOption string `json:"valueInputOption,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Data") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchUpdateValuesByDataFilterRequest: The request for updating more than one range of values in a spreadsheet.
func (*BatchUpdateValuesByDataFilterRequest) MarshalJSON ¶
func (s *BatchUpdateValuesByDataFilterRequest) MarshalJSON() ([]byte, error)
type BatchUpdateValuesByDataFilterResponse ¶
type BatchUpdateValuesByDataFilterResponse struct { // Responses: The response for each range updated. Responses []*UpdateValuesByDataFilterResponse `json:"responses,omitempty"` // SpreadsheetId: The spreadsheet the updates were applied to. SpreadsheetId string `json:"spreadsheetId,omitempty"` // TotalUpdatedCells: The total number of cells updated. TotalUpdatedCells int64 `json:"totalUpdatedCells,omitempty"` // TotalUpdatedColumns: The total number of columns where at least one // cell in the column was updated. TotalUpdatedColumns int64 `json:"totalUpdatedColumns,omitempty"` // TotalUpdatedRows: The total number of rows where at least one cell in // the row was updated. TotalUpdatedRows int64 `json:"totalUpdatedRows,omitempty"` // TotalUpdatedSheets: The total number of sheets where at least one // cell in the sheet was updated. TotalUpdatedSheets int64 `json:"totalUpdatedSheets,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Responses") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Responses") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchUpdateValuesByDataFilterResponse: The response when updating a range of values in a spreadsheet.
func (*BatchUpdateValuesByDataFilterResponse) MarshalJSON ¶
func (s *BatchUpdateValuesByDataFilterResponse) MarshalJSON() ([]byte, error)
type BatchUpdateValuesRequest ¶
type BatchUpdateValuesRequest struct { // Data: The new values to apply to the spreadsheet. Data []*ValueRange `json:"data,omitempty"` // IncludeValuesInResponse: Determines if the update response should // include the values of the cells that were updated. By default, // responses do not include the updated values. The `updatedData` field // within each of the BatchUpdateValuesResponse.responses contains the // updated values. If the range to write was larger than the range // actually written, the response includes all values in the requested // range (excluding trailing empty rows and columns). IncludeValuesInResponse bool `json:"includeValuesInResponse,omitempty"` // ResponseDateTimeRenderOption: Determines how dates, times, and // durations in the response should be rendered. This is ignored if // response_value_render_option is FORMATTED_VALUE. The default dateTime // render option is SERIAL_NUMBER. // // Possible values: // "SERIAL_NUMBER" - Instructs date, time, datetime, and duration // fields to be output as doubles in "serial number" format, as // popularized by Lotus 1-2-3. The whole number portion of the value // (left of the decimal) counts the days since December 30th 1899. The // fractional portion (right of the decimal) counts the time as a // fraction of the day. For example, January 1st 1900 at noon would be // 2.5, 2 because it's 2 days after December 30th 1899, and .5 because // noon is half a day. February 1st 1900 at 3pm would be 33.625. This // correctly treats the year 1900 as not a leap year. // "FORMATTED_STRING" - Instructs date, time, datetime, and duration // fields to be output as strings in their given number format (which // depends on the spreadsheet locale). ResponseDateTimeRenderOption string `json:"responseDateTimeRenderOption,omitempty"` // ResponseValueRenderOption: Determines how values in the response // should be rendered. The default render option is FORMATTED_VALUE. // // Possible values: // "FORMATTED_VALUE" - Values will be calculated & formatted in the // reply according to the cell's formatting. Formatting is based on the // spreadsheet's locale, not the requesting user's locale. For example, // if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then // `A2` would return "$1.23". // "UNFORMATTED_VALUE" - Values will be calculated, but not formatted // in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and // formatted as currency, then `A2` would return the number `1.23`. // "FORMULA" - Values will not be calculated. The reply will include // the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and // formatted as currency, then A2 would return "=A1". ResponseValueRenderOption string `json:"responseValueRenderOption,omitempty"` // ValueInputOption: How the input data should be interpreted. // // Possible values: // "INPUT_VALUE_OPTION_UNSPECIFIED" - Default input value. This value // must not be used. // "RAW" - The values the user has entered will not be parsed and will // be stored as-is. // "USER_ENTERED" - The values will be parsed as if the user typed // them into the UI. Numbers will stay as numbers, but strings may be // converted to numbers, dates, etc. following the same rules that are // applied when entering text into a cell via the Google Sheets UI. ValueInputOption string `json:"valueInputOption,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Data") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchUpdateValuesRequest: The request for updating more than one range of values in a spreadsheet.
func (*BatchUpdateValuesRequest) MarshalJSON ¶
func (s *BatchUpdateValuesRequest) MarshalJSON() ([]byte, error)
type BatchUpdateValuesResponse ¶
type BatchUpdateValuesResponse struct { // Responses: One UpdateValuesResponse per requested range, in the same // order as the requests appeared. Responses []*UpdateValuesResponse `json:"responses,omitempty"` // SpreadsheetId: The spreadsheet the updates were applied to. SpreadsheetId string `json:"spreadsheetId,omitempty"` // TotalUpdatedCells: The total number of cells updated. TotalUpdatedCells int64 `json:"totalUpdatedCells,omitempty"` // TotalUpdatedColumns: The total number of columns where at least one // cell in the column was updated. TotalUpdatedColumns int64 `json:"totalUpdatedColumns,omitempty"` // TotalUpdatedRows: The total number of rows where at least one cell in // the row was updated. TotalUpdatedRows int64 `json:"totalUpdatedRows,omitempty"` // TotalUpdatedSheets: The total number of sheets where at least one // cell in the sheet was updated. TotalUpdatedSheets int64 `json:"totalUpdatedSheets,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Responses") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Responses") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchUpdateValuesResponse: The response when updating a range of values in a spreadsheet.
func (*BatchUpdateValuesResponse) MarshalJSON ¶
func (s *BatchUpdateValuesResponse) MarshalJSON() ([]byte, error)
type BigQueryDataSourceSpec ¶ added in v0.31.0
type BigQueryDataSourceSpec struct { // ProjectId: The ID of a BigQuery enabled GCP project with a billing // account attached. For any queries executed against the data source, // the project is charged. ProjectId string `json:"projectId,omitempty"` // QuerySpec: A BigQueryQuerySpec. QuerySpec *BigQueryQuerySpec `json:"querySpec,omitempty"` // TableSpec: A BigQueryTableSpec. TableSpec *BigQueryTableSpec `json:"tableSpec,omitempty"` // ForceSendFields is a list of field names (e.g. "ProjectId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ProjectId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BigQueryDataSourceSpec: The specification of a BigQuery data source that's connected to a sheet.
func (*BigQueryDataSourceSpec) MarshalJSON ¶ added in v0.31.0
func (s *BigQueryDataSourceSpec) MarshalJSON() ([]byte, error)
type BigQueryQuerySpec ¶ added in v0.31.0
type BigQueryQuerySpec struct { // RawQuery: The raw query string. RawQuery string `json:"rawQuery,omitempty"` // ForceSendFields is a list of field names (e.g. "RawQuery") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RawQuery") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BigQueryQuerySpec: Specifies a custom BigQuery query.
func (*BigQueryQuerySpec) MarshalJSON ¶ added in v0.31.0
func (s *BigQueryQuerySpec) MarshalJSON() ([]byte, error)
type BigQueryTableSpec ¶ added in v0.31.0
type BigQueryTableSpec struct { // DatasetId: The BigQuery dataset id. DatasetId string `json:"datasetId,omitempty"` // TableId: The BigQuery table id. TableId string `json:"tableId,omitempty"` // TableProjectId: The ID of a BigQuery project the table belongs to. If // not specified, the project_id is assumed. TableProjectId string `json:"tableProjectId,omitempty"` // ForceSendFields is a list of field names (e.g. "DatasetId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DatasetId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BigQueryTableSpec: Specifies a BigQuery table definition. Only native tables (https://cloud.google.com/bigquery/docs/tables-intro) is allowed.
func (*BigQueryTableSpec) MarshalJSON ¶ added in v0.31.0
func (s *BigQueryTableSpec) MarshalJSON() ([]byte, error)
type BooleanCondition ¶
type BooleanCondition struct { // Type: The type of condition. // // Possible values: // "CONDITION_TYPE_UNSPECIFIED" - The default value, do not use. // "NUMBER_GREATER" - The cell's value must be greater than the // condition's value. Supported by data validation, conditional // formatting and filters. Requires a single ConditionValue. // "NUMBER_GREATER_THAN_EQ" - The cell's value must be greater than or // equal to the condition's value. Supported by data validation, // conditional formatting and filters. Requires a single ConditionValue. // "NUMBER_LESS" - The cell's value must be less than the condition's // value. Supported by data validation, conditional formatting and // filters. Requires a single ConditionValue. // "NUMBER_LESS_THAN_EQ" - The cell's value must be less than or equal // to the condition's value. Supported by data validation, conditional // formatting and filters. Requires a single ConditionValue. // "NUMBER_EQ" - The cell's value must be equal to the condition's // value. Supported by data validation, conditional formatting and // filters. Requires a single ConditionValue for data validation, // conditional formatting, and filters on non-data source objects and at // least one ConditionValue for filters on data source objects. // "NUMBER_NOT_EQ" - The cell's value must be not equal to the // condition's value. Supported by data validation, conditional // formatting and filters. Requires a single ConditionValue for data // validation, conditional formatting, and filters on non-data source // objects and at least one ConditionValue for filters on data source // objects. // "NUMBER_BETWEEN" - The cell's value must be between the two // condition values. Supported by data validation, conditional // formatting and filters. Requires exactly two ConditionValues. // "NUMBER_NOT_BETWEEN" - The cell's value must not be between the two // condition values. Supported by data validation, conditional // formatting and filters. Requires exactly two ConditionValues. // "TEXT_CONTAINS" - The cell's value must contain the condition's // value. Supported by data validation, conditional formatting and // filters. Requires a single ConditionValue. // "TEXT_NOT_CONTAINS" - The cell's value must not contain the // condition's value. Supported by data validation, conditional // formatting and filters. Requires a single ConditionValue. // "TEXT_STARTS_WITH" - The cell's value must start with the // condition's value. Supported by conditional formatting and filters. // Requires a single ConditionValue. // "TEXT_ENDS_WITH" - The cell's value must end with the condition's // value. Supported by conditional formatting and filters. Requires a // single ConditionValue. // "TEXT_EQ" - The cell's value must be exactly the condition's value. // Supported by data validation, conditional formatting and filters. // Requires a single ConditionValue for data validation, conditional // formatting, and filters on non-data source objects and at least one // ConditionValue for filters on data source objects. // "TEXT_IS_EMAIL" - The cell's value must be a valid email address. // Supported by data validation. Requires no ConditionValues. // "TEXT_IS_URL" - The cell's value must be a valid URL. Supported by // data validation. Requires no ConditionValues. // "DATE_EQ" - The cell's value must be the same date as the // condition's value. Supported by data validation, conditional // formatting and filters. Requires a single ConditionValue for data // validation, conditional formatting, and filters on non-data source // objects and at least one ConditionValue for filters on data source // objects. // "DATE_BEFORE" - The cell's value must be before the date of the // condition's value. Supported by data validation, conditional // formatting and filters. Requires a single ConditionValue that may be // a relative date. // "DATE_AFTER" - The cell's value must be after the date of the // condition's value. Supported by data validation, conditional // formatting and filters. Requires a single ConditionValue that may be // a relative date. // "DATE_ON_OR_BEFORE" - The cell's value must be on or before the // date of the condition's value. Supported by data validation. Requires // a single ConditionValue that may be a relative date. // "DATE_ON_OR_AFTER" - The cell's value must be on or after the date // of the condition's value. Supported by data validation. Requires a // single ConditionValue that may be a relative date. // "DATE_BETWEEN" - The cell's value must be between the dates of the // two condition values. Supported by data validation. Requires exactly // two ConditionValues. // "DATE_NOT_BETWEEN" - The cell's value must be outside the dates of // the two condition values. Supported by data validation. Requires // exactly two ConditionValues. // "DATE_IS_VALID" - The cell's value must be a date. Supported by // data validation. Requires no ConditionValues. // "ONE_OF_RANGE" - The cell's value must be listed in the grid in // condition value's range. Supported by data validation. Requires a // single ConditionValue, and the value must be a valid range in A1 // notation. // "ONE_OF_LIST" - The cell's value must be in the list of condition // values. Supported by data validation. Supports any number of // condition values, one per item in the list. Formulas are not // supported in the values. // "BLANK" - The cell's value must be empty. Supported by conditional // formatting and filters. Requires no ConditionValues. // "NOT_BLANK" - The cell's value must not be empty. Supported by // conditional formatting and filters. Requires no ConditionValues. // "CUSTOM_FORMULA" - The condition's formula must evaluate to true. // Supported by data validation, conditional formatting and filters. Not // supported by data source sheet filters. Requires a single // ConditionValue. // "BOOLEAN" - The cell's value must be TRUE/FALSE or in the list of // condition values. Supported by data validation. Renders as a cell // checkbox. Supports zero, one or two ConditionValues. No values // indicates the cell must be TRUE or FALSE, where TRUE renders as // checked and FALSE renders as unchecked. One value indicates the cell // will render as checked when it contains that value and unchecked when // it is blank. Two values indicate that the cell will render as checked // when it contains the first value and unchecked when it contains the // second value. For example, ["Yes","No"] indicates that the cell will // render a checked box when it has the value "Yes" and an unchecked box // when it has the value "No". // "TEXT_NOT_EQ" - The cell's value must be exactly not the // condition's value. Supported by filters on data source objects. // Requires at least one ConditionValue. // "DATE_NOT_EQ" - The cell's value must be exactly not the // condition's value. Supported by filters on data source objects. // Requires at least one ConditionValue. Type string `json:"type,omitempty"` // Values: The values of the condition. The number of supported values // depends on the condition type. Some support zero values, others one // or two values, and ConditionType.ONE_OF_LIST supports an arbitrary // number of values. Values []*ConditionValue `json:"values,omitempty"` // ForceSendFields is a list of field names (e.g. "Type") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Type") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BooleanCondition: A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters.
func (*BooleanCondition) MarshalJSON ¶
func (s *BooleanCondition) MarshalJSON() ([]byte, error)
type BooleanRule ¶
type BooleanRule struct { // Condition: The condition of the rule. If the condition evaluates to // true, the format is applied. Condition *BooleanCondition `json:"condition,omitempty"` // Format: The format to apply. Conditional formatting can only apply a // subset of formatting: bold, italic, strikethrough, foreground color & // background color. Format *CellFormat `json:"format,omitempty"` // ForceSendFields is a list of field names (e.g. "Condition") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Condition") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BooleanRule: A rule that may or may not match, depending on the condition.
func (*BooleanRule) MarshalJSON ¶
func (s *BooleanRule) MarshalJSON() ([]byte, error)
type Border ¶
type Border struct { // Color: The color of the border. Deprecated: Use color_style. Color *Color `json:"color,omitempty"` // ColorStyle: The color of the border. If color is also set, this field // takes precedence. ColorStyle *ColorStyle `json:"colorStyle,omitempty"` // Style: The style of the border. // // Possible values: // "STYLE_UNSPECIFIED" - The style is not specified. Do not use this. // "DOTTED" - The border is dotted. // "DASHED" - The border is dashed. // "SOLID" - The border is a thin solid line. // "SOLID_MEDIUM" - The border is a medium solid line. // "SOLID_THICK" - The border is a thick solid line. // "NONE" - No border. Used only when updating a border in order to // erase it. // "DOUBLE" - The border is two solid lines. Style string `json:"style,omitempty"` // Width: The width of the border, in pixels. Deprecated; the width is // determined by the "style" field. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Color") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Color") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Border: A border along a cell.
func (*Border) MarshalJSON ¶
type Borders ¶
type Borders struct { // Bottom: The bottom border of the cell. Bottom *Border `json:"bottom,omitempty"` // Left: The left border of the cell. Left *Border `json:"left,omitempty"` // Right: The right border of the cell. Right *Border `json:"right,omitempty"` // Top: The top border of the cell. Top *Border `json:"top,omitempty"` // ForceSendFields is a list of field names (e.g. "Bottom") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Bottom") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Borders: The borders of the cell.
func (*Borders) MarshalJSON ¶
type BubbleChartSpec ¶
type BubbleChartSpec struct { // BubbleBorderColor: The bubble border color. Deprecated: Use // bubble_border_color_style. BubbleBorderColor *Color `json:"bubbleBorderColor,omitempty"` // BubbleBorderColorStyle: The bubble border color. If // bubble_border_color is also set, this field takes precedence. BubbleBorderColorStyle *ColorStyle `json:"bubbleBorderColorStyle,omitempty"` // BubbleLabels: The data containing the bubble labels. These do not // need to be unique. BubbleLabels *ChartData `json:"bubbleLabels,omitempty"` // BubbleMaxRadiusSize: The max radius size of the bubbles, in pixels. // If specified, the field must be a positive value. BubbleMaxRadiusSize int64 `json:"bubbleMaxRadiusSize,omitempty"` // BubbleMinRadiusSize: The minimum radius size of the bubbles, in // pixels. If specific, the field must be a positive value. BubbleMinRadiusSize int64 `json:"bubbleMinRadiusSize,omitempty"` // BubbleOpacity: The opacity of the bubbles between 0 and 1.0. 0 is // fully transparent and 1 is fully opaque. BubbleOpacity float64 `json:"bubbleOpacity,omitempty"` // BubbleSizes: The data containing the bubble sizes. Bubble sizes are // used to draw the bubbles at different sizes relative to each other. // If specified, group_ids must also be specified. This field is // optional. BubbleSizes *ChartData `json:"bubbleSizes,omitempty"` // BubbleTextStyle: The format of the text inside the bubbles. // Strikethrough, underline, and link are not supported. BubbleTextStyle *TextFormat `json:"bubbleTextStyle,omitempty"` // Domain: The data containing the bubble x-values. These values locate // the bubbles in the chart horizontally. Domain *ChartData `json:"domain,omitempty"` // GroupIds: The data containing the bubble group IDs. All bubbles with // the same group ID are drawn in the same color. If bubble_sizes is // specified then this field must also be specified but may contain // blank values. This field is optional. GroupIds *ChartData `json:"groupIds,omitempty"` // LegendPosition: Where the legend of the chart should be drawn. // // Possible values: // "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED" - Default value, do not // use. // "BOTTOM_LEGEND" - The legend is rendered on the bottom of the // chart. // "LEFT_LEGEND" - The legend is rendered on the left of the chart. // "RIGHT_LEGEND" - The legend is rendered on the right of the chart. // "TOP_LEGEND" - The legend is rendered on the top of the chart. // "NO_LEGEND" - No legend is rendered. // "INSIDE_LEGEND" - The legend is rendered inside the chart area. LegendPosition string `json:"legendPosition,omitempty"` // Series: The data containing the bubble y-values. These values locate // the bubbles in the chart vertically. Series *ChartData `json:"series,omitempty"` // ForceSendFields is a list of field names (e.g. "BubbleBorderColor") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BubbleBorderColor") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
BubbleChartSpec: A bubble chart.
func (*BubbleChartSpec) MarshalJSON ¶
func (s *BubbleChartSpec) MarshalJSON() ([]byte, error)
func (*BubbleChartSpec) UnmarshalJSON ¶
func (s *BubbleChartSpec) UnmarshalJSON(data []byte) error
type CandlestickChartSpec ¶
type CandlestickChartSpec struct { // Data: The Candlestick chart data. Only one CandlestickData is // supported. Data []*CandlestickData `json:"data,omitempty"` // Domain: The domain data (horizontal axis) for the candlestick chart. // String data will be treated as discrete labels, other data will be // treated as continuous values. Domain *CandlestickDomain `json:"domain,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Data") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CandlestickChartSpec: A candlestick chart.
func (*CandlestickChartSpec) MarshalJSON ¶
func (s *CandlestickChartSpec) MarshalJSON() ([]byte, error)
type CandlestickData ¶
type CandlestickData struct { // CloseSeries: The range data (vertical axis) for the close/final value // for each candle. This is the top of the candle body. If greater than // the open value the candle will be filled. Otherwise the candle will // be hollow. CloseSeries *CandlestickSeries `json:"closeSeries,omitempty"` // HighSeries: The range data (vertical axis) for the high/maximum value // for each candle. This is the top of the candle's center line. HighSeries *CandlestickSeries `json:"highSeries,omitempty"` // LowSeries: The range data (vertical axis) for the low/minimum value // for each candle. This is the bottom of the candle's center line. LowSeries *CandlestickSeries `json:"lowSeries,omitempty"` // OpenSeries: The range data (vertical axis) for the open/initial value // for each candle. This is the bottom of the candle body. If less than // the close value the candle will be filled. Otherwise the candle will // be hollow. OpenSeries *CandlestickSeries `json:"openSeries,omitempty"` // ForceSendFields is a list of field names (e.g. "CloseSeries") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CloseSeries") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CandlestickData: The Candlestick chart data, each containing the low, open, close, and high values for a series.
func (*CandlestickData) MarshalJSON ¶
func (s *CandlestickData) MarshalJSON() ([]byte, error)
type CandlestickDomain ¶
type CandlestickDomain struct { // Data: The data of the CandlestickDomain. Data *ChartData `json:"data,omitempty"` // Reversed: True to reverse the order of the domain values (horizontal // axis). Reversed bool `json:"reversed,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Data") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CandlestickDomain: The domain of a CandlestickChart.
func (*CandlestickDomain) MarshalJSON ¶
func (s *CandlestickDomain) MarshalJSON() ([]byte, error)
type CandlestickSeries ¶
type CandlestickSeries struct { // Data: The data of the CandlestickSeries. Data *ChartData `json:"data,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Data") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CandlestickSeries: The series of a CandlestickData.
func (*CandlestickSeries) MarshalJSON ¶
func (s *CandlestickSeries) MarshalJSON() ([]byte, error)
type CellData ¶
type CellData struct { // DataSourceFormula: Output only. Information about a data source // formula on the cell. The field is set if user_entered_value is a // formula referencing some DATA_SOURCE sheet, e.g. // `=SUM(DataSheet!Column)`. DataSourceFormula *DataSourceFormula `json:"dataSourceFormula,omitempty"` // DataSourceTable: A data source table anchored at this cell. The size // of data source table itself is computed dynamically based on its // configuration. Only the first cell of the data source table contains // the data source table definition. The other cells will contain the // display values of the data source table result in their // effective_value fields. DataSourceTable *DataSourceTable `json:"dataSourceTable,omitempty"` // DataValidation: A data validation rule on the cell, if any. When // writing, the new data validation rule will overwrite any prior rule. DataValidation *DataValidationRule `json:"dataValidation,omitempty"` // EffectiveFormat: The effective format being used by the cell. This // includes the results of applying any conditional formatting and, if // the cell contains a formula, the computed number format. If the // effective format is the default format, effective format will not be // written. This field is read-only. EffectiveFormat *CellFormat `json:"effectiveFormat,omitempty"` // EffectiveValue: The effective value of the cell. For cells with // formulas, this is the calculated value. For cells with literals, this // is the same as the user_entered_value. This field is read-only. EffectiveValue *ExtendedValue `json:"effectiveValue,omitempty"` // FormattedValue: The formatted value of the cell. This is the value as // it's shown to the user. This field is read-only. FormattedValue string `json:"formattedValue,omitempty"` // Hyperlink: A hyperlink this cell points to, if any. If the cell // contains multiple hyperlinks, this field will be empty. This field is // read-only. To set it, use a `=HYPERLINK` formula in the // userEnteredValue.formulaValue field. A cell-level link can also be // set from the userEnteredFormat.textFormat field. Alternatively, set a // hyperlink in the textFormatRun.format.link field that spans the // entire cell. Hyperlink string `json:"hyperlink,omitempty"` // Note: Any note on the cell. Note string `json:"note,omitempty"` // PivotTable: A pivot table anchored at this cell. The size of pivot // table itself is computed dynamically based on its data, grouping, // filters, values, etc. Only the top-left cell of the pivot table // contains the pivot table definition. The other cells will contain the // calculated values of the results of the pivot in their // effective_value fields. PivotTable *PivotTable `json:"pivotTable,omitempty"` // TextFormatRuns: Runs of rich text applied to subsections of the cell. // Runs are only valid on user entered strings, not formulas, bools, or // numbers. Properties of a run start at a specific index in the text // and continue until the next run. Runs will inherit the properties of // the cell unless explicitly changed. When writing, the new runs will // overwrite any prior runs. When writing a new user_entered_value, // previous runs are erased. TextFormatRuns []*TextFormatRun `json:"textFormatRuns,omitempty"` // UserEnteredFormat: The format the user entered for the cell. When // writing, the new format will be merged with the existing format. UserEnteredFormat *CellFormat `json:"userEnteredFormat,omitempty"` // UserEnteredValue: The value the user entered in the cell. e.g, // `1234`, `'Hello'`, or `=NOW()` Note: Dates, Times and DateTimes are // represented as doubles in serial number format. UserEnteredValue *ExtendedValue `json:"userEnteredValue,omitempty"` // ForceSendFields is a list of field names (e.g. "DataSourceFormula") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataSourceFormula") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
CellData: Data about a specific cell.
func (*CellData) MarshalJSON ¶
type CellFormat ¶
type CellFormat struct { // BackgroundColor: The background color of the cell. Deprecated: Use // background_color_style. BackgroundColor *Color `json:"backgroundColor,omitempty"` // BackgroundColorStyle: The background color of the cell. If // background_color is also set, this field takes precedence. BackgroundColorStyle *ColorStyle `json:"backgroundColorStyle,omitempty"` // Borders: The borders of the cell. Borders *Borders `json:"borders,omitempty"` // HorizontalAlignment: The horizontal alignment of the value in the // cell. // // Possible values: // "HORIZONTAL_ALIGN_UNSPECIFIED" - The horizontal alignment is not // specified. Do not use this. // "LEFT" - The text is explicitly aligned to the left of the cell. // "CENTER" - The text is explicitly aligned to the center of the // cell. // "RIGHT" - The text is explicitly aligned to the right of the cell. HorizontalAlignment string `json:"horizontalAlignment,omitempty"` // HyperlinkDisplayType: If one exists, how a hyperlink should be // displayed in the cell. // // Possible values: // "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED" - The default value: the // hyperlink is rendered. Do not use this. // "LINKED" - A hyperlink should be explicitly rendered. // "PLAIN_TEXT" - A hyperlink should not be rendered. HyperlinkDisplayType string `json:"hyperlinkDisplayType,omitempty"` // NumberFormat: A format describing how number values should be // represented to the user. NumberFormat *NumberFormat `json:"numberFormat,omitempty"` // Padding: The padding of the cell. Padding *Padding `json:"padding,omitempty"` // TextDirection: The direction of the text in the cell. // // Possible values: // "TEXT_DIRECTION_UNSPECIFIED" - The text direction is not specified. // Do not use this. // "LEFT_TO_RIGHT" - The text direction of left-to-right was set by // the user. // "RIGHT_TO_LEFT" - The text direction of right-to-left was set by // the user. TextDirection string `json:"textDirection,omitempty"` // TextFormat: The format of the text in the cell (unless overridden by // a format run). Setting a cell-level link here clears the cell's // existing links. Setting the link field in a TextFormatRun takes // precedence over the cell-level link. TextFormat *TextFormat `json:"textFormat,omitempty"` // TextRotation: The rotation applied to text in the cell. TextRotation *TextRotation `json:"textRotation,omitempty"` // VerticalAlignment: The vertical alignment of the value in the cell. // // Possible values: // "VERTICAL_ALIGN_UNSPECIFIED" - The vertical alignment is not // specified. Do not use this. // "TOP" - The text is explicitly aligned to the top of the cell. // "MIDDLE" - The text is explicitly aligned to the middle of the // cell. // "BOTTOM" - The text is explicitly aligned to the bottom of the // cell. VerticalAlignment string `json:"verticalAlignment,omitempty"` // WrapStrategy: The wrap strategy for the value in the cell. // // Possible values: // "WRAP_STRATEGY_UNSPECIFIED" - The default value, do not use. // "OVERFLOW_CELL" - Lines that are longer than the cell width will be // written in the next cell over, so long as that cell is empty. If the // next cell over is non-empty, this behaves the same as `CLIP`. The // text will never wrap to the next line unless the user manually // inserts a new line. Example: | First sentence. | | Manual newline // that is very long. <- Text continues into next cell | Next newline. | // "LEGACY_WRAP" - This wrap strategy represents the old Google Sheets // wrap strategy where words that are longer than a line are clipped // rather than broken. This strategy is not supported on all platforms // and is being phased out. Example: | Cell has a | | loooooooooo| <- // Word is clipped. | word. | // "CLIP" - Lines that are longer than the cell width will be clipped. // The text will never wrap to the next line unless the user manually // inserts a new line. Example: | First sentence. | | Manual newline t| // <- Text is clipped | Next newline. | // "WRAP" - Words that are longer than a line are wrapped at the // character level rather than clipped. Example: | Cell has a | | // loooooooooo| <- Word is broken. | ong word. | WrapStrategy string `json:"wrapStrategy,omitempty"` // ForceSendFields is a list of field names (e.g. "BackgroundColor") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BackgroundColor") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
CellFormat: The format of a cell.
func (*CellFormat) MarshalJSON ¶
func (s *CellFormat) MarshalJSON() ([]byte, error)
type ChartAxisViewWindowOptions ¶ added in v0.8.0
type ChartAxisViewWindowOptions struct { // ViewWindowMax: The maximum numeric value to be shown in this view // window. If unset, will automatically determine a maximum value that // looks good for the data. ViewWindowMax float64 `json:"viewWindowMax,omitempty"` // ViewWindowMin: The minimum numeric value to be shown in this view // window. If unset, will automatically determine a minimum value that // looks good for the data. ViewWindowMin float64 `json:"viewWindowMin,omitempty"` // ViewWindowMode: The view window's mode. // // Possible values: // "DEFAULT_VIEW_WINDOW_MODE" - The default view window mode used in // the Sheets editor for this chart type. In most cases, if set, the // default mode is equivalent to `PRETTY`. // "VIEW_WINDOW_MODE_UNSUPPORTED" - Do not use. Represents that the // currently set mode is not supported by the API. // "EXPLICIT" - Follows the min and max exactly if specified. If a // value is unspecified, it will fall back to the `PRETTY` value. // "PRETTY" - Chooses a min and max that make the chart look good. // Both min and max are ignored in this mode. ViewWindowMode string `json:"viewWindowMode,omitempty"` // ForceSendFields is a list of field names (e.g. "ViewWindowMax") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ViewWindowMax") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ChartAxisViewWindowOptions: The options that define a "view window" for a chart (such as the visible values in an axis).
func (*ChartAxisViewWindowOptions) MarshalJSON ¶ added in v0.8.0
func (s *ChartAxisViewWindowOptions) MarshalJSON() ([]byte, error)
func (*ChartAxisViewWindowOptions) UnmarshalJSON ¶ added in v0.8.0
func (s *ChartAxisViewWindowOptions) UnmarshalJSON(data []byte) error
type ChartCustomNumberFormatOptions ¶ added in v0.12.0
type ChartCustomNumberFormatOptions struct { // Prefix: Custom prefix to be prepended to the chart attribute. This // field is optional. Prefix string `json:"prefix,omitempty"` // Suffix: Custom suffix to be appended to the chart attribute. This // field is optional. Suffix string `json:"suffix,omitempty"` // ForceSendFields is a list of field names (e.g. "Prefix") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Prefix") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ChartCustomNumberFormatOptions: Custom number formatting options for chart attributes.
func (*ChartCustomNumberFormatOptions) MarshalJSON ¶ added in v0.12.0
func (s *ChartCustomNumberFormatOptions) MarshalJSON() ([]byte, error)
type ChartData ¶
type ChartData struct { // AggregateType: The aggregation type for the series of a data source // chart. Only supported for data source charts. // // Possible values: // "CHART_AGGREGATE_TYPE_UNSPECIFIED" - Default value, do not use. // "AVERAGE" - Average aggregate function. // "COUNT" - Count aggregate function. // "MAX" - Maximum aggregate function. // "MEDIAN" - Median aggregate function. // "MIN" - Minimum aggregate function. // "SUM" - Sum aggregate function. AggregateType string `json:"aggregateType,omitempty"` // ColumnReference: The reference to the data source column that the // data reads from. ColumnReference *DataSourceColumnReference `json:"columnReference,omitempty"` // GroupRule: The rule to group the data by if the ChartData backs the // domain of a data source chart. Only supported for data source charts. GroupRule *ChartGroupRule `json:"groupRule,omitempty"` // SourceRange: The source ranges of the data. SourceRange *ChartSourceRange `json:"sourceRange,omitempty"` // ForceSendFields is a list of field names (e.g. "AggregateType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AggregateType") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ChartData: The data included in a domain or series.
func (*ChartData) MarshalJSON ¶
type ChartDateTimeRule ¶ added in v0.31.0
type ChartDateTimeRule struct { // Type: The type of date-time grouping to apply. // // Possible values: // "CHART_DATE_TIME_RULE_TYPE_UNSPECIFIED" - The default type, do not // use. // "SECOND" - Group dates by second, from 0 to 59. // "MINUTE" - Group dates by minute, from 0 to 59. // "HOUR" - Group dates by hour using a 24-hour system, from 0 to 23. // "HOUR_MINUTE" - Group dates by hour and minute using a 24-hour // system, for example 19:45. // "HOUR_MINUTE_AMPM" - Group dates by hour and minute using a 12-hour // system, for example 7:45 PM. The AM/PM designation is translated // based on the spreadsheet locale. // "DAY_OF_WEEK" - Group dates by day of week, for example Sunday. The // days of the week will be translated based on the spreadsheet locale. // "DAY_OF_YEAR" - Group dates by day of year, from 1 to 366. Note // that dates after Feb. 29 fall in different buckets in leap years than // in non-leap years. // "DAY_OF_MONTH" - Group dates by day of month, from 1 to 31. // "DAY_MONTH" - Group dates by day and month, for example 22-Nov. The // month is translated based on the spreadsheet locale. // "MONTH" - Group dates by month, for example Nov. The month is // translated based on the spreadsheet locale. // "QUARTER" - Group dates by quarter, for example Q1 (which // represents Jan-Mar). // "YEAR" - Group dates by year, for example 2008. // "YEAR_MONTH" - Group dates by year and month, for example 2008-Nov. // The month is translated based on the spreadsheet locale. // "YEAR_QUARTER" - Group dates by year and quarter, for example 2008 // Q4. // "YEAR_MONTH_DAY" - Group dates by year, month, and day, for example // 2008-11-22. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Type") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Type") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ChartDateTimeRule: Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values.
func (*ChartDateTimeRule) MarshalJSON ¶ added in v0.31.0
func (s *ChartDateTimeRule) MarshalJSON() ([]byte, error)
type ChartGroupRule ¶ added in v0.31.0
type ChartGroupRule struct { // DateTimeRule: A ChartDateTimeRule. DateTimeRule *ChartDateTimeRule `json:"dateTimeRule,omitempty"` // HistogramRule: A ChartHistogramRule HistogramRule *ChartHistogramRule `json:"histogramRule,omitempty"` // ForceSendFields is a list of field names (e.g. "DateTimeRule") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DateTimeRule") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ChartGroupRule: An optional setting on the ChartData of the domain of a data source chart that defines buckets for the values in the domain rather than breaking out each individual value. For example, when plotting a data source chart, you can specify a histogram rule on the domain (it should only contain numeric values), grouping its values into buckets. Any values of a chart series that fall into the same bucket are aggregated based on the aggregate_type.
func (*ChartGroupRule) MarshalJSON ¶ added in v0.31.0
func (s *ChartGroupRule) MarshalJSON() ([]byte, error)
type ChartHistogramRule ¶ added in v0.31.0
type ChartHistogramRule struct { // IntervalSize: The size of the buckets that are created. Must be // positive. IntervalSize float64 `json:"intervalSize,omitempty"` // MaxValue: The maximum value at which items are placed into buckets. // Values greater than the maximum are grouped into a single bucket. If // omitted, it is determined by the maximum item value. MaxValue float64 `json:"maxValue,omitempty"` // MinValue: The minimum value at which items are placed into buckets. // Values that are less than the minimum are grouped into a single // bucket. If omitted, it is determined by the minimum item value. MinValue float64 `json:"minValue,omitempty"` // ForceSendFields is a list of field names (e.g. "IntervalSize") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "IntervalSize") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ChartHistogramRule: Allows you to organize numeric values in a source data column into buckets of constant size.
func (*ChartHistogramRule) MarshalJSON ¶ added in v0.31.0
func (s *ChartHistogramRule) MarshalJSON() ([]byte, error)
func (*ChartHistogramRule) UnmarshalJSON ¶ added in v0.31.0
func (s *ChartHistogramRule) UnmarshalJSON(data []byte) error
type ChartSourceRange ¶
type ChartSourceRange struct { // Sources: The ranges of data for a series or domain. Exactly one // dimension must have a length of 1, and all sources in the list must // have the same dimension with length 1. The domain (if it exists) & // all series must have the same number of source ranges. If using more // than one source range, then the source range at a given offset must // be in order and contiguous across the domain and series. For example, // these are valid configurations: domain sources: A1:A5 series1 // sources: B1:B5 series2 sources: D6:D10 domain sources: A1:A5, C10:C12 // series1 sources: B1:B5, D10:D12 series2 sources: C1:C5, E10:E12 Sources []*GridRange `json:"sources,omitempty"` // ForceSendFields is a list of field names (e.g. "Sources") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Sources") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ChartSourceRange: Source ranges for a chart.
func (*ChartSourceRange) MarshalJSON ¶
func (s *ChartSourceRange) MarshalJSON() ([]byte, error)
type ChartSpec ¶
type ChartSpec struct { // AltText: The alternative text that describes the chart. This is often // used for accessibility. AltText string `json:"altText,omitempty"` // BackgroundColor: The background color of the entire chart. Not // applicable to Org charts. Deprecated: Use background_color_style. BackgroundColor *Color `json:"backgroundColor,omitempty"` // BackgroundColorStyle: The background color of the entire chart. Not // applicable to Org charts. If background_color is also set, this field // takes precedence. BackgroundColorStyle *ColorStyle `json:"backgroundColorStyle,omitempty"` // BasicChart: A basic chart specification, can be one of many kinds of // charts. See BasicChartType for the list of all charts this supports. BasicChart *BasicChartSpec `json:"basicChart,omitempty"` // BubbleChart: A bubble chart specification. BubbleChart *BubbleChartSpec `json:"bubbleChart,omitempty"` // CandlestickChart: A candlestick chart specification. CandlestickChart *CandlestickChartSpec `json:"candlestickChart,omitempty"` // DataSourceChartProperties: If present, the field contains data source // chart specific properties. DataSourceChartProperties *DataSourceChartProperties `json:"dataSourceChartProperties,omitempty"` // FilterSpecs: The filters applied to the source data of the chart. // Only supported for data source charts. FilterSpecs []*FilterSpec `json:"filterSpecs,omitempty"` // FontName: The name of the font to use by default for all chart text // (e.g. title, axis labels, legend). If a font is specified for a // specific part of the chart it will override this font name. FontName string `json:"fontName,omitempty"` // HiddenDimensionStrategy: Determines how the charts will use hidden // rows or columns. // // Possible values: // "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED" - Default value, do // not use. // "SKIP_HIDDEN_ROWS_AND_COLUMNS" - Charts will skip hidden rows and // columns. // "SKIP_HIDDEN_ROWS" - Charts will skip hidden rows only. // "SKIP_HIDDEN_COLUMNS" - Charts will skip hidden columns only. // "SHOW_ALL" - Charts will not skip any hidden rows or columns. HiddenDimensionStrategy string `json:"hiddenDimensionStrategy,omitempty"` // HistogramChart: A histogram chart specification. HistogramChart *HistogramChartSpec `json:"histogramChart,omitempty"` // Maximized: True to make a chart fill the entire space in which it's // rendered with minimum padding. False to use the default padding. (Not // applicable to Geo and Org charts.) Maximized bool `json:"maximized,omitempty"` // OrgChart: An org chart specification. OrgChart *OrgChartSpec `json:"orgChart,omitempty"` // PieChart: A pie chart specification. PieChart *PieChartSpec `json:"pieChart,omitempty"` // ScorecardChart: A scorecard chart specification. ScorecardChart *ScorecardChartSpec `json:"scorecardChart,omitempty"` // SortSpecs: The order to sort the chart data by. Only a single sort // spec is supported. Only supported for data source charts. SortSpecs []*SortSpec `json:"sortSpecs,omitempty"` // Subtitle: The subtitle of the chart. Subtitle string `json:"subtitle,omitempty"` // SubtitleTextFormat: The subtitle text format. Strikethrough, // underline, and link are not supported. SubtitleTextFormat *TextFormat `json:"subtitleTextFormat,omitempty"` // SubtitleTextPosition: The subtitle text position. This field is // optional. SubtitleTextPosition *TextPosition `json:"subtitleTextPosition,omitempty"` // Title: The title of the chart. Title string `json:"title,omitempty"` // TitleTextFormat: The title text format. Strikethrough, underline, and // link are not supported. TitleTextFormat *TextFormat `json:"titleTextFormat,omitempty"` // TitleTextPosition: The title text position. This field is optional. TitleTextPosition *TextPosition `json:"titleTextPosition,omitempty"` // TreemapChart: A treemap chart specification. TreemapChart *TreemapChartSpec `json:"treemapChart,omitempty"` // WaterfallChart: A waterfall chart specification. WaterfallChart *WaterfallChartSpec `json:"waterfallChart,omitempty"` // ForceSendFields is a list of field names (e.g. "AltText") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AltText") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ChartSpec: The specifications of a chart.
func (*ChartSpec) MarshalJSON ¶
type ClearBasicFilterRequest ¶
type ClearBasicFilterRequest struct { // SheetId: The sheet ID on which the basic filter should be cleared. SheetId int64 `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "SheetId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "SheetId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ClearBasicFilterRequest: Clears the basic filter, if any exists on the sheet.
func (*ClearBasicFilterRequest) MarshalJSON ¶
func (s *ClearBasicFilterRequest) MarshalJSON() ([]byte, error)
type ClearValuesRequest ¶
type ClearValuesRequest struct { }
ClearValuesRequest: The request for clearing a range of values in a spreadsheet.
type ClearValuesResponse ¶
type ClearValuesResponse struct { // ClearedRange: The range (in A1 notation) that was cleared. (If the // request was for an unbounded range or a ranger larger than the bounds // of the sheet, this will be the actual range that was cleared, bounded // to the sheet's limits.) ClearedRange string `json:"clearedRange,omitempty"` // SpreadsheetId: The spreadsheet the updates were applied to. SpreadsheetId string `json:"spreadsheetId,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ClearedRange") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClearedRange") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ClearValuesResponse: The response when clearing a range of values in a spreadsheet.
func (*ClearValuesResponse) MarshalJSON ¶
func (s *ClearValuesResponse) MarshalJSON() ([]byte, error)
type Color ¶
type Color struct { // Alpha: The fraction of this color that should be applied to the // pixel. That is, the final pixel color is defined by the equation: // `pixel color = alpha * (this color) + (1.0 - alpha) * (background // color)` This means that a value of 1.0 corresponds to a solid color, // whereas a value of 0.0 corresponds to a completely transparent color. // This uses a wrapper message rather than a simple float scalar so that // it is possible to distinguish between a default value and the value // being unset. If omitted, this color object is rendered as a solid // color (as if the alpha value had been explicitly given a value of // 1.0). Alpha float64 `json:"alpha,omitempty"` // Blue: The amount of blue in the color as a value in the interval [0, // 1]. Blue float64 `json:"blue,omitempty"` // Green: The amount of green in the color as a value in the interval // [0, 1]. Green float64 `json:"green,omitempty"` // Red: The amount of red in the color as a value in the interval [0, // 1]. Red float64 `json:"red,omitempty"` // ForceSendFields is a list of field names (e.g. "Alpha") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Alpha") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Color: Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(”); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(”); }; // ...
func (*Color) MarshalJSON ¶
func (*Color) UnmarshalJSON ¶
type ColorStyle ¶ added in v0.15.0
type ColorStyle struct { // RgbColor: RGB color. The `alpha` // (/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) // value in the `Color` // (/sheets/api/reference/rest/v4/spreadsheets/other#color) object isn't // generally supported. RgbColor *Color `json:"rgbColor,omitempty"` // ThemeColor: Theme color. // // Possible values: // "THEME_COLOR_TYPE_UNSPECIFIED" - Unspecified theme color // "TEXT" - Represents the primary text color // "BACKGROUND" - Represents the primary background color // "ACCENT1" - Represents the first accent color // "ACCENT2" - Represents the second accent color // "ACCENT3" - Represents the third accent color // "ACCENT4" - Represents the fourth accent color // "ACCENT5" - Represents the fifth accent color // "ACCENT6" - Represents the sixth accent color // "LINK" - Represents the color to use for hyperlinks ThemeColor string `json:"themeColor,omitempty"` // ForceSendFields is a list of field names (e.g. "RgbColor") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RgbColor") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ColorStyle: A color value.
func (*ColorStyle) MarshalJSON ¶ added in v0.15.0
func (s *ColorStyle) MarshalJSON() ([]byte, error)
type ConditionValue ¶
type ConditionValue struct { // RelativeDate: A relative date (based on the current date). Valid only // if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or // DATE_ON_OR_AFTER. Relative dates are not supported in data // validation. They are supported only in conditional formatting and // conditional filters. // // Possible values: // "RELATIVE_DATE_UNSPECIFIED" - Default value, do not use. // "PAST_YEAR" - The value is one year before today. // "PAST_MONTH" - The value is one month before today. // "PAST_WEEK" - The value is one week before today. // "YESTERDAY" - The value is yesterday. // "TODAY" - The value is today. // "TOMORROW" - The value is tomorrow. RelativeDate string `json:"relativeDate,omitempty"` // UserEnteredValue: A value the condition is based on. The value is // parsed as if the user typed into a cell. Formulas are supported (and // must begin with an `=` or a '+'). UserEnteredValue string `json:"userEnteredValue,omitempty"` // ForceSendFields is a list of field names (e.g. "RelativeDate") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RelativeDate") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ConditionValue: The value of the condition.
func (*ConditionValue) MarshalJSON ¶
func (s *ConditionValue) MarshalJSON() ([]byte, error)
type ConditionalFormatRule ¶
type ConditionalFormatRule struct { // BooleanRule: The formatting is either "on" or "off" according to the // rule. BooleanRule *BooleanRule `json:"booleanRule,omitempty"` // GradientRule: The formatting will vary based on the gradients in the // rule. GradientRule *GradientRule `json:"gradientRule,omitempty"` // Ranges: The ranges that are formatted if the condition is true. All // the ranges must be on the same grid. Ranges []*GridRange `json:"ranges,omitempty"` // ForceSendFields is a list of field names (e.g. "BooleanRule") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BooleanRule") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ConditionalFormatRule: A rule describing a conditional format.
func (*ConditionalFormatRule) MarshalJSON ¶
func (s *ConditionalFormatRule) MarshalJSON() ([]byte, error)
type CopyPasteRequest ¶
type CopyPasteRequest struct { // Destination: The location to paste to. If the range covers a span // that's a multiple of the source's height or width, then the data will // be repeated to fill in the destination range. If the range is smaller // than the source range, the entire source data will still be copied // (beyond the end of the destination range). Destination *GridRange `json:"destination,omitempty"` // PasteOrientation: How that data should be oriented when pasting. // // Possible values: // "NORMAL" - Paste normally. // "TRANSPOSE" - Paste transposed, where all rows become columns and // vice versa. PasteOrientation string `json:"pasteOrientation,omitempty"` // PasteType: What kind of data to paste. // // Possible values: // "PASTE_NORMAL" - Paste values, formulas, formats, and merges. // "PASTE_VALUES" - Paste the values ONLY without formats, formulas, // or merges. // "PASTE_FORMAT" - Paste the format and data validation only. // "PASTE_NO_BORDERS" - Like `PASTE_NORMAL` but without borders. // "PASTE_FORMULA" - Paste the formulas only. // "PASTE_DATA_VALIDATION" - Paste the data validation only. // "PASTE_CONDITIONAL_FORMATTING" - Paste the conditional formatting // rules only. PasteType string `json:"pasteType,omitempty"` // Source: The source range to copy. Source *GridRange `json:"source,omitempty"` // ForceSendFields is a list of field names (e.g. "Destination") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Destination") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CopyPasteRequest: Copies data from the source to the destination.
func (*CopyPasteRequest) MarshalJSON ¶
func (s *CopyPasteRequest) MarshalJSON() ([]byte, error)
type CopySheetToAnotherSpreadsheetRequest ¶
type CopySheetToAnotherSpreadsheetRequest struct { // DestinationSpreadsheetId: The ID of the spreadsheet to copy the sheet // to. DestinationSpreadsheetId string `json:"destinationSpreadsheetId,omitempty"` // ForceSendFields is a list of field names (e.g. // "DestinationSpreadsheetId") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DestinationSpreadsheetId") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
CopySheetToAnotherSpreadsheetRequest: The request to copy a sheet across spreadsheets.
func (*CopySheetToAnotherSpreadsheetRequest) MarshalJSON ¶
func (s *CopySheetToAnotherSpreadsheetRequest) MarshalJSON() ([]byte, error)
type CreateDeveloperMetadataRequest ¶
type CreateDeveloperMetadataRequest struct { // DeveloperMetadata: The developer metadata to create. DeveloperMetadata *DeveloperMetadata `json:"developerMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "DeveloperMetadata") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DeveloperMetadata") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
CreateDeveloperMetadataRequest: A request to create developer metadata.
func (*CreateDeveloperMetadataRequest) MarshalJSON ¶
func (s *CreateDeveloperMetadataRequest) MarshalJSON() ([]byte, error)
type CreateDeveloperMetadataResponse ¶
type CreateDeveloperMetadataResponse struct { // DeveloperMetadata: The developer metadata that was created. DeveloperMetadata *DeveloperMetadata `json:"developerMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "DeveloperMetadata") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DeveloperMetadata") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
CreateDeveloperMetadataResponse: The response from creating developer metadata.
func (*CreateDeveloperMetadataResponse) MarshalJSON ¶
func (s *CreateDeveloperMetadataResponse) MarshalJSON() ([]byte, error)
type CutPasteRequest ¶
type CutPasteRequest struct { // Destination: The top-left coordinate where the data should be pasted. Destination *GridCoordinate `json:"destination,omitempty"` // PasteType: What kind of data to paste. All the source data will be // cut, regardless of what is pasted. // // Possible values: // "PASTE_NORMAL" - Paste values, formulas, formats, and merges. // "PASTE_VALUES" - Paste the values ONLY without formats, formulas, // or merges. // "PASTE_FORMAT" - Paste the format and data validation only. // "PASTE_NO_BORDERS" - Like `PASTE_NORMAL` but without borders. // "PASTE_FORMULA" - Paste the formulas only. // "PASTE_DATA_VALIDATION" - Paste the data validation only. // "PASTE_CONDITIONAL_FORMATTING" - Paste the conditional formatting // rules only. PasteType string `json:"pasteType,omitempty"` // Source: The source data to cut. Source *GridRange `json:"source,omitempty"` // ForceSendFields is a list of field names (e.g. "Destination") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Destination") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CutPasteRequest: Moves data from the source to the destination.
func (*CutPasteRequest) MarshalJSON ¶
func (s *CutPasteRequest) MarshalJSON() ([]byte, error)
type DataExecutionStatus ¶ added in v0.31.0
type DataExecutionStatus struct { // ErrorCode: The error code. // // Possible values: // "DATA_EXECUTION_ERROR_CODE_UNSPECIFIED" - Default value, do not // use. // "TIMED_OUT" - The data execution timed out. // "TOO_MANY_ROWS" - The data execution returns more rows than the // limit. // "TOO_MANY_COLUMNS" - The data execution returns more columns than // the limit. // "TOO_MANY_CELLS" - The data execution returns more cells than the // limit. // "ENGINE" - Error is received from the backend data execution engine // (e.g. BigQuery). Check error_message for details. // "PARAMETER_INVALID" - One or some of the provided data source // parameters are invalid. // "UNSUPPORTED_DATA_TYPE" - The data execution returns an unsupported // data type. // "DUPLICATE_COLUMN_NAMES" - The data execution returns duplicate // column names or aliases. // "INTERRUPTED" - The data execution is interrupted. Please refresh // later. // "CONCURRENT_QUERY" - The data execution is currently in progress, // can not be refreshed until it completes. // "OTHER" - Other errors. // "TOO_MANY_CHARS_PER_CELL" - The data execution returns values that // exceed the maximum characters allowed in a single cell. // "DATA_NOT_FOUND" - The database referenced by the data source is // not found. */ // "PERMISSION_DENIED" - The user does not have access to the database // referenced by the data source. // "MISSING_COLUMN_ALIAS" - The data execution returns columns with // missing aliases. // "OBJECT_NOT_FOUND" - The data source object does not exist. // "OBJECT_IN_ERROR_STATE" - The data source object is currently in // error state. To force refresh, set force in RefreshDataSourceRequest. // "OBJECT_SPEC_INVALID" - The data source object specification is // invalid. ErrorCode string `json:"errorCode,omitempty"` // ErrorMessage: The error message, which may be empty. ErrorMessage string `json:"errorMessage,omitempty"` // LastRefreshTime: Gets the time the data last successfully refreshed. LastRefreshTime string `json:"lastRefreshTime,omitempty"` // State: The state of the data execution. // // Possible values: // "DATA_EXECUTION_STATE_UNSPECIFIED" - Default value, do not use. // "NOT_STARTED" - The data execution has not started. // "RUNNING" - The data execution has started and is running. // "SUCCEEDED" - The data execution has completed successfully. // "FAILED" - The data execution has completed with errors. State string `json:"state,omitempty"` // ForceSendFields is a list of field names (e.g. "ErrorCode") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ErrorCode") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataExecutionStatus: The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects.
func (*DataExecutionStatus) MarshalJSON ¶ added in v0.31.0
func (s *DataExecutionStatus) MarshalJSON() ([]byte, error)
type DataFilter ¶
type DataFilter struct { // A1Range: Selects data that matches the specified A1 range. A1Range string `json:"a1Range,omitempty"` // DeveloperMetadataLookup: Selects data associated with the developer // metadata matching the criteria described by this // DeveloperMetadataLookup. DeveloperMetadataLookup *DeveloperMetadataLookup `json:"developerMetadataLookup,omitempty"` // GridRange: Selects data that matches the range described by the // GridRange. GridRange *GridRange `json:"gridRange,omitempty"` // ForceSendFields is a list of field names (e.g. "A1Range") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "A1Range") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataFilter: Filter that describes what data should be selected or returned from a request.
func (*DataFilter) MarshalJSON ¶
func (s *DataFilter) MarshalJSON() ([]byte, error)
type DataFilterValueRange ¶
type DataFilterValueRange struct { // DataFilter: The data filter describing the location of the values in // the spreadsheet. DataFilter *DataFilter `json:"dataFilter,omitempty"` // MajorDimension: The major dimension of the values. // // Possible values: // "DIMENSION_UNSPECIFIED" - The default value, do not use. // "ROWS" - Operates on the rows of a sheet. // "COLUMNS" - Operates on the columns of a sheet. MajorDimension string `json:"majorDimension,omitempty"` // Values: The data to be written. If the provided values exceed any of // the ranges matched by the data filter then the request fails. If the // provided values are less than the matched ranges only the specified // values are written, existing values in the matched ranges remain // unaffected. Values [][]interface{} `json:"values,omitempty"` // ForceSendFields is a list of field names (e.g. "DataFilter") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataFilter") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataFilterValueRange: A range of values whose location is specified by a DataFilter.
func (*DataFilterValueRange) MarshalJSON ¶
func (s *DataFilterValueRange) MarshalJSON() ([]byte, error)
type DataLabel ¶ added in v0.36.0
type DataLabel struct { // CustomLabelData: Data to use for custom labels. Only used if type is // set to CUSTOM. This data must be the same length as the series or // other element this data label is applied to. In addition, if the // series is split into multiple source ranges, this source data must // come from the next column in the source data. For example, if the // series is B2:B4,E6:E8 then this data must come from C2:C4,F6:F8. CustomLabelData *ChartData `json:"customLabelData,omitempty"` // Placement: The placement of the data label relative to the labeled // data. // // Possible values: // "DATA_LABEL_PLACEMENT_UNSPECIFIED" - The positioning is determined // automatically by the renderer. // "CENTER" - Center within a bar or column, both horizontally and // vertically. // "LEFT" - To the left of a data point. // "RIGHT" - To the right of a data point. // "ABOVE" - Above a data point. // "BELOW" - Below a data point. // "INSIDE_END" - Inside a bar or column at the end (top if positive, // bottom if negative). // "INSIDE_BASE" - Inside a bar or column at the base. // "OUTSIDE_END" - Outside a bar or column at the end. Placement string `json:"placement,omitempty"` // TextFormat: The text format used for the data label. The link field // is not supported. TextFormat *TextFormat `json:"textFormat,omitempty"` // Type: The type of the data label. // // Possible values: // "DATA_LABEL_TYPE_UNSPECIFIED" - The data label type is not // specified and will be interpreted depending on the context of the // data label within the chart. // "NONE" - The data label is not displayed. // "DATA" - The data label is displayed using values from the series // data. // "CUSTOM" - The data label is displayed using values from a custom // data source indicated by customLabelData. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "CustomLabelData") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CustomLabelData") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DataLabel: Settings for one set of data labels. Data labels are annotations that appear next to a set of data, such as the points on a line chart, and provide additional information about what the data represents, such as a text representation of the value behind that point on the graph.
func (*DataLabel) MarshalJSON ¶ added in v0.36.0
type DataSource ¶ added in v0.31.0
type DataSource struct { // CalculatedColumns: All calculated columns in the data source. CalculatedColumns []*DataSourceColumn `json:"calculatedColumns,omitempty"` // DataSourceId: The spreadsheet-scoped unique ID that identifies the // data source. Example: 1080547365. DataSourceId string `json:"dataSourceId,omitempty"` // SheetId: The ID of the Sheet connected with the data source. The // field cannot be changed once set. When creating a data source, an // associated DATA_SOURCE sheet is also created, if the field is not // specified, the ID of the created sheet will be randomly generated. SheetId int64 `json:"sheetId,omitempty"` // Spec: The DataSourceSpec for the data source connected with this // spreadsheet. Spec *DataSourceSpec `json:"spec,omitempty"` // ForceSendFields is a list of field names (e.g. "CalculatedColumns") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CalculatedColumns") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DataSource: Information about an external data source in the spreadsheet.
func (*DataSource) MarshalJSON ¶ added in v0.31.0
func (s *DataSource) MarshalJSON() ([]byte, error)
type DataSourceChartProperties ¶ added in v0.31.0
type DataSourceChartProperties struct { // DataExecutionStatus: Output only. The data execution status. DataExecutionStatus *DataExecutionStatus `json:"dataExecutionStatus,omitempty"` // DataSourceId: ID of the data source that the chart is associated // with. DataSourceId string `json:"dataSourceId,omitempty"` // ForceSendFields is a list of field names (e.g. "DataExecutionStatus") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataExecutionStatus") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DataSourceChartProperties: Properties of a data source chart.
func (*DataSourceChartProperties) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceChartProperties) MarshalJSON() ([]byte, error)
type DataSourceColumn ¶ added in v0.31.0
type DataSourceColumn struct { // Formula: The formula of the calculated column. Formula string `json:"formula,omitempty"` // Reference: The column reference. Reference *DataSourceColumnReference `json:"reference,omitempty"` // ForceSendFields is a list of field names (e.g. "Formula") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Formula") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceColumn: A column in a data source.
func (*DataSourceColumn) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceColumn) MarshalJSON() ([]byte, error)
type DataSourceColumnReference ¶ added in v0.31.0
type DataSourceColumnReference struct { // Name: The display name of the column. It should be unique within a // data source. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceColumnReference: An unique identifier that references a data source column.
func (*DataSourceColumnReference) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceColumnReference) MarshalJSON() ([]byte, error)
type DataSourceFormula ¶ added in v0.31.0
type DataSourceFormula struct { // DataExecutionStatus: Output only. The data execution status. DataExecutionStatus *DataExecutionStatus `json:"dataExecutionStatus,omitempty"` // DataSourceId: The ID of the data source the formula is associated // with. DataSourceId string `json:"dataSourceId,omitempty"` // ForceSendFields is a list of field names (e.g. "DataExecutionStatus") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataExecutionStatus") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DataSourceFormula: A data source formula.
func (*DataSourceFormula) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceFormula) MarshalJSON() ([]byte, error)
type DataSourceObjectReference ¶ added in v0.31.0
type DataSourceObjectReference struct { // ChartId: References to a data source chart. ChartId int64 `json:"chartId,omitempty"` // DataSourceFormulaCell: References to a cell containing // DataSourceFormula. DataSourceFormulaCell *GridCoordinate `json:"dataSourceFormulaCell,omitempty"` // DataSourcePivotTableAnchorCell: References to a data source // PivotTable anchored at the cell. DataSourcePivotTableAnchorCell *GridCoordinate `json:"dataSourcePivotTableAnchorCell,omitempty"` // DataSourceTableAnchorCell: References to a DataSourceTable anchored // at the cell. DataSourceTableAnchorCell *GridCoordinate `json:"dataSourceTableAnchorCell,omitempty"` // SheetId: References to a DATA_SOURCE sheet. SheetId string `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "ChartId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ChartId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceObjectReference: Reference to a data source object.
func (*DataSourceObjectReference) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceObjectReference) MarshalJSON() ([]byte, error)
type DataSourceObjectReferences ¶ added in v0.31.0
type DataSourceObjectReferences struct { // References: The references. References []*DataSourceObjectReference `json:"references,omitempty"` // ForceSendFields is a list of field names (e.g. "References") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "References") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceObjectReferences: A list of references to data source objects.
func (*DataSourceObjectReferences) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceObjectReferences) MarshalJSON() ([]byte, error)
type DataSourceParameter ¶ added in v0.31.0
type DataSourceParameter struct { // Name: Named parameter. Must be a legitimate identifier for the // DataSource that supports it. For example, BigQuery identifier // (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). Name string `json:"name,omitempty"` // NamedRangeId: ID of a NamedRange. Its size must be 1x1. NamedRangeId string `json:"namedRangeId,omitempty"` // Range: A range that contains the value of the parameter. Its size // must be 1x1. Range *GridRange `json:"range,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceParameter: A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query.
func (*DataSourceParameter) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceParameter) MarshalJSON() ([]byte, error)
type DataSourceRefreshDailySchedule ¶ added in v0.31.0
type DataSourceRefreshDailySchedule struct { // StartTime: The start time of a time interval in which a data source // refresh is scheduled. Only `hours` part is used. The time interval // size defaults to that in the Sheets editor. StartTime *TimeOfDay `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "StartTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "StartTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceRefreshDailySchedule: A schedule for data to refresh every day in a given time interval.
func (*DataSourceRefreshDailySchedule) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceRefreshDailySchedule) MarshalJSON() ([]byte, error)
type DataSourceRefreshMonthlySchedule ¶ added in v0.31.0
type DataSourceRefreshMonthlySchedule struct { // DaysOfMonth: Days of the month to refresh. Only 1-28 are supported, // mapping to the 1st to the 28th day. At lesat one day must be // specified. DaysOfMonth []int64 `json:"daysOfMonth,omitempty"` // StartTime: The start time of a time interval in which a data source // refresh is scheduled. Only `hours` part is used. The time interval // size defaults to that in the Sheets editor. StartTime *TimeOfDay `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "DaysOfMonth") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DaysOfMonth") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceRefreshMonthlySchedule: A monthly schedule for data to refresh on specific days in the month in a given time interval.
func (*DataSourceRefreshMonthlySchedule) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceRefreshMonthlySchedule) MarshalJSON() ([]byte, error)
type DataSourceRefreshSchedule ¶ added in v0.31.0
type DataSourceRefreshSchedule struct { // DailySchedule: Daily refresh schedule. DailySchedule *DataSourceRefreshDailySchedule `json:"dailySchedule,omitempty"` // Enabled: True if the refresh schedule is enabled, or false otherwise. Enabled bool `json:"enabled,omitempty"` // MonthlySchedule: Monthly refresh schedule. MonthlySchedule *DataSourceRefreshMonthlySchedule `json:"monthlySchedule,omitempty"` // NextRun: Output only. The time interval of the next run. NextRun *Interval `json:"nextRun,omitempty"` // RefreshScope: The scope of the refresh. Must be ALL_DATA_SOURCES. // // Possible values: // "DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED" - Default value, do not // use. // "ALL_DATA_SOURCES" - Refreshes all data sources and their // associated data source objects in the spreadsheet. RefreshScope string `json:"refreshScope,omitempty"` // WeeklySchedule: Weekly refresh schedule. WeeklySchedule *DataSourceRefreshWeeklySchedule `json:"weeklySchedule,omitempty"` // ForceSendFields is a list of field names (e.g. "DailySchedule") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DailySchedule") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceRefreshSchedule: Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8am , the refresh will take place between 8am and 12pm every day.
func (*DataSourceRefreshSchedule) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceRefreshSchedule) MarshalJSON() ([]byte, error)
type DataSourceRefreshWeeklySchedule ¶ added in v0.31.0
type DataSourceRefreshWeeklySchedule struct { // DaysOfWeek: Days of the week to refresh. At least one day must be // specified. // // Possible values: // "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified. // "MONDAY" - Monday // "TUESDAY" - Tuesday // "WEDNESDAY" - Wednesday // "THURSDAY" - Thursday // "FRIDAY" - Friday // "SATURDAY" - Saturday // "SUNDAY" - Sunday DaysOfWeek []string `json:"daysOfWeek,omitempty"` // StartTime: The start time of a time interval in which a data source // refresh is scheduled. Only `hours` part is used. The time interval // size defaults to that in the Sheets editor. StartTime *TimeOfDay `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "DaysOfWeek") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DaysOfWeek") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceRefreshWeeklySchedule: A weekly schedule for data to refresh on specific days in a given time interval.
func (*DataSourceRefreshWeeklySchedule) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceRefreshWeeklySchedule) MarshalJSON() ([]byte, error)
type DataSourceSheetDimensionRange ¶ added in v0.31.0
type DataSourceSheetDimensionRange struct { // ColumnReferences: The columns on the data source sheet. ColumnReferences []*DataSourceColumnReference `json:"columnReferences,omitempty"` // SheetId: The ID of the data source sheet the range is on. SheetId int64 `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnReferences") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnReferences") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DataSourceSheetDimensionRange: A range along a single dimension on a DATA_SOURCE sheet.
func (*DataSourceSheetDimensionRange) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceSheetDimensionRange) MarshalJSON() ([]byte, error)
type DataSourceSheetProperties ¶ added in v0.31.0
type DataSourceSheetProperties struct { // Columns: The columns displayed on the sheet, corresponding to the // values in RowData. Columns []*DataSourceColumn `json:"columns,omitempty"` // DataExecutionStatus: The data execution status. DataExecutionStatus *DataExecutionStatus `json:"dataExecutionStatus,omitempty"` // DataSourceId: ID of the DataSource the sheet is connected to. DataSourceId string `json:"dataSourceId,omitempty"` // ForceSendFields is a list of field names (e.g. "Columns") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Columns") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceSheetProperties: Additional properties of a DATA_SOURCE sheet.
func (*DataSourceSheetProperties) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceSheetProperties) MarshalJSON() ([]byte, error)
type DataSourceSpec ¶ added in v0.31.0
type DataSourceSpec struct { // BigQuery: A BigQueryDataSourceSpec. BigQuery *BigQueryDataSourceSpec `json:"bigQuery,omitempty"` // Parameters: The parameters of the data source, used when querying the // data source. Parameters []*DataSourceParameter `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "BigQuery") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BigQuery") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataSourceSpec: This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.
func (*DataSourceSpec) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceSpec) MarshalJSON() ([]byte, error)
type DataSourceTable ¶ added in v0.31.0
type DataSourceTable struct { // ColumnSelectionType: The type to select columns for the data source // table. Defaults to SELECTED. // // Possible values: // "DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED" - The default // column selection type, do not use. // "SELECTED" - Select columns specified by columns field. // "SYNC_ALL" - Sync all current and future columns in the data // source. If set, the data source table fetches all the columns in the // data source at the time of refresh. ColumnSelectionType string `json:"columnSelectionType,omitempty"` // Columns: Columns selected for the data source table. The // column_selection_type must be SELECTED. Columns []*DataSourceColumnReference `json:"columns,omitempty"` // DataExecutionStatus: Output only. The data execution status. DataExecutionStatus *DataExecutionStatus `json:"dataExecutionStatus,omitempty"` // DataSourceId: The ID of the data source the data source table is // associated with. DataSourceId string `json:"dataSourceId,omitempty"` // FilterSpecs: Filter specifications in the data source table. FilterSpecs []*FilterSpec `json:"filterSpecs,omitempty"` // RowLimit: The limit of rows to return. If not set, a default limit is // applied. Please refer to the Sheets editor for the default and max // limit. RowLimit int64 `json:"rowLimit,omitempty"` // SortSpecs: Sort specifications in the data source table. The result // of the data source table is sorted based on the sort specifications // in order. SortSpecs []*SortSpec `json:"sortSpecs,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnSelectionType") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnSelectionType") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DataSourceTable: A data source table, which allows the user to import a static table of data from the DataSource into Sheets. This is also known as "Extract" in the Sheets editor.
func (*DataSourceTable) MarshalJSON ¶ added in v0.31.0
func (s *DataSourceTable) MarshalJSON() ([]byte, error)
type DataValidationRule ¶
type DataValidationRule struct { // Condition: The condition that data in the cell must match. Condition *BooleanCondition `json:"condition,omitempty"` // InputMessage: A message to show the user when adding data to the // cell. InputMessage string `json:"inputMessage,omitempty"` // ShowCustomUi: True if the UI should be customized based on the kind // of condition. If true, "List" conditions will show a dropdown. ShowCustomUi bool `json:"showCustomUi,omitempty"` // Strict: True if invalid data should be rejected. Strict bool `json:"strict,omitempty"` // ForceSendFields is a list of field names (e.g. "Condition") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Condition") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DataValidationRule: A data validation rule.
func (*DataValidationRule) MarshalJSON ¶
func (s *DataValidationRule) MarshalJSON() ([]byte, error)
type DateTimeRule ¶
type DateTimeRule struct { // Type: The type of date-time grouping to apply. // // Possible values: // "DATE_TIME_RULE_TYPE_UNSPECIFIED" - The default type, do not use. // "SECOND" - Group dates by second, from 0 to 59. // "MINUTE" - Group dates by minute, from 0 to 59. // "HOUR" - Group dates by hour using a 24-hour system, from 0 to 23. // "HOUR_MINUTE" - Group dates by hour and minute using a 24-hour // system, for example 19:45. // "HOUR_MINUTE_AMPM" - Group dates by hour and minute using a 12-hour // system, for example 7:45 PM. The AM/PM designation is translated // based on the spreadsheet locale. // "DAY_OF_WEEK" - Group dates by day of week, for example Sunday. The // days of the week will be translated based on the spreadsheet locale. // "DAY_OF_YEAR" - Group dates by day of year, from 1 to 366. Note // that dates after Feb. 29 fall in different buckets in leap years than // in non-leap years. // "DAY_OF_MONTH" - Group dates by day of month, from 1 to 31. // "DAY_MONTH" - Group dates by day and month, for example 22-Nov. The // month is translated based on the spreadsheet locale. // "MONTH" - Group dates by month, for example Nov. The month is // translated based on the spreadsheet locale. // "QUARTER" - Group dates by quarter, for example Q1 (which // represents Jan-Mar). // "YEAR" - Group dates by year, for example 2008. // "YEAR_MONTH" - Group dates by year and month, for example 2008-Nov. // The month is translated based on the spreadsheet locale. // "YEAR_QUARTER" - Group dates by year and quarter, for example 2008 // Q4. // "YEAR_MONTH_DAY" - Group dates by year, month, and day, for example // 2008-11-22. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Type") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Type") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DateTimeRule: Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values. For example, consider a pivot table showing sales transactions by date: +----------+--------------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | $621.14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | ... +----------+--------------+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH results in the following pivot table. +--------------+--------------+ | Grouped Date | SUM of Sales | +--------------+--------------+ | 2017-Jan | $53,731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... +--------------+--------------+
func (*DateTimeRule) MarshalJSON ¶
func (s *DateTimeRule) MarshalJSON() ([]byte, error)
type DeleteBandingRequest ¶
type DeleteBandingRequest struct { // BandedRangeId: The ID of the banded range to delete. BandedRangeId int64 `json:"bandedRangeId,omitempty"` // ForceSendFields is a list of field names (e.g. "BandedRangeId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BandedRangeId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteBandingRequest: Removes the banded range with the given ID from the spreadsheet.
func (*DeleteBandingRequest) MarshalJSON ¶
func (s *DeleteBandingRequest) MarshalJSON() ([]byte, error)
type DeleteConditionalFormatRuleRequest ¶
type DeleteConditionalFormatRuleRequest struct { // Index: The zero-based index of the rule to be deleted. Index int64 `json:"index,omitempty"` // SheetId: The sheet the rule is being deleted from. SheetId int64 `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "Index") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Index") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteConditionalFormatRuleRequest: Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented.
func (*DeleteConditionalFormatRuleRequest) MarshalJSON ¶
func (s *DeleteConditionalFormatRuleRequest) MarshalJSON() ([]byte, error)
type DeleteConditionalFormatRuleResponse ¶
type DeleteConditionalFormatRuleResponse struct { // Rule: The rule that was deleted. Rule *ConditionalFormatRule `json:"rule,omitempty"` // ForceSendFields is a list of field names (e.g. "Rule") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Rule") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteConditionalFormatRuleResponse: The result of deleting a conditional format rule.
func (*DeleteConditionalFormatRuleResponse) MarshalJSON ¶
func (s *DeleteConditionalFormatRuleResponse) MarshalJSON() ([]byte, error)
type DeleteDataSourceRequest ¶ added in v0.31.0
type DeleteDataSourceRequest struct { // DataSourceId: The ID of the data source to delete. DataSourceId string `json:"dataSourceId,omitempty"` // ForceSendFields is a list of field names (e.g. "DataSourceId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataSourceId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteDataSourceRequest: Deletes a data source. The request also deletes the associated data source sheet, and unlinks all associated data source objects.
func (*DeleteDataSourceRequest) MarshalJSON ¶ added in v0.31.0
func (s *DeleteDataSourceRequest) MarshalJSON() ([]byte, error)
type DeleteDeveloperMetadataRequest ¶
type DeleteDeveloperMetadataRequest struct { // DataFilter: The data filter describing the criteria used to select // which developer metadata entry to delete. DataFilter *DataFilter `json:"dataFilter,omitempty"` // ForceSendFields is a list of field names (e.g. "DataFilter") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataFilter") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteDeveloperMetadataRequest: A request to delete developer metadata.
func (*DeleteDeveloperMetadataRequest) MarshalJSON ¶
func (s *DeleteDeveloperMetadataRequest) MarshalJSON() ([]byte, error)
type DeleteDeveloperMetadataResponse ¶
type DeleteDeveloperMetadataResponse struct { // DeletedDeveloperMetadata: The metadata that was deleted. DeletedDeveloperMetadata []*DeveloperMetadata `json:"deletedDeveloperMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. // "DeletedDeveloperMetadata") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DeletedDeveloperMetadata") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DeleteDeveloperMetadataResponse: The response from deleting developer metadata.
func (*DeleteDeveloperMetadataResponse) MarshalJSON ¶
func (s *DeleteDeveloperMetadataResponse) MarshalJSON() ([]byte, error)
type DeleteDimensionGroupRequest ¶
type DeleteDimensionGroupRequest struct { // Range: The range of the group to be deleted. Range *DimensionRange `json:"range,omitempty"` // ForceSendFields is a list of field names (e.g. "Range") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Range") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteDimensionGroupRequest: Deletes a group over the specified range by decrementing the depth of the dimensions in the range. For example, assume the sheet has a depth-1 group over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the sheet with a depth-1 group over B:D and a depth-2 group over C:C.
func (*DeleteDimensionGroupRequest) MarshalJSON ¶
func (s *DeleteDimensionGroupRequest) MarshalJSON() ([]byte, error)
type DeleteDimensionGroupResponse ¶
type DeleteDimensionGroupResponse struct { // DimensionGroups: All groups of a dimension after deleting a group // from that dimension. DimensionGroups []*DimensionGroup `json:"dimensionGroups,omitempty"` // ForceSendFields is a list of field names (e.g. "DimensionGroups") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DimensionGroups") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DeleteDimensionGroupResponse: The result of deleting a group.
func (*DeleteDimensionGroupResponse) MarshalJSON ¶
func (s *DeleteDimensionGroupResponse) MarshalJSON() ([]byte, error)
type DeleteDimensionRequest ¶
type DeleteDimensionRequest struct { // Range: The dimensions to delete from the sheet. Range *DimensionRange `json:"range,omitempty"` // ForceSendFields is a list of field names (e.g. "Range") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Range") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteDimensionRequest: Deletes the dimensions from the sheet.
func (*DeleteDimensionRequest) MarshalJSON ¶
func (s *DeleteDimensionRequest) MarshalJSON() ([]byte, error)
type DeleteDuplicatesRequest ¶ added in v0.8.0
type DeleteDuplicatesRequest struct { // ComparisonColumns: The columns in the range to analyze for duplicate // values. If no columns are selected then all columns are analyzed for // duplicates. ComparisonColumns []*DimensionRange `json:"comparisonColumns,omitempty"` // Range: The range to remove duplicates rows from. Range *GridRange `json:"range,omitempty"` // ForceSendFields is a list of field names (e.g. "ComparisonColumns") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ComparisonColumns") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DeleteDuplicatesRequest: Removes rows within this range that contain values in the specified columns that are duplicates of values in any previous row. Rows with identical values but different letter cases, formatting, or formulas are considered to be duplicates. This request also removes duplicate rows hidden from view (for example, due to a filter). When removing duplicates, the first instance of each duplicate row scanning from the top downwards is kept in the resulting range. Content outside of the specified range isn't removed, and rows considered duplicates do not have to be adjacent to each other in the range.
func (*DeleteDuplicatesRequest) MarshalJSON ¶ added in v0.8.0
func (s *DeleteDuplicatesRequest) MarshalJSON() ([]byte, error)
type DeleteDuplicatesResponse ¶ added in v0.8.0
type DeleteDuplicatesResponse struct { // DuplicatesRemovedCount: The number of duplicate rows removed. DuplicatesRemovedCount int64 `json:"duplicatesRemovedCount,omitempty"` // ForceSendFields is a list of field names (e.g. // "DuplicatesRemovedCount") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DuplicatesRemovedCount") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DeleteDuplicatesResponse: The result of removing duplicates in a range.
func (*DeleteDuplicatesResponse) MarshalJSON ¶ added in v0.8.0
func (s *DeleteDuplicatesResponse) MarshalJSON() ([]byte, error)
type DeleteEmbeddedObjectRequest ¶
type DeleteEmbeddedObjectRequest struct { // ObjectId: The ID of the embedded object to delete. ObjectId int64 `json:"objectId,omitempty"` // ForceSendFields is a list of field names (e.g. "ObjectId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ObjectId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteEmbeddedObjectRequest: Deletes the embedded object with the given ID.
func (*DeleteEmbeddedObjectRequest) MarshalJSON ¶
func (s *DeleteEmbeddedObjectRequest) MarshalJSON() ([]byte, error)
type DeleteFilterViewRequest ¶
type DeleteFilterViewRequest struct { // FilterId: The ID of the filter to delete. FilterId int64 `json:"filterId,omitempty"` // ForceSendFields is a list of field names (e.g. "FilterId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FilterId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteFilterViewRequest: Deletes a particular filter view.
func (*DeleteFilterViewRequest) MarshalJSON ¶
func (s *DeleteFilterViewRequest) MarshalJSON() ([]byte, error)
type DeleteNamedRangeRequest ¶
type DeleteNamedRangeRequest struct { // NamedRangeId: The ID of the named range to delete. NamedRangeId string `json:"namedRangeId,omitempty"` // ForceSendFields is a list of field names (e.g. "NamedRangeId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NamedRangeId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteNamedRangeRequest: Removes the named range with the given ID from the spreadsheet.
func (*DeleteNamedRangeRequest) MarshalJSON ¶
func (s *DeleteNamedRangeRequest) MarshalJSON() ([]byte, error)
type DeleteProtectedRangeRequest ¶
type DeleteProtectedRangeRequest struct { // ProtectedRangeId: The ID of the protected range to delete. ProtectedRangeId int64 `json:"protectedRangeId,omitempty"` // ForceSendFields is a list of field names (e.g. "ProtectedRangeId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ProtectedRangeId") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DeleteProtectedRangeRequest: Deletes the protected range with the given ID.
func (*DeleteProtectedRangeRequest) MarshalJSON ¶
func (s *DeleteProtectedRangeRequest) MarshalJSON() ([]byte, error)
type DeleteRangeRequest ¶
type DeleteRangeRequest struct { // Range: The range of cells to delete. Range *GridRange `json:"range,omitempty"` // ShiftDimension: The dimension from which deleted cells will be // replaced with. If ROWS, existing cells will be shifted upward to // replace the deleted cells. If COLUMNS, existing cells will be shifted // left to replace the deleted cells. // // Possible values: // "DIMENSION_UNSPECIFIED" - The default value, do not use. // "ROWS" - Operates on the rows of a sheet. // "COLUMNS" - Operates on the columns of a sheet. ShiftDimension string `json:"shiftDimension,omitempty"` // ForceSendFields is a list of field names (e.g. "Range") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Range") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteRangeRequest: Deletes a range of cells, shifting other cells into the deleted area.
func (*DeleteRangeRequest) MarshalJSON ¶
func (s *DeleteRangeRequest) MarshalJSON() ([]byte, error)
type DeleteSheetRequest ¶
type DeleteSheetRequest struct { // SheetId: The ID of the sheet to delete. If the sheet is of // DATA_SOURCE type, the associated DataSource is also deleted. SheetId int64 `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "SheetId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "SheetId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeleteSheetRequest: Deletes the requested sheet.
func (*DeleteSheetRequest) MarshalJSON ¶
func (s *DeleteSheetRequest) MarshalJSON() ([]byte, error)
type DeveloperMetadata ¶
type DeveloperMetadata struct { // Location: The location where the metadata is associated. Location *DeveloperMetadataLocation `json:"location,omitempty"` // MetadataId: The spreadsheet-scoped unique ID that identifies the // metadata. IDs may be specified when metadata is created, otherwise // one will be randomly generated and assigned. Must be positive. MetadataId int64 `json:"metadataId,omitempty"` // MetadataKey: The metadata key. There may be multiple metadata in a // spreadsheet with the same key. Developer metadata must always have a // key specified. MetadataKey string `json:"metadataKey,omitempty"` // MetadataValue: Data associated with the metadata's key. MetadataValue string `json:"metadataValue,omitempty"` // Visibility: The metadata visibility. Developer metadata must always // have a visibility specified. // // Possible values: // "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" - Default value. // "DOCUMENT" - Document-visible metadata is accessible from any // developer project with access to the document. // "PROJECT" - Project-visible metadata is only visible to and // accessible by the developer project that created the metadata. Visibility string `json:"visibility,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Location") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Location") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DeveloperMetadata: Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too.
func (*DeveloperMetadata) MarshalJSON ¶
func (s *DeveloperMetadata) MarshalJSON() ([]byte, error)
type DeveloperMetadataLocation ¶
type DeveloperMetadataLocation struct { // DimensionRange: Represents the row or column when metadata is // associated with a dimension. The specified DimensionRange must // represent a single row or column; it cannot be unbounded or span // multiple rows or columns. DimensionRange *DimensionRange `json:"dimensionRange,omitempty"` // LocationType: The type of location this object represents. This field // is read-only. // // Possible values: // "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" - Default value. // "ROW" - Developer metadata associated on an entire row dimension. // "COLUMN" - Developer metadata associated on an entire column // dimension. // "SHEET" - Developer metadata associated on an entire sheet. // "SPREADSHEET" - Developer metadata associated on the entire // spreadsheet. LocationType string `json:"locationType,omitempty"` // SheetId: The ID of the sheet when metadata is associated with an // entire sheet. SheetId int64 `json:"sheetId,omitempty"` // Spreadsheet: True when metadata is associated with an entire // spreadsheet. Spreadsheet bool `json:"spreadsheet,omitempty"` // ForceSendFields is a list of field names (e.g. "DimensionRange") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DimensionRange") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DeveloperMetadataLocation: A location where metadata may be associated in a spreadsheet.
func (*DeveloperMetadataLocation) MarshalJSON ¶
func (s *DeveloperMetadataLocation) MarshalJSON() ([]byte, error)
type DeveloperMetadataLookup ¶
type DeveloperMetadataLookup struct { // LocationMatchingStrategy: Determines how this lookup matches the // location. If this field is specified as EXACT, only developer // metadata associated on the exact location specified is matched. If // this field is specified to INTERSECTING, developer metadata // associated on intersecting locations is also matched. If left // unspecified, this field assumes a default value of INTERSECTING. If // this field is specified, a metadataLocation must also be specified. // // Possible values: // "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED" - // Default value. This value must not be used. // "EXACT_LOCATION" - Indicates that a specified location should be // matched exactly. For example, if row three were specified as a // location this matching strategy would only match developer metadata // also associated on row three. Metadata associated on other locations // would not be considered. // "INTERSECTING_LOCATION" - Indicates that a specified location // should match that exact location as well as any intersecting // locations. For example, if row three were specified as a location // this matching strategy would match developer metadata associated on // row three as well as metadata associated on locations that intersect // row three. If, for instance, there was developer metadata associated // on column B, this matching strategy would also match that location // because column B intersects row three. LocationMatchingStrategy string `json:"locationMatchingStrategy,omitempty"` // LocationType: Limits the selected developer metadata to those entries // which are associated with locations of the specified type. For // example, when this field is specified as ROW this lookup only // considers developer metadata associated on rows. If the field is left // unspecified, all location types are considered. This field cannot be // specified as SPREADSHEET when the locationMatchingStrategy is // specified as INTERSECTING or when the metadataLocation is specified // as a non-spreadsheet location: spreadsheet metadata cannot intersect // any other developer metadata location. This field also must be left // unspecified when the locationMatchingStrategy is specified as EXACT. // // Possible values: // "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" - Default value. // "ROW" - Developer metadata associated on an entire row dimension. // "COLUMN" - Developer metadata associated on an entire column // dimension. // "SHEET" - Developer metadata associated on an entire sheet. // "SPREADSHEET" - Developer metadata associated on the entire // spreadsheet. LocationType string `json:"locationType,omitempty"` // MetadataId: Limits the selected developer metadata to that which has // a matching DeveloperMetadata.metadata_id. MetadataId int64 `json:"metadataId,omitempty"` // MetadataKey: Limits the selected developer metadata to that which has // a matching DeveloperMetadata.metadata_key. MetadataKey string `json:"metadataKey,omitempty"` // MetadataLocation: Limits the selected developer metadata to those // entries associated with the specified location. This field either // matches exact locations or all intersecting locations according the // specified locationMatchingStrategy. MetadataLocation *DeveloperMetadataLocation `json:"metadataLocation,omitempty"` // MetadataValue: Limits the selected developer metadata to that which // has a matching DeveloperMetadata.metadata_value. MetadataValue string `json:"metadataValue,omitempty"` // Visibility: Limits the selected developer metadata to that which has // a matching DeveloperMetadata.visibility. If left unspecified, all // developer metadata visibile to the requesting project is considered. // // Possible values: // "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" - Default value. // "DOCUMENT" - Document-visible metadata is accessible from any // developer project with access to the document. // "PROJECT" - Project-visible metadata is only visible to and // accessible by the developer project that created the metadata. Visibility string `json:"visibility,omitempty"` // ForceSendFields is a list of field names (e.g. // "LocationMatchingStrategy") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "LocationMatchingStrategy") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DeveloperMetadataLookup: Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified.
func (*DeveloperMetadataLookup) MarshalJSON ¶
func (s *DeveloperMetadataLookup) MarshalJSON() ([]byte, error)
type DimensionGroup ¶
type DimensionGroup struct { // Collapsed: This field is true if this group is collapsed. A collapsed // group remains collapsed if an overlapping group at a shallower depth // is expanded. A true value does not imply that all dimensions within // the group are hidden, since a dimension's visibility can change // independently from this group property. However, when this property // is updated, all dimensions within it are set to hidden if this field // is true, or set to visible if this field is false. Collapsed bool `json:"collapsed,omitempty"` // Depth: The depth of the group, representing how many groups have a // range that wholly contains the range of this group. Depth int64 `json:"depth,omitempty"` // Range: The range over which this group exists. Range *DimensionRange `json:"range,omitempty"` // ForceSendFields is a list of field names (e.g. "Collapsed") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Collapsed") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DimensionGroup: A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet.
func (*DimensionGroup) MarshalJSON ¶
func (s *DimensionGroup) MarshalJSON() ([]byte, error)
type DimensionProperties ¶
type DimensionProperties struct { // DataSourceColumnReference: Output only. If set, this is a column in a // data source sheet. DataSourceColumnReference *DataSourceColumnReference `json:"dataSourceColumnReference,omitempty"` // DeveloperMetadata: The developer metadata associated with a single // row or column. DeveloperMetadata []*DeveloperMetadata `json:"developerMetadata,omitempty"` // HiddenByFilter: True if this dimension is being filtered. This field // is read-only. HiddenByFilter bool `json:"hiddenByFilter,omitempty"` // HiddenByUser: True if this dimension is explicitly hidden. HiddenByUser bool `json:"hiddenByUser,omitempty"` // PixelSize: The height (if a row) or width (if a column) of the // dimension in pixels. PixelSize int64 `json:"pixelSize,omitempty"` // ForceSendFields is a list of field names (e.g. // "DataSourceColumnReference") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "DataSourceColumnReference") to include in API requests with the JSON // null value. By default, fields with empty values are omitted from API // requests. However, any field with an empty value appearing in // NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
DimensionProperties: Properties about a dimension.
func (*DimensionProperties) MarshalJSON ¶
func (s *DimensionProperties) MarshalJSON() ([]byte, error)
type DimensionRange ¶
type DimensionRange struct { // Dimension: The dimension of the span. // // Possible values: // "DIMENSION_UNSPECIFIED" - The default value, do not use. // "ROWS" - Operates on the rows of a sheet. // "COLUMNS" - Operates on the columns of a sheet. Dimension string `json:"dimension,omitempty"` // EndIndex: The end (exclusive) of the span, or not set if unbounded. EndIndex int64 `json:"endIndex,omitempty"` // SheetId: The sheet this span is on. SheetId int64 `json:"sheetId,omitempty"` // StartIndex: The start (inclusive) of the span, or not set if // unbounded. StartIndex int64 `json:"startIndex,omitempty"` // ForceSendFields is a list of field names (e.g. "Dimension") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Dimension") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DimensionRange: A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.
func (*DimensionRange) MarshalJSON ¶
func (s *DimensionRange) MarshalJSON() ([]byte, error)
type DuplicateFilterViewRequest ¶
type DuplicateFilterViewRequest struct { // FilterId: The ID of the filter being duplicated. FilterId int64 `json:"filterId,omitempty"` // ForceSendFields is a list of field names (e.g. "FilterId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FilterId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DuplicateFilterViewRequest: Duplicates a particular filter view.
func (*DuplicateFilterViewRequest) MarshalJSON ¶
func (s *DuplicateFilterViewRequest) MarshalJSON() ([]byte, error)
type DuplicateFilterViewResponse ¶
type DuplicateFilterViewResponse struct { // Filter: The newly created filter. Filter *FilterView `json:"filter,omitempty"` // ForceSendFields is a list of field names (e.g. "Filter") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Filter") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DuplicateFilterViewResponse: The result of a filter view being duplicated.
func (*DuplicateFilterViewResponse) MarshalJSON ¶
func (s *DuplicateFilterViewResponse) MarshalJSON() ([]byte, error)
type DuplicateSheetRequest ¶
type DuplicateSheetRequest struct { // InsertSheetIndex: The zero-based index where the new sheet should be // inserted. The index of all sheets after this are incremented. InsertSheetIndex int64 `json:"insertSheetIndex,omitempty"` // NewSheetId: If set, the ID of the new sheet. If not set, an ID is // chosen. If set, the ID must not conflict with any existing sheet ID. // If set, it must be non-negative. NewSheetId int64 `json:"newSheetId,omitempty"` // NewSheetName: The name of the new sheet. If empty, a new name is // chosen for you. NewSheetName string `json:"newSheetName,omitempty"` // SourceSheetId: The sheet to duplicate. If the source sheet is of // DATA_SOURCE type, its backing DataSource is also duplicated and // associated with the new copy of the sheet. No data execution is // triggered, the grid data of this sheet is also copied over but only // available after the batch request completes. SourceSheetId int64 `json:"sourceSheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "InsertSheetIndex") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "InsertSheetIndex") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DuplicateSheetRequest: Duplicates the contents of a sheet.
func (*DuplicateSheetRequest) MarshalJSON ¶
func (s *DuplicateSheetRequest) MarshalJSON() ([]byte, error)
type DuplicateSheetResponse ¶
type DuplicateSheetResponse struct { // Properties: The properties of the duplicate sheet. Properties *SheetProperties `json:"properties,omitempty"` // ForceSendFields is a list of field names (e.g. "Properties") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Properties") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DuplicateSheetResponse: The result of duplicating a sheet.
func (*DuplicateSheetResponse) MarshalJSON ¶
func (s *DuplicateSheetResponse) MarshalJSON() ([]byte, error)
type Editors ¶
type Editors struct { // DomainUsersCanEdit: True if anyone in the document's domain has edit // access to the protected range. Domain protection is only supported on // documents within a domain. DomainUsersCanEdit bool `json:"domainUsersCanEdit,omitempty"` // Groups: The email addresses of groups with edit access to the // protected range. Groups []string `json:"groups,omitempty"` // Users: The email addresses of users with edit access to the protected // range. Users []string `json:"users,omitempty"` // ForceSendFields is a list of field names (e.g. "DomainUsersCanEdit") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DomainUsersCanEdit") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Editors: The editors of a protected range.
func (*Editors) MarshalJSON ¶
type EmbeddedChart ¶
type EmbeddedChart struct { // Border: The border of the chart. Border *EmbeddedObjectBorder `json:"border,omitempty"` // ChartId: The ID of the chart. ChartId int64 `json:"chartId,omitempty"` // Position: The position of the chart. Position *EmbeddedObjectPosition `json:"position,omitempty"` // Spec: The specification of the chart. Spec *ChartSpec `json:"spec,omitempty"` // ForceSendFields is a list of field names (e.g. "Border") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Border") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
EmbeddedChart: A chart embedded in a sheet.
func (*EmbeddedChart) MarshalJSON ¶
func (s *EmbeddedChart) MarshalJSON() ([]byte, error)
type EmbeddedObjectBorder ¶ added in v0.36.0
type EmbeddedObjectBorder struct { // Color: The color of the border. Deprecated: Use color_style. Color *Color `json:"color,omitempty"` // ColorStyle: The color of the border. If color is also set, this field // takes precedence. ColorStyle *ColorStyle `json:"colorStyle,omitempty"` // ForceSendFields is a list of field names (e.g. "Color") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Color") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
EmbeddedObjectBorder: A border along an embedded object.
func (*EmbeddedObjectBorder) MarshalJSON ¶ added in v0.36.0
func (s *EmbeddedObjectBorder) MarshalJSON() ([]byte, error)
type EmbeddedObjectPosition ¶
type EmbeddedObjectPosition struct { // NewSheet: If true, the embedded object is put on a new sheet whose ID // is chosen for you. Used only when writing. NewSheet bool `json:"newSheet,omitempty"` // OverlayPosition: The position at which the object is overlaid on top // of a grid. OverlayPosition *OverlayPosition `json:"overlayPosition,omitempty"` // SheetId: The sheet this is on. Set only if the embedded object is on // its own sheet. Must be non-negative. SheetId int64 `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "NewSheet") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NewSheet") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
EmbeddedObjectPosition: The position of an embedded object such as a chart.
func (*EmbeddedObjectPosition) MarshalJSON ¶
func (s *EmbeddedObjectPosition) MarshalJSON() ([]byte, error)
type ErrorValue ¶
type ErrorValue struct { // Message: A message with more information about the error (in the // spreadsheet's locale). Message string `json:"message,omitempty"` // Type: The type of error. // // Possible values: // "ERROR_TYPE_UNSPECIFIED" - The default error type, do not use this. // "ERROR" - Corresponds to the `#ERROR!` error. // "NULL_VALUE" - Corresponds to the `#NULL!` error. // "DIVIDE_BY_ZERO" - Corresponds to the `#DIV/0` error. // "VALUE" - Corresponds to the `#VALUE!` error. // "REF" - Corresponds to the `#REF!` error. // "NAME" - Corresponds to the `#NAME?` error. // "NUM" - Corresponds to the `#NUM!` error. // "N_A" - Corresponds to the `#N/A` error. // "LOADING" - Corresponds to the `Loading...` state. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Message") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Message") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ErrorValue: An error in a cell.
func (*ErrorValue) MarshalJSON ¶
func (s *ErrorValue) MarshalJSON() ([]byte, error)
type ExtendedValue ¶
type ExtendedValue struct { // BoolValue: Represents a boolean value. BoolValue *bool `json:"boolValue,omitempty"` // ErrorValue: Represents an error. This field is read-only. ErrorValue *ErrorValue `json:"errorValue,omitempty"` // FormulaValue: Represents a formula. FormulaValue *string `json:"formulaValue,omitempty"` // NumberValue: Represents a double value. Note: Dates, Times and // DateTimes are represented as doubles in SERIAL_NUMBER format. NumberValue *float64 `json:"numberValue,omitempty"` // StringValue: Represents a string value. Leading single quotes are not // included. For example, if the user typed `'123` into the UI, this // would be represented as a `stringValue` of "123". StringValue *string `json:"stringValue,omitempty"` // ForceSendFields is a list of field names (e.g. "BoolValue") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BoolValue") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ExtendedValue: The kinds of value that a cell in a spreadsheet can have.
func (*ExtendedValue) MarshalJSON ¶
func (s *ExtendedValue) MarshalJSON() ([]byte, error)
func (*ExtendedValue) UnmarshalJSON ¶
func (s *ExtendedValue) UnmarshalJSON(data []byte) error
type FilterCriteria ¶
type FilterCriteria struct { // Condition: A condition that must be true for values to be shown. // (This does not override hidden_values -- if a value is listed there, // it will still be hidden.) Condition *BooleanCondition `json:"condition,omitempty"` // HiddenValues: Values that should be hidden. HiddenValues []string `json:"hiddenValues,omitempty"` // VisibleBackgroundColor: The background fill color to filter by; only // cells with this fill color are shown. Mutually exclusive with // visible_foreground_color. Deprecated: Use // visible_background_color_style. VisibleBackgroundColor *Color `json:"visibleBackgroundColor,omitempty"` // VisibleBackgroundColorStyle: The background fill color to filter by; // only cells with this fill color are shown. This field is mutually // exclusive with visible_foreground_color, and must be set to an // RGB-type color. If visible_background_color is also set, this field // takes precedence. VisibleBackgroundColorStyle *ColorStyle `json:"visibleBackgroundColorStyle,omitempty"` // VisibleForegroundColor: The foreground color to filter by; only cells // with this foreground color are shown. Mutually exclusive with // visible_background_color. Deprecated: Use // visible_foreground_color_style. VisibleForegroundColor *Color `json:"visibleForegroundColor,omitempty"` // VisibleForegroundColorStyle: The foreground color to filter by; only // cells with this foreground color are shown. This field is mutually // exclusive with visible_background_color, and must be set to an // RGB-type color. If visible_foreground_color is also set, this field // takes precedence. VisibleForegroundColorStyle *ColorStyle `json:"visibleForegroundColorStyle,omitempty"` // ForceSendFields is a list of field names (e.g. "Condition") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Condition") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
FilterCriteria: Criteria for showing/hiding rows in a filter or filter view.
func (*FilterCriteria) MarshalJSON ¶
func (s *FilterCriteria) MarshalJSON() ([]byte, error)
type FilterSpec ¶ added in v0.31.0
type FilterSpec struct { // ColumnIndex: The column index. ColumnIndex int64 `json:"columnIndex,omitempty"` // DataSourceColumnReference: Reference to a data source column. DataSourceColumnReference *DataSourceColumnReference `json:"dataSourceColumnReference,omitempty"` // FilterCriteria: The criteria for the column. FilterCriteria *FilterCriteria `json:"filterCriteria,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnIndex") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnIndex") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
FilterSpec: The filter criteria associated with a specific column.
func (*FilterSpec) MarshalJSON ¶ added in v0.31.0
func (s *FilterSpec) MarshalJSON() ([]byte, error)
type FilterView ¶
type FilterView struct { // Criteria: The criteria for showing/hiding values per column. The // map's key is the column index, and the value is the criteria for that // column. This field is deprecated in favor of filter_specs. Criteria map[string]FilterCriteria `json:"criteria,omitempty"` // FilterSpecs: The filter criteria for showing/hiding values per // column. Both criteria and filter_specs are populated in responses. If // both fields are specified in an update request, this field takes // precedence. FilterSpecs []*FilterSpec `json:"filterSpecs,omitempty"` // FilterViewId: The ID of the filter view. FilterViewId int64 `json:"filterViewId,omitempty"` // NamedRangeId: The named range this filter view is backed by, if any. // When writing, only one of range or named_range_id may be set. NamedRangeId string `json:"namedRangeId,omitempty"` // Range: The range this filter view covers. When writing, only one of // range or named_range_id may be set. Range *GridRange `json:"range,omitempty"` // SortSpecs: The sort order per column. Later specifications are used // when values are equal in the earlier specifications. SortSpecs []*SortSpec `json:"sortSpecs,omitempty"` // Title: The name of the filter view. Title string `json:"title,omitempty"` // ForceSendFields is a list of field names (e.g. "Criteria") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Criteria") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
FilterView: A filter view.
func (*FilterView) MarshalJSON ¶
func (s *FilterView) MarshalJSON() ([]byte, error)
type FindReplaceRequest ¶
type FindReplaceRequest struct { // AllSheets: True to find/replace over all sheets. AllSheets bool `json:"allSheets,omitempty"` // Find: The value to search. Find string `json:"find,omitempty"` // IncludeFormulas: True if the search should include cells with // formulas. False to skip cells with formulas. IncludeFormulas bool `json:"includeFormulas,omitempty"` // MatchCase: True if the search is case sensitive. MatchCase bool `json:"matchCase,omitempty"` // MatchEntireCell: True if the find value should match the entire cell. MatchEntireCell bool `json:"matchEntireCell,omitempty"` // Range: The range to find/replace over. Range *GridRange `json:"range,omitempty"` // Replacement: The value to use as the replacement. Replacement string `json:"replacement,omitempty"` // SearchByRegex: True if the find value is a regex. The regular // expression and replacement should follow Java regex rules at // https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. // The replacement string is allowed to refer to capturing groups. For // example, if one cell has the contents "Google Sheets" and another // has "Google Docs", then searching for "o.* (.*)" with a // replacement of "$1 Rocks" would change the contents of the cells to // "GSheets Rocks" and "GDocs Rocks" respectively. SearchByRegex bool `json:"searchByRegex,omitempty"` // SheetId: The sheet to find/replace over. SheetId int64 `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "AllSheets") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AllSheets") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
FindReplaceRequest: Finds and replaces data in cells over a range, sheet, or all sheets.
func (*FindReplaceRequest) MarshalJSON ¶
func (s *FindReplaceRequest) MarshalJSON() ([]byte, error)
type FindReplaceResponse ¶
type FindReplaceResponse struct { // FormulasChanged: The number of formula cells changed. FormulasChanged int64 `json:"formulasChanged,omitempty"` // OccurrencesChanged: The number of occurrences (possibly multiple // within a cell) changed. For example, if replacing "e" with "o" in // "Google Sheets", this would be "3" because "Google Sheets" -> // "Googlo Shoots". OccurrencesChanged int64 `json:"occurrencesChanged,omitempty"` // RowsChanged: The number of rows changed. RowsChanged int64 `json:"rowsChanged,omitempty"` // SheetsChanged: The number of sheets changed. SheetsChanged int64 `json:"sheetsChanged,omitempty"` // ValuesChanged: The number of non-formula cells changed. ValuesChanged int64 `json:"valuesChanged,omitempty"` // ForceSendFields is a list of field names (e.g. "FormulasChanged") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormulasChanged") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
FindReplaceResponse: The result of the find/replace.
func (*FindReplaceResponse) MarshalJSON ¶
func (s *FindReplaceResponse) MarshalJSON() ([]byte, error)
type GetSpreadsheetByDataFilterRequest ¶
type GetSpreadsheetByDataFilterRequest struct { // DataFilters: The DataFilters used to select which ranges to retrieve // from the spreadsheet. DataFilters []*DataFilter `json:"dataFilters,omitempty"` // IncludeGridData: True if grid data should be returned. This parameter // is ignored if a field mask was set in the request. IncludeGridData bool `json:"includeGridData,omitempty"` // ForceSendFields is a list of field names (e.g. "DataFilters") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataFilters") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GetSpreadsheetByDataFilterRequest: The request for retrieving a Spreadsheet.
func (*GetSpreadsheetByDataFilterRequest) MarshalJSON ¶
func (s *GetSpreadsheetByDataFilterRequest) MarshalJSON() ([]byte, error)
type GradientRule ¶
type GradientRule struct { // Maxpoint: The final interpolation point. Maxpoint *InterpolationPoint `json:"maxpoint,omitempty"` // Midpoint: An optional midway interpolation point. Midpoint *InterpolationPoint `json:"midpoint,omitempty"` // Minpoint: The starting interpolation point. Minpoint *InterpolationPoint `json:"minpoint,omitempty"` // ForceSendFields is a list of field names (e.g. "Maxpoint") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Maxpoint") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GradientRule: A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points.
func (*GradientRule) MarshalJSON ¶
func (s *GradientRule) MarshalJSON() ([]byte, error)
type GridCoordinate ¶
type GridCoordinate struct { // ColumnIndex: The column index of the coordinate. ColumnIndex int64 `json:"columnIndex,omitempty"` // RowIndex: The row index of the coordinate. RowIndex int64 `json:"rowIndex,omitempty"` // SheetId: The sheet this coordinate is on. SheetId int64 `json:"sheetId,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnIndex") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnIndex") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GridCoordinate: A coordinate in a sheet. All indexes are zero-based.
func (*GridCoordinate) MarshalJSON ¶
func (s *GridCoordinate) MarshalJSON() ([]byte, error)
type GridData ¶
type GridData struct { // ColumnMetadata: Metadata about the requested columns in the grid, // starting with the column in start_column. ColumnMetadata []*DimensionProperties `json:"columnMetadata,omitempty"` // RowData: The data in the grid, one entry per row, starting with the // row in startRow. The values in RowData will correspond to columns // starting at start_column. RowData []*RowData `json:"rowData,omitempty"` // RowMetadata: Metadata about the requested rows in the grid, starting // with the row in start_row. RowMetadata []*DimensionProperties `json:"rowMetadata,omitempty"` // StartColumn: The first column this GridData refers to, zero-based. StartColumn int64 `json:"startColumn,omitempty"` // StartRow: The first row this GridData refers to, zero-based. StartRow int64 `json:"startRow,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnMetadata") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnMetadata") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GridData: Data in the grid, as well as metadata about the dimensions.
func (*GridData) MarshalJSON ¶
type GridProperties ¶
type GridProperties struct { // ColumnCount: The number of columns in the grid. ColumnCount int64 `json:"columnCount,omitempty"` // ColumnGroupControlAfter: True if the column grouping control toggle // is shown after the group. ColumnGroupControlAfter bool `json:"columnGroupControlAfter,omitempty"` // FrozenColumnCount: The number of columns that are frozen in the grid. FrozenColumnCount int64 `json:"frozenColumnCount,omitempty"` // FrozenRowCount: The number of rows that are frozen in the grid. FrozenRowCount int64 `json:"frozenRowCount,omitempty"` // HideGridlines: True if the grid isn't showing gridlines in the UI. HideGridlines bool `json:"hideGridlines,omitempty"` // RowCount: The number of rows in the grid. RowCount int64 `json:"rowCount,omitempty"` // RowGroupControlAfter: True if the row grouping control toggle is // shown after the group. RowGroupControlAfter bool `json:"rowGroupControlAfter,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnCount") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnCount") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GridProperties: Properties of a grid.
func (*GridProperties) MarshalJSON ¶
func (s *GridProperties) MarshalJSON() ([]byte, error)
type GridRange ¶
type GridRange struct { // EndColumnIndex: The end column (exclusive) of the range, or not set // if unbounded. EndColumnIndex int64 `json:"endColumnIndex,omitempty"` // EndRowIndex: The end row (exclusive) of the range, or not set if // unbounded. EndRowIndex int64 `json:"endRowIndex,omitempty"` // SheetId: The sheet this range is on. SheetId int64 `json:"sheetId,omitempty"` // StartColumnIndex: The start column (inclusive) of the range, or not // set if unbounded. StartColumnIndex int64 `json:"startColumnIndex,omitempty"` // StartRowIndex: The start row (inclusive) of the range, or not set if // unbounded. StartRowIndex int64 `json:"startRowIndex,omitempty"` // ForceSendFields is a list of field names (e.g. "EndColumnIndex") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EndColumnIndex") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GridRange: A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if "Sheet1" is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`.
func (*GridRange) MarshalJSON ¶
type HistogramChartSpec ¶
type HistogramChartSpec struct { // BucketSize: By default the bucket size (the range of values stacked // in a single column) is chosen automatically, but it may be overridden // here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 // - 3.0, etc. Cannot be negative. This field is optional. BucketSize float64 `json:"bucketSize,omitempty"` // LegendPosition: The position of the chart legend. // // Possible values: // "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED" - Default value, do // not use. // "BOTTOM_LEGEND" - The legend is rendered on the bottom of the // chart. // "LEFT_LEGEND" - The legend is rendered on the left of the chart. // "RIGHT_LEGEND" - The legend is rendered on the right of the chart. // "TOP_LEGEND" - The legend is rendered on the top of the chart. // "NO_LEGEND" - No legend is rendered. // "INSIDE_LEGEND" - The legend is rendered inside the chart area. LegendPosition string `json:"legendPosition,omitempty"` // OutlierPercentile: The outlier percentile is used to ensure that // outliers do not adversely affect the calculation of bucket sizes. For // example, setting an outlier percentile of 0.05 indicates that the top // and bottom 5% of values when calculating buckets. The values are // still included in the chart, they will be added to the first or last // buckets instead of their own buckets. Must be between 0.0 and 0.5. OutlierPercentile float64 `json:"outlierPercentile,omitempty"` // Series: The series for a histogram may be either a single series of // values to be bucketed or multiple series, each of the same length, // containing the name of the series followed by the values to be // bucketed for that series. Series []*HistogramSeries `json:"series,omitempty"` // ShowItemDividers: Whether horizontal divider lines should be // displayed between items in each column. ShowItemDividers bool `json:"showItemDividers,omitempty"` // ForceSendFields is a list of field names (e.g. "BucketSize") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BucketSize") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HistogramChartSpec: A histogram chart. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly.
func (*HistogramChartSpec) MarshalJSON ¶
func (s *HistogramChartSpec) MarshalJSON() ([]byte, error)
func (*HistogramChartSpec) UnmarshalJSON ¶
func (s *HistogramChartSpec) UnmarshalJSON(data []byte) error
type HistogramRule ¶
type HistogramRule struct { // End: The maximum value at which items are placed into buckets of // constant size. Values above end are lumped into a single bucket. This // field is optional. End float64 `json:"end,omitempty"` // Interval: The size of the buckets that are created. Must be positive. Interval float64 `json:"interval,omitempty"` // Start: The minimum value at which items are placed into buckets of // constant size. Values below start are lumped into a single bucket. // This field is optional. Start float64 `json:"start,omitempty"` // ForceSendFields is a list of field names (e.g. "End") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "End") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HistogramRule: Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+
func (*HistogramRule) MarshalJSON ¶
func (s *HistogramRule) MarshalJSON() ([]byte, error)
func (*HistogramRule) UnmarshalJSON ¶
func (s *HistogramRule) UnmarshalJSON(data []byte) error
type HistogramSeries ¶
type HistogramSeries struct { // BarColor: The color of the column representing this series in each // bucket. This field is optional. Deprecated: Use bar_color_style. BarColor *Color `json:"barColor,omitempty"` // BarColorStyle: The color of the column representing this series in // each bucket. This field is optional. If bar_color is also set, this // field takes precedence. BarColorStyle *ColorStyle `json:"barColorStyle,omitempty"` // Data: The data for this histogram series. Data *ChartData `json:"data,omitempty"` // ForceSendFields is a list of field names (e.g. "BarColor") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BarColor") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HistogramSeries: A histogram series containing the series color and data.
func (*HistogramSeries) MarshalJSON ¶
func (s *HistogramSeries) MarshalJSON() ([]byte, error)
type InsertDimensionRequest ¶
type InsertDimensionRequest struct { // InheritFromBefore: Whether dimension properties should be extended // from the dimensions before or after the newly inserted dimensions. // True to inherit from the dimensions before (in which case the start // index must be greater than 0), and false to inherit from the // dimensions after. For example, if row index 0 has red background and // row index 1 has a green background, then inserting 2 rows at index 1 // can inherit either the green or red background. If // `inheritFromBefore` is true, the two new rows will be red (because // the row before the insertion point was red), whereas if // `inheritFromBefore` is false, the two new rows will be green (because // the row after the insertion point was green). InheritFromBefore bool `json:"inheritFromBefore,omitempty"` // Range: The dimensions to insert. Both the start and end indexes must // be bounded. Range *DimensionRange `json:"range,omitempty"` // ForceSendFields is a list of field names (e.g. "InheritFromBefore") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "InheritFromBefore") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
InsertDimensionRequest: Inserts rows or columns in a sheet at a particular index.
func (*InsertDimensionRequest) MarshalJSON ¶
func (s *InsertDimensionRequest) MarshalJSON() ([]byte, error)
type InsertRangeRequest ¶
type InsertRangeRequest struct { // Range: The range to insert new cells into. Range *GridRange `json:"range,omitempty"` // ShiftDimension: The dimension which will be shifted when inserting // cells. If ROWS, existing cells will be shifted down. If COLUMNS, // existing cells will be shifted right. // // Possible values: // "DIMENSION_UNSPECIFIED" - The default value, do not use. // "ROWS" - Operates on the rows of a sheet. // "COLUMNS" - Operates on the columns of a sheet. ShiftDimension string `json:"shiftDimension,omitempty"` // ForceSendFields is a list of field names (e.g. "Range") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Range") to include in API // requests with the JSON null value. By defaul