REST Resource: spreadsheets

Resource: Spreadsheet

Resource yang merepresentasikan spreadsheet.

Representasi JSON 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode)
}
Kolom
spreadsheetId

string

ID spreadsheet. Kolom ini bersifat hanya baca.
properties

object (SpreadsheetProperties)

Properti keseluruhan spreadsheet.
sheets[]

object (Sheet)

Sheet yang merupakan bagian dari spreadsheet.
namedRanges[]

object (NamedRange)

Rentang bernama yang ditentukan dalam spreadsheet.
spreadsheetUrl

string

URL spreadsheet. Kolom ini bersifat hanya baca.
developerMetadata[]

object (DeveloperMetadata)

Metadata developer yang terkait dengan spreadsheet.
dataSources[]

object (DataSource)

Daftar sumber data eksternal yang terhubung dengan spreadsheet.
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Hanya output. Daftar jadwal pemuatan ulang sumber data.
comments[]

object (CommentThread)

Rangkaian komentar yang terkait dengan spreadsheet.

commentsViewMode

enum (CommentsViewMode)

Hanya output. Mode tampilan komentar diterapkan ke spreadsheet.

SpreadsheetProperties

Properti spreadsheet.

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

string

Judul spreadsheet.
locale

string

Lokalitas spreadsheet dalam salah satu format berikut:

  • kode bahasa ISO 639-1 seperti en

  • kode bahasa ISO 639-2 seperti fil, jika tidak ada kode 639-1

  • kombinasi kode bahasa ISO dan kode negara, seperti en_US

Catatan: saat memperbarui kolom ini, tidak semua lokalitas/bahasa didukung.
autoRecalc

enum (RecalculationInterval)

Jumlah waktu yang harus ditunggu sebelum fungsi yang tidak stabil dihitung ulang.
timeZone

string

Zona waktu spreadsheet, dalam format CLDR seperti America/New_York. Jika zona waktu tidak dikenali, zona waktu tersebut mungkin merupakan zona waktu kustom seperti GMT-07:00.
defaultFormat

object (CellFormat)

Format default semua sel dalam spreadsheet. CellData.effectiveFormat tidak akan ditetapkan jika format sel sama dengan format default ini. Kolom ini bersifat hanya baca.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Menentukan apakah dan bagaimana referensi sirkular diselesaikan dengan penghitungan berulang. Jika kolom ini tidak ada, referensi melingkar akan menyebabkan error penghitungan.
spreadsheetTheme

object (SpreadsheetTheme)

Tema diterapkan ke spreadsheet.
importFunctionsExternalUrlAccessAllowed

boolean

Apakah akan mengizinkan akses URL eksternal untuk fungsi gambar dan impor. Hanya baca jika benar. Jika salah, Anda dapat menyetelnya ke benar. Nilai ini akan dilewati dan selalu menampilkan nilai benar jika admin telah mengaktifkan fitur daftar yang diizinkan.

RecalculationInterval

Enumerasi opsi interval penghitungan ulang yang mungkin.

Enum
RECALCULATION_INTERVAL_UNSPECIFIED Nilai default. Nilai ini tidak boleh digunakan.
ON_CHANGE Fungsi yang tidak stabil diperbarui pada setiap perubahan.
MINUTE Fungsi yang tidak stabil diperbarui pada setiap perubahan dan setiap menit.
HOUR Fungsi yang tidak stabil diperbarui setiap kali ada perubahan dan setiap jam.

IterativeCalculationSettings

Setelan untuk mengontrol cara dependensi sirkular diselesaikan dengan penghitungan berulang.

Representasi JSON 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Kolom
maxIterations

integer

Jika penghitungan berulang diaktifkan, jumlah maksimum putaran penghitungan yang akan dilakukan.
convergenceThreshold

number

Jika penghitungan berulang diaktifkan dan hasil berturut-turut berbeda kurang dari nilai minimum ini, penghitungan putaran akan berhenti.

SpreadsheetTheme

Mewakili tema spreadsheet

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

string

Nama jenis font utama.
themeColors[]

object (ThemeColorPair)

Pasangan warna tema spreadsheet. Untuk memperbarui, Anda harus memberikan semua pasangan warna tema.

ThemeColorPair

Pasangan yang memetakan jenis warna tema spreadsheet ke warna konkret yang diwakilinya.

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

enum (ThemeColorType)

Jenis warna tema spreadsheet.
color

object (ColorStyle)

Warna konkret yang sesuai dengan jenis warna tema.

NamedRange

Rentang bernama.

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

string

ID rentang bernama.
name

string

Nama rentang bernama.
range

object (GridRange)

Rentang yang diwakili olehnya.

DataSource

Informasi tentang sumber data eksternal dalam spreadsheet.

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

string

ID unik cakupan spreadsheet yang mengidentifikasi sumber data. Contoh: 1080547365.
spec

object (DataSourceSpec)

DataSourceSpec untuk sumber data yang terhubung dengan spreadsheet ini.
calculatedColumns[]

object (DataSourceColumn)

Semua kolom kalkulasi di sumber data.
sheetId

integer

ID Sheet yang terhubung dengan sumber data. Kolom tidak dapat diubah setelah ditetapkan.

Saat membuat sumber data, sheet DATA_SOURCE terkait juga dibuat. Jika kolom tidak ditentukan, ID sheet yang dibuat akan dibuat secara acak.

DataSourceSpec

Tindakan ini menentukan detail sumber data. Misalnya, untuk BigQuery, hal ini menentukan informasi tentang sumber BigQuery.

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

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
Kolom
parameters[]

object (DataSourceParameter)

Parameter sumber data, yang digunakan saat membuat kueri sumber data.
Kolom union spec. Spesifikasi sebenarnya per jenis sumber data. spec hanya dapat berupa salah satu dari berikut:
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec.
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][].

BigQueryDataSourceSpec

Spesifikasi sumber data BigQuery yang terhubung ke sheet.

Representasi JSON 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
Kolom
projectId

string

ID project Google Cloud yang mengaktifkan BigQuery dengan akun penagihan terlampir. Untuk kueri apa pun yang dijalankan terhadap sumber data, project akan ditagih.
Kolom union spec. Spesifikasi sebenarnya. spec hanya dapat berupa salah satu dari berikut:
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec.

BigQueryQuerySpec

Menentukan kueri BigQuery kustom.

Representasi JSON 
{
  "rawQuery": string
}
Kolom
rawQuery

string

String kueri mentah.

BigQueryTableSpec

Menentukan definisi tabel BigQuery. Hanya tabel native yang diizinkan.

Representasi JSON 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Kolom
tableProjectId

string

ID project BigQuery tempat tabel berada. Jika tidak ditentukan, projectId diasumsikan.
tableId

string

ID tabel BigQuery.
datasetId

string

ID set data BigQuery.

LookerDataSourceSpec

Spesifikasi sumber data Looker.

Representasi JSON 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Kolom
instanceUri

string

URL instance Looker.
model

string

Nama model Looker.
explore

string

Nama eksplorasi model Looker.

DataSourceParameter

Parameter dalam kueri sumber data. Parameter ini memungkinkan pengguna meneruskan nilai dari spreadsheet ke dalam kueri.

Representasi JSON 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
Kolom
Kolom union identifier. ID parameter. identifier hanya dapat berupa salah satu dari berikut:
name

string

Parameter bernama. Harus berupa ID yang sah untuk DataSource yang mendukungnya. Misalnya, ID BigQuery.
Kolom union value. Nilai parameter. value hanya dapat berupa salah satu dari berikut:
namedRangeId

string

ID NamedRange. Ukurannya harus 1x1.
range

object (GridRange)

Rentang yang berisi nilai parameter. Ukurannya harus 1x1.

DataSourceRefreshSchedule

Jadwalkan pembaruan sumber data.

Sumber data dalam spreadsheet diperbarui dalam interval waktu. Anda dapat menentukan waktu mulai dengan mengklik tombol Muat Ulang Terjadwal di editor Spreadsheet, tetapi intervalnya ditetapkan pada 4 jam. Misalnya, jika Anda menentukan waktu mulai pukul 08.00 , refresh akan dilakukan antara pukul 08.00 dan 12.00 setiap hari.

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

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
Kolom
enabled

boolean

Benar jika jadwal refresh diaktifkan, atau salah jika tidak.
refreshScope

enum (DataSourceRefreshScope)

Cakupan refresh. Harus berupa ALL_DATA_SOURCES.
nextRun

object (Interval)

Hanya output. Interval waktu untuk operasi berikutnya.
Kolom union schedule_config. Konfigurasi jadwal schedule_config hanya dapat berupa salah satu dari berikut:
dailySchedule

object (DataSourceRefreshDailySchedule)

Jadwal pembaruan harian.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Jadwal pembaruan mingguan.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Jadwal pembaruan bulanan.

DataSourceRefreshScope

Cakupan pembaruan sumber data.

Enum
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Nilai default, jangan gunakan.
ALL_DATA_SOURCES Memuat ulang semua sumber data dan objek sumber data terkait dalam spreadsheet.

DataSourceRefreshDailySchedule

Jadwal untuk memperbarui data setiap hari dalam interval waktu tertentu.

Representasi JSON 
{
  "startTime": {
    object (TimeOfDay)
  }
}
Kolom
startTime

object (TimeOfDay)

Waktu mulai interval waktu saat pembaruan sumber data dijadwalkan. Hanya bagian hours yang digunakan. Ukuran interval waktu secara default sama dengan yang ada di editor Spreadsheet.

TimeOfDay

Merepresentasikan waktu. Tanggal dan zona waktu tidak signifikan atau ditentukan di tempat lain. API dapat memilih untuk mengizinkan detik kabisat. Jenis terkait adalah google.type.Date dan google.protobuf.Timestamp.

Representasi JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Kolom
hours

integer

Jam dalam format 24 jam. Harus lebih besar dari atau sama dengan 0 dan biasanya harus kurang dari atau sama dengan 23. API dapat memilih untuk mengizinkan nilai "24:00:00" untuk skenario seperti waktu tutup bisnis.
minutes

integer

Menit dalam satu jam. Harus lebih besar dari atau sama dengan 0 dan kurang dari atau sama dengan 59.
seconds

integer

Detik dalam satu menit. Harus lebih besar dari atau sama dengan 0 dan biasanya harus kurang dari atau sama dengan 59. API dapat mengizinkan nilai 60 jika memungkinkan lompatan-detik.
nanos

integer

Pecahan detik, dalam nanodetik. Harus lebih besar dari atau sama dengan 0 dan kurang dari atau sama dengan 999.999.999.

DataSourceRefreshWeeklySchedule

Jadwal mingguan untuk memperbarui data pada hari tertentu dalam interval waktu tertentu.

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

object (TimeOfDay)

Waktu mulai interval waktu saat pembaruan sumber data dijadwalkan. Hanya bagian hours yang digunakan. Ukuran interval waktu secara default sama dengan yang ada di editor Spreadsheet.
daysOfWeek[]

enum (DayOfWeek)

Hari dalam seminggu untuk memuat ulang. Setidaknya satu hari harus ditentukan.

DayOfWeek

Mewakili hari dalam seminggu.

Enum
DAY_OF_WEEK_UNSPECIFIED Hari dalam seminggu tidak ditentukan.
MONDAY Senin
TUESDAY Selasa
WEDNESDAY Rabu
THURSDAY Kamis
FRIDAY Jumat
SATURDAY Sabtu
SUNDAY Minggu

DataSourceRefreshMonthlySchedule

Jadwal bulanan untuk memuat ulang data pada hari tertentu dalam sebulan dalam interval waktu tertentu.

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

object (TimeOfDay)

Waktu mulai interval waktu saat pembaruan sumber data dijadwalkan. Hanya bagian hours yang digunakan. Ukuran interval waktu secara default sama dengan yang ada di editor Spreadsheet.
daysOfMonth[]

integer

Hari dalam sebulan untuk memperbarui. Hanya 1-28 yang didukung, yang dipetakan ke hari ke-1 hingga ke-28. Setidaknya satu hari harus ditentukan.

Interval

Menampilkan interval waktu yang dienkode sebagai waktu mulai Stempel Waktu (inklusif) dan waktu berakhir Stempel Waktu (eksklusif).

Waktu mulai harus kurang dari atau sama dengan waktu berakhir. Jika waktu mulai sama dengan waktu berakhir, intervalnya kosong (tidak ada waktu yang cocok). Jika waktu mulai dan waktu berakhir tidak ditentukan, intervalnya akan cocok dengan semua waktu.

Representasi JSON 
{
  "startTime": string,
  "endTime": string
}
Kolom
startTime

string (Timestamp format)

Opsional. Waktu mulai interval inklusif.

Jika ditentukan, Stempel Waktu yang cocok dengan interval ini harus sama dengan atau setelah waktu mulai.
endTime

string (Timestamp format)

Opsional. Waktu berakhir interval eksklusif.

Jika ditentukan, Stempel Waktu yang cocok dengan interval ini harus sebelum waktu berakhir.

CommentThread

Menampilkan rangkaian komentar tunggal di dalam spreadsheet.

Representasi JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
Kolom
commentId

string

ID unik rangkaian komentar.
anchorId

string

ID CommentAnchor di sheet yang terkait dengan rangkaian pesan ini.
headPost

object (Post)

Postingan pertama dalam rangkaian pesan.
replies[]

object (Post)

Balasan untuk postingan utama.
status

enum (Status)

Apakah rangkaian pesan terbuka atau sudah diselesaikan.
Kolom union quote. Teks yang dikutip dari dokumen saat komentar dibuat. quote hanya dapat berupa salah satu dari berikut:
plainTextQuote

string

Teks yang dikutip dari spreadsheet saat komentar dibuat, diformat sebagai teks biasa.

Posting

Menampilkan satu postingan dalam rangkaian komentar.

Representasi JSON 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
Kolom
postId

string

Hanya output. ID unik postingan.
content

string

Konten postingan.

Wajib tidak kosong jika commentAction bukan RESOLVE atau REOPEN.

Konten teks ini akan ditangani dengan cara yang sama seperti komentar yang dibuat di editor Spreadsheet. Akan ada perilaku serupa untuk pemformatan, notifikasi, dll.

Tidak boleh melebihi 2.048 unit kode UTF-8.
contentHtml

string

Hanya output. Konten postingan sebagai HTML.
author

object (PostAuthor)

Hanya output. Pengguna yang membuat postingan.
createTime

string (Timestamp format)

Hanya output. Waktu postingan dibuat.
updateTime

string (Timestamp format)

Hanya output. Waktu postingan terakhir diperbarui.
deleted

boolean

Hanya output. Apakah postingan dihapus. Jika kolom true, content, dan author akan kosong.
fromImportedSpreadsheet

boolean

Hanya output. Apakah postingan berasal dari spreadsheet yang diimpor. Kolom ini tidak dapat disetel secara langsung oleh pemanggil.
fromCopiedSpreadsheet

boolean

Hanya output. Apakah postingan berasal dari spreadsheet yang disalin. Kolom ini tidak dapat disetel secara langsung oleh pemanggil.
assigneeEmail

string

Opsional. Email pengguna yang baru ditetapkan ke rangkaian pesan sebagai bagian dari postingan ini.

Menampilkan error permintaan tidak valid 400 jika:

  • Rangkaian pesan induk adalah CommentThread yang headPost-nya tidak memiliki penerima tugas.

  • commentAction ditentukan sebagai RESOLVE atau REOPEN.

  • assigneeEmail melebihi 2048 unit kode UTF-8.
commentAction

enum (CommentActionType)

Tindakan yang dilakukan sebagai bagian dari pembuatan postingan.

PostAuthor

Merepresentasikan pengguna yang menulis postingan komentar.

Representasi JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Kolom
displayName

string

Nama tampilan pengguna. Mungkin tidak ada jika penulisnya anonim.
me

boolean

Apakah pengguna adalah pengguna terautentikasi yang membuat permintaan.
anonymous

boolean

Apakah pengguna anonim.
user

string

Nama resource pengguna penulis postingan, yang juga dapat digunakan untuk mengidentifikasi pengguna di Google People API. Format: users/{user}. Tidak akan diisi jika kolom anonim adalah true atau jika postingan berasal dari spreadsheet yang diimpor.

CommentActionType

Tindakan yang dilakukan dengan balasan ini ke rangkaian pesan komentar.

Enum
COMMENT_ACTION_TYPE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
NO_COMMENT_ACTION_CHANGE Tidak ada perubahan tindakan dalam postingan ini.
RESOLVE Postingan ini menyelesaikan rangkaian pesan.
REOPEN Postingan ini membuka kembali rangkaian pesan.

Status

Opsi status rangkaian pesan komentar.

Enum
STATUS_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
OPEN Rangkaian komentar terbuka.
RESOLVED Untaian komentar telah diselesaikan.

CommentsViewMode

Mode tampilan komentar yang diterapkan ke spreadsheet yang menunjukkan apakah komentar disertakan. Fitur ini menyediakan opsi untuk membaca spreadsheet dengan atau tanpa komentar dan penanda komentar.

Enum
COMMENTS_VIEW_MODE_UNSPECIFIED CommentsViewMode tidak ditentukan; COMMENTS_VIEW_MODE_OMITTED diterapkan.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS CommentsViewMode yang diterapkan ke spreadsheet yang ditampilkan bergantung pada tingkat akses pengguna saat ini. Jika pengguna hanya memiliki akses lihat, COMMENTS_VIEW_MODE_OMITTED diterapkan. Jika tidak, COMMENTS_VIEW_MODE_INCLUDED akan diterapkan.
COMMENTS_VIEW_MODE_OMITTED Spreadsheet yang ditampilkan tidak menyertakan komentar.
COMMENTS_VIEW_MODE_INCLUDED

Spreadsheet yang ditampilkan menyertakan komentar.

Permintaan untuk mengambil spreadsheet menggunakan mode ini akan menampilkan error 403 jika pengguna tidak memiliki izin untuk melihat komentar.

Metode

batchUpdate

 Menerapkan satu atau beberapa update ke spreadsheet.

create

 Membuat spreadsheet, menampilkan spreadsheet yang baru dibuat.

get

 Menampilkan spreadsheet pada ID yang diberikan.

getByDataFilter

 Menampilkan spreadsheet pada ID yang diberikan.