גיליון
גיליון בגיליון אלקטרוני.
ייצוג ב-JSON |
---|
{ "properties": { object ( |
שדות | |
---|---|
properties
|
מאפייני הגיליון. |
data[]
|
הנתונים ברשת, אם מדובר בגיליון רשת.
מספר אובייקטי GridData שיוחזרו תלוי במספר הטווחים שביקשת בגיליון הזה. לדוגמה, אם הערך הזה מייצג את
בגיליון |
merges[]
|
טווחי הנתונים שיוחדרו. |
conditionalFormats[]
|
כללי העיצוב המותנה בגיליון הזה. |
filterViews[]
|
תצוגות הסינון בגיליון הזה. |
protectedRanges[]
|
טווחי התאים המוגנים בגיליון הזה. |
basicFilter
|
המסנן בגיליון הזה, אם יש כזה. |
charts[]
|
המפרטים של כל תרשים בגיליון הזה. |
bandedRanges[]
|
הטווחים עם פס (צבעים מתחלפים) בגיליון הזה. |
developerMetadata[]
|
המטא-נתונים של המפתח שמשויכים לגיליון. |
rowGroups[]
|
כל קבוצות השורות בגיליון הזה, בסדר עולה של אינדקס ההתחלה של הטווח, ולאחר מכן לפי עומק הקבוצה. |
columnGroups[]
|
כל קבוצות העמודות בגיליון הזה, לפי סדר הולך וגדל של אינדקס ההתחלה של הטווח, ולאחר מכן לפי עומק הקבוצה. |
slicers[]
|
כלי החיתוך בגיליון הזה. |
SheetProperties
מאפייני גיליון.
ייצוג ב-JSON |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
שדות | |
---|---|
sheetId
|
המזהה של הגיליון. הערך חייב להיות לא שלילי. לא ניתן לשנות את השדה הזה אחרי שמגדירים אותו. |
title
|
שם הגיליון. |
index
|
האינדקס של הגיליון בתוך הגיליון האלקטרוני. כשמוסיפים או מעדכנים מאפייני גיליונות, אם השדה הזה לא נכלל, הגיליון מתווסף או מועבר לסוף רשימת הגיליונות. כשמעדכנים את האינדקסים של הגיליונות או מוסיפים גיליונות, ההעברה נלקחת בחשבון באינדקסים 'לפני ההעברה'. לדוגמה, אם יש שלוש גיליונות (S1, S2, S3), כדי להעביר את S1 לפני S2 צריך להגדיר את האינדקס כ-2. המערכת מתעלמת מבקשות לעדכון של אינדקס גיליון אם האינדקס המבוקש זהה לאינדקס הנוכחי של הגיליון, או אם האינדקס החדש המבוקש שווה לאינדקס הנוכחי של הגיליון + 1. |
sheetType
|
סוג הגיליון. ברירת המחדל היא |
gridProperties
|
מאפיינים נוספים של הגיליון, אם הגיליון הזה הוא רשת. (אם הגיליון הוא גיליון של אובייקטים שמכיל תרשים או תמונה, השדה הזה לא יופיע). כשכותבים הודעות, לא בטוח להגדיר מאפייני רשת בגיליונות שהם לא דפי רשת.
אם הגיליון הזה הוא גיליון |
tabColor
|
הצבע של הכרטיסייה בממשק המשתמש. הוצאה משימוש: יש להשתמש ב- |
tabColorStyle
|
הצבע של הכרטיסייה בממשק המשתמש. אם גם |
rightToLeft
|
הערך True מופיע אם הגיליון הוא גיליון RTL במקום גיליון LTR. |
dataSourceSheetProperties
|
פלט בלבד. אם השדה הזה קיים, הוא מכיל מאפיינים ספציפיים לגיליון האלקטרוני |
SheetType
סוג הגיליון.
טיפוסים בני מנייה (enum) | |
---|---|
SHEET_TYPE_UNSPECIFIED
|
ערך ברירת מחדל, אין להשתמש בו. |
GRID
|
הגיליון הוא רשת. |
OBJECT
|
בגיליון אין רשת, ובמקום זאת יש בו אובייקט כמו תרשים או תמונה. |
DATA_SOURCE
|
הגיליון מתחבר ל-DataSource חיצוני ומציג את התצוגה המקדימה של הנתונים.
|
GridProperties
מאפייני רשת.
ייצוג JSON |
---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
שדות | |
---|---|
rowCount
|
מספר השורות ברשת. |
columnCount
|
מספר העמודות ברשת. |
frozenRowCount
|
מספר השורות שהוקפאו ברשת. |
frozenColumnCount
|
מספר העמודות שהוקפאו ברשת. |
hideGridlines
|
הערך True מופיע אם אין קווים של רשת בתצוגת הרשת בממשק המשתמש. |
rowGroupControlAfter
|
הערך True מופיע אם המתג של בקרת קיבוץ השורות מוצג אחרי הקבוצה. |
columnGroupControlAfter
|
הערך יהיה True אם המתג של אמצעי הבקרה לקיבוץ עמודות מופיע אחרי הקבוצה. |
DataSourceSheetProperties
מאפיינים נוספים של גיליון DATA_SOURCE
.
ייצוג ב-JSON |
---|
{ "dataSourceId": string, "columns": [ { object ( |
שדות | |
---|---|
dataSourceId
|
המזהה של ה- |
columns[]
|
העמודות שמוצגות בגיליון, בהתאם לערכים ב- |
dataExecutionStatus
|
סטטוס ביצוע הנתונים. |
GridData
נתונים ברשימה, וגם מטא-נתונים על המאפיינים.
ייצוג ב-JSON |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
שדות | |
---|---|
startRow
|
השורה הראשונה שאליה מתייחס ה-GridData, שמתחילה בספרה אפס. |
startColumn
|
העמודה הראשונה שאליה מתייחס ה-GridData, שמתחילה בספרה אפס. |
rowData[]
|
הנתונים ברשת, רשומה אחת בכל שורה, החל מהשורה ב-startRow. הערכים ב-RowData יתואמו לעמודות שמתחילות ב- |
rowMetadata[]
|
מטא-נתונים על השורות המבוקשות ברשימה, החל מהשורה שמופיעה ב- |
columnMetadata[]
|
מטא-נתונים על העמודות המבוקשות ברשימה, החל מהעמודה ב- |
RowData
נתונים על כל תא בשורה.
ייצוג ב-JSON |
---|
{
"values": [
{
object ( |
שדות | |
---|---|
values[]
|
הערכים בשורה, ערך אחד לכל עמודה. |
DimensionProperties
מאפיינים של מאפיין.
ייצוג JSON |
---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
שדות | |
---|---|
pixelSize
|
הגובה (אם מדובר בשורה) או הרוחב (אם מדובר בעמודה) של המאפיין בפיקסלים. |
developerMetadata[]
|
המטא-נתונים למפתחים שמשויכים לשורה או לעמודה אחת. |
dataSourceColumnReference
|
פלט בלבד. אם הערך מוגדר, זוהי עמודה בגיליון של מקור הנתונים. |
ConditionalFormatRule
כלל שמתאר פורמט מותנה.
ייצוג ב-JSON |
---|
{ "ranges": [ { object ( |
שדות | |
---|---|
ranges[]
|
הטווחים שיש לעצב אם התנאי מתקיים. כל הטווחים צריכים להיות באותה רשת. |
שדה האיחוד
rule . יש להגדיר את הכלל שקובע את הפורמט המותנה הזה, צריך להגדיר אחד בלבד.
rule
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
booleanRule
|
העיצוב מוגדר כ'מופעל' או כ'מושבת' בהתאם לכלל. |
gradientRule
|
הפורמט ישתנה בהתאם להדרגתיות של הכלל. |
BooleanRule
כלל שעשוי להתאים לו או לא, תלוי בתנאי.
ייצוג ב-JSON |
---|
{ "condition": { object ( |
שדות | |
---|---|
condition
|
תנאי הכלל. אם התנאי מקבל את הערך True, הפורמט מוחלט. |
format
|
הפורמט להחלה. אפשר להחיל עיצוב מותנה רק על קבוצת משנה של עיצובים:
|
GradientRule
כלל שחלה עליו פורמט של סולם צבעים בגוון פסטל, על סמך נקודות הביניים שצוינו. הפורמט של תא ישתנה בהתאם לתוכן שלו בהשוואה לערכים של נקודות האינטרפולציה.
ייצוג JSON |
---|
{ "minpoint": { object ( |
שדות | |
---|---|
minpoint
|
נקודת ההתחלה של האינטרפולציה. |
midpoint
|
נקודת ביניים אופציונלית של אינטרפולציה. |
maxpoint
|
נקודת האינטרפולציה הסופית. |
InterpolationPoint
נקודת אינטרפולציה אחת בפורמט מותנה של שיפוע. הם מסמנים את סולם הצבעים של הדרגתיות בהתאם לצבע, לסוג ולערך שבחרתם.
ייצוג ב-JSON |
---|
{ "color": { object ( |
שדות | |
---|---|
color
|
הצבע שבו נקודת האינטרפולציה הזו צריכה להשתמש. הוצאה משימוש: יש להשתמש ב- |
colorStyle
|
הצבע שבו נקודת האינטרפולציה הזו צריכה להשתמש. אם גם |
type
|
איך צריך לפרש את הערך. |
value
|
הערך שנקודת האינטרפולציה הזו משתמשת בו. יכול להיות נוסחה. לא בשימוש אם |
InterpolationPointType
סוג נקודת הביניים.
טיפוסים בני מנייה (enum) | |
---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED
|
ערך ברירת המחדל, אין להשתמש בו. |
MIN
|
נקודת האינטרפולציה משתמשת בערך המינימלי בתאים שבטווח של הפורמט המותנה. |
MAX
|
נקודת האינטרפולציה משתמשת בערך המקסימלי בתאים שבטווח של הפורמט המותנה. |
NUMBER
|
בנקודת הביניים של האינטרפולציה נעשה שימוש בדיוק בערך שמופיע ב-InterpolationPoint.value .
|
PERCENT
|
נקודת האינטרפולציה היא האחוז הנתון מתוך כל התאים בטווח של הפורמט המותנה. הערך הזה שווה ל- |
PERCENTILE
|
נקודת הביניים היא האחוזון הנתון מתוך כל התאים בטווח של הפורמט המותנה. הערך הזה שווה ל-NUMBER אם הערך היה:=PERCENTILE(FLATTEN(range), value / 100) (כשהמערכת מתעלמת משגיאות בטווח במהלך יישור הנתונים).
|
FilterView
תצוגת מסנן.
ייצוג ב-JSON |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
שדות | |
---|---|
filterViewId
|
המזהה של תצוגת המסנן. |
title
|
השם של תצוגת המסנן. |
range
|
הטווח שתצוגת המסנן הזו מכסה.
בזמן הכתיבה, אפשר להגדיר רק אחת מ- |
namedRangeId
|
הטווח המכונה שתצוגת המסנן הזו מבוססת עליו, אם יש כזה.
בזמן הכתיבה, אפשר להגדיר רק אחד מ- |
sortSpecs[]
|
סדר המיון בכל עמודה. המערכת משתמשת במפרטים מאוחרים יותר כשהערכים זהים במפרטים הקודמים. |
criteria
|
הקריטריונים להצגה/להסתרה של ערכים בכל עמודה. המפתח של המפה הוא אינדקס העמודה, והערך הוא הקריטריונים של העמודה הזו.
השדה הזה הוצא משימוש והוחלף על ידי השדה |
filterSpecs[]
|
קריטריונים לסינון להצגה/להסתרה של ערכים בכל עמודה.
גם השדה |
ProtectedRange
טווח תאים מוגן.
ייצוג ב-JSON |
---|
{ "protectedRangeId": integer, "range": { object ( |
שדות | |
---|---|
protectedRangeId
|
המזהה של טווח התאים המוגן. השדה הזה הוא לקריאה בלבד. |
range
|
הטווח שמוגן. יכול להיות שהטווח יהיה לא מוגבל לגמרי, ובמקרה כזה נחשב לגיליון מוגן.
בזמן הכתיבה, אפשר להגדיר רק אחד מהערכים |
namedRangeId
|
הטווח בעל השם שעליו מבוסס הטווח המוגן, אם יש כזה.
בזמן הכתיבה, אפשר להגדיר רק אחד מהערכים |
description
|
התיאור של טווח התאים המוגן הזה. |
warningOnly
|
הערך True מופיע אם בטווח המוגן הזה תוצג אזהרה בזמן עריכה. הגנה מבוססת-אזהרה פירושה שכל משתמש יכול לערוך נתונים בטווח המוגן, אבל לפני העריכה תוצג אזהרה שבה המשתמש יתבקש לאשר את העריכה.
כשכותבים: אם השדה הזה הוא true, אז |
requestingUserCanEdit
|
הערך true אם המשתמש שהגיש את הבקשה לטווח המוגן הזה יכול לערוך את האזור המוגן. השדה הזה הוא לקריאה בלבד. |
unprotectedRanges[]
|
רשימת הטווחים הלא מוגנים בגיליון מוגן. טווחים לא מוגנים נתמכים רק בגיליונות מוגנים. |
editors
|
המשתמשים והקבוצות שיש להם הרשאת עריכה בטווח המוגן. השדה הזה גלוי רק למשתמשים שיש להם גישת עריכה לטווח המוגן ולמסמך. אין תמיכה בכלי עריכה עם הגנה מסוג |
עורכים
העורכים של טווח תאים מוגן.
ייצוג ב-JSON |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
שדות | |
---|---|
users[]
|
כתובות האימייל של משתמשים שיש להם גישת עריכה לטווח המוגן. |
groups[]
|
כתובות האימייל של הקבוצות שיש להן הרשאת עריכה בטווח המוגן. |
domainUsersCanEdit
|
הערך True מופיע אם לכל משתמש בדומיין של המסמך יש גישת עריכה לטווח המוגן. הגנת דומיין נתמכת רק במסמכים בתוך דומיין. |
BasicFilter
מסנן ברירת המחדל שמשויך לגיליון.
ייצוג ב-JSON |
---|
{ "range": { object ( |
שדות | |
---|---|
range
|
הטווח שאליו חל המסנן. |
sortSpecs[]
|
סדר המיון בכל עמודה. המערכת משתמשת במפרטים מאוחרים יותר כשהערכים זהים במפרטים הקודמים. |
criteria
|
הקריטריונים להצגה/להסתרה של ערכים בכל עמודה. המפתח של המפה הוא אינדקס העמודה, והערך הוא הקריטריונים של העמודה הזו.
השדה הזה הוצא משימוש והוחלף על ידי השדה |
filterSpecs[]
|
קריטריוני הסינון בכל עמודה.
גם השדה |
BandedRange
טווח עם פסים (צבעים מתחלפים) בגיליון.
ייצוג ב-JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
שדות | |
---|---|
bandedRangeId
|
המזהה של הטווח המחולק. |
range
|
הטווח שבו המאפיינים האלה חלים. |
rowProperties
|
מאפיינים של פסורי שורות. המאפיינים האלה מוחלים על כל שורה בנפרד בכל השורות בטווח. צריך לציין לפחות אחד מ- |
columnProperties
|
מאפיינים של קבוצות עמודות. המאפיינים האלה חלים על כל העמודות בטווח, עמודה אחר עמודה. צריך לציין לפחות אחד מ- |
BandingProperties
נכסים שמפנים למאפיין יחיד (שורה או עמודה). אם מוגדרים גם BandedRange.row_properties
וגם BandedRange.column_properties
, צבעי המילוי יחולו על התאים לפי הכללים הבאים:
-
headerColor
ו-footerColor
נותנים עדיפות על פני צבעים של פס. -
firstBandColor
מקבלת עדיפות על פניsecondBandColor
. -
rowProperties
מקבלת עדיפות על פניcolumnProperties
.
לדוגמה, הצבע של השורה הראשונה מקבל עדיפות על פני הצבע של העמודה הראשונה, אבל הצבע של העמודה הראשונה מקבל עדיפות על פני הצבע של השורה השנייה. באופן דומה, כותרת השורה מקבלת עדיפות על פני כותרת העמודה בתא הימני העליון, אבל כותרת העמודה מקבלת עדיפות על פני הצבע של השורה הראשונה אם כותרת השורה לא מוגדרת.
ייצוג JSON |
---|
{ "headerColor": { object ( |
שדות | |
---|---|
headerColor
|
הצבע של השורה או העמודה הראשונה. אם השדה הזה מוגדר, השורה או העמודה הראשונה ימולאו בצבע הזה והצבעים יהיו חלופיים בין |
headerColorStyle
|
הצבע של השורה או העמודה הראשונה. אם השדה הזה מוגדר, השורה או העמודה הראשונה ימולאו בצבע הזה והצבעים יהיו חלופיים בין |
firstBandColor
|
הצבע הראשון שמשתנה. (חובה) הוצא משימוש: יש להשתמש ב- |
firstBandColorStyle
|
הצבע הראשון שמתחלף. (חובה) אם גם |
secondBandColor
|
הצבע השני שמתחלף. (חובה) הוצא משימוש: צריך להשתמש
ב- |
secondBandColorStyle
|
הצבע השני שמתחלף. (חובה) אם גם השדה |
footerColor
|
הצבע של השורה או העמודה האחרונה. אם השדה הזה לא מוגדר, השורה או העמודה האחרונות יתמלאו ב- |
footerColorStyle
|
הצבע של השורה או העמודה האחרונה. אם השדה הזה לא מוגדר, השורה או העמודה האחרונות יתמלאו ב- |
DimensionGroup
קבוצה של טווח שורות או עמודות בגיליון, שיכולה להכיל קבוצות אחרות או להיכלל בקבוצות אחרות. אפשר לכווץ או להרחיב קבוצה כיחידה בגיליון.
ייצוג ב-JSON |
---|
{
"range": {
object ( |
שדות | |
---|---|
range
|
הטווח שבו הקבוצה הזו קיימת. |
depth
|
עומק הקבוצה, שמייצג את מספר הקבוצות שיש להן טווח שמכיל את הטווח של הקבוצה הזו. |
collapsed
|
השדה הזה יהיה True אם הקבוצה הזו מכווצת. קבוצה מכווצת נשארת מכווצת אם קבוצה חופפת ברמה פחות עמוקה מורחבת. ערך True לא מרמז על כך שכל המאפיינים בקבוצה מוסתרים, מפני שהחשיפה של מאפיין יכולה להשתנות ללא תלות בנכס הקבוצתי הזה. עם זאת, כשהמאפיין הזה מתעדכן, כל המאפיינים שנמצאים בתוכו מוגדרים כ'מוסתרים' אם השדה הזה מוגדר כ-True, או כ'גלויים' אם השדה הזה מוגדר כ-False. |
כלי סינון
כלי סינון בגיליון.
ייצוג JSON |
---|
{ "slicerId": integer, "spec": { object ( |
שדות | |
---|---|
slicerId
|
המזהה של הכלי לחתיכה. |
spec
|
המפרט של כלי הסינון. |
position
|
המיקום של כלי הסינון. הערה: אפשר למקם את הכלי לחילוץ נתונים רק בגיליון קיים. בנוסף, אפשר לשנות באופן אוטומטי את הרוחב והגובה של כלי החיתוך כדי שהוא יישאר בתוך המגבלות המותרות. |
SlicerSpec
המפרטים של כלי סינון.
ייצוג ב-JSON |
---|
{ "dataRange": { object ( |
שדות | |
---|---|
dataRange
|
טווח הנתונים של כלי הסינון. |
filterCriteria
|
הקריטריונים לסינון של כלי הסינון. |
columnIndex
|
אינדקס העמודה שמתחיל באפס בטבלת הנתונים שבה חל המסנן. |
applyToPivotTables
|
הערך True מופיע אם המסנן צריך לחול על טבלאות צירים. אם המדיניות לא מוגדרת, ברירת המחדל היא |
title
|
הכותרת של הכלי לחלוקה. |
textFormat
|
פורמט הטקסט של השם בחלונית החיתוך. אין תמיכה בשדה הקישור. |
backgroundColor
|
צבע הרקע של כלי הסינון. הוצאה משימוש: יש להשתמש ב- |
backgroundColorStyle
|
צבע הרקע של הכלי לחתימה. אם גם |
horizontalAlignment
|
היישור האופקי של הכותרת בחלוקת המסך. אם לא צוין ערך, ברירת המחדל היא
|