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)

A [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, מתבצע מיפוי ליום הראשון ליום ה-28. צריך לציין יום אחד לפחות.

מרווח

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

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

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

string (Timestamp format)

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

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

string (Timestamp format)

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

אם צוין, חותמת זמן שתואמת למרווח הזמן הזה צריכה להופיע לפני הסוף.

שיטות

batchUpdate

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

create

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

get

 מחזירה את הגיליון האלקטרוני עם המזהה הנתון.

getByDataFilter

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