generated/google/apis/sheets_v4/classes.rb in google-api-client-0.45.1 vs generated/google/apis/sheets_v4/classes.rb in google-api-client-0.46.0

- old
+ new

@@ -123,13 +123,13 @@ @rule = args[:rule] if args.key?(:rule) end end # Adds a data source. After the data source is added successfully, an associated - # DataSource 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. + # 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. class AddDataSourceRequest include Google::Apis::Core::Hashable # Information about an external data source in the spreadsheet. # Corresponds to the JSON property `dataSource` @@ -148,11 +148,19 @@ # The result of adding a data source. class AddDataSourceResponse include Google::Apis::Core::Hashable - # The data execution status. + # The data execution status. A data execution is created to sync a data source + # object with the latest data from a DataSource. It is usually scheduled to run + # at background, you can check its state to tell if an execution completes There + # are several scenarios where a data execution is triggered to run: * Adding a + # data source creates an associated data source sheet as well as a data + # execution to sync the data from the data source to the sheet. * Updating a + # data source creates a data execution to refresh the associated data source + # sheet similarly. * You can send refresh request to explicitly refresh one or + # multiple data source objects. # Corresponds to the JSON property `dataExecutionStatus` # @return [Google::Apis::SheetsV4::DataExecutionStatus] attr_accessor :data_execution_status # Information about an external data source in the spreadsheet. @@ -561,11 +569,11 @@ # Automatically resizes one or more dimensions based on the contents of the # cells in that dimension. class AutoResizeDimensionsRequest include Google::Apis::Core::Hashable - # A range along a single dimension on a DataSource sheet. + # A range along a single dimension on a DATA_SOURCE sheet. # Corresponds to the JSON property `dataSourceSheetDimensions` # @return [Google::Apis::SheetsV4::DataSourceSheetDimensionRange] attr_accessor :data_source_sheet_dimensions # A range along a single dimension on a sheet. All indexes are zero-based. @@ -1318,11 +1326,12 @@ # The default filter associated with a sheet. class BasicFilter include Google::Apis::Core::Hashable # 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. + # index, and the value is the criteria for that column. This field is deprecated + # in favor of filter_specs. # Corresponds to the JSON property `criteria` # @return [Hash<String,Google::Apis::SheetsV4::FilterCriteria>] attr_accessor :criteria # The filter criteria per column. Both criteria and filter_specs are populated @@ -1838,11 +1847,11 @@ @total_updated_rows = args[:total_updated_rows] if args.key?(:total_updated_rows) @total_updated_sheets = args[:total_updated_sheets] if args.key?(:total_updated_sheets) end end - # The specification of a BigQuery data source. + # The specification of a BigQuery data source that's connected to a sheet. class BigQueryDataSourceSpec include Google::Apis::Core::Hashable # 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. @@ -1853,11 +1862,12 @@ # Specifies a custom BigQuery query. # Corresponds to the JSON property `querySpec` # @return [Google::Apis::SheetsV4::BigQueryQuerySpec] attr_accessor :query_spec - # Specifies a BigQuery table definition. Only native tables is allowed. + # Specifies a BigQuery table definition. Only [native tables](https://cloud. + # google.com/bigquery/docs/tables-intro) is allowed. # Corresponds to the JSON property `tableSpec` # @return [Google::Apis::SheetsV4::BigQueryTableSpec] attr_accessor :table_spec def initialize(**args) @@ -1889,11 +1899,12 @@ def update!(**args) @raw_query = args[:raw_query] if args.key?(:raw_query) end end - # Specifies a BigQuery table definition. Only native tables is allowed. + # Specifies a BigQuery table definition. Only [native tables](https://cloud. + # google.com/bigquery/docs/tables-intro) is allowed. class BigQueryTableSpec include Google::Apis::Core::Hashable # The BigQuery dataset id. # Corresponds to the JSON property `datasetId` @@ -2344,12 +2355,13 @@ # A data source formula. # Corresponds to the JSON property `dataSourceFormula` # @return [Google::Apis::SheetsV4::DataSourceFormula] attr_accessor :data_source_formula - # A data source table, allowing to import a static table of data from the - # DataSource into Sheets. This is also known as "Extract" in the Sheets editor. + # A data source table, which allows the user to import a static table of data + # from the DataSource into Sheets. This is also known as "Extract" in the Sheets + # editor. # Corresponds to the JSON property `dataSourceTable` # @return [Google::Apis::SheetsV4::DataSourceTable] attr_accessor :data_source_table # A data validation rule. @@ -2629,11 +2641,11 @@ # regular charts. # Corresponds to the JSON property `aggregateType` # @return [String] attr_accessor :aggregate_type - # An unique identifier that references to a data source column. + # An unique identifier that references a data source column. # Corresponds to the JSON property `columnReference` # @return [Google::Apis::SheetsV4::DataSourceColumnReference] attr_accessor :column_reference # An optional setting on the ChartData of the domain of a data source chart that @@ -3459,11 +3471,19 @@ @paste_type = args[:paste_type] if args.key?(:paste_type) @source = args[:source] if args.key?(:source) end end - # The data execution status. + # The data execution status. A data execution is created to sync a data source + # object with the latest data from a DataSource. It is usually scheduled to run + # at background, you can check its state to tell if an execution completes There + # are several scenarios where a data execution is triggered to run: * Adding a + # data source creates an associated data source sheet as well as a data + # execution to sync the data from the data source to the sheet. * Updating a + # data source creates a data execution to refresh the associated data source + # sheet similarly. * You can send refresh request to explicitly refresh one or + # multiple data source objects. class DataExecutionStatus include Google::Apis::Core::Hashable # The error code. # Corresponds to the JSON property `errorCode` @@ -3590,24 +3610,26 @@ # All calculated columns in the data source. # Corresponds to the JSON property `calculatedColumns` # @return [Array<Google::Apis::SheetsV4::DataSourceColumn>] attr_accessor :calculated_columns - # The spreadsheet-scoped unique ID that identifies the data source. + # The spreadsheet-scoped unique ID that identifies the data source. Example: + # 1080547365. # Corresponds to the JSON property `dataSourceId` # @return [String] attr_accessor :data_source_id # The ID of the Sheet connected with the data source. The field cannot be - # changed once set. When creating a data source, an associated SheetType. - # DATA_SOURCE sheet is also created, if the field is not specified, the ID of - # the created sheet will be randomly generated. + # changed once set. When creating a data source, an associated DATA_SOURCE sheet + # is also created, if the field is not specified, the ID of the created sheet + # will be randomly generated. # Corresponds to the JSON property `sheetId` # @return [Fixnum] attr_accessor :sheet_id - # The specification of a data source. + # This specifies the details of the data source. For example, for BigQuery, this + # specifies information about the BigQuery source. # Corresponds to the JSON property `spec` # @return [Google::Apis::SheetsV4::DataSourceSpec] attr_accessor :spec def initialize(**args) @@ -3625,11 +3647,19 @@ # Properties of a data source chart. class DataSourceChartProperties include Google::Apis::Core::Hashable - # The data execution status. + # The data execution status. A data execution is created to sync a data source + # object with the latest data from a DataSource. It is usually scheduled to run + # at background, you can check its state to tell if an execution completes There + # are several scenarios where a data execution is triggered to run: * Adding a + # data source creates an associated data source sheet as well as a data + # execution to sync the data from the data source to the sheet. * Updating a + # data source creates a data execution to refresh the associated data source + # sheet similarly. * You can send refresh request to explicitly refresh one or + # multiple data source objects. # Corresponds to the JSON property `dataExecutionStatus` # @return [Google::Apis::SheetsV4::DataExecutionStatus] attr_accessor :data_execution_status # ID of the data source that the chart is associated with. @@ -3646,20 +3676,20 @@ @data_execution_status = args[:data_execution_status] if args.key?(:data_execution_status) @data_source_id = args[:data_source_id] if args.key?(:data_source_id) end end - # A data source column. + # A column in a data source. class DataSourceColumn include Google::Apis::Core::Hashable # The formula of the calculated column. # Corresponds to the JSON property `formula` # @return [String] attr_accessor :formula - # An unique identifier that references to a data source column. + # An unique identifier that references a data source column. # Corresponds to the JSON property `reference` # @return [Google::Apis::SheetsV4::DataSourceColumnReference] attr_accessor :reference def initialize(**args) @@ -3671,11 +3701,11 @@ @formula = args[:formula] if args.key?(:formula) @reference = args[:reference] if args.key?(:reference) end end - # An unique identifier that references to a data source column. + # An unique identifier that references a data source column. class DataSourceColumnReference include Google::Apis::Core::Hashable # The display name of the column. It should be unique within a data source. # Corresponds to the JSON property `name` @@ -3694,11 +3724,19 @@ # A data source formula. class DataSourceFormula include Google::Apis::Core::Hashable - # The data execution status. + # The data execution status. A data execution is created to sync a data source + # object with the latest data from a DataSource. It is usually scheduled to run + # at background, you can check its state to tell if an execution completes There + # are several scenarios where a data execution is triggered to run: * Adding a + # data source creates an associated data source sheet as well as a data + # execution to sync the data from the data source to the sheet. * Updating a + # data source creates a data execution to refresh the associated data source + # sheet similarly. * You can send refresh request to explicitly refresh one or + # multiple data source objects. # Corresponds to the JSON property `dataExecutionStatus` # @return [Google::Apis::SheetsV4::DataExecutionStatus] attr_accessor :data_execution_status # The ID of the data source the formula is associated with. @@ -3719,11 +3757,11 @@ # Reference to a data source object. class DataSourceObjectReference include Google::Apis::Core::Hashable - # References to a DataSourceChart. + # References to a data source chart. # Corresponds to the JSON property `chartId` # @return [Fixnum] attr_accessor :chart_id # A coordinate in a sheet. All indexes are zero-based. @@ -3739,11 +3777,11 @@ # A coordinate in a sheet. All indexes are zero-based. # Corresponds to the JSON property `dataSourceTableAnchorCell` # @return [Google::Apis::SheetsV4::GridCoordinate] attr_accessor :data_source_table_anchor_cell - # References to a SheetType.DATA_SOURCE sheet. + # References to a DATA_SOURCE sheet. # Corresponds to the JSON property `sheetId` # @return [String] attr_accessor :sheet_id def initialize(**args) @@ -3777,17 +3815,18 @@ def update!(**args) @references = args[:references] if args.key?(:references) end end - # A parameter in a data source's query. The parameter allows user to pass in + # A parameter in a data source's query. The parameter allows the user to pass in # values from the spreadsheet into a query. class DataSourceParameter include Google::Apis::Core::Hashable # Named parameter. Must be a legitimate identifier for the DataSource that - # supports it. For example, BigQuery identifier + # supports it. For example, [BigQuery identifier](https://cloud.google.com/ + # bigquery/docs/reference/standard-sql/lexical#identifiers). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # ID of a NamedRange. Its size must be 1x1. @@ -3822,11 +3861,11 @@ @named_range_id = args[:named_range_id] if args.key?(:named_range_id) @range = args[:range] if args.key?(:range) end end - # Schedule refreshes in a time interval everyday. + # A schedule for data to refresh every day in a given time interval. class DataSourceRefreshDailySchedule include Google::Apis::Core::Hashable # Represents a time of day. The date and time zone are either not significant or # are specified elsewhere. An API may choose to allow leap seconds. Related @@ -3843,12 +3882,12 @@ def update!(**args) @start_time = args[:start_time] if args.key?(:start_time) end end - # Schedule refreshes in a time interval on specified days in a month and repeats - # monthly. + # A monthly schedule for data to refresh on specific days in the month in a + # given time interval. class DataSourceRefreshMonthlySchedule include Google::Apis::Core::Hashable # Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to # the 28th day. At lesat one day must be specified. @@ -3872,31 +3911,31 @@ @days_of_month = args[:days_of_month] if args.key?(:days_of_month) @start_time = args[:start_time] if args.key?(:start_time) end end - # The data source refresh schedule. All data sources in the spreadsheet are - # scheduled to refresh in a future time interval. The time interval size - # defaults to the one defined in the Sheets editor. For example, if a daily - # schedule at start time of 8am is scheduled, and the time interval is 4 hours, - # the scheduled refresh will happen between 8am and 12pm every day. + # Schedule for refreshing the data source. Data sources in the spreadsheet are + # refreshed within a time interval. You can specify the start time by clicking + # the Scheduled Refresh button in the Sheets editor, but the interval is fixed + # at 4 hours. For example, if you specify a start time of 8am , the refresh will + # take place between 8am and 12pm every day. class DataSourceRefreshSchedule include Google::Apis::Core::Hashable - # Schedule refreshes in a time interval everyday. + # A schedule for data to refresh every day in a given time interval. # Corresponds to the JSON property `dailySchedule` # @return [Google::Apis::SheetsV4::DataSourceRefreshDailySchedule] attr_accessor :daily_schedule # True if the refresh schedule is enabled, or false otherwise. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled - # Schedule refreshes in a time interval on specified days in a month and repeats - # monthly. + # A monthly schedule for data to refresh on specific days in the month in a + # given time interval. # Corresponds to the JSON property `monthlySchedule` # @return [Google::Apis::SheetsV4::DataSourceRefreshMonthlySchedule] attr_accessor :monthly_schedule # Represents a time interval, encoded as a Timestamp start (inclusive) and a @@ -3905,17 +3944,17 @@ # both start and end are unspecified, the interval matches any time. # Corresponds to the JSON property `nextRun` # @return [Google::Apis::SheetsV4::Interval] attr_accessor :next_run - # The scope of the refresh. + # The scope of the refresh. Must be ALL_DATA_SOURCES. # Corresponds to the JSON property `refreshScope` # @return [String] attr_accessor :refresh_scope - # Schedule refreshes in a time interval on specified days in a week and repeats - # weekly. + # A weekly schedule for data to refresh on specific days in a given time + # interval. # Corresponds to the JSON property `weeklySchedule` # @return [Google::Apis::SheetsV4::DataSourceRefreshWeeklySchedule] attr_accessor :weekly_schedule def initialize(**args) @@ -3931,12 +3970,12 @@ @refresh_scope = args[:refresh_scope] if args.key?(:refresh_scope) @weekly_schedule = args[:weekly_schedule] if args.key?(:weekly_schedule) end end - # Schedule refreshes in a time interval on specified days in a week and repeats - # weekly. + # A weekly schedule for data to refresh on specific days in a given time + # interval. class DataSourceRefreshWeeklySchedule include Google::Apis::Core::Hashable # Days of the week to refresh. At least one day must be specified. # Corresponds to the JSON property `daysOfWeek` @@ -3959,11 +3998,11 @@ @days_of_week = args[:days_of_week] if args.key?(:days_of_week) @start_time = args[:start_time] if args.key?(:start_time) end end - # A range along a single dimension on a DataSource sheet. + # A range along a single dimension on a DATA_SOURCE sheet. class DataSourceSheetDimensionRange include Google::Apis::Core::Hashable # The columns on the data source sheet. # Corresponds to the JSON property `columnReferences` @@ -3984,25 +4023,33 @@ @column_references = args[:column_references] if args.key?(:column_references) @sheet_id = args[:sheet_id] if args.key?(:sheet_id) end end - # Additional properties of a SheetType.DATA_SOURCE sheet. + # Additional properties of a DATA_SOURCE sheet. class DataSourceSheetProperties include Google::Apis::Core::Hashable # The columns displayed on the sheet, corresponding to the values in RowData. # Corresponds to the JSON property `columns` # @return [Array<Google::Apis::SheetsV4::DataSourceColumn>] attr_accessor :columns - # The data execution status. + # The data execution status. A data execution is created to sync a data source + # object with the latest data from a DataSource. It is usually scheduled to run + # at background, you can check its state to tell if an execution completes There + # are several scenarios where a data execution is triggered to run: * Adding a + # data source creates an associated data source sheet as well as a data + # execution to sync the data from the data source to the sheet. * Updating a + # data source creates a data execution to refresh the associated data source + # sheet similarly. * You can send refresh request to explicitly refresh one or + # multiple data source objects. # Corresponds to the JSON property `dataExecutionStatus` # @return [Google::Apis::SheetsV4::DataExecutionStatus] attr_accessor :data_execution_status - # ID of the DataSource the sheet connected with. + # ID of the DataSource the sheet is connected to. # Corresponds to the JSON property `dataSourceId` # @return [String] attr_accessor :data_source_id def initialize(**args) @@ -4015,20 +4062,21 @@ @data_execution_status = args[:data_execution_status] if args.key?(:data_execution_status) @data_source_id = args[:data_source_id] if args.key?(:data_source_id) end end - # The specification of a data source. + # This specifies the details of the data source. For example, for BigQuery, this + # specifies information about the BigQuery source. class DataSourceSpec include Google::Apis::Core::Hashable - # The specification of a BigQuery data source. + # The specification of a BigQuery data source that's connected to a sheet. # Corresponds to the JSON property `bigQuery` # @return [Google::Apis::SheetsV4::BigQueryDataSourceSpec] attr_accessor :big_query - # The parameters of the data source. + # The parameters of the data source, used when querying the data source. # Corresponds to the JSON property `parameters` # @return [Array<Google::Apis::SheetsV4::DataSourceParameter>] attr_accessor :parameters def initialize(**args) @@ -4040,12 +4088,13 @@ @big_query = args[:big_query] if args.key?(:big_query) @parameters = args[:parameters] if args.key?(:parameters) end end - # A data source table, allowing to import a static table of data from the - # DataSource into Sheets. This is also known as "Extract" in the Sheets editor. + # A data source table, which allows the user to import a static table of data + # from the DataSource into Sheets. This is also known as "Extract" in the Sheets + # editor. class DataSourceTable include Google::Apis::Core::Hashable # The type to select columns for the data source table. Defaults to SELECTED. # Corresponds to the JSON property `columnSelectionType` @@ -4056,11 +4105,19 @@ # SELECTED. # Corresponds to the JSON property `columns` # @return [Array<Google::Apis::SheetsV4::DataSourceColumnReference>] attr_accessor :columns - # The data execution status. + # The data execution status. A data execution is created to sync a data source + # object with the latest data from a DataSource. It is usually scheduled to run + # at background, you can check its state to tell if an execution completes There + # are several scenarios where a data execution is triggered to run: * Adding a + # data source creates an associated data source sheet as well as a data + # execution to sync the data from the data source to the sheet. * Updating a + # data source creates a data execution to refresh the associated data source + # sheet similarly. * You can send refresh request to explicitly refresh one or + # multiple data source objects. # Corresponds to the JSON property `dataExecutionStatus` # @return [Google::Apis::SheetsV4::DataExecutionStatus] attr_accessor :data_execution_status # The ID of the data source the data source table is associated with. @@ -4537,11 +4594,12 @@ # Deletes the requested sheet. class DeleteSheetRequest include Google::Apis::Core::Hashable - # The ID of the sheet to delete. + # The ID of the sheet to delete. If the sheet is of SheetType.DATA_SOURCE type, + # the associated DataSource is also deleted. # Corresponds to the JSON property `sheetId` # @return [Fixnum] attr_accessor :sheet_id def initialize(**args) @@ -4774,11 +4832,11 @@ # Properties about a dimension. class DimensionProperties include Google::Apis::Core::Hashable - # An unique identifier that references to a data source column. + # An unique identifier that references a data source column. # Corresponds to the JSON property `dataSourceColumnReference` # @return [Google::Apis::SheetsV4::DataSourceColumnReference] attr_accessor :data_source_column_reference # The developer metadata associated with a single row or column. @@ -4913,11 +4971,14 @@ # The name of the new sheet. If empty, a new name is chosen for you. # Corresponds to the JSON property `newSheetName` # @return [String] attr_accessor :new_sheet_name - # The sheet to duplicate. + # The sheet to duplicate. If the source sheet is of DATA_SOURCE type, its + # backing DataSource is also duplicated and associated with the new copy of the + # sheet. No data execution is triggered, the grid data of this sheet is also + # copied over but only available after the batch request completes. # Corresponds to the JSON property `sourceSheetId` # @return [Fixnum] attr_accessor :source_sheet_id def initialize(**args) @@ -5267,11 +5328,11 @@ # The column index. # Corresponds to the JSON property `columnIndex` # @return [Fixnum] attr_accessor :column_index - # An unique identifier that references to a data source column. + # An unique identifier that references a data source column. # Corresponds to the JSON property `dataSourceColumnReference` # @return [Google::Apis::SheetsV4::DataSourceColumnReference] attr_accessor :data_source_column_reference # Criteria for showing/hiding rows in a filter or filter view. @@ -5294,11 +5355,12 @@ # A filter view. class FilterView include Google::Apis::Core::Hashable # 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. + # index, and the value is the criteria for that column. This field is deprecated + # in favor of filter_specs. # Corresponds to the JSON property `criteria` # @return [Hash<String,Google::Apis::SheetsV4::FilterCriteria>] attr_accessor :criteria # The filter criteria for showing/hiding values per column. Both criteria and @@ -6814,11 +6876,11 @@ # The column offset of the source range. # Corresponds to the JSON property `columnOffsetIndex` # @return [Fixnum] attr_accessor :column_offset_index - # An unique identifier that references to a data source column. + # An unique identifier that references a data source column. # Corresponds to the JSON property `dataSourceColumnReference` # @return [Google::Apis::SheetsV4::DataSourceColumnReference] attr_accessor :data_source_column_reference # Criteria for showing/hiding rows in a pivot table. @@ -6840,11 +6902,11 @@ # A single grouping (either row or column) in a pivot table. class PivotGroup include Google::Apis::Core::Hashable - # An unique identifier that references to a data source column. + # An unique identifier that references a data source column. # Corresponds to the JSON property `dataSourceColumnReference` # @return [Google::Apis::SheetsV4::DataSourceColumnReference] attr_accessor :data_source_column_reference # The count limit on rows or columns in the pivot group. @@ -7106,16 +7168,24 @@ # An optional mapping of filters per source column offset. The filters are # applied before aggregating data into the pivot table. The map's key is the # column offset of the source range that you want to filter, and the value is # the criteria for that column. For example, if the source was `C10:E15`, a key # of `0` will have the filter for column `C`, whereas the key `1` is for column ` - # D`. + # D`. This field is deprecated in favor of filter_specs. # Corresponds to the JSON property `criteria` # @return [Hash<String,Google::Apis::SheetsV4::PivotFilterCriteria>] attr_accessor :criteria - # The data execution status. + # The data execution status. A data execution is created to sync a data source + # object with the latest data from a DataSource. It is usually scheduled to run + # at background, you can check its state to tell if an execution completes There + # are several scenarios where a data execution is triggered to run: * Adding a + # data source creates an associated data source sheet as well as a data + # execution to sync the data from the data source to the sheet. * Updating a + # data source creates a data execution to refresh the associated data source + # sheet similarly. * You can send refresh request to explicitly refresh one or + # multiple data source objects. # Corresponds to the JSON property `dataExecutionStatus` # @return [Google::Apis::SheetsV4::DataExecutionStatus] attr_accessor :data_execution_status # The ID of the data source the pivot table is reading data from. @@ -7192,11 +7262,11 @@ # editor, this is referred to as "Show As" in the value section of a pivot table. # Corresponds to the JSON property `calculatedDisplayType` # @return [String] attr_accessor :calculated_display_type - # An unique identifier that references to a data source column. + # An unique identifier that references a data source column. # Corresponds to the JSON property `dataSourceColumnReference` # @return [Google::Apis::SheetsV4::DataSourceColumnReference] attr_accessor :data_source_column_reference # A custom formula to calculate the value. The formula must start with an `=` @@ -7356,11 +7426,19 @@ # The execution status of refreshing one data source object. class RefreshDataSourceObjectExecutionStatus include Google::Apis::Core::Hashable - # The data execution status. + # The data execution status. A data execution is created to sync a data source + # object with the latest data from a DataSource. It is usually scheduled to run + # at background, you can check its state to tell if an execution completes There + # are several scenarios where a data execution is triggered to run: * Adding a + # data source creates an associated data source sheet as well as a data + # execution to sync the data from the data source to the sheet. * Updating a + # data source creates a data execution to refresh the associated data source + # sheet similarly. * You can send refresh request to explicitly refresh one or + # multiple data source objects. # Corresponds to the JSON property `dataExecutionStatus` # @return [Google::Apis::SheetsV4::DataExecutionStatus] attr_accessor :data_execution_status # Reference to a data source object. @@ -7378,12 +7456,12 @@ @reference = args[:reference] if args.key?(:reference) end end # Refreshes one or multiple data source objects in the spreadsheet by the - # specified references. The request requires an additional bigquery.readonly - # OAuth scope. If there're multiple refresh requests referencing the same data + # specified references. The request requires an additional `bigquery.readonly` + # OAuth scope. If there are multiple refresh requests referencing the same data # source objects in one batch, only the last refresh request is processed, and # all those requests will have the same response accordingly. class RefreshDataSourceRequest include Google::Apis::Core::Hashable @@ -7517,13 +7595,13 @@ # Corresponds to the JSON property `addConditionalFormatRule` # @return [Google::Apis::SheetsV4::AddConditionalFormatRuleRequest] attr_accessor :add_conditional_format_rule # Adds a data source. After the data source is added successfully, an associated - # DataSource 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. + # 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. # Corresponds to the JSON property `addDataSource` # @return [Google::Apis::SheetsV4::AddDataSourceRequest] attr_accessor :add_data_source # Creates a group over the specified range. If the requested range is a superset @@ -7734,12 +7812,12 @@ # Corresponds to the JSON property `randomizeRange` # @return [Google::Apis::SheetsV4::RandomizeRangeRequest] attr_accessor :randomize_range # Refreshes one or multiple data source objects in the spreadsheet by the - # specified references. The request requires an additional bigquery.readonly - # OAuth scope. If there're multiple refresh requests referencing the same data + # specified references. The request requires an additional `bigquery.readonly` + # OAuth scope. If there are multiple refresh requests referencing the same data # source objects in one batch, only the last refresh request is processed, and # all those requests will have the same response accordingly. # Corresponds to the JSON property `refreshDataSource` # @return [Google::Apis::SheetsV4::RefreshDataSourceRequest] attr_accessor :refresh_data_source @@ -7824,13 +7902,13 @@ # Corresponds to the JSON property `updateConditionalFormatRule` # @return [Google::Apis::SheetsV4::UpdateConditionalFormatRuleRequest] attr_accessor :update_conditional_format_rule # Updates a data source. After the data source is updated successfully, an - # execution is triggered to refresh the associated DataSource sheet to read data - # from the updated data source. The request requires an additional bigquery. - # readonly OAuth scope. + # execution is triggered to refresh the associated DATA_SOURCE sheet to read + # data from the updated data source. The request requires an additional ` + # bigquery.readonly` OAuth scope. # Corresponds to the JSON property `updateDataSource` # @return [Google::Apis::SheetsV4::UpdateDataSourceRequest] attr_accessor :update_data_source # A request to update properties of developer metadata. Updates the properties @@ -8139,11 +8217,13 @@ # difference from a baseline value can be highlighted, like changes over time. class ScorecardChartSpec include Google::Apis::Core::Hashable # The aggregation type for key and baseline chart data in scorecard chart. This - # field is optional. + # field is not supported for data source charts. Use the ChartData.aggregateType + # field of the key_value_data or baseline_value_data instead for data source + # charts. This field is optional. # Corresponds to the JSON property `aggregateType` # @return [String] attr_accessor :aggregate_type # The data included in a domain or series. @@ -8330,11 +8410,13 @@ # Data in the grid, if this is a grid sheet. The number of GridData objects # returned is dependent on the number of ranges requested on this sheet. For # example, if this is representing `Sheet1`, and the spreadsheet was requested # with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will # have a startRow/startColumn of `0`, while the second one will have `startRow - # 14` (zero-based row 15), and `startColumn 3` (zero-based column D). + # 14` (zero-based row 15), and `startColumn 3` (zero-based column D). For a + # DATA_SOURCE sheet, you can not request a specific range, the GridData contains + # all the values. # Corresponds to the JSON property `data` # @return [Array<Google::Apis::SheetsV4::GridData>] attr_accessor :data # The developer metadata associated with a sheet. @@ -8397,11 +8479,11 @@ # Properties of a sheet. class SheetProperties include Google::Apis::Core::Hashable - # Additional properties of a SheetType.DATA_SOURCE sheet. + # Additional properties of a DATA_SOURCE sheet. # Corresponds to the JSON property `dataSourceSheetProperties` # @return [Google::Apis::SheetsV4::DataSourceSheetProperties] attr_accessor :data_source_sheet_properties # Properties of a grid. @@ -8773,11 +8855,11 @@ # A color value. # Corresponds to the JSON property `backgroundColorStyle` # @return [Google::Apis::SheetsV4::ColorStyle] attr_accessor :background_color_style - # An unique identifier that references to a data source column. + # An unique identifier that references a data source column. # Corresponds to the JSON property `dataSourceColumnReference` # @return [Google::Apis::SheetsV4::DataSourceColumnReference] attr_accessor :data_source_column_reference # The dimension the sort should be applied to. @@ -10073,23 +10155,23 @@ @old_rule = args[:old_rule] if args.key?(:old_rule) end end # Updates a data source. After the data source is updated successfully, an - # execution is triggered to refresh the associated DataSource sheet to read data - # from the updated data source. The request requires an additional bigquery. - # readonly OAuth scope. + # execution is triggered to refresh the associated DATA_SOURCE sheet to read + # data from the updated data source. The request requires an additional ` + # bigquery.readonly` OAuth scope. class UpdateDataSourceRequest include Google::Apis::Core::Hashable # Information about an external data source in the spreadsheet. # Corresponds to the JSON property `dataSource` # @return [Google::Apis::SheetsV4::DataSource] attr_accessor :data_source # The fields that should be updated. At least one field must be specified. The - # root 'dataSource' is implied and should not be specified. A single `"*"` can + # root `dataSource` is implied and should not be specified. A single `"*"` can # be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -10106,11 +10188,19 @@ # The response from updating data source. class UpdateDataSourceResponse include Google::Apis::Core::Hashable - # The data execution status. + # The data execution status. A data execution is created to sync a data source + # object with the latest data from a DataSource. It is usually scheduled to run + # at background, you can check its state to tell if an execution completes There + # are several scenarios where a data execution is triggered to run: * Adding a + # data source creates an associated data source sheet as well as a data + # execution to sync the data from the data source to the sheet. * Updating a + # data source creates a data execution to refresh the associated data source + # sheet similarly. * You can send refresh request to explicitly refresh one or + # multiple data source objects. # Corresponds to the JSON property `dataExecutionStatus` # @return [Google::Apis::SheetsV4::DataExecutionStatus] attr_accessor :data_execution_status # Information about an external data source in the spreadsheet. @@ -10223,10 +10313,10 @@ # Updates properties of dimensions within the specified range. class UpdateDimensionPropertiesRequest include Google::Apis::Core::Hashable - # A range along a single dimension on a DataSource sheet. + # A range along a single dimension on a DATA_SOURCE sheet. # Corresponds to the JSON property `dataSourceSheetRange` # @return [Google::Apis::SheetsV4::DataSourceSheetDimensionRange] attr_accessor :data_source_sheet_range # The fields that should be updated. At least one field must be specified. The