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 מטא-נתונים שגלויים לפרויקט גלויים רק לפרויקט המפתח שיצר את המטא-נתונים, ונגישים להם.

שיטות

get

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