REST Resource: spreadsheets

แหล่งข้อมูล: สเปรดชีต

ทรัพยากรที่แสดงถึงสเปรดชีต

การแสดง JSON
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
ช่อง
spreadsheetId

string

รหัสของสเปรดชีต ช่องนี้เป็นแบบอ่านอย่างเดียว

properties

object (SpreadsheetProperties)

พร็อพเพอร์ตี้โดยรวมของสเปรดชีต

sheets[]

object (Sheet)

ชีตที่เป็นส่วนหนึ่งของสเปรดชีต

namedRanges[]

object (NamedRange)

ช่วงที่ตั้งชื่อแล้วซึ่งกำหนดไว้ในสเปรดชีต

spreadsheetUrl

string

URL ของสเปรดชีต ช่องนี้เป็นแบบอ่านอย่างเดียว

developerMetadata[]

object (DeveloperMetadata)

ข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับสเปรดชีต

dataSources[]

object (DataSource)

รายการแหล่งข้อมูลภายนอกที่เชื่อมต่อกับสเปรดชีต

dataSourceSchedules[]

object (DataSourceRefreshSchedule)

เอาต์พุตเท่านั้น รายการกำหนดเวลาการรีเฟรชแหล่งข้อมูล

SpreadsheetProperties

คุณสมบัติของสเปรดชีต

การแสดง JSON
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
ช่อง
title

string

ชื่อของสเปรดชีต

locale

string

ภาษาของสเปรดชีตในรูปแบบใดรูปแบบหนึ่งต่อไปนี้

  • รหัสภาษา ISO 639-1 เช่น en

  • รหัสภาษา ISO 639-2 เช่น fil หากไม่มีรหัส 639-1

  • รหัสภาษา ISO และรหัสประเทศ เช่น en_US

หมายเหตุ: เมื่ออัปเดตช่องนี้ ระบบจะไม่รองรับบางภาษา

autoRecalc

enum (RecalculationInterval)

ระยะเวลาที่ต้องรอก่อนที่ฟังก์ชันที่ผันผวนจะคำนวณใหม่

timeZone

string

เขตเวลาของสเปรดชีตในรูปแบบ CLDR เช่น America/New_York หากไม่รู้จักเขตเวลานี้ อาจเป็นเขตเวลาที่กำหนดเอง เช่น GMT-07:00

defaultFormat

object (CellFormat)

รูปแบบเริ่มต้นของเซลล์ทั้งหมดในสเปรดชีต จะไม่มีการกำหนด CellData.effectiveFormat หากรูปแบบของเซลล์เท่ากับรูปแบบเริ่มต้นนี้ ช่องนี้เป็นแบบอ่านอย่างเดียว

iterativeCalculationSettings

object (IterativeCalculationSettings)

ระบุการแก้ปัญหาการอ้างอิงแบบวนรอบด้วยการคำนวณซ้ำหรือไม่และอย่างไร การไม่มีฟิลด์นี้หมายความว่าการอ้างอิงแบบวงกลมจะทำให้เกิดข้อผิดพลาดในการคำนวณ

spreadsheetTheme

object (SpreadsheetTheme)

ใช้ธีมกับสเปรดชีตแล้ว

importFunctionsExternalUrlAccessAllowed

boolean

จะอนุญาตให้เข้าถึง URL ภายนอกสำหรับฟังก์ชันรูปภาพและการนำเข้าหรือไม่ อ่านเมื่อเป็นจริงเท่านั้น เมื่อเป็น "เท็จ" คุณสามารถตั้งเป็น "จริง" ได้

RecalculationInterval

การแจงนับตัวเลือกช่วงการคำนวณใหม่ที่อาจเป็นไปได้

Enum
RECALCULATION_INTERVAL_UNSPECIFIED ค่าเริ่มต้น ต้องไม่ใช้ค่านี้
ON_CHANGE ระบบจะอัปเดตฟังก์ชันที่มีความผันผวนทุกครั้งที่เปลี่ยนแปลง
MINUTE ฟังก์ชันที่ผันผวนจะอัปเดตทุกการเปลี่ยนแปลงและทุกนาที
HOUR ฟังก์ชันที่มีความผันผวนจะอัปเดตทุกการเปลี่ยนแปลงและทุกชั่วโมง

IterativeCalculationSettings

การตั้งค่าเพื่อควบคุมวิธีแก้ไขทรัพยากร Dependency แบบวนซ้ำด้วยการคำนวณซ้ำ

การแสดง JSON
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
ช่อง
maxIterations

integer

เมื่อเปิดใช้การคำนวณซ้ำ จำนวนรอบการคำนวณสูงสุดที่จะดำเนินการ

convergenceThreshold

number

เมื่อเปิดใช้การคำนวณซ้ำและผลลัพธ์ต่อเนื่องแตกต่างกันน้อยกว่าค่าเกณฑ์นี้ รอบการคำนวณจะหยุดลง

SpreadsheetTheme

แสดงธีมของสเปรดชีต

การแสดง JSON
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
ช่อง
primaryFontFamily

string

ชื่อของชุดแบบอักษรหลัก

themeColors[]

object (ThemeColorPair)

คู่สีธีมสเปรดชีต หากต้องการอัปเดต คุณต้องระบุคู่สีธีมทั้งหมด

ThemeColorPair

การจับคู่ประเภทสีธีมสเปรดชีตกับสีคอนกรีตที่แสดง

การแสดง JSON
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
ช่อง
colorType

enum (ThemeColorType)

ประเภทสีธีมของสเปรดชีต

color

object (ColorStyle)

สีคอนกรีตที่สอดคล้องกับประเภทสีธีม

NamedRange

ช่วงที่ตั้งชื่อแล้ว

การแสดง JSON
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
ช่อง
namedRangeId

string

รหัสของช่วงที่ตั้งชื่อแล้ว

name

string

ชื่อของช่วงที่ตั้งชื่อแล้ว

range

object (GridRange)

ช่วงที่แสดง

DataSource

ข้อมูลเกี่ยวกับแหล่งข้อมูลภายนอกในสเปรดชีต

การแสดง JSON
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
ช่อง
dataSourceId

string

รหัสที่ไม่ซ้ำกันในขอบเขตระดับสเปรดชีตที่ระบุแหล่งข้อมูล เช่น 1080547365

spec

object (DataSourceSpec)

DataSourceSpec สำหรับแหล่งข้อมูลที่เชื่อมต่อกับสเปรดชีตนี้

calculatedColumns[]

object (DataSourceColumn)

คอลัมน์ที่คำนวณทั้งหมดในแหล่งข้อมูล

sheetId

integer

รหัสของ Sheet ที่เชื่อมต่อกับแหล่งข้อมูล เมื่อตั้งค่าแล้ว ฟิลด์ดังกล่าวจะไม่สามารถเปลี่ยนแปลงได้

เมื่อสร้างแหล่งข้อมูล ระบบจะสร้างชีต DATA_SOURCE ที่เชื่อมโยงด้วย หากไม่ได้ระบุช่องไว้ ระบบจะสร้างรหัสของชีตที่สร้างขึ้นแบบสุ่ม

DataSourceSpec

แอตทริบิวต์นี้จะระบุรายละเอียดของแหล่งข้อมูล เช่น สําหรับ BigQuery ค่านี้จะระบุข้อมูลเกี่ยวกับแหล่งที่มาของ BigQuery

การแสดง 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.
}
ช่อง
parameters[]

object (DataSourceParameter)

พารามิเตอร์ของแหล่งข้อมูลที่ใช้เมื่อค้นหาแหล่งข้อมูล

ช่องการรวม spec ข้อกำหนดจริงต่อประเภทแหล่งข้อมูล spec ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec

looker

object (LookerDataSourceSpec)

LookerDataSourceSpec

BigQueryDataSourceSpec

ข้อกำหนดของแหล่งข้อมูล BigQuery ที่เชื่อมต่อกับชีต

การแสดง 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.
}
ช่อง
projectId

string

รหัสของโปรเจ็กต์ Google Cloud ที่เปิดใช้ BigQuery และแนบบัญชีสำหรับการเรียกเก็บเงิน ระบบจะเรียกเก็บเงินจากโปรเจ็กต์สำหรับการค้นหาที่ดำเนินการในแหล่งข้อมูล

ช่องการรวม spec ข้อกำหนดจริง spec ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec

tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec

BigQueryQuerySpec

ระบุการค้นหา BigQuery ที่กําหนดเอง

การแสดง JSON
{
  "rawQuery": string
}
ช่อง
rawQuery

string

สตริงคำค้นหาดิบ

BigQueryTableSpec

ระบุคำจำกัดความของตาราง BigQuery อนุญาตให้ใช้เฉพาะตารางเนทีฟ

การแสดง JSON
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
ช่อง
tableProjectId

string

รหัสโปรเจ็กต์ BigQuery ที่มีตารางอยู่ หากไม่ได้ระบุไว้ ระบบจะถือว่าใช้ projectId

tableId

string

รหัสตาราง BigQuery

datasetId

string

รหัสชุดข้อมูล BigQuery

LookerDataSourceSpec

ข้อกำหนดของแหล่งข้อมูล Looker

การแสดง JSON
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
ช่อง
instanceUri

string

URL อินสแตนซ์ Looker

model

string

ชื่อโมเดล Looker

explore

string

ชื่อของการสำรวจโมเดล Looker

DataSourceParameter

พารามิเตอร์ในการค้นหาของแหล่งข้อมูล พารามิเตอร์นี้ช่วยให้ผู้ใช้ส่งผ่านค่าจากสเปรดชีตไปยังคำค้นหาได้

การแสดง 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.
}
ช่อง
ช่องการรวม identifier ตัวระบุพารามิเตอร์ identifier ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
name

string

พารามิเตอร์ที่มีชื่อ ต้องเป็นตัวระบุที่ถูกต้องสำหรับ DataSource ที่รองรับ เช่น ตัวระบุ BigQuery

ช่องการรวม value ค่าพารามิเตอร์ value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
namedRangeId

string

รหัสของ NamedRange ต้องมีขนาด 1x1

range

object (GridRange)

ช่วงที่มีค่าของพารามิเตอร์ ต้องมีขนาด 1x1

DataSourceRefreshSchedule

ตั้งเวลาเพื่อรีเฟรชแหล่งข้อมูล

ระบบจะรีเฟรชแหล่งข้อมูลในสเปรดชีตภายในช่วงเวลาหนึ่ง คุณจะระบุเวลาเริ่มต้นได้โดยคลิกปุ่มรีเฟรชตามกำหนดการในเครื่องมือแก้ไขชีต แต่ช่วงเวลาจะคงที่ที่ 4 ชั่วโมง ตัวอย่างเช่น หากคุณระบุเวลาเริ่มต้นเป็น 8:00 น. การรีเฟรชจะเกิดขึ้นระหว่างเวลา 8:00 น. ถึง 12:00 น. ของทุกวัน

การแสดง 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.
}
ช่อง
enabled

boolean

จริง หากเปิดใช้กำหนดการรีเฟรช หรือเป็นเท็จ

refreshScope

enum (DataSourceRefreshScope)

ขอบเขตของการรีเฟรช ต้องเป็น ALL_DATA_SOURCES

nextRun

object (Interval)

เอาต์พุตเท่านั้น ช่วงเวลาของการเรียกใช้ครั้งถัดไป

ช่องการรวม schedule_config การกำหนดค่ากำหนดการ schedule_config ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้
dailySchedule

object (DataSourceRefreshDailySchedule)

กำหนดเวลาการรีเฟรชรายวัน

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

กำหนดเวลารีเฟรชรายสัปดาห์

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

กำหนดเวลาการรีเฟรชรายเดือน

DataSourceRefreshScope

ขอบเขตการรีเฟรชแหล่งข้อมูล

Enum
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED ค่าเริ่มต้น อย่านำไปใช้
ALL_DATA_SOURCES รีเฟรชแหล่งข้อมูลทั้งหมดและออบเจ็กต์แหล่งข้อมูลที่เชื่อมโยงในสเปรดชีต

DataSourceRefreshDailySchedule

การตั้งเวลาข้อมูลให้รีเฟรชทุกวันในช่วงเวลาที่กำหนด

การแสดง JSON
{
  "startTime": {
    object (TimeOfDay)
  }
}
ช่อง
startTime

object (TimeOfDay)

เวลาเริ่มต้นของช่วงเวลาที่กําหนดเวลาการรีเฟรชแหล่งข้อมูล ใช้ hours ส่วนเท่านั้น ค่าเริ่มต้นของขนาดช่วงเวลาในเครื่องมือแก้ไขชีต

TimeOfDay

แสดงช่วงเวลาของวัน วันที่และเขตเวลาไม่มีความสำคัญหรือมีการระบุไว้ที่อื่น API อาจเลือกอนุญาตการใช้เวลาไม่กี่วินาที ประเภทที่เกี่ยวข้องคือ google.type.Date และ google.protobuf.Timestamp

การแสดง JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
ช่อง
hours

integer

ชั่วโมงของวันในรูปแบบ 24 ชั่วโมง ควรอยู่ระหว่าง 0 ถึง 23 API อาจเลือกอนุญาตค่า "24:00:00" สำหรับสถานการณ์ต่างๆ เช่น เวลาปิดทำการ

minutes

integer

นาทีต่อชั่วโมง ต้องอยู่ระหว่าง 0 ถึง 59

seconds

integer

เวลาเป็นวินาที โดยปกติต้องอยู่ระหว่าง 0 ถึง 59 API อาจอนุญาตให้ใช้ค่า 60 หากอนุญาตให้มีวินาทีอธิกวาร

nanos

integer

เศษส่วนของวินาทีในหน่วยนาโนวินาที ต้องมีค่าตั้งแต่ 0 ถึง 999,999,999

DataSourceRefreshWeeklySchedule

กำหนดการรายสัปดาห์เพื่อให้ข้อมูลรีเฟรชในวันที่ระบุในช่วงเวลาที่กำหนด

การแสดง JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
ช่อง
startTime

object (TimeOfDay)

เวลาเริ่มต้นของช่วงเวลาที่กําหนดเวลาการรีเฟรชแหล่งข้อมูล ใช้ hours ส่วนเท่านั้น ค่าเริ่มต้นของขนาดช่วงเวลาในเครื่องมือแก้ไขชีต

daysOfWeek[]

enum (DayOfWeek)

วันของสัปดาห์ที่จะรีเฟรช ต้องระบุอย่างน้อย 1 วัน

วันของสัปดาห์

แสดงวันของสัปดาห์

Enum
DAY_OF_WEEK_UNSPECIFIED ไม่ระบุวันของสัปดาห์
MONDAY วันจันทร์
TUESDAY อังคาร
WEDNESDAY พุธ
THURSDAY พฤหัสบดี
FRIDAY ศุกร์
SATURDAY เสาร์
SUNDAY วันอาทิตย์

DataSourceRefreshMonthlySchedule

กำหนดการรายเดือนสำหรับรีเฟรชข้อมูลในวันใดวันหนึ่งของเดือนในช่วงเวลาที่ระบุ

การแสดง JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
ช่อง
startTime

object (TimeOfDay)

เวลาเริ่มต้นของช่วงเวลาที่กําหนดเวลาการรีเฟรชแหล่งข้อมูล ใช้ hours ส่วนเท่านั้น ค่าเริ่มต้นของขนาดช่วงเวลาในเครื่องมือแก้ไขชีต

daysOfMonth[]

integer

วันของเดือนที่จะรีเฟรช รองรับหมายเลข 1-28 เท่านั้น โดยจะแมปตั้งแต่วันที่ 1 ถึงวันที่ 28 ต้องระบุอย่างน้อย 1 วัน

ช่วงเวลา

แสดงช่วงเวลาที่เข้ารหัสเป็นจุดเริ่มต้นของการประทับเวลา (นับรวมด้วย) และเวลาสิ้นสุดของการประทับเวลา (ไม่รวม)

จุดเริ่มต้นต้องน้อยกว่าหรือเท่ากับจุดสิ้นสุด เมื่อเริ่มต้นเท่ากับจุดสิ้นสุด ช่วงเวลาจะว่างเปล่า (ไม่จับคู่) เมื่อไม่ได้ระบุทั้งจุดเริ่มต้นและจุดสิ้นสุด ช่วงเวลาจะตรงกันได้ทุกเมื่อ

การแสดง JSON
{
  "startTime": string,
  "endTime": string
}
ช่อง
startTime

string (Timestamp format)

ไม่บังคับ จุดเริ่มต้นของช่วงเวลาแบบรวม

หากระบุไว้ การประทับเวลาที่ตรงกับช่วงเวลานี้จะต้องเป็นรายการเดียวกันหรือหลังจากเวลาเริ่มต้น

endTime

string (Timestamp format)

ไม่บังคับ ช่วงสิ้นสุดพิเศษ

หากระบุไว้ การประทับเวลาที่ตรงกับช่วงเวลานี้จะต้องอยู่ก่อนสิ้นสุด

เมธอด

batchUpdate

ใช้การอัปเดตอย่างน้อย 1 รายการกับสเปรดชีต

create

สร้างสเปรดชีต โดยส่งคืนสเปรดชีตที่สร้างใหม่

get

แสดงสเปรดชีตตามรหัสที่ระบุ

getByDataFilter

แสดงสเปรดชีตตามรหัสที่ระบุ