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

מייצג ערך כפול. הערה: תאריכים, שעות ו-DateTime מיוצגים ככפולים בפורמט 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

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

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

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

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