Class DeveloperMetadata

DeveloperMetadata

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
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)

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

פרמטרים

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

החזרות

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

הרשאות

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

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

---

moveToRow(row)

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

פרמטרים

שם	תיאור	התיאור
row	Range	הטווח שמייצג את השורה של המיקום החדש למטא נתונים של המפתח הזה.

החזרות

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

הרשאות

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

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

---

moveToSheet(sheet)

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

פרמטרים

שם	תיאור	התיאור
sheet	Sheet	הגיליון שמכיל את המיקום החדש של המטאטה של המפתח.

החזרות

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)

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

פרמטרים

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

החזרות

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

הרשאות

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

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

---

setValue(value)

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

פרמטרים

שם	תיאור	התיאור
value	String	הערך החדש שיש להגדיר עבור המטא-נתונים האלה.

החזרות

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

הרשאות

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

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

---

setVisibility(visibility)

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

פרמטרים

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

החזרות

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

הרשאות

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

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