מחלקה של google.script.url (ממשק API בצד הלקוח)

google.script.url הוא ממשק API אסינכרוני של JavaScript בצד הלקוח, שיכול לשלוח שאילתות לכתובות אתרים כדי לקבל את הפרמטרים והמקטע הנוכחיים של כתובות האתר. ה-API הזה תומך ב-API google.script.history. אפשר להשתמש בו רק באפליקציות אינטרנט שמשתמשות ב-IFRAME. הוא לא מיועד לשימוש בסרגלי צד ובתיבות דו-שיח בהקשר של תוסף או של סקריפט קונטיינר. למידע נוסף, אפשר לקרוא את המדריך לשימוש בהיסטוריית הדפדפן באפליקציות אינטרנט.

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
getLocation(function) void הפונקציה מקבלת אובייקט מיקום של כתובת URL ומעבירה אותו לפונקציית הקריאה החוזרת שצוינה.

תיעוד מפורט

getLocation(function)

הפונקציה מקבלת אובייקט מיקום של כתובת URL ומעבירה אותו לפונקציית הקריאה החוזרת שצוינה (כארגומנט היחיד).

Index.html

google.script.url.getLocation(function(location) {
  console.log(location.parameters);
  console.log(location.hash);
});

פרמטרים

שםתיאורהתיאור
functionFunctionפונקציית קריאה חוזרת בצד הלקוח להרצה, תוך שימוש באובייקט המיקום כארגומנט היחיד.

מיקום אובייקט

בטבלה הבאה מוצגות דוגמאות לרכיבי המיקום שיצוינו אם כתובת ה-URL הבאה תכלול שאילתה: http://www.example.com?n=1&name=alice&n=2#headingAnchor
שדות
location.hash

ערך המחרוזת של קטע כתובת ה-URL אחרי התו #, או מחרוזת ריקה אם לא קיים מקטע של כתובת URL

headingAnchor
location.parameter

אובייקט של צמדי מפתח/ערך שתואמים לפרמטרים של הבקשה לכתובת URL. רק הערך הראשון יוחזר לפרמטרים שיש להם ערכים מרובים. אם לא נמצאו פרמטרים, זהו אובייקט ריק.

{"name": "alice", "n": "1"}
location.parameters

אובייקט שדומה ל-location.parameter, אבל עם מערך של ערכים לכל מפתח. אם לא נמצאו פרמטרים, זהו אובייקט ריק.

{"name": ["alice"], "n": ["1", "2"]}