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

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

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

DeveloperMetadataVisibility

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

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

Methods

get

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