Class DeveloperMetadata

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