REST Resource: spreadsheets

Tài nguyên: Bảng tính

Tài nguyên đại diện cho một bảng tính.

Biểu diễn dưới dạng JSON
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
Các trường
spreadsheetId

string

Mã nhận dạng của bảng tính. Đây là trường chỉ đọc.

properties

object (SpreadsheetProperties)

Thuộc tính tổng thể của bảng tính.

sheets[]

object (Sheet)

Các trang tính là một phần của bảng tính.

namedRanges[]

object (NamedRange)

Dải ô được đặt tên được xác định trong bảng tính.

spreadsheetUrl

string

Url của bảng tính. Đây là trường chỉ đọc.

developerMetadata[]

object (DeveloperMetadata)

Siêu dữ liệu nhà phát triển liên kết với bảng tính.

dataSources[]

object (DataSource)

Danh sách các nguồn dữ liệu bên ngoài được kết nối với bảng tính.

dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Chỉ đầu ra. Danh sách lịch làm mới nguồn dữ liệu.

Thuộc tính bảng tính

Thuộc tính của bảng tính.

Biểu diễn dưới dạng JSON
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  }
}
Các trường
title

string

Tiêu đề bảng tính.

locale

string

Ngôn ngữ của bảng tính ở một trong các định dạng sau:

  • mã ngôn ngữ ISO 639-1, chẳng hạn như en

  • mã ngôn ngữ ISO 639-2 chẳng hạn như fil nếu không có mã 639-1

  • kết hợp mã ngôn ngữ ISO và mã quốc gia, chẳng hạn như en_US

Lưu ý: Khi cập nhật trường này, không phải tất cả các ngôn ngữ/ngôn ngữ đều được hỗ trợ.

autoRecalc

enum (RecalculationInterval)

Khoảng thời gian chờ trước khi các hàm biến động được tính toán lại.

timeZone

string

Múi giờ của bảng tính, ở định dạng CLDR, chẳng hạn như America/New_York. Nếu không nhận dạng được múi giờ, thì đây có thể là múi giờ tùy chỉnh, chẳng hạn như GMT-07:00.

defaultFormat

object (CellFormat)

Định dạng mặc định của tất cả các ô trong bảng tính. CellData.effectiveFormat sẽ không được đặt nếu định dạng của ô bằng định dạng mặc định này. Đây là trường chỉ đọc.

iterativeCalculationSettings

object (IterativeCalculationSettings)

Xác định xem liệu các tham chiếu vòng có được phân giải hay không và cách giải quyết bằng tính toán lặp. Thiếu trường này có nghĩa là các tham chiếu vòng tròn dẫn đến lỗi tính toán.

spreadsheetTheme

object (SpreadsheetTheme)

Đã áp dụng chủ đề cho bảng tính.

Khoảng thời gian tính toán lại

Bảng liệt kê các tuỳ chọn có thể tính toán lại khoảng thời gian.

Enum
RECALCULATION_INTERVAL_UNSPECIFIED Giá trị mặc định. Không được sử dụng giá trị này.
ON_CHANGE Các hàm biến động được cập nhật sau mỗi lần thay đổi.
MINUTE Các hàm biến động được cập nhật theo mỗi thay đổi và mỗi phút.
HOUR Hàm biến động được cập nhật theo từng giờ và mỗi thay đổi.

Cài đặt tính toán lặp lại

Các chế độ cài đặt để kiểm soát cách phân giải các phần phụ thuộc vòng có tính toán lặp lại.

Biểu diễn dưới dạng JSON
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Các trường
maxIterations

integer

Khi tính toán lặp lại được bật, số vòng tính toán tối đa cần thực hiện.

convergenceThreshold

number

Khi tính toán lặp lại được bật và các kết quả liên tiếp khác nhau nhỏ hơn giá trị ngưỡng này, các vòng tính toán sẽ dừng lại.

Chủ đề bảng tính

Đại diện cho chủ đề bảng tính

Biểu diễn dưới dạng JSON
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Các trường
primaryFontFamily

string

Tên của họ phông chữ chính.

themeColors[]

object (ThemeColorPair)

Cặp màu giao diện bảng tính. Để cập nhật, bạn phải cung cấp tất cả các cặp màu giao diện.

Cặp màu giao diện

Một cặp ánh xạ loại màu giao diện bảng tính với màu cụ thể mà bảng tính đại diện.

Biểu diễn dưới dạng JSON
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
Các trường
colorType

enum (ThemeColorType)

Loại màu chủ đề bảng tính.

color

object (ColorStyle)

Màu cụ thể tương ứng với loại màu giao diện.

Dải ô được đặt tên

Dải ô được đặt tên.

Biểu diễn dưới dạng JSON
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
Các trường
namedRangeId

string

Mã của dải ô được đặt tên.

name

string

Tên của dải ô được đặt tên.

range

object (GridRange)

Dải ô này đại diện cho.

Nguồn dữ liệu

Thông tin về một nguồn dữ liệu bên ngoài trong bảng tính.

Biểu diễn dưới dạng JSON
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
Các trường
dataSourceId

string

Mã nhận dạng duy nhất trong phạm vi bảng tính xác định nguồn dữ liệu. Ví dụ: 1080547365.

spec

object (DataSourceSpec)

DataSourceSpec cho nguồn dữ liệu được kết nối với bảng tính này.

calculatedColumns[]

object (DataSourceColumn)

Tất cả các cột đã tính trong nguồn dữ liệu.

sheetId

integer

Mã nhận dạng của Sheet được kết nối với nguồn dữ liệu. Không thể thay đổi trường sau khi đã đặt.

Khi tạo nguồn dữ liệu, trang tính DATA_SOURCE liên kết cũng được tạo. Nếu bạn không chỉ định trường này, mã của trang tính đã tạo sẽ được tạo ngẫu nhiên.

DataSourceSpec

Thao tác này sẽ chỉ định thông tin chi tiết về nguồn dữ liệu. Ví dụ: đối với BigQuery, thông tin này chỉ định thông tin về nguồn BigQuery.

Biểu diễn dưới dạng JSON
{
  "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.
}
Các trường
parameters[]

object (DataSourceParameter)

Các thông số của nguồn dữ liệu, được sử dụng khi truy vấn nguồn dữ liệu.

Trường nhóm spec. Thông số kỹ thuật thực tế cho mỗi loại nguồn dữ liệu. spec chỉ có thể là một trong những loại sau đây:
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec.

BigQueryDataSourceSpec

Thông số kỹ thuật của nguồn dữ liệu BigQuery được kết nối với một trang tính.

Biểu diễn dưới dạng JSON
{
  "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.
}
Các trường
projectId

string

Mã của dự án BigQuery hỗ trợ Google Cloud trong tài khoản thanh toán. Đối với mọi truy vấn được thực thi đối với nguồn dữ liệu, dự án sẽ bị tính phí.

Trường nhóm spec. Thông số kỹ thuật thực tế. spec chỉ có thể là một trong những loại sau đây:
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec.

tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec.

BigQueryQuerySpec

Chỉ định truy vấn BigQuery tùy chỉnh.

Biểu diễn dưới dạng JSON
{
  "rawQuery": string
}
Các trường
rawQuery

string

Chuỗi truy vấn thô.

BigQueryTableSpec

Chỉ định định nghĩa bảng BigQuery. Chỉ cho phép bảng gốc.

Biểu diễn dưới dạng JSON
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Các trường
tableProjectId

string

Mã của dự án BigQuery chứa bảng. Nếu bạn không chỉ định thì projectId sẽ được giả định.

tableId

string

Mã bảng BigQuery.

datasetId

string

Mã tập dữ liệu BigQuery.

Thông số nguồn dữ liệu

Một tham số trong truy vấn của nguồn dữ liệu. Thông số này cho phép người dùng chuyển các giá trị từ bảng tính vào một truy vấn.

Biểu diễn dưới dạng JSON
{

  // 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.
}
Các trường
Trường nhóm identifier. Giá trị nhận dạng thông số. identifier chỉ có thể là một trong những loại sau đây:
name

string

Tham số được đặt tên. Phải là giá trị nhận dạng hợp lệ cho DataSource hỗ trợ giá trị đó. Ví dụ: Giá trị nhận dạng BigQuery.

Trường nhóm value. Giá trị tham số. value chỉ có thể là một trong những loại sau đây:
namedRangeId

string

Mã nhận dạng của NamedRange. Kích thước của tệp phải là 1x1.

range

object (GridRange)

Dải ô chứa giá trị của thông số. Kích thước của tệp phải là 1x1.

Lịch làm mới dữ liệu

Lên lịch làm mới nguồn dữ liệu.

Các nguồn dữ liệu trong bảng tính được làm mới trong một khoảng thời gian. Bạn có thể chỉ định thời gian bắt đầu bằng cách nhấp vào nút Làm mới theo lịch trong trình chỉnh sửa Trang tính, nhưng khoảng thời gian này cố định là 4 giờ. Ví dụ: nếu bạn chỉ định thời gian bắt đầu là 8 giờ sáng thì quá trình làm mới sẽ diễn ra từ 8 giờ sáng đến 12 giờ đêm mỗi ngày.

Biểu diễn dưới dạng JSON
{
  "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.
}
Các trường
enabled

boolean

Đúng nếu lịch làm mới được bật hoặc false nếu ngược lại.

refreshScope

enum (DataSourceRefreshScope)

Phạm vi làm mới. Phải là ALL_DATA_SOURCES.

nextRun

object (Interval)

Chỉ đầu ra. Khoảng thời gian chạy vào lần tiếp theo.

Trường nhóm schedule_config. Cấu hình lịch biểu schedule_config chỉ có thể là một trong các chế độ sau:
dailySchedule

object (DataSourceRefreshDailySchedule)

Lịch làm mới hàng ngày.

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Lịch làm mới hàng tuần.

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Lịch làm mới hàng tháng.

Làm mới nguồn dữ liệu

Phạm vi làm mới nguồn dữ liệu.

Enum
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Giá trị mặc định, không sử dụng.
ALL_DATA_SOURCES Làm mới tất cả nguồn dữ liệu và đối tượng nguồn dữ liệu liên kết trong bảng tính.

Làm mới nguồn dữ liệu hàng ngày

Lịch biểu làm mới dữ liệu hằng ngày trong một khoảng thời gian nhất định.

Biểu diễn dưới dạng JSON
{
  "startTime": {
    object (TimeOfDay)
  }
}
Các trường
startTime

object (TimeOfDay)

Thời gian bắt đầu của khoảng thời gian mà lịch làm mới nguồn dữ liệu được lên lịch. Chỉ sử dụng hours phần. Kích thước khoảng thời gian mặc định là kích thước trong trình chỉnh sửa Trang tính.

Giờ trong ngày

Thể hiện thời gian trong ngày. Ngày và múi giờ không quan trọng hoặc được chỉ định ở nơi khác. Một API có thể chọn cho phép giây nhuận. Các loại liên quan là google.type.Dategoogle.protobuf.Timestamp.

Biểu diễn dưới dạng JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Các trường
hours

integer

Giờ trong ngày ở định dạng 24 giờ. Nên từ 0 đến 23. API có thể chọn cho phép giá trị "24:00:00" trong các trường hợp như thời gian đóng cửa của doanh nghiệp.

minutes

integer

Số phút trong ngày. Phải từ 0 đến 59.

seconds

integer

Giây phút. Thường phải từ 0 đến 59. API có thể cho phép giá trị 60 nếu API cho phép leap-seconds.

nanos

integer

Phân số giây tính bằng nano giây. Phải từ 0 đến 999.999.999.

Lịch biểu làm mới nguồn dữ liệu hàng tuần

Lịch biểu dữ liệu hàng tuần để làm mới các ngày cụ thể trong một khoảng thời gian nhất định.

Biểu diễn dưới dạng JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Các trường
startTime

object (TimeOfDay)

Thời gian bắt đầu của khoảng thời gian mà lịch làm mới nguồn dữ liệu được lên lịch. Chỉ sử dụng hours phần. Kích thước khoảng thời gian mặc định là kích thước trong trình chỉnh sửa Trang tính.

daysOfWeek[]

enum (DayOfWeek)

Ngày trong tuần để làm mới. Phải chỉ định ít nhất một ngày.

Ngày trong tuần

Thể hiện một ngày trong tuần.

Enum
DAY_OF_WEEK_UNSPECIFIED Chưa xác định ngày trong tuần.
MONDAY Thứ Hai
TUESDAY Thứ Ba
WEDNESDAY Thứ Tư
THURSDAY Thursday (thứ Năm)
FRIDAY Thứ Sáu
SATURDAY Saturday (thứ Bảy)
SUNDAY Chủ Nhật

Lịch biểu làm mới nguồn dữ liệu hàng tháng

Lịch biểu dữ liệu hằng tháng để làm mới các ngày cụ thể trong tháng trong một khoảng thời gian nhất định.

Biểu diễn dưới dạng JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Các trường
startTime

object (TimeOfDay)

Thời gian bắt đầu của khoảng thời gian mà lịch làm mới nguồn dữ liệu được lên lịch. Chỉ sử dụng hours phần. Kích thước khoảng thời gian mặc định là kích thước trong trình chỉnh sửa Trang tính.

daysOfMonth[]

integer

Ngày trong tháng để làm mới. Chỉ hỗ trợ 1-28, ánh xạ đến ngày 1 đến ngày 28. Phải chỉ định ít nhất một ngày.

Khoảng thời gian

Biểu thị một khoảng thời gian, được mã hóa dưới dạng thời điểm bắt đầu Dấu thời gian (bao gồm) và thời điểm kết thúc Dấu thời gian (không bao gồm).

Điểm bắt đầu phải nhỏ hơn hoặc bằng kết thúc. Khi điểm bắt đầu bằng điểm cuối, khoảng thời gian trống (không có thời gian). Khi cả điểm bắt đầu và điểm kết thúc đều không được chỉ định, khoảng thời gian sẽ khớp bất kỳ lúc nào.

Biểu diễn dưới dạng JSON
{
  "startTime": string,
  "endTime": string
}
Các trường
startTime

string (Timestamp format)

Không bắt buộc. Bắt đầu bao gồm khoảng thời gian.

Nếu được chỉ định, Dấu thời gian khớp với khoảng thời gian này sẽ phải giống nhau hoặc sau thời điểm bắt đầu.

endTime

string (Timestamp format)

Không bắt buộc. Kết thúc độc quyền của khoảng thời gian.

Nếu được chỉ định, Dấu thời gian phù hợp với khoảng thời gian này sẽ phải trước thời gian kết thúc.

Phương thức

batchUpdate

Áp dụng một hoặc nhiều nội dung cập nhật cho bảng tính.

create

Tạo bảng tính, trả về bảng tính mới được tạo.

get

Trả về bảng tính ở mã nhận dạng đã cho.

getByDataFilter

Trả về bảng tính ở mã nhận dạng đã cho.