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.

RecalculationInterval

ספירה של האפשרויות האפשריות למרווחי חישוב מחדש.

טיפוסים בני מנייה (enums)
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)
  }
  // End of list of possible types for union field spec.
}
שדות
parameters[]

object (DataSourceParameter)

הפרמטרים של מקור הנתונים שמשמשים ליצירת שאילתות במקור הנתונים.
שדה איחוד spec. המפרט בפועל לכל סוג של מקור נתונים. spec יכול להיות רק אחד מהבאים:
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec.

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.

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 שעות. לדוגמה, אם מציינים את שעת ההתחלה 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

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

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

טיפוסים בני מנייה (enums)
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

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

טיפוסים בני מנייה (enums)
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

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