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ó thể đọc.
properties

object (SpreadsheetProperties)

Các thuộc tính tổng thể của một bảng tính.
sheets[]

object (Sheet)

Các trang tính trong một bảng tính.
namedRanges[]

object (NamedRange)

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

string

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

object (DeveloperMetadata)

Siêu dữ liệu của nhà phát triển được 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, 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

  • sự kết hợp giữa mã ngôn ngữ và mã quốc gia theo tiêu chuẩn ISO, chẳng hạn như en_US

Lưu ý: khi cập nhật trường này, không phải ngôn ngữ/ngôn ngữ nào cũng đượ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 ra múi giờ, thì đây có thể là múi giờ tuỳ 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 với định dạng mặc định này. Trường này chỉ có thể đọc.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Xác định xem có giải quyết được tham chiếu vòng lặp bằng tính toán lặp lại hay không và cách giải quyết. Nếu không có trường này, thì các tệp tham chiếu vòng tròn sẽ dẫn đến lỗi tính toán.
spreadsheetTheme

object (SpreadsheetTheme)

Giao diện được áp dụng cho bảng tính.
importFunctionsExternalUrlAccessAllowed

boolean

Cho phép truy cập URL bên ngoài cho hàm 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. Giá trị này sẽ bị bỏ qua và luôn trả về true nếu quản trị viên đã bật tính năng danh sách cho phép.

RecalculationInterval

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 khi có thay đổi và hằng giờ.

IterativeCalculationSettings

Chế độ cài đặt để kiểm soát cách giải quyết các phần phụ thuộc vòng bằng tính toán 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 đượ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 ít hơn giá trị ngưỡng này, các 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ác cặp màu giao diện của bảng tính. Để cập nhật, bạn phải cung cấp tất cả cặp màu giao diện.

ThemeColorPair

Một cặp ánh xạ loại màu giao diện của bảng tính với màu cụ thể mà nó thể hiệ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

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ề 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
}
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ột được tính toán 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. Bạn không thể thay đổi trường này sau khi thiết lập.

Khi tạo nguồn dữ liệu, một 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 được tạo sẽ được tạo ngẫu nhiên.

DataSourceSpec

Thuộc tính này chỉ định thông tin chi tiết về 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)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
  // 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 hợp nhất 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:
bigQuery

object (BigQueryDataSourceSpec)

Một BigQueryDataSourceSpec.
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][].

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

object (BigQueryQuerySpec)

Một BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

Một 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 đị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 mà bảng thuộc về. Nếu không chỉ định, projectId sẽ được giả định.
tableId

string

Mã bảng BigQuery.
datasetId

string

Mã nhận dạng tập dữ liệu BigQuery.

LookerDataSourceSpec

Thông số kỹ thuật của nguồn dữ liệu Looker.

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

string

URL của phiên bản Looker.
model

string

Tên của một mô hình Looker.
explore

string

Tên của một dữ liệu khám phá mô hình Looker.

DataSourceParameter

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

string

Mã của NamedRange. Kích thước của hình ảnh này phải là 1x1.
range

object (GridRange)

Một dải ô chứa giá trị của thông số. Kích thước của hình ảnh này phải là 1x1.

DataSourceRefreshSchedule

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 đượ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 từ 8 giờ sáng đến 12 giờ trưa 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

Đúng nếu lịch biểu làm mới được bật, nếu không thì là sai.
refreshScope

enum (DataSourceRefreshScope)

Phạm vi làm mới. 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 hợp nhất schedule_config. Cấu hình lịch biểu schedule_config chỉ có thể là một trong những loại 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à các đối tượng nguồn dữ liệu liên kết với nguồn dữ liệu đó trong bảng tính.

DataSourceRefreshDailySchedule

Lịch 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)
  }
}
Trường
startTime

object (TimeOfDay)

Thời gian bắt đầu của một khoảng thời gian mà quá trình làm mới nguồn dữ liệu được lên lịch. Chỉ sử dụng phần hours. 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.

TimeOfDay

Biểu thị 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 theo định dạng 24 giờ. Phải 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

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

integer

Số giây trong phút. Thường phải nằm trong khoảng 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. Phải từ 0 đến 999.999.999.

DataSourceRefreshWeeklySchedule

Lịch hằng tuần để làm mới dữ liệu vào những 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 mà quá trình làm mới nguồn dữ liệu được lên lịch. Chỉ sử dụng phần hours. 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. 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 Ngày trong tuần không được chỉ định.
MONDAY Thứ Hai
TUESDAY Tuesday (thứ Ba)
WEDNESDAY Wednesday (thứ Tư)
THURSDAY Thursday (thứ Năm)
FRIDAY Friday (thứ Sáu)
SATURDAY Saturday (thứ Bảy)
SUNDAY Chủ Nhật

DataSourceRefreshMonthlySchedule

Lịch hằng tháng để làm mới dữ liệu vào những 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 mà quá trình làm mới nguồn dữ liệu được lên lịch. Chỉ sử dụng phần hours. 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ợ từ 1 đến 28, ánh xạ đến 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

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

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

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

string (Timestamp format)

Không bắt buộc. Kết thúc khoảng thời gian không bao gồm giá trị đầu và giá trị cuối.

Nếu được chỉ định, Dấu thời gian khớp với khoảng thời gian này phải nằm trước thời điểm 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.

getByDataFilter

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