REST Resource: spreadsheets

{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}

string

The ID of the spreadsheet. This field is read-only.

object (SpreadsheetProperties)

Overall properties of a spreadsheet.

object (Sheet)

The sheets that are part of a spreadsheet.

object (NamedRange)

The named ranges defined in a spreadsheet.

string

The url of the spreadsheet. This field is read-only.

object (DeveloperMetadata)

The developer metadata associated with a spreadsheet.

object (DataSource)

A list of external data sources connected with the spreadsheet.

object (DataSourceRefreshSchedule)

Output only. A list of data source refresh schedules.

{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}

string

The title of the spreadsheet.

string

The locale of the spreadsheet in one of the following formats:

• an ISO 639-1 language code such as en

• an ISO 639-2 language code such as fil, if no 639-1 code exists

• a combination of the ISO language code and country code, such as en_US

Note: when updating this field, not all locales/languages are supported.

enum (RecalculationInterval)

The amount of time to wait before volatile functions are recalculated.

string

The time zone of the spreadsheet, in CLDR format such as America/New_York. If the time zone isn't recognized, this may be a custom time zone such as GMT-07:00.

object (CellFormat)

The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only.

object (IterativeCalculationSettings)

Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references result in calculation errors.

object (SpreadsheetTheme)

Theme applied to the spreadsheet.

boolean

Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true.

{
  "maxIterations": integer,
  "convergenceThreshold": number
}

integer

When iterative calculation is enabled, the maximum number of calculation rounds to perform.

number

When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop.

{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}

string

Name of the primary font family.

object (ThemeColorPair)

The spreadsheet theme color pairs. To update you must provide all theme color pairs.

{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}

enum (ThemeColorType)

The type of the spreadsheet theme color.

object (ColorStyle)

The concrete color corresponding to the theme color type.

{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}

string

The ID of the named range.

string

The name of the named range.

object (GridRange)

The range this represents.

{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}

string

The spreadsheet-scoped unique ID that identifies the data source. Example: 1080547365.

object (DataSourceSpec)

The DataSourceSpec for the data source connected with this spreadsheet.

object (DataSourceColumn)

All calculated columns in the data source.

integer

The ID of the Sheet connected with the data source. The field cannot be changed once set.

When creating a data source, an associated DATA_SOURCE sheet is also created, if the field is not specified, the ID of the created sheet will be randomly generated.

{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}

object (DataSourceParameter)

The parameters of the data source, used when querying the data source.

object (BigQueryDataSourceSpec)

A BigQueryDataSourceSpec.

{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}

string

The ID of a BigQuery enabled Google Cloud project with a billing account attached. For any queries executed against the data source, the project is charged.

object (BigQueryQuerySpec)

A BigQueryQuerySpec.

object (BigQueryTableSpec)

A BigQueryTableSpec.

{
  "rawQuery": string
}

string

The raw query string.

{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}

string

The ID of a BigQuery project the table belongs to. If not specified, the projectId is assumed.

string

The BigQuery table id.

string

The BigQuery dataset id.

{

  // Union field identifier can be only one of the following:
  "name": string
  // End of list of possible types for union field identifier.

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}

string

Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, BigQuery identifier.

string

ID of a NamedRange. Its size must be 1x1.

object (GridRange)

A range that contains the value of the parameter. Its size must be 1x1.

{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}

boolean

True if the refresh schedule is enabled, or false otherwise.

enum (DataSourceRefreshScope)

The scope of the refresh. Must be ALL_DATA_SOURCES.

object (Interval)

Output only. The time interval of the next run.

object (DataSourceRefreshDailySchedule)

Daily refresh schedule.

object (DataSourceRefreshWeeklySchedule)

Weekly refresh schedule.

object (DataSourceRefreshMonthlySchedule)

Monthly refresh schedule.

{
  "startTime": {
    object (TimeOfDay)
  }
}

object (TimeOfDay)

The start time of a time interval in which a data source refresh is scheduled. Only hours part is used. The time interval size defaults to that in the Sheets editor.

{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}

integer

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

integer

Minutes of hour of day. Must be from 0 to 59.

integer

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

integer

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}

object (TimeOfDay)

The start time of a time interval in which a data source refresh is scheduled. Only hours part is used. The time interval size defaults to that in the Sheets editor.

enum (DayOfWeek)

Days of the week to refresh. At least one day must be specified.

{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}

object (TimeOfDay)

The start time of a time interval in which a data source refresh is scheduled. Only hours part is used. The time interval size defaults to that in the Sheets editor.

integer

Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At least one day must be specified.

{
  "startTime": string,
  "endTime": string
}

string (Timestamp format)

Optional. Inclusive start of the interval.

If specified, a Timestamp matching this interval will have to be the same or after the start.

string (Timestamp format)

Optional. Exclusive end of the interval.

If specified, a Timestamp matching this interval will have to be before the end.