REST Resource: spreadsheets

Resource: Spreadsheet

Resource yang mewakili 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)
    }
  ]
}
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 pembaruan sumber data.

PropertiProperti

Properti spreadsheet.

Representasi JSON
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  }
}
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 tunggu sebelum fungsi yang tidak stabil dihitung ulang.

timeZone

string

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

defaultFormat

object (CellFormat)

Format default semua sel di 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 melingkar diselesaikan dengan penghitungan berulang. Tidak adanya kolom ini berarti referensi melingkar menghasilkan error penghitungan.

spreadsheetTheme

object (SpreadsheetTheme)

Tema diterapkan ke spreadsheet.

Penghitungan UlangInterval

Enumerasi opsi interval penghitungan ulang yang memungkinkan.

Enumerasi
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 pada setiap perubahan dan setiap jam.

Setelan IteratifPenghitungan

Setelan untuk mengontrol cara dependensi sirkular diselesaikan dengan penghitungan berulang.

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

integer

Jika penghitungan berulang diaktifkan, jumlah pembulatan penghitungan yang akan dilakukan akan mencapai jumlah maksimum.

convergenceThreshold

number

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

Tema Spreadsheet

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 mengupdate, Anda harus memberikan semua pasangan warna tema.

PasanganTemaTema

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.

RentangBernama

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 ini.

DataSource

Informasi tentang sumber data eksternal di 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 ini 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.

DataSourceSpesifikasi

Ini menentukan detail sumber data. Misalnya, untuk BigQuery, parameter ini menentukan informasi tentang sumber BigQuery.

Representasi 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.
}
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.

BigQueryDataSourceSpec

Spesifikasi sumber data BigQuery yang terhubung ke sheet.

Representasi 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.
}
Kolom
projectId

string

ID project Google Cloud yang mengaktifkan BigQuery dengan akun penagihan yang terlampir. Untuk kueri yang dijalankan terhadap sumber data, project akan dikenai biaya.

Kolom union spec. Spesifikasi yang 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 yang mencakup tabel. Jika tidak ditentukan, projectId adalah format yang diasumsikan.

tableId

string

ID tabel BigQuery.

datasetId

string

ID set data BigQuery.

DataSourceParameter

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

Representasi 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.
}
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.

Jadwal Refresh DataSource

Jadwalkan untuk memuat ulang sumber data.

Sumber data di spreadsheet diperbarui dalam interval waktu tertentu. 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 , pembaruan akan berlangsung antara pukul 08.00 hingga 12.00 setiap hari.

Representasi 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.
}
Kolom
enabled

boolean

Benar jika jadwal pembaruan diaktifkan, atau salah jika sebaliknya.

refreshScope

enum (DataSourceRefreshScope)

Cakupan refresh. Harus ALL_DATA_SOURCES.

nextRun

object (Interval)

Hanya output. Interval waktu operasi berikutnya.

Kolom union schedule_config. Konfigurasi jadwal schedule_config hanya dapat berupa salah satu dari berikut ini:
dailySchedule

object (DataSourceRefreshDailySchedule)

Jadwal pembaruan harian.

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Jadwal pembaruan mingguan.

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Jadwal pembaruan bulanan.

DataSourceRefreshScope

Cakupan pembaruan sumber data.

Enumerasi
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Nilai default, jangan gunakan.
ALL_DATA_SOURCES Memperbarui semua sumber data dan objek sumber datanya yang terkait di spreadsheet.

DataSourceRefreshJadwal

Jadwal data yang akan diperbarui 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 hours bagian yang digunakan. Secara default, ukuran interval waktu akan ditampilkan di editor Spreadsheet.

Waktu

Merepresentasikan waktu. Tanggal dan zona waktu tidak signifikan atau ditentukan di tempat lain. API dapat memilih untuk mengizinkan detik kabisat. Jenis yang 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 dari 0 hingga 23. API dapat memilih untuk mengizinkan nilai "24:00:00" untuk skenario seperti waktu penutupan bisnis.

minutes

integer

Menit dalam jam. Harus dari 0 hingga 59.

seconds

integer

Detik menit dari waktu. Biasanya harus dari 0 hingga 59. API mungkin mengizinkan nilai 60 jika mengizinkan detik kabisat.

nanos

integer

Pecahan detik dalam nanodetik. Harus dari 0 hingga 999,999,999.

Jadwal DataSourceRefreshWeekly

Jadwal mingguan untuk data yang dimuat ulang 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 hours bagian yang digunakan. Secara default, ukuran interval waktu akan ditampilkan di editor Spreadsheet.

daysOfWeek[]

enum (DayOfWeek)

Memuat ulang hari. Setidaknya satu hari harus ditentukan.

Hari

Merepresentasikan hari dalam seminggu.

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

DataSourceRefreshJadwal Bulanan

Jadwal bulanan untuk data yang diperbarui 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 hours bagian yang digunakan. Secara default, ukuran interval waktu akan ditampilkan di editor Spreadsheet.

daysOfMonth[]

integer

Pembaruan untuk bulan tertentu. Hanya mendukung 1-28, memetakan ke hari ke-1 hingga ke-28. Setidaknya satu hari harus ditentukan.

Interval

Merepresentasikan interval waktu, yang dienkode sebagai awal Stempel waktu (inklusif) dan Akhir stempel waktu (eksklusif).

Awalnya harus kurang dari atau sama dengan bagian akhir. Jika awal sama dengan akhir, interval kosong (tidak cocok dengan waktu). Jika awal dan akhir tidak ditentukan, interval cocok kapan saja.

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

string (Timestamp format)

Opsional. Awal interval inklusif.

Jika ditentukan, Stempel waktu yang cocok dengan interval ini harus sama atau setelah dimulai.

endTime

string (Timestamp format)

Opsional. Akhir interval eksklusif.

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

Metode

batchUpdate

Menerapkan satu atau beberapa pembaruan pada spreadsheet.

create

Membuat spreadsheet, menampilkan spreadsheet yang baru dibuat.

get

Menampilkan spreadsheet dengan ID yang diberikan.

getByDataFilter

Menampilkan spreadsheet dengan ID yang diberikan.