Other

צבע

מייצג צבע במרחב הצבעים RGBA. הייצוג הזה נועד לפשט את ההמרה לייצוגים של צבעים בשפות שונות, ולאפשר המרה מהם, ולאו דווקא להיות קומפקטי. לדוגמה, אפשר לספק את השדות של הייצוג הזה בקלות לבונה של java.awt.Color ב-Java. אפשר גם לספק אותם בקלות לשיטה +colorWithRed:green:blue:alpha של UIColor ב-iOS. בנוסף, אפשר לעצב אותם בקלות למחרוזת rgba() של CSS ב-JavaScript.

בדף ההפניה הזה אין מידע על מרחב הצבעים המוחלט שבו צריך להשתמש כדי לפרש את ערך ה-RGB – לדוגמה, sRGB,‏ Adobe RGB,‏ DCI-P3 ו-BT.2020. כברירת מחדל, האפליקציות צריכות להניח שמרחב הצבעים הוא sRGB.

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

דוגמה (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

דוגמה (iOS / Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

דוגמה (JavaScript):

// ...

var protoToCssColor = function(rgbColor) {
   var redFrac = rgbColor.red || 0.0;
   var greenFrac = rgbColor.green || 0.0;
   var blueFrac = rgbColor.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgbColor)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgbColor.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
ייצוג ב-JSON
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
שדות
red

number

כמות האדום בצבע כערך במרווח [0, 1].

green

number

כמות הירוק בצבע כערך במרווח [0, 1].

blue

number

כמות הכחול בצבע כערך בטווח [0, 1].

alpha

number

החלק היחסי של הצבע הזה שצריך להחיל על הפיקסל. כלומר, הצבע הסופי של הפיקסל מוגדר על ידי המשוואה:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

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

ColorStyle

ערך צבע.

ייצוג ב-JSON
{

  // Union field kind can be only one of the following:
  "rgbColor": {
    object (Color)
  },
  "themeColor": enum (ThemeColorType)
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג ערך הצבע. ‫kind יכול להיות רק אחד מהבאים:
rgbColor

object (Color)

צבע RGB. הערך alpha באובייקט Color לא נתמך בדרך כלל.

themeColor

enum (ThemeColorType)

צבע העיצוב.

ThemeColorType

סוגי צבעי העיצוב.

SpreadsheetProperties כוללים תג SpreadsheetTheme שמגדיר מיפוי של סוגי צבעי העיצוב האלה לצבעים קונקרטיים.

טיפוסים בני מנייה (enum)
THEME_COLOR_TYPE_UNSPECIFIED צבע עיצוב לא מוגדר
TEXT מייצג את צבע הטקסט הראשי
BACKGROUND מייצג את צבע הרקע הראשי
ACCENT1 מייצג את הצבע המשני הראשון
ACCENT2 מייצג את הצבע המשני השני
ACCENT3 מייצג את הצבע המשני השלישי
ACCENT4 מייצג את הצבע המשני הרביעי
ACCENT5 מייצג את הצבע המשני החמישי
ACCENT6 מייצג את הצבע המשני השישי

HorizontalAlign

היישור האופקי של הטקסט בתא.

טיפוסים בני מנייה (enum)
HORIZONTAL_ALIGN_UNSPECIFIED לא צוין יישור אופקי. אל תשתמשו בזה.
LEFT הטקסט מיושר באופן מפורש לצד השמאלי של התא.
CENTER הטקסט מיושר במפורש למרכז התא.
RIGHT הטקסט מיושר באופן מפורש לצד ימין של התא.

TextFormat

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

ייצוג ב-JSON
{
  "foregroundColor": {
    object (Color)
  },
  "foregroundColorStyle": {
    object (ColorStyle)
  },
  "fontFamily": string,
  "fontSize": integer,
  "bold": boolean,
  "italic": boolean,
  "strikethrough": boolean,
  "underline": boolean,
  "link": {
    object (Link)
  }
}
שדות
foregroundColor
(deprecated)

object (Color)

צבע החזית של הטקסט. הוצא משימוש: צריך להשתמש ב-foregroundColorStyle.

foregroundColorStyle

object (ColorStyle)

צבע החזית של הטקסט. אם גם foregroundColor מוגדר, השדה הזה מקבל עדיפות.

fontFamily

string

משפחת הגופנים.

fontSize

integer

גודל הגופן.

bold

boolean

הפונקציה מחזירה True אם הטקסט מודגש.

italic

boolean

הערך True אם הטקסט מוטה.

strikethrough

boolean

הערך True אם הטקסט כולל קו חוצה.

underline

boolean

הערך True אם הטקסט מודגש.

DataSourceColumn

עמודה במקור נתונים.

ייצוג ב-JSON
{
  "reference": {
    object (DataSourceColumnReference)
  },
  "formula": string
}
שדות
reference

object (DataSourceColumnReference)

ההפניה לעמודה.

formula

string

הנוסחה של העמודה שמכילה חישוב.

DataSourceColumnReference

מזהה ייחודי שמפנה לעמודה במקור נתונים.

ייצוג ב-JSON
{
  "name": string
}
שדות
name

string

השם המוצג של העמודה. הוא צריך להיות ייחודי במקור נתונים.

DataExecutionStatus

הסטטוס של הפעלת הנתונים.

נוצרת הפעלה של נתונים כדי לסנכרן אובייקט של מקור נתונים עם הנתונים העדכניים מ-DataSource. בדרך כלל, התהליך מתוזמן לפעול ברקע. אפשר לבדוק את state כדי לדעת אם ההרצה הושלמה.

יש כמה תרחישים שבהם מופעלת הרצת נתונים:

  • Adding a data source יוצר גם גיליון מקור נתונים משויך וגם הפעלה של נתונים כדי לסנכרן את הנתונים ממקור הנתונים לגיליון.
  • Updating a data source יוצרת הפעלה של נתונים כדי לרענן את הגיליון המשויך של מקור הנתונים באופן דומה.
  • אפשר לשלוח refresh request כדי לרענן באופן מפורש אובייקט אחד או יותר של מקור נתונים.
ייצוג ב-JSON
{
  "state": enum (DataExecutionState),
  "errorCode": enum (DataExecutionErrorCode),
  "errorMessage": string,
  "lastRefreshTime": string
}
שדות
state

enum (DataExecutionState)

המצב של הפעלת הנתונים.

errorCode

enum (DataExecutionErrorCode)

קוד השגיאה.

errorMessage

string

הודעת השגיאה, שיכולה להיות ריקה.

lastRefreshTime

string (Timestamp format)

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

DataExecutionState

ספירה של מצבי הפעלת נתונים.

טיפוסים בני מנייה (enum)
DATA_EXECUTION_STATE_UNSPECIFIED ערך ברירת מחדל, אין להשתמש.
NOT_STARTED הפעלת הנתונים לא התחילה.
RUNNING הפעלת הנתונים התחילה והיא פועלת.
CANCELLING הביצוע של הנתונים מבוטל כרגע.
SUCCEEDED ההרצה של הנתונים הושלמה בהצלחה.
FAILED הפעלת הנתונים הושלמה עם שגיאות.

DataExecutionErrorCode

ספירה של קוד שגיאה בהפעלת נתונים.

טיפוסים בני מנייה (enum)
DATA_EXECUTION_ERROR_CODE_UNSPECIFIED ערך ברירת מחדל, אין להשתמש.
TIMED_OUT הזמן שהוקצב להפעלת הנתונים הסתיים.
TOO_MANY_ROWS בעקבות הפעלת הנתונים הוחזרו יותר שורות מהמגבלה.
TOO_MANY_COLUMNS בעקבות הפעלת הנתונים הוחזרו יותר עמודות מהמגבלה.
TOO_MANY_CELLS בעקבות הפעלת הנתונים הוחזרו יותר תאים מהמגבלה.
ENGINE השגיאה מתקבלת ממנוע הביצוע של נתוני הקצה העורפי (למשל BigQuery). פרטים נוספים זמינים במאמר errorMessage.
PARAMETER_INVALID פרמטר אחד או יותר של מקור הנתונים שצוינו לא תקינים.
UNSUPPORTED_DATA_TYPE הפעלת הנתונים מחזירה סוג נתונים שלא נתמך.
DUPLICATE_COLUMN_NAMES בעקבות הפעלת הנתונים הוחזרו שמות או כינויים כפולים של עמודות.
INTERRUPTED הפעלת הנתונים מופסקת. כדאי לרענן מאוחר יותר.
CONCURRENT_QUERY הנתונים נמצאים כרגע בתהליך עיבוד, ואי אפשר לרענן אותם עד שהתהליך יסתיים.
OTHER שגיאות אחרות.
TOO_MANY_CHARS_PER_CELL הפעלת הנתונים מחזירה ערכים שחורגים ממספר התווים המקסימלי שמותר להזין בתא אחד.
DATA_NOT_FOUND מסד הנתונים שאליו מפנה מקור הנתונים לא נמצא. ‎*/‎
PERMISSION_DENIED למשתמש אין גישה למסד הנתונים שאליו מפנה מקור הנתונים.
MISSING_COLUMN_ALIAS בעקבות הפעלת הנתונים הוחזרו עמודות ללא כינויים.
OBJECT_NOT_FOUND אובייקט מקור הנתונים לא קיים.
OBJECT_IN_ERROR_STATE האובייקט של מקור הנתונים נמצא כרגע במצב שגיאה. כדי לבצע רענון ידני, צריך להגדיר force ב- RefreshDataSourceRequest.
OBJECT_SPEC_INVALID המפרט של אובייקט מקור הנתונים לא תקין.
DATA_EXECUTION_CANCELLED ההפעלה של הנתונים בוטלה.

ExtendedValue

סוגי הערכים שיכולים להיות בתא בגיליון אלקטרוני.

ייצוג ב-JSON
{

  // Union field value can be only one of the following:
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "formulaValue": string,
  "errorValue": {
    object (ErrorValue)
  }
  // End of list of possible types for union field value.
}
שדות
שדה איחוד value. סוג הערך בתא. אם לא מוגדר שדה, התא לא מכיל נתונים. ‫value יכול להיות רק אחד מהבאים:
numberValue

number

מייצג ערך כפול. הערה: תאריכים, שעות ותאריכים עם שעות מיוצגים כמספרים כפולים בפורמט SERIAL_NUMBER.

stringValue

string

מייצג ערך מחרוזת. לא כוללים את המירכאות הבודדות הראשונות. לדוגמה, אם המשתמש הקליד '123 בממשק המשתמש, זה ייוצג כ-stringValue של "123".

boolValue

boolean

מייצג ערך בוליאני.

formulaValue

string

מייצג נוסחה.

errorValue

object (ErrorValue)

מייצג שגיאה. השדה הזה הוא לקריאה בלבד.

ErrorValue

שגיאה בתא.

ייצוג ב-JSON
{
  "type": enum (ErrorType),
  "message": string
}
שדות
type

enum (ErrorType)

סוג השגיאה.

message

string

הודעה עם מידע נוסף על השגיאה (במיקום הגיאוגרפי של הגיליון האלקטרוני).

ErrorType

סוג השגיאה.

טיפוסים בני מנייה (enum)
ERROR_TYPE_UNSPECIFIED סוג השגיאה שמוגדר כברירת מחדל. אל תשתמשו בו.
ERROR תואם לשגיאה #ERROR!.
NULL_VALUE תואם לשגיאה #NULL!.
DIVIDE_BY_ZERO תואם לשגיאה #DIV/0.
VALUE תואם לשגיאה #VALUE!.
REF תואם לשגיאה #REF!.
NAME תואם לשגיאה #NAME?.
NUM תואם לשגיאה #NUM!.
N_A תואם לשגיאה #N/A.
LOADING תואם למצב Loading....

BooleanCondition

תנאי שהערך המחושב שלו יכול להיות True או False. התנאים הבוליאניים משמשים לעיצוב מותנה, לאימות נתונים ולקריטריונים במסננים.

ייצוג ב-JSON
{
  "type": enum (ConditionType),
  "values": [
    {
      object (ConditionValue)
    }
  ]
}
שדות
type

enum (ConditionType)

סוג התנאי.

values[]

object (ConditionValue)

הערכים של התנאי. מספר הערכים הנתמכים תלוי בcondition type. חלק מהפונקציות תומכות בערך אפס, אחרות בערך אחד או שניים, והפונקציה ConditionType.ONE_OF_LIST תומכת במספר שרירותי של ערכים.

ConditionType

סוג התנאי.

טיפוסים בני מנייה (enum)
CONDITION_TYPE_UNSPECIFIED ערך ברירת המחדל, לא לשימוש.
NUMBER_GREATER הערך בתא צריך להיות גדול מהערך בתנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue יחיד.
NUMBER_GREATER_THAN_EQ הערך בתא צריך להיות גדול מהערך של התנאי או שווה לו. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue יחיד.
NUMBER_LESS הערך בתא חייב להיות קטן מהערך של התנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue יחיד.
NUMBER_LESS_THAN_EQ הערך בתא חייב להיות קטן מהערך של התנאי או שווה לו. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue יחיד.
NUMBER_EQ הערך בתא חייב להיות שווה לערך התנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue אחד לאימות נתונים, לעיצוב מותנה ולמסננים באובייקטים שהם לא מקור נתונים, ולפחות ConditionValue אחד למסננים באובייקטים של מקור נתונים.
NUMBER_NOT_EQ הערך בתא לא יכול להיות שווה לערך בתנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue אחד לאימות נתונים, לעיצוב מותנה ולמסננים באובייקטים שהם לא מקור נתונים, ולפחות ConditionValue אחד למסננים באובייקטים של מקור נתונים.
NUMBER_BETWEEN הערך בתא צריך להיות בין שני ערכי התנאים. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרשים בדיוק שני ConditionValues.
NUMBER_NOT_BETWEEN הערך בתא לא יכול להיות בין שני ערכי התנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרשים בדיוק שני ConditionValues.
TEXT_CONTAINS הערך בתא חייב להכיל את ערך התנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue יחיד.
TEXT_NOT_CONTAINS הערך בתא לא יכול להכיל את ערך התנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue יחיד.
TEXT_STARTS_WITH הערך בתא חייב להתחיל בערך של התנאי. יש תמיכה בעיצוב מותנה ובמסננים. נדרש ConditionValue יחיד.
TEXT_ENDS_WITH הערך בתא צריך להסתיים בערך של התנאי. יש תמיכה בעיצוב מותנה ובמסננים. נדרש ConditionValue יחיד.
TEXT_EQ הערך בתא חייב להיות בדיוק הערך של התנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue אחד לאימות נתונים, לעיצוב מותנה ולמסננים באובייקטים שהם לא מקור נתונים, ולפחות ConditionValue אחד למסננים באובייקטים של מקור נתונים.
TEXT_IS_EMAIL הערך בתא חייב להיות כתובת אימייל תקינה. יש תמיכה באימות נתונים. לא נדרש מינוי ל-ConditionValues.
TEXT_IS_URL הערך בתא חייב להיות כתובת URL תקינה. יש תמיכה באימות נתונים. לא נדרש מינוי ל-ConditionValues.
DATE_EQ הערך בתא צריך להיות זהה לתאריך שמוגדר בתנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. נדרש ConditionValue אחד לאימות נתונים, לעיצוב מותנה ולמסננים באובייקטים שהם לא מקור נתונים, ולפחות ConditionValue אחד למסננים באובייקטים של מקור נתונים.
DATE_BEFORE הערך בתא חייב להיות לפני התאריך של ערך התנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. היא צריכה לכלול ConditionValue יחיד, שיכול להיות relative date.
DATE_AFTER הערך בתא צריך להיות מאוחר מהתאריך שמוגדר כערך התנאי. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. היא צריכה לכלול ConditionValue יחיד, שיכול להיות relative date.
DATE_ON_OR_BEFORE הערך בתא צריך להיות זהה לערך התנאי או מוקדם ממנו. יש תמיכה באימות נתונים. היא צריכה לכלול ConditionValue יחיד, שיכול להיות relative date.
DATE_ON_OR_AFTER הערך בתאריך צריך להיות זהה לערך התאריך בתנאי או מאוחר ממנו. יש תמיכה באימות נתונים. היא צריכה לכלול ConditionValue יחיד, שיכול להיות relative date.
DATE_BETWEEN הערך בתא צריך להיות בין התאריכים של שני ערכי התנאים. יש תמיכה באימות נתונים. נדרשים בדיוק שני ConditionValues.
DATE_NOT_BETWEEN הערך בתא צריך להיות מחוץ לטווח התאריכים של שני ערכי התנאי. יש תמיכה באימות נתונים. נדרשים בדיוק שני ConditionValues.
DATE_IS_VALID הערך בתא חייב להיות תאריך. יש תמיכה באימות נתונים. לא נדרש מינוי ל-ConditionValues.
ONE_OF_RANGE הערך של התא צריך להיות ברשימה בטווח של ערך התנאי. יש תמיכה באימות נתונים. הפונקציה דורשת ערך יחיד ConditionValue, והערך צריך להיות טווח תקין בסימון A1.
ONE_OF_LIST הערך בתא צריך להיות ברשימת ערכי התנאים. יש תמיכה באימות נתונים. אפשר להשתמש בכל מספר של תגי condition values, אחד לכל פריט ברשימה. אין תמיכה בנוסחאות בערכים.
BLANK הערך בתא חייב להיות ריק. יש תמיכה בעיצוב מותנה ובמסננים. לא נדרש מינוי ל-ConditionValues.
NOT_BLANK הערך בתא לא יכול להיות ריק. יש תמיכה בעיצוב מותנה ובמסננים. לא נדרש מינוי ל-ConditionValues.
CUSTOM_FORMULA הנוסחה של התנאי צריכה להחזיר את הערך True. יש תמיכה באימות נתונים, בעיצוב מותנה ובמסננים. לא נתמך במסננים של גיליון מקור הנתונים. נדרש ConditionValue יחיד.
BOOLEAN הערך בתא צריך להיות TRUE או FALSE, או להיות ברשימת ערכי התנאי. יש תמיכה באימות נתונים. מוצג כתיבת סימון בתא. הערך יכול להיות אפס, אחד או שניים ConditionValues. אם לא מציינים ערכים, התא חייב להיות TRUE או FALSE. הערך TRUE מוצג כסימון וי והערך FALSE מוצג כסימון ביטול. ערך אחד מציין שהתא יוצג כשהוא מסומן אם הוא מכיל את הערך הזה, וכשהוא לא מסומן אם הוא ריק. שני ערכים מציינים שהתא יוצג כשהוא מסומן אם הוא מכיל את הערך הראשון, וכשהוא לא מסומן אם הוא מכיל את הערך השני. לדוגמה, הערך [‎"Yes",‎"No"‎] מציין שיוצג תא עם תיבת סימון מסומנת אם הערך הוא Yes, ותא עם תיבת סימון לא מסומנת אם הערך הוא No.
TEXT_NOT_EQ הערך בתא צריך להיות שונה מהערך של התנאי. האפשרות הזו נתמכת על ידי מסננים באובייקטים של מקור הנתונים. צריך להוסיף לפחות ConditionValue אחד.
DATE_NOT_EQ הערך בתא צריך להיות שונה מהערך של התנאי. האפשרות הזו נתמכת על ידי מסננים באובייקטים של מקור הנתונים. צריך להוסיף לפחות ConditionValue אחד.
FILTER_EXPRESSION הערך בתא צריך להיות בהתאם לתבנית שצוינה. נדרש ConditionValue יחיד.

ConditionValue

הערך של התנאי.

ייצוג ב-JSON
{

  // Union field value can be only one of the following:
  "relativeDate": enum (RelativeDate),
  "userEnteredValue": string
  // End of list of possible types for union field value.
}
שדות
שדה איחוד value. ערך התנאי. חובה להגדיר ערך אחד בדיוק. ‫value יכול להיות רק אחד מהבאים:
relativeDate

enum (RelativeDate)

תאריך יחסי (מבוסס על התאריך הנוכחי). המאפיין תקף רק אם הערך של type הוא DATE_BEFORE,‏ DATE_AFTER,‏ DATE_ON_OR_BEFORE או DATE_ON_OR_AFTER.

אין תמיכה בתאריכים יחסיים באימות נתונים. הם נתמכים רק בעיצוב מותנה ובמסננים מותנים.

userEnteredValue

string

ערך שהתנאי מבוסס עליו. הערך מנותח כאילו המשתמש הקליד אותו בתא. יש תמיכה בנוסחאות (והן חייבות להתחיל ב-= או בסימן '+').

RelativeDate

האפשרות הזו קובעת איך המערכת מעריכה תנאי לתאריך.

טיפוסים בני מנייה (enum)
RELATIVE_DATE_UNSPECIFIED ערך ברירת מחדל, אין להשתמש.
PAST_YEAR הערך הוא שנה לפני התאריך של היום.
PAST_MONTH הערך הוא חודש לפני היום.
PAST_WEEK הערך הוא שבוע לפני היום.
YESTERDAY הערך הוא אתמול.
TODAY הערך הוא היום.
TOMORROW הערך הוא מחר.

GridRange

טווח בגיליון. כל האינדקסים מבוססים על אפסים. האינדקסים הם חצי פתוחים, כלומר האינדקס ההתחלתי נכלל והאינדקס הסופי לא נכלל – [startIndex, endIndex). אינדקסים חסרים מציינים שהטווח לא מוגבל בצד הזה.

לדוגמה, אם "Sheet1" הוא מזהה הגיליון 123456, אז:

Sheet1!A1:A1 == sheetId: 123456, startRowIndex: 0, endRowIndex: 1, startColumnIndex: 0, endColumnIndex: 1

Sheet1!A3:B4 == sheetId: 123456, startRowIndex: 2, endRowIndex: 4, startColumnIndex: 0, endColumnIndex: 2

Sheet1!A:B == sheetId: 123456, startColumnIndex: 0, endColumnIndex: 2

Sheet1!A5:B == sheetId: 123456, startRowIndex: 4, startColumnIndex: 0, endColumnIndex: 2

Sheet1 == sheetId: 123456

אינדקס ההתחלה תמיד צריך להיות קטן מאינדקס הסיום או שווה לו. אם אינדקס ההתחלה שווה לאינדקס הסיום, הטווח ריק. בדרך כלל טווחים ריקים הם חסרי משמעות, ובדרך כלל הם מוצגים בממשק המשתמש כ-#REF!.

ייצוג ב-JSON
{
  "sheetId": integer,
  "startRowIndex": integer,
  "endRowIndex": integer,
  "startColumnIndex": integer,
  "endColumnIndex": integer
}
שדות
sheetId

integer

הגיליון שבו נמצא הטווח.

startRowIndex

integer

השורה הראשונה (כולל) בטווח, או שלא מוגדרת אם הטווח לא מוגבל.

endRowIndex

integer

שורה סופית (לא כולל) של הטווח, או לא מוגדר אם לא מוגבל.

startColumnIndex

integer

העמודה הראשונה (כולל) בטווח, או שלא מוגדרת אם הטווח לא מוגבל.

endColumnIndex

integer

עמודת הסיום (לא כולל) של הטווח, או לא מוגדרת אם הטווח לא מוגבל.

SortOrder

סדר מיון.

טיפוסים בני מנייה (enum)
SORT_ORDER_UNSPECIFIED ערך ברירת מחדל, אין להשתמש בו.
ASCENDING מיון בסדר עולה.
DESCENDING מיון בסדר יורד.

FilterSpec

קריטריוני המסנן שמשויכים לעמודה ספציפית.

ייצוג ב-JSON
{
  "filterCriteria": {
    object (FilterCriteria)
  },

  // Union field reference can be only one of the following:
  "columnIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field reference.
}
שדות
filterCriteria

object (FilterCriteria)

הקריטריונים של העמודה.

שדה איחוד reference. הפניה לעמודה המסוננת. ‫reference יכול להיות רק אחד מהבאים:
columnIndex

integer

אינדקס העמודות שמתחיל ב-0.

dataSourceColumnReference

object (DataSourceColumnReference)

הפניה לעמודה של מקור נתונים.

FilterCriteria

קריטריונים להצגה או להסתרה של שורות במסנן או בתצוגת סינון.

ייצוג ב-JSON
{
  "hiddenValues": [
    string
  ],
  "condition": {
    object (BooleanCondition)
  },
  "visibleBackgroundColor": {
    object (Color)
  },
  "visibleBackgroundColorStyle": {
    object (ColorStyle)
  },
  "visibleForegroundColor": {
    object (Color)
  },
  "visibleForegroundColorStyle": {
    object (ColorStyle)
  }
}
שדות
hiddenValues[]

string

הערכים שצריך להסתיר.

condition

object (BooleanCondition)

תנאי שצריך להיות true כדי שהערכים יוצגו. (הפעולה הזו לא מבטלת את ההגדרה של hiddenValues. אם ערך מופיע שם, הוא עדיין יוסתר).

visibleBackgroundColor
(deprecated)

object (Color)

צבע המילוי של הרקע שלפיו רוצים לסנן. רק תאים עם צבע המילוי הזה יוצגו. המאפיין הזה בלעדי למאפיין visibleForegroundColor. הוצא משימוש: צריך להשתמש ב-visibleBackgroundColorStyle.

visibleBackgroundColorStyle

object (ColorStyle)

צבע המילוי של הרקע שלפיו רוצים לסנן. רק תאים עם צבע המילוי הזה יוצגו. השדה הזה לא יכול להיות ביחד עם השדה visibleForegroundColor, והוא חייב להיות מוגדר כצבע מסוג RGB. אם גם visibleBackgroundColor מוגדר, השדה הזה מקבל עדיפות.

visibleForegroundColor
(deprecated)

object (Color)

צבע החזית שלפיו רוצים לסנן. יוצגו רק תאים עם צבע החזית הזה. המאפיין הזה בלעדי למאפיין visibleBackgroundColor. הוצא משימוש: צריך להשתמש ב-visibleForegroundColorStyle.

visibleForegroundColorStyle

object (ColorStyle)

צבע החזית שלפיו רוצים לסנן. יוצגו רק תאים עם צבע החזית הזה. השדה הזה לא יכול להיות ביחד עם השדה visibleBackgroundColor, והוא חייב להיות מוגדר כצבע מסוג RGB. אם גם visibleForegroundColor מוגדר, השדה הזה מקבל עדיפות.

SortSpec

סדר מיון שמשויך לעמודה או לשורה ספציפית.

ייצוג ב-JSON
{
  "sortOrder": enum (SortOrder),
  "foregroundColor": {
    object (Color)
  },
  "foregroundColorStyle": {
    object (ColorStyle)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },

  // Union field reference can be only one of the following:
  "dimensionIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field reference.
}
שדות
sortOrder

enum (SortOrder)

צריך למיין את נתוני ההזמנות.

foregroundColor
(deprecated)

object (Color)

צבע החזית שלפיו יתבצע המיון. התאים עם צבע החזית הזה ימוינו לחלק העליון. המאפיין הזה בלעדי למאפיין backgroundColor. הוצא משימוש: צריך להשתמש ב-foregroundColorStyle.

foregroundColorStyle

object (ColorStyle)

צבע החזית שלפיו יתבצע המיון. התאים עם צבע החזית הזה ימוינו לחלק העליון. המאפיין הזה לא יכול להיות ביחד עם backgroundColor, והצבע צריך להיות מסוג RGB. אם גם foregroundColor מוגדר, השדה הזה מקבל עדיפות.

backgroundColor
(deprecated)

object (Color)

צבע המילוי של הרקע שלפיו יתבצע המיון. תאים עם צבע המילוי הזה ימוינו לחלק העליון. המאפיין הזה בלעדי למאפיין foregroundColor. הוצא משימוש: צריך להשתמש ב-backgroundColorStyle.

backgroundColorStyle

object (ColorStyle)

צבע המילוי של הרקע שלפיו יתבצע המיון. תאים עם צבע המילוי הזה ימוינו לחלק העליון. המאפיין הזה לא יכול להיות ביחד עם foregroundColor, והצבע צריך להיות מסוג RGB. אם גם backgroundColor מוגדר, השדה הזה מקבל עדיפות.

שדה איחוד reference. הפניה למאפיין הממוין. ‫reference יכול להיות רק אחד מהבאים:
dimensionIndex

integer

המאפיין שלפיו יתבצע המיון.

dataSourceColumnReference

object (DataSourceColumnReference)

הפניה לעמודה של מקור נתונים.

EmbeddedObjectPosition

המיקום של אובייקט מוטמע, כמו תרשים.

ייצוג ב-JSON
{

  // Union field location can be only one of the following:
  "sheetId": integer,
  "overlayPosition": {
    object (OverlayPosition)
  },
  "newSheet": boolean
  // End of list of possible types for union field location.
}
שדות
שדה איחוד location. המיקום של האובייקט. חובה להגדיר בדיוק ערך אחד. ‫location יכול להיות רק אחד מהבאים:
sheetId

integer

הגיליון שבו נמצאת הנוסחה. ההגדרה הזו רלוונטית רק אם האובייקט המוטמע נמצא בגיליון משלו. הערך לא יכול להיות שלילי.

overlayPosition

object (OverlayPosition)

המיקום שבו האובייקט מוצג על גבי רשת.

newSheet

boolean

אם הערך הוא true, האובייקט המוטמע ממוקם בגיליון חדש שהמזהה שלו נבחר בשבילכם. השימוש הוא רק בזמן כתיבה.

OverlayPosition

המיקום שבו אובייקט מוצג בשכבת-על מעל רשת.

ייצוג ב-JSON
{
  "anchorCell": {
    object (GridCoordinate)
  },
  "offsetXPixels": integer,
  "offsetYPixels": integer,
  "widthPixels": integer,
  "heightPixels": integer
}
שדות
anchorCell

object (GridCoordinate)

התא שאליו מוצמד האובייקט.

offsetXPixels

integer

ההיסט האופקי, בפיקסלים, של האובייקט מתא העוגן.

offsetYPixels

integer

ההיסט האנכי, בפיקסלים, של האובייקט מהתא של העוגן.

widthPixels

integer

רוחב האובייקט, בפיקסלים. ברירת המחדל היא 600.

heightPixels

integer

גובה האובייקט, בפיקסלים. ברירת המחדל היא 371.

GridCoordinate

קואורדינטה בגיליון. כל האינדקסים מבוססים על אפסים.

ייצוג ב-JSON
{
  "sheetId": integer,
  "rowIndex": integer,
  "columnIndex": integer
}
שדות
sheetId

integer

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

rowIndex

integer

האינדקס של השורה בקואורדינטה.

columnIndex

integer

אינדקס העמודה של הקואורדינטה.