Class DeveloperMetadata

מטא-נתונים למפתחים

גישה למטא-נתונים של מפתחים ושינוי שלהם. כדי ליצור מטא-נתונים חדשים של מפתחים, משתמשים ב-Range.addDeveloperMetadata(key), ב-Sheet.addDeveloperMetadata(key) או ב-Spreadsheet.addDeveloperMetadata(key).

Methods

שיטהסוג הערך המוחזרתיאור קצר
getId()Integerהפונקציה מחזירה את המזהה הייחודי שמשויך למטא-נתונים של המפתח.
getKey()Stringהפונקציה מחזירה את המפתח שמשויך למטא-נתונים של המפתח.
getLocation()DeveloperMetadataLocationהפונקציה מחזירה את המיקום של המטא-נתונים של המפתח.
getValue()Stringהפונקציה מחזירה את הערך שמשויך למטא-נתונים של המפתח, או את הערך null אם למטא-נתונים האלה אין ערך.
getVisibility()DeveloperMetadataVisibilityהפונקציה מחזירה את סטטוס השיתוף של המטא נתונים של המפתח.
moveToColumn(column)DeveloperMetadataהעברת המטא-נתונים של המפתח לעמודה שצוינה.
moveToRow(row)DeveloperMetadataהעברת המטא-נתונים של המפתח לשורה שצוינה.
moveToSheet(sheet)DeveloperMetadataהעברת המטא-נתונים של המפתח לגיליון שצוין.
moveToSpreadsheet()DeveloperMetadataהעברת המטא-נתונים של המפתח לגיליון האלקטרוני ברמה העליונה.
remove()voidמחיקת המטא-נתונים האלה.
setKey(key)DeveloperMetadataהגדרת המפתח של מטא-נתוני המפתח לערך שצוין.
setValue(value)DeveloperMetadataהגדרת הערך שצוין לערך שמשויך למטא-נתונים של המפתח.
setVisibility(visibility)DeveloperMetadataהגדרת החשיפה של המטא-נתונים האלה של המפתח לחשיפה שצוינה.

מסמכים מפורטים

getId()

הפונקציה מחזירה את המזהה הייחודי שמשויך למטא-נתונים של המפתח.

חזרה

Integer – המזהה הייחודי שמשויך למטא-נתונים של המפתח.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getKey()

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

חזרה

String – המפתח שמשויך למטא-נתונים של המפתח.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getLocation()

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

חזרה

DeveloperMetadataLocation – המיקום של המטא-נתונים של המפתח.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getValue()

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

חזרה

String – הערך שמשויך למטא-נתונים של המפתח, או null אם למטא-נתונים האלה אין ערך.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getVisibility()

הפונקציה מחזירה את סטטוס השיתוף של המטא נתונים של המפתח.

חזרה

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

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToColumn(column)

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

פרמטרים

שםסוגתיאור
columnRangeהטווח שמייצג את העמודה שמהווה את המיקום החדש של המטא-נתונים של המפתח.

חזרה

DeveloperMetadata – המטא-נתונים של המפתח, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToRow(row)

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

פרמטרים

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

חזרה

DeveloperMetadata – המטא-נתונים של המפתח, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToSheet(sheet)

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

פרמטרים

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

חזרה

DeveloperMetadata – המטא-נתונים של המפתח, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToSpreadsheet()

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

חזרה

DeveloperMetadata – המטא-נתונים של המפתח, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

מחיקת המטא-נתונים האלה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setKey(key)

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

פרמטרים

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

חזרה

DeveloperMetadata – המטא-נתונים של המפתח, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValue(value)

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

פרמטרים

שםסוגתיאור
valueStringהערך החדש להגדרה של המטא-נתונים האלה.

חזרה

DeveloperMetadata – המטא-נתונים של המפתח, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVisibility(visibility)

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

פרמטרים

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

חזרה

DeveloperMetadata – המטא-נתונים של המפתח, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets