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 שצוין.