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

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

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

สตริงการค้นหาไฟล์ข้อมูล RAW

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 ชั่วโมง เช่น หากคุณระบุเวลาเริ่มต้นเป็น 08:00 น. การรีเฟรชจะเกิดขึ้นระหว่างเวลา 08: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

วินาทีใน 1 นาที ต้องมากกว่าหรือเท่ากับ 0 และโดยทั่วไปต้องน้อยกว่าหรือเท่ากับ 59 API อาจอนุญาตให้ใช้ค่า 60 ได้หากอนุญาตให้ใช้วินาทีของ leap
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

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