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)
  }
  // End of list of possible types for union field spec.
}
ช่อง
parameters[]

object (DataSourceParameter)

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

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec

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

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 วัน

DayOfWeek

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

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

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