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)
    }
  ]
}
Trường
spreadsheetId

string

Mã của bảng tính. Trường này chỉ để đọc.
properties

object (SpreadsheetProperties)

Thuộc tính tổng thể của một 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)

Các dải ô được đặt tên được xác định trong một bảng tính.
spreadsheetUrl

string

URL của bảng tính. Trường này chỉ để đọc.
developerMetadata[]

object (DeveloperMetadata)

Siêu dữ liệu dành cho nhà phát triển liên kết với một 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ỉ có đầu ra. Danh sách lịch làm mới nguồn dữ liệu.

SpreadsheetProperties

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)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
Trường
title

string

Tiêu đề của 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 như en

  • mã ngôn ngữ ISO 639-2 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ả ngôn ngữ đều được hỗ trợ.
autoRecalc

enum (RecalculationInterval)

Khoảng thời gian chờ trước khi tính toán lại hàm biến động.
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 hệ thống không nhận dạng được múi giờ, thì đây có thể là một múi giờ tuỳ chỉnh 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. Trường này chỉ để đọc.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Xác định xem liệu các tham chiếu vòng tròn có được giải quyết hay không bằng phép tính lặp lại. 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 giao diện cho bảng tính.
importFunctionsExternalUrlAccessAllowed

boolean

Liệu có cho phép truy cập URL bên ngoài đối với hàm nhập hình ảnh và hàm nhập hay không. Chỉ đọc khi đúng. Khi giá trị là false, bạn có thể đặt thành true.

RecalculationInterval

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

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

IterativeCalculationSettings

Các chế độ cài đặt để kiểm soát cách giải quyết các phần phụ thuộc tuần hoàn bằng phép tính lặp lại.

Biểu diễn dưới dạng JSON 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
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 sẽ 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 chênh lệch nhỏ hơn giá trị ngưỡng này, thì vòng tính toán sẽ dừng lại.

SpreadsheetTheme

Biểu thị giao diện bảng tính

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

string

Tên của bộ phông chữ chính.
themeColors[]

object (ThemeColorPair)

Cặp màu cho giao diện của 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.

ThemeColorPair

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

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

enum (ThemeColorType)

Loại màu giao diện của bảng tính.
color

object (ColorStyle)

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

NamedRange

Một dải ô được đặt tên.

Biểu diễn dưới dạng JSON 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
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 ô mà giá trị này đại diện.

DataSource

Thông tin về 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
}
Trường
dataSourceId

string

Mã nhận dạng duy nhất trong phạm vi bảng tính giúp 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 đã được tính trong nguồn dữ liệu.
sheetId

integer

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

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

DataSourceSpec

Trường này cho biết thông tin chi tiết của nguồn dữ liệu. Ví dụ: đối với BigQuery, thuộc tính 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.
}
Trường
parameters[]

object (DataSourceParameter)

Các tham số của nguồn dữ liệu, được dùng khi truy vấn nguồn dữ liệu.
Trường hợp 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 trạng thái sau:
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.
}
Trường
projectId

string

Mã của một dự án trên Google Cloud có hỗ trợ BigQuery và có liên kết với một tài khoản thanh toán. Đối với mọi truy vấn được thực thi dựa trên nguồn dữ liệu, dự án sẽ bị tính phí.
Trường hợp spec. Thông số kỹ thuật thực tế. spec chỉ có thể là một trong những trạng thái sau:
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec.

BigQueryQuerySpec

Chỉ định một truy vấn BigQuery tuỳ chỉnh.

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

string

Chuỗi truy vấn thô.

BigQueryTableSpec

Chỉ định một đị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
}
Trường
tableProjectId

string

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

string

Mã bảng BigQuery.
datasetId

string

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

DataSourceParameter

Một tham số trong truy vấn của nguồn dữ liệu. Tham số cho phép người dùng chuyển các giá trị từ bảng tính vào 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.
}
Trường
Trường hợp identifier. Giá trị nhận dạng thông số. identifier chỉ có thể là một trong những trạng thái sau:
name

string

Tham số được đặt tên. Phải là giá trị nhận dạng hợp lệ của DataSource hỗ trợ việc đó. Ví dụ: mã nhận dạng BigQuery.
Trường hợp value. Giá trị thông số. value chỉ có thể là một trong những trạng thái sau:
namedRangeId

string

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

object (GridRange)

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

DataSourceRefreshSchedule

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 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 trong khoảng 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.
}
Trường
enabled

boolean

"True" nếu lịch làm mới được bật hoặc "false" nếu không bật.
refreshScope

enum (DataSourceRefreshScope)

Phạm vi của quá trình làm mới. Giá trị phải là ALL_DATA_SOURCES.
nextRun

object (Interval)

Chỉ có đầu ra. Khoảng thời gian của lần chạy tiếp theo.
Trường hợp schedule_config. Cấu hình lịch biểu schedule_config chỉ có thể là một trong những cấu hình 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.

DataSourceRefreshScope

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 quan trong bảng tính.

DataSourceRefreshDailySchedule

Lịch biểu để làm mới dữ liệu mỗi 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)
  }
}
Trường
startTime

object (TimeOfDay)

Thời gian bắt đầu của một khoảng thời gian theo đó quá trình 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 được mặc định là kích thước trong Trình chỉnh sửa Trang tính.

TimeOfDay

Đại diện cho 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. API có thể chọn cho phép giây nhuận. Các loại liên quan là google.type.Date và google.protobuf.Timestamp.

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

integer

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

integer

Phút trong giờ trong ngày. Giá trị phải nằm trong khoảng từ 0 đến 59.
seconds

integer

Số giây trong phút của thời gian. Thông thường phải từ 0 đến 59. API có thể cho phép giá trị 60 nếu cho phép giây nhuận.
nanos

integer

Phân số giây tính bằng nano giây. Giá trị phải nằm trong khoảng từ 0 đến 999.999.999.

DataSourceRefreshWeeklySchedule

Lịch biểu hằng tuần để làm mới dữ liệu vào 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)
  ]
}
Trường
startTime

object (TimeOfDay)

Thời gian bắt đầu của một khoảng thời gian theo đó quá trình 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 được 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. Bạn phải chỉ định ít nhất một ngày.

DayOfWeek

Đại diện cho 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

DataSourceRefreshMonthlySchedule

Lịch biểu hằng tháng cho việc làm mới dữ liệu vào 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
  ]
}
Trường
startTime

object (TimeOfDay)

Thời gian bắt đầu của một khoảng thời gian theo đó quá trình 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 được 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, lập bản đồ từ ngày 1 đến ngày 28. Bạn phải chỉ định ít nhất một ngày.

Khoảng thời gian

Đại diện cho một khoảng thời gian, được mã hoá dưới dạng thời điểm bắt đầu là dấu thời gian (bao gồm cả thời gian này) và thời điểm kết thúc là dấu thời gian (độc quyền).

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

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

string (Timestamp format)

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

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 hoặc sau thời điểm bắt đầu.
endTime

string (Timestamp format)

Không bắt buộc. Cuối khoảng thời gian không có giá trị kết thúc.

Nếu được chỉ định, một Dấu thời gian khớp với khoảng thời gian này sẽ phải ở trước khi 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 một bảng tính, trả về bảng tính mới tạo.

get

 Trả về bảng tính tại mã nhận dạng cho trước.

getByDataFilter

 Trả về bảng tính tại mã nhận dạng cho trước.