REST Resource: spreadsheets.developerMetadata

משאב: DeveloperMetadata

מטא-נתונים של מפתח שמשויכים למיקום או לאובייקט בגיליון אלקטרוני. אפשר להשתמש במטא-נתונים של מפתח כדי לשייך נתונים שרירותיים לחלקים שונים בגיליון האלקטרוני, והם יישארו משויכים למיקומים האלה בזמן ההעברה שלהם והגיליון האלקטרוני נערך. לדוגמה, אם המטא-נתונים של המפתח משויכים לשורה 5, ושורה אחרת מתווספת לאחר מכן לשורה 5, המטא-נתונים המקוריים עדיין ישויכו לשורה שבה היא שויכו לראשונה (מה שנקרא עכשיו שורה 6). אם האובייקט המשויך נמחק, גם המטא-נתונים שלו נמחקים.

ייצוג JSON 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
שדות
metadataId

integer

המזהה הייחודי ברמת הגיליון האלקטרוני שמזהה את המטא-נתונים. אפשר לציין מזהים כשנוצר מטא-נתונים, אחרת המזהה ייווצר באופן אקראי ויוקצה להם. חייב להיות חיובי.
metadataKey

string

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

string

נתונים המשויכים למפתח של המטא-נתונים.
location

object (DeveloperMetadataLocation)

המיקום שאליו המטא-נתונים משוייך.
visibility

enum (DeveloperMetadataVisibility)

הרשאות הגישה למטא-נתונים. המטא-נתונים של המפתח חייבים תמיד להיות גלויים.

מיקוםמטא נתונים של מפתח

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

ייצוג JSON 
{
  "locationType": enum (DeveloperMetadataLocationType),

  // Union field location can be only one of the following:
  "spreadsheet": boolean,
  "sheetId": integer,
  "dimensionRange": {
    object (DimensionRange)
  }
  // End of list of possible types for union field location.
}
שדות
locationType

enum (DeveloperMetadataLocationType)

סוג המיקום שהאובייקט הזה מייצג. השדה הזה הוא לקריאה בלבד.
שדה איחוד location. המיקום שאליו משויך המטא-נתונים. location יכול להיות רק אחד מהבאים:
spreadsheet

boolean

הערך הוא True כאשר המטא-נתונים משויכים לגיליון אלקטרוני שלם.
sheetId

integer

המזהה של הגיליון כאשר המטא-נתונים משויכים לגיליון שלם.
dimensionRange

object (DimensionRange)

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

סוג מטא-נתונים של מיקום

ספירה של סוגי המיקומים שניתן לשייך אליהם מטא-נתונים של מפתחים.

Enums
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED ערך ברירת המחדל.
ROW מטא נתונים של מפתח המשויכים למאפיין שלם של שורה.
COLUMN מטא נתונים של מפתח המשויכים למאפיין של עמודה שלם.
SHEET מטא-נתונים של מפתח שמשויכים לגיליון שלם.
SPREADSHEET מטא נתונים של מפתח המשויכים לכל הגיליון האלקטרוני.

הרשאות צפייה במטא-נתונים למפתחים

ספירה של ניראות מטא-נתונים אפשרית.

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED ערך ברירת המחדל.
DOCUMENT ניתן לגשת למטא נתונים הגלויים למסמך מכל פרויקט פיתוח עם גישה למסמך.
PROJECT המטא-נתונים הגלויים לפרויקט גלויים רק לפרויקט למפתחים שיצר את המטא-נתונים, וניתן לגשת אליהם.

שיטות

get

 מחזירה את המטא-נתונים של המפתח עם המזהה שצוין.
הפונקציה מחזירה את כל המטא-נתונים של המפתח שתואמים לערך שצוין ב-DataFilter.