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)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode)
}
ช่อง
spreadsheetId

string

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

object (SpreadsheetProperties)

คุณสมบัติโดยรวมของสเปรดชีต
sheets[]

object (Sheet)

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

object (NamedRange)

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

string

URL ของสเปรดชีต ฟิลด์นี้เป็นแบบอ่านอย่างเดียว
developerMetadata[]

object (DeveloperMetadata)

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

object (DataSource)

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

object (DataSourceRefreshSchedule)

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

object (CommentThread)

ชุดข้อความความคิดเห็นที่เชื่อมโยงกับสเปรดชีต
commentsViewMode

enum (CommentsViewMode)

เอาต์พุตเท่านั้น โหมดมุมมองความคิดเห็นที่ใช้กับสเปรดชีต

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)
    }
  ],

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
ช่อง
parameters[]

object (DataSourceParameter)

พารามิเตอร์ของแหล่งข้อมูลที่ใช้เมื่อทำการค้นหาแหล่งข้อมูล
ข้อกำหนดที่แท้จริงต่อประเภทแหล่งข้อมูล ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
bigQuery

object (BigQueryDataSourceSpec)

A BigQueryDataSourceSpec
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][]
สิ้นสุดฟิลด์ที่แยกกัน

BigQueryDataSourceSpec

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

การแสดง JSON 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
ช่อง
projectId

string

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

object (BigQueryQuerySpec)

A BigQueryQuerySpec
tableSpec

object (BigQueryTableSpec)

A 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 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
ช่อง
ตัวระบุพารามิเตอร์ ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
name

string

พารามิเตอร์ที่มีชื่อ ต้องเป็นตัวระบุที่ถูกต้องสำหรับ DataSource ที่รองรับ เช่น ตัวระบุ BigQuery
สิ้นสุดฟิลด์ที่แยกกัน
ค่าพารามิเตอร์ ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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)
  },

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
ช่อง
enabled

boolean

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

enum (DataSourceRefreshScope)

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

object (Interval)

เอาต์พุตเท่านั้น ช่วงเวลาของการเรียกใช้ครั้งถัดไป
การกำหนดค่าตารางเวลา รายการต่อไปนี้คือฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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)

ไม่บังคับ จุดสิ้นสุดของช่วงเวลา (ไม่รวมวันที่สิ้นสุด)

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

CommentThread

แสดงชุดข้อความความคิดเห็นเดียวภายในสเปรดชีต

การแสดง JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
ช่อง
commentId

string

รหัสที่ไม่ซ้ำกันของชุดความคิดเห็น
anchorId

string

รหัสของ CommentAnchor ในชีตที่เชื่อมโยงกับเธรดนี้
headPost

object (Post)

โพสต์แรกในชุดข้อความ
replies[]

object (Post)

การตอบกลับโพสต์หลัก
status

enum (Status)

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

string

ข้อความที่ยกมาในสเปรดชีตเมื่อสร้างความคิดเห็น โดยจัดรูปแบบเป็นข้อความธรรมดา
สิ้นสุดฟิลด์ที่แยกกัน

โพสต์

แสดงโพสต์เดียวในชุดข้อความความคิดเห็น

การแสดง JSON 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
ช่อง
postId

string

เอาต์พุตเท่านั้น รหัสที่ไม่ซ้ำกันของโพสต์
content

string

เนื้อหาของโพสต์

ต้องไม่ว่างเปล่าหาก commentAction ไม่ใช่ RESOLVE หรือ REOPEN

ระบบจะจัดการเนื้อหาข้อความนี้ในลักษณะเดียวกับความคิดเห็นที่สร้างในโปรแกรมแก้ไขชีต โดยจะมีลักษณะการทำงานที่คล้ายกันสำหรับการจัดรูปแบบ การแจ้งเตือน ฯลฯ

ต้องยาวไม่เกิน 2048 หน่วยรหัส UTF-8
contentHtml

string

เอาต์พุตเท่านั้น เนื้อหาของโพสต์เป็น HTML
author

object (PostAuthor)

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างโพสต์
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างโพสต์
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่อัปเดตโพสต์ครั้งล่าสุด
deleted

boolean

เอาต์พุตเท่านั้น มีการลบโพสต์หรือไม่ หากฟิลด์ true, content และ author จะว่างเปล่า
fromImportedSpreadsheet

boolean

เอาต์พุตเท่านั้น โพสต์มาจากสเปรดชีตที่นำเข้าหรือไม่ ผู้โทรตั้งค่าฟิลด์นี้โดยตรงไม่ได้
fromCopiedSpreadsheet

boolean

เอาต์พุตเท่านั้น โพสต์มาจากสเปรดชีตที่คัดลอกหรือไม่ ผู้โทรตั้งค่าฟิลด์นี้โดยตรงไม่ได้
assigneeEmail

string

ไม่บังคับ อีเมลของผู้ใช้ที่ได้รับมอบหมายให้เข้าร่วมเธรดใหม่เป็นส่วนหนึ่งของโพสต์นี้

แสดงข้อผิดพลาด 400 คำขอไม่ถูกต้องในกรณีต่อไปนี้

  • เธรดหลักคือ CommentThread ที่ headPost ไม่มีผู้รับมอบหมาย

  • commentAction ระบุเป็น RESOLVE หรือ REOPEN

  • assigneeEmail เกิน 2048 หน่วยรหัส UTF-8
commentAction

enum (CommentActionType)

การดำเนินการที่ทำเป็นส่วนหนึ่งของการสร้างโพสต์

PostAuthor

แสดงผู้ใช้ที่เขียนโพสต์ความคิดเห็น

การแสดง JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
ช่อง
displayName

string

ชื่อที่แสดงของผู้ใช้ อาจไม่มีหากผู้เขียนไม่ประสงค์จะออกนาม
me

boolean

ดูว่าผู้ใช้เป็นผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ซึ่งส่งคำขอหรือไม่
anonymous

boolean

ดูว่าผู้ใช้ไม่ระบุตัวตนหรือไม่
user

string

ชื่อทรัพยากรของผู้ใช้ที่เป็นผู้เขียนโพสต์ ซึ่งใช้เพื่อระบุผู้ใช้ใน Google People API ได้ด้วย รูปแบบ: users/{user} จะไม่แสดงหากฟิลด์ที่ไม่ระบุตัวตนเป็น true หรือหากโพสต์มาจากสเปรดชีตที่นำเข้า

CommentActionType

การดำเนินการที่ทำกับการตอบกลับชุดความคิดเห็นนี้

Enum
COMMENT_ACTION_TYPE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
NO_COMMENT_ACTION_CHANGE ไม่มีการเปลี่ยนแปลงการดำเนินการในโพสต์นี้
RESOLVE โพสต์นี้จะปิดชุดข้อความ
REOPEN โพสต์นี้จะเปิดชุดข้อความอีกครั้ง

สถานะ

ตัวเลือกสถานะของชุดข้อความความคิดเห็น

Enum
STATUS_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
OPEN ชุดข้อความความคิดเห็นเปิดอยู่
RESOLVED ชุดความคิดเห็นได้รับการแก้ไขแล้ว

CommentsViewMode

โหมดมุมมองความคิดเห็นที่ใช้กับสเปรดชีตซึ่งระบุว่ารวมความคิดเห็นไว้หรือไม่ โดยจะมีตัวเลือกสำหรับการอ่านสเปรดชีตที่มีหรือไม่มีความคิดเห็นและเครื่องหมายความคิดเห็น

Enum
COMMENTS_VIEW_MODE_UNSPECIFIED ไม่ได้ระบุ CommentsViewMode จึงใช้ COMMENTS_VIEW_MODE_OMITTED
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS โหมดการดูความคิดเห็นที่ใช้กับสเปรดชีตที่ส่งคืนจะขึ้นอยู่กับระดับการเข้าถึงปัจจุบันของผู้ใช้ หากผู้ใช้มีสิทธิ์ดูอย่างเดียว ระบบจะใช้ COMMENTS_VIEW_MODE_OMITTED ไม่เช่นนั้น ระบบจะใช้ COMMENTS_VIEW_MODE_INCLUDED
COMMENTS_VIEW_MODE_OMITTED สเปรดชีตที่ส่งคืนจะไม่มีความคิดเห็น
COMMENTS_VIEW_MODE_INCLUDED

สเปรดชีตที่ส่งคืนจะมีข้อความความคิดเห็นรวมอยู่ด้วย

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

เมธอด

batchUpdate

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

create

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

get

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

getByDataFilter

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