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 חיצוניות לפונקציות של תמונות וייבוא. קריאה בלבד כשהערך הוא true. אם הערך הוא false, אפשר להגדיר אותו כ-true. אם האדמין הפעיל את התכונה של הרשימה המורשית, הערך הזה יתעקף ותמיד יוחזר true.

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

מחרוזת השאילתה הגולמית.

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

תזמון לרענון מקור הנתונים.

מקורות הנתונים בגיליון האלקטרוני מתעדכנים במרווח זמן מסוים. אפשר לציין את שעת ההתחלה בלחיצה על הלחצן 'רענון מתוזמן' בעורך של Sheets, אבל מרווח הזמן קבוע ל-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

הערך True אם לוח הזמנים לרענון מופעל, או False אחרת.
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. ברירת המחדל של גודל מרווח הזמן היא זו שמוגדרת בכלי העריכה של Sheets.

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. ברירת המחדל של גודל מרווח הזמן היא זו שמוגדרת בכלי העריכה של Sheets.
daysOfWeek[]

enum (DayOfWeek)

ימי השבוע שבהם הנתונים יתעדכנו. צריך לציין לפחות יום אחד.

DayOfWeek

מייצג יום בשבוע.

טיפוסים בני מנייה (enum)
DAY_OF_WEEK_UNSPECIFIED היום בשבוע לא צוין.
MONDAY שני
TUESDAY שלישי
WEDNESDAY רביעי
THURSDAY חמישי
FRIDAY שישי
SATURDAY שבת
SUNDAY ראשון

DataSourceRefreshMonthlySchedule

לוח זמנים חודשי לרענון נתונים בימים ספציפיים בחודש במרווח זמן נתון.

ייצוג ב-JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
שדות
startTime

object (TimeOfDay)

שעת ההתחלה של חלון הזמן שבו מתוזמן רענון של מקור הנתונים. המערכת משתמשת רק בחלק hours. ברירת המחדל של גודל מרווח הזמן היא זו שמוגדרת בכלי העריכה של Sheets.
daysOfMonth[]

integer

הימים בחודש שרוצים לרענן. יש תמיכה רק בערכים 1 עד 28, שממופים ליום ה-1 עד ה-28. צריך לציין לפחות יום אחד.

מרווח

מייצג מרווח זמן, שמקודד כחותמת זמן להתחלה (כולל) וכחותמת זמן לסיום (לא כולל).

ההתחלה חייבת להיות קטנה מסיום או שווה לו. כשההתחלה שווה לסיום, מרווח הזמן ריק (לא מתאים לשום זמן). אם לא צוינו התחלה וסיום, מרווח הזמן תואם לכל זמן.

ייצוג ב-JSON 
{
  "startTime": string,
  "endTime": string
}
שדות
startTime

string (Timestamp format)

זה שינוי אופציונלי. תחילת המרווח, כולל.

אם יצוין תאריך חותמת זמן שתואמת למרווח הזמן הזה, הוא יצטרך להיות זהה לתאריך ההתחלה או מאוחר ממנו.
endTime

string (Timestamp format)

זה שינוי אופציונלי. סיום המרווח, בלעדי.

אם יצוין טווח זמן, חותמת הזמן שתתאים לטווח הזה תצטרך להיות לפני הסיום.

Methods

batchUpdate

 החלת עדכון אחד או יותר על הגיליון האלקטרוני.

create

 יצירת גיליון אלקטרוני והחזרת הגיליון החדש שנוצר.

get

 הפונקציה מחזירה את הגיליון האלקטרוני במזהה הנתון.

getByDataFilter

 הפונקציה מחזירה את הגיליון האלקטרוני במזהה הנתון.