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)

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

DeveloperMetadataLocation

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

ייצוג 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 שצוין חייב לייצג שורה או עמודה אחת. הוא לא יכול להיות ללא גבולות או להתפרס על כמה שורות או עמודות.

DeveloperMetadataLocationType

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

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

DeveloperMetadataVisibility

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

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

שיטות

get

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