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)

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

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

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

การแสดง JSON
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  }
}
ช่อง
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)

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

ช่วงเวลาการคํานวณใหม่

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

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

การตั้งค่าการคํานวณการคํานวณซ้ํา

การตั้งค่าสําหรับควบคุมวิธีแก้ไขการพึ่งพากันเองด้วยการคํานวณซ้ํา

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

integer

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

convergenceThreshold

number

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

ธีมสเปรดชีต

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

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

string

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

themeColors[]

object (ThemeColorPair)

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

คู่ธีม

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

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

enum (ThemeColorType)

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

color

object (ColorStyle)

สีคอนกรีตที่สัมพันธ์กับประเภทสีของธีม

ช่วงที่มีชื่อ

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

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

string

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

name

string

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

range

object (GridRange)

ช่วงที่แสดงค่านี้

แหล่งข้อมูล

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

การแสดง 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 ที่เชื่อมโยงด้วย หากไม่ได้ระบุช่องดังกล่าว ระบบจะสร้างรหัสของชีตที่สร้างขึ้นแบบสุ่ม

ข้อมูลจําเพาะของแหล่งข้อมูล

ข้อมูลนี้จะระบุรายละเอียดของแหล่งข้อมูล ตัวอย่างเช่น สําหรับ 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)

พารามิเตอร์ของแหล่งข้อมูล ซึ่งใช้ในการค้นหาข้อมูลต้นฉบับ

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

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec

ข้อมูลจําเพาะของ BigQueryDataSource

ข้อกําหนดของแหล่งข้อมูล 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

รหัสของโปรเจ็กต์ GCP ที่เปิดใช้บัญชีซึ่งแนบบัญชีสําหรับการเรียกเก็บเงินไว้ ระบบจะเรียกเก็บเงินสําหรับคําค้นหาที่ดําเนินการกับข้อมูลต้นฉบับ

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

object (BigQueryQuerySpec)

BigQueryQuerySpec

tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec

ข้อมูลจําเพาะของ BigQuery

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

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

string

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

ข้อกําหนดตาราง BigQuery

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

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

string

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

tableId

string

รหัสตาราง BigQuery

datasetId

string

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

พารามิเตอร์แหล่งข้อมูล

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

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

string

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

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

string

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

range

object (GridRange)

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

กําหนดเวลาการรีเฟรชแหล่งข้อมูล

กําหนดเวลาในการรีเฟรชแหล่งข้อมูล

ระบบจะรีเฟรชข้อมูลต้นฉบับในสเปรดชีตภายในช่วงเวลาหนึ่ง คุณระบุเวลาเริ่มต้นได้โดยการคลิกปุ่มรีเฟรชที่กําหนดเวลาในเครื่องมือแก้ไขชีต แต่ระยะเวลาจะคงที่อยู่ที่ 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)

เอาต์พุตเท่านั้น ช่วงเวลาของการทํางานครั้งต่อไป

ช่อง Union schedule_config การกําหนดค่ากําหนดการ schedule_config ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
dailySchedule

object (DataSourceRefreshDailySchedule)

กําหนดเวลาการรีเฟรชทุกวัน

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

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

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

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

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

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

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

รีเฟรชรายวันของแหล่งข้อมูล

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

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

object (TimeOfDay)

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

เวลาของวัน

แสดงช่วงเวลาของวัน วันที่และเวลาไม่มีความสําคัญหรือระบุไว้ที่อื่น 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

กําหนดเวลาการรีเฟรชแหล่งข้อมูลรายสัปดาห์

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

การแสดง 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 วันอาทิตย์

รีเฟรชแหล่งข้อมูลรายเดือน

กําหนดการรายเดือนที่จะมีการรีเฟรชข้อมูลในวันที่เฉพาะเจาะจงของเดือนในช่วงเวลาที่กําหนด

การแสดง 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

นําการอัปเดตไปใช้ในสเปรดชีต

create

สร้างสเปรดชีตและส่งคืนสเปรดชีตที่สร้างใหม่

get

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

getByDataFilter

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