blob: 7cddb6f69e05820a8dae3bd28647077cf2bcb22e [file] [log] [blame]
// Copyright 2020 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// 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.
package sheets // import "google.golang.org/api/sheets/v4"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
const apiId = "sheets:v4"
const apiName = "sheets"
const apiVersion = "v4"
const basePath = "https://sheets.googleapis.com/"
const mtlsBasePath = "https://sheets.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See, edit, create, and delete all of your Google Drive files
DriveScope = "https://www.googleapis.com/auth/drive"
// View and manage Google Drive files and folders that you have opened
// or created 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 your spreadsheets in Google Drive
SpreadsheetsScope = "https://www.googleapis.com/auth/spreadsheets"
// View your Google Spreadsheets
SpreadsheetsReadonlyScope = "https://www.googleapis.com/auth/spreadsheets.readonly"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := option.WithScopes(
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/drive.readonly",
"https://www.googleapis.com/auth/spreadsheets",
"https://www.googleapis.com/auth/spreadsheets.readonly",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Spreadsheets = NewSpreadsheetsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Spreadsheets *SpreadsheetsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewSpreadsheetsService(s *Service) *SpreadsheetsService {
rs := &SpreadsheetsService{s: s}
rs.DeveloperMetadata = NewSpreadsheetsDeveloperMetadataService(s)
rs.Sheets = NewSpreadsheetsSheetsService(s)
rs.Values = NewSpreadsheetsValuesService(s)
return rs
}
type SpreadsheetsService struct {
s *Service
DeveloperMetadata *SpreadsheetsDeveloperMetadataService
Sheets *SpreadsheetsSheetsService
Values *SpreadsheetsValuesService
}
func NewSpreadsheetsDeveloperMetadataService(s *Service) *SpreadsheetsDeveloperMetadataService {
rs := &SpreadsheetsDeveloperMetadataService{s: s}
return rs
}
type SpreadsheetsDeveloperMetadataService struct {
s *Service
}
func NewSpreadsheetsSheetsService(s *Service) *SpreadsheetsSheetsService {
rs := &SpreadsheetsSheetsService{s: s}
return rs
}
type SpreadsheetsSheetsService struct {
s *Service
}
func NewSpreadsheetsValuesService(s *Service) *SpreadsheetsValuesService {
rs := &SpreadsheetsValuesService{s: s}
return rs
}
type SpreadsheetsValuesService struct {
s *Service
}
// AddBandingRequest: Adds a new banded range to the spreadsheet.
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 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:"-"`
}
func (s *AddBandingRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddBandingRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddBandingResponse: The result of adding a banded range.
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 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:"-"`
}
func (s *AddBandingResponse) MarshalJSON() ([]byte, error) {
type NoMethod AddBandingResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddChartRequest: Adds a chart to a sheet in the spreadsheet.
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 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:"-"`
}
func (s *AddChartRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddChartRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddChartResponse: The result of adding a chart to a spreadsheet.
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 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:"-"`
}
func (s *AddChartResponse) MarshalJSON() ([]byte, error) {
type NoMethod AddChartResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddConditionalFormatRuleRequest: Adds a new conditional format rule
// at the given index. All subsequent rules' indexes are incremented.
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 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:"-"`
}
func (s *AddConditionalFormatRuleRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddConditionalFormatRuleRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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.
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 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:"-"`
}
func (s *AddDataSourceRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddDataSourceRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddDataSourceResponse: The result of adding a data source.
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 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:"-"`
}
func (s *AddDataSourceResponse) MarshalJSON() ([]byte, error) {
type NoMethod AddDataSourceResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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].
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 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:"-"`
}
func (s *AddDimensionGroupRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddDimensionGroupRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddDimensionGroupResponse: The result of adding a group.
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 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:"-"`
}
func (s *AddDimensionGroupResponse) MarshalJSON() ([]byte, error) {
type NoMethod AddDimensionGroupResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddFilterViewRequest: Adds a filter view.
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 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:"-"`
}
func (s *AddFilterViewRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddFilterViewRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddFilterViewResponse: The result of adding a filter view.
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 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:"-"`
}
func (s *AddFilterViewResponse) MarshalJSON() ([]byte, error) {
type NoMethod AddFilterViewResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddNamedRangeRequest: Adds a named range to the spreadsheet.
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 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:"-"`
}
func (s *AddNamedRangeRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddNamedRangeRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddNamedRangeResponse: The result of adding a named range.
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 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:"-"`
}
func (s *AddNamedRangeResponse) MarshalJSON() ([]byte, error) {
type NoMethod AddNamedRangeResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddProtectedRangeRequest: Adds a new protected range.
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 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:"-"`
}
func (s *AddProtectedRangeRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddProtectedRangeRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddProtectedRangeResponse: The result of adding a new protected
// range.
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 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:"-"`
}
func (s *AddProtectedRangeResponse) MarshalJSON() ([]byte, error) {
type NoMethod AddProtectedRangeResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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.
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 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:"-"`
}
func (s *AddSheetRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddSheetRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddSheetResponse: The result of adding a sheet.
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 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:"-"`
}
func (s *AddSheetResponse) MarshalJSON() ([]byte, error) {
type NoMethod AddSheetResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddSlicerRequest: Adds a slicer to a sheet in the spreadsheet.
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 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:"-"`
}
func (s *AddSlicerRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddSlicerRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddSlicerResponse: The result of adding a slicer to a spreadsheet.
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 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:"-"`
}
func (s *AddSlicerResponse) MarshalJSON() ([]byte, error) {
type NoMethod AddSlicerResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AppendCellsRequest: Adds new cells after the last row with data in a
// sheet, inserting new rows into the sheet if necessary.
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 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:"-"`
}
func (s *AppendCellsRequest) MarshalJSON() ([]byte, error) {
type NoMethod AppendCellsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AppendDimensionRequest: Appends rows or columns to the end of a
// sheet.
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 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:"-"`
}
func (s *AppendDimensionRequest) MarshalJSON() ([]byte, error) {
type NoMethod AppendDimensionRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AppendValuesResponse: The response when updating a range of values in
// a spreadsheet.
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 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:"-"`
}
func (s *AppendValuesResponse) MarshalJSON() ([]byte, error) {
type NoMethod AppendValuesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AutoFillRequest: Fills in more data based on existing data.
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 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:"-"`
}
func (s *AutoFillRequest) MarshalJSON() ([]byte, error) {
type NoMethod AutoFillRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AutoResizeDimensionsRequest: Automatically resizes one or more
// dimensions based on the contents of the cells in that dimension.
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 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:"-"`
}
func (s *AutoResizeDimensionsRequest) MarshalJSON() ([]byte, error) {
type NoMethod AutoResizeDimensionsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BandedRange: A banded (alternating colors) range in a sheet.
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 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:"-"`
}
func (s *BandedRange) MarshalJSON() ([]byte, error) {
type NoMethod BandedRange
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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.
type BandingProperties struct {
// FirstBandColor: The first color that is alternating. (Required)
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"`
// FooterColor: The color of the last row or column. If this field 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.
FooterColor *Color `json:"footerColor,omitempty"`
// FooterColorStyle: The color of the last row or column. If this field
// 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.
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)
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 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:"-"`
}
func (s *BandingProperties) MarshalJSON() ([]byte, error) {
type NoMethod BandingProperties
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BaselineValueFormat: Formatting options for baseline value.
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.
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.
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.
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 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:"-"`
}
func (s *BaselineValueFormat) MarshalJSON() ([]byte, error) {
type NoMethod BaselineValueFormat
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BasicChartAxis: An axis of the chart. A chart may not have more than
// one axis per axis position.
type BasicChartAxis struct {
// Format: The format of the title. Only valid if the axis is not
// associated with the domain.
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 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:"-"`
}
func (s *BasicChartAxis) MarshalJSON() ([]byte, error) {
type NoMethod BasicChartAxis
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BasicChartDomain: The domain of a chart. For example, if charting
// stock prices over time, this would be the date.
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 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:"-"`
}
func (s *BasicChartDomain) MarshalJSON() ([]byte, error) {
type NoMethod BasicChartDomain
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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".
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.
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"`
// 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"`
// Series: The data being visualized in this chart series.
Series *ChartData `json:"series,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 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:"-"`
}
func (s *BasicChartSeries) MarshalJSON() ([]byte, error) {
type NoMethod BasicChartSeries
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BasicChartSpec: The specification for a basic chart. See
// BasicChartType for the list of charts this supports.
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"`
// ForceSendFields is a list of field names (e.g. "Axis") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *BasicChartSpec) MarshalJSON() ([]byte, error) {
type NoMethod BasicChartSpec
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BasicFilter: The default filter associated with a sheet.
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 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:"-"`
}
func (s *BasicFilter) MarshalJSON() ([]byte, error) {
type NoMethod BasicFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchClearValuesByDataFilterRequest: The request for clearing more
// than one range selected by a DataFilter in a spreadsheet.
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 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:"-"`
}
func (s *BatchClearValuesByDataFilterRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchClearValuesByDataFilterRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchClearValuesByDataFilterResponse: The response when clearing a
// range of values selected with DataFilters in a spreadsheet.
type BatchClearValuesByDataFilterResponse 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 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:"-"`
}
func (s *BatchClearValuesByDataFilterResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchClearValuesByDataFilterResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchClearValuesRequest: The request for clearing more than one range
// of values in a spreadsheet.
type BatchClearValuesRequest struct {
// Ranges: The ranges to clear, in A1 notation.
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 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:"-"`
}
func (s *BatchClearValuesRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchClearValuesRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchClearValuesResponse: The response when clearing a range of
// values in a spreadsheet.
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 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:"-"`
}
func (s *BatchClearValuesResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchClearValuesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchGetValuesByDataFilterRequest: The request for retrieving a range
// of values in a spreadsheet selected by a set of DataFilters.
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
// [DateTimeRenderOption.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 30st 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 is
// dependent 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 ValueRenderOption.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 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:"-"`
}
func (s *BatchGetValuesByDataFilterRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchGetValuesByDataFilterRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchGetValuesByDataFilterResponse: The response when retrieving more
// than one range of values in a spreadsheet selected by DataFilters.
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 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:"-"`
}
func (s *BatchGetValuesByDataFilterResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchGetValuesByDataFilterResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchGetValuesResponse: The response when retrieving more than one
// range of values in a spreadsheet.
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 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:"-"`
}
func (s *BatchGetValuesResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchGetValuesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchUpdateSpreadsheetRequest: The request for updating any aspect of
// a spreadsheet.
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 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:"-"`
}
func (s *BatchUpdateSpreadsheetRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchUpdateSpreadsheetRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchUpdateSpreadsheetResponse: The reply for batch updating a
// spreadsheet.
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 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:"-"`
}
func (s *BatchUpdateSpreadsheetResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchUpdateSpreadsheetResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchUpdateValuesByDataFilterRequest: The request for updating more
// than one range of values in a spreadsheet.
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 DateTimeRenderOption.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 30st 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 is
// dependent on the spreadsheet locale).
ResponseDateTimeRenderOption string `json:"responseDateTimeRenderOption,omitempty"`
// ResponseValueRenderOption: Determines how values in the response
// should be rendered. The default render option is
// ValueRenderOption.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 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:"-"`
}
func (s *BatchUpdateValuesByDataFilterRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchUpdateValuesByDataFilterRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchUpdateValuesByDataFilterResponse: The response when updating a
// range of values in a spreadsheet.
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 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:"-"`
}
func (s *BatchUpdateValuesByDataFilterResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchUpdateValuesByDataFilterResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchUpdateValuesRequest: The request for updating more than one
// range of values in a spreadsheet.
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 DateTimeRenderOption.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 30st 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 is
// dependent on the spreadsheet locale).
ResponseDateTimeRenderOption string `json:"responseDateTimeRenderOption,omitempty"`
// ResponseValueRenderOption: Determines how values in the response
// should be rendered. The default render option is
// ValueRenderOption.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 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:"-"`
}
func (s *BatchUpdateValuesRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchUpdateValuesRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchUpdateValuesResponse: The response when updating a range of
// values in a spreadsheet.
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 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:"-"`
}
func (s *BatchUpdateValuesResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchUpdateValuesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BigQueryDataSourceSpec: The specification of a BigQuery data source
// that's connected to a sheet.
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 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:"-"`
}
func (s *BigQueryDataSourceSpec) MarshalJSON() ([]byte, error) {
type NoMethod BigQueryDataSourceSpec
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BigQueryQuerySpec: Specifies a custom BigQuery query.
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 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:"-"`
}
func (s *BigQueryQuerySpec) MarshalJSON() ([]byte, error) {
type NoMethod BigQueryQuerySpec
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BigQueryTableSpec: Specifies a BigQuery table definition. Only
// [native tables](https://cloud.google.com/bigquery/docs/tables-intro)
// is allowed.
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 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:"-"`
}
func (s *BigQueryTableSpec) MarshalJSON() ([]byte, error) {
type NoMethod BigQueryTableSpec
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BooleanCondition: A condition that can evaluate to true or false.
// BooleanConditions are used by conditional formatting, data
// validation, and the criteria in filters.
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 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:"-"`
}
func (s *BooleanCondition) MarshalJSON() ([]byte, error) {
type NoMethod BooleanCondition
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BooleanRule: A rule that may or may not match, depending on the
// condition.
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 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:"-"`
}
func (s *BooleanRule) MarshalJSON() ([]byte, error) {
type NoMethod BooleanRule
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Border: A border along a cell.
type Border struct {
// Color: The color of the border.
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 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:"-"`
}
func (s *Border) MarshalJSON() ([]byte, error) {
type NoMethod Border
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Borders: The borders of the cell.
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 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:"-"`
}
func (s *Borders) MarshalJSON() ([]byte, error) {
type NoMethod Borders
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BubbleChartSpec: A bubble chart.
type BubbleChartSpec struct {
// BubbleBorderColor: The bubble border color.
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 contianing 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. Underline
// and Strikethrough 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 contianing 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 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:"-"`
}
func (s *BubbleChartSpec) MarshalJSON() ([]byte, error) {
type NoMethod BubbleChartSpec
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *BubbleChartSpec) UnmarshalJSON(data []byte) error {
type NoMethod BubbleChartSpec
var s1 struct {
BubbleOpacity gensupport.JSONFloat64 `json:"bubbleOpacity"`
*NoMethod
}
s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
s.BubbleOpacity = float64(s1.BubbleOpacity)
return nil
}
// CandlestickChartSpec: A candlestick chart.
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 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:"-"`
}
func (s *CandlestickChartSpec) MarshalJSON() ([]byte, error) {
type NoMethod CandlestickChartSpec
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CandlestickData: The Candlestick chart data, each containing the low,
// open, close, and high values for a series.
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 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:"-"`
}
func (s *CandlestickData) MarshalJSON() ([]byte, error) {
type NoMethod CandlestickData
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CandlestickDomain: The domain of a CandlestickChart.
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 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:"-"`
}
func (s *CandlestickDomain) MarshalJSON() ([]byte, error) {
type NoMethod CandlestickDomain
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CandlestickSeries: The series of a CandlestickData.
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 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:"-"`
}
func (s *CandlestickSeries) MarshalJSON() ([]byte, error) {
type NoMethod CandlestickSeries
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CellData: Data about a specific cell.
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. This field is
// read-only. (To set it, use a `=HYPERLINK` formula in the
// userEnteredValue.formulaValue field.)
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. Runs start at specific indexes in the text and continue
// until the next run. Properties of a run will continue unless
// explicitly changed in a subsequent run (and properties of the first
// run will continue 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 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:"-"`
}
func (s *CellData) MarshalJSON() ([]byte, error) {
type NoMethod CellData
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CellFormat: The format of a cell.
type CellFormat struct {
// BackgroundColor: The background color of the cell.
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: How a hyperlink, if it exists, 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).
TextFormat *TextFormat `json:"textFormat,omitempty"`
// TextRotation: The rotation applied to text in a 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 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:"-"`
}
func (s *CellFormat) MarshalJSON() ([]byte, error) {
type NoMethod CellFormat
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ChartAxisViewWindowOptions: The options that define a "view window"
// for a chart (such as the visible values in an axis).
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 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:"-"`
}
func (s *ChartAxisViewWindowOptions) MarshalJSON() ([]byte, error) {
type NoMethod ChartAxisViewWindowOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *ChartAxisViewWindowOptions) UnmarshalJSON(data []byte) error {
type NoMethod ChartAxisViewWindowOptions
var s1 struct {
ViewWindowMax gensupport.JSONFloat64 `json:"viewWindowMax"`
ViewWindowMin gensupport.JSONFloat64 `json:"viewWindowMin"`
*NoMethod
}
s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
s.ViewWindowMax = float64(s1.ViewWindowMax)
s.ViewWindowMin = float64(s1.ViewWindowMin)
return nil
}
// ChartCustomNumberFormatOptions: Custom number formatting options for
// chart attributes.
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 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:"-"`
}
func (s *ChartCustomNumberFormatOptions) MarshalJSON() ([]byte, error) {
type NoMethod ChartCustomNumberFormatOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ChartData: The data included in a domain or series.
type ChartData struct {
// AggregateType: The aggregation type for the series of a data source
// chart. Not supported for regular 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. Not supported for regular 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 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:"-"`
}
func (s *ChartData) MarshalJSON() ([]byte, error) {
type NoMethod ChartData
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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.
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 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:"-"`
}
func (s *ChartDateTimeRule) MarshalJSON() ([]byte, error) {
type NoMethod ChartDateTimeRule
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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.
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 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:"-"`
}
func (s *ChartGroupRule) MarshalJSON() ([]byte, error) {
type NoMethod ChartGroupRule
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ChartHistogramRule: Allows you to organize numeric values in a source
// data column into buckets of constant size.
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 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:"-"`
}
func (s *ChartHistogramRule) MarshalJSON() ([]byte, error) {
type NoMethod ChartHistogramRule
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *ChartHistogramRule) UnmarshalJSON(data []byte) error {
type NoMethod ChartHistogramRule
var s1 struct {
IntervalSize gensupport.JSONFloat64 `json:"intervalSize"`
MaxValue gensupport.JSONFloat64 `json:"maxValue"`
MinValue gensupport.JSONFloat64 `json:"minValue"`
*NoMethod
}
s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
s.IntervalSize = float64(s1.IntervalSize)
s.MaxValue = float64(s1.MaxValue)
s.MinValue = float64(s1.MinValue)
return nil
}
// ChartSourceRange: Source ranges for a chart.
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 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:"-"`
}
func (s *ChartSourceRange) MarshalJSON() ([]byte, error) {
type NoMethod ChartSourceRange
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ChartSpec: The specifications of a chart.
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.
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.