کلاس google.script.url (API سمت مشتری)
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
google.script.url یک API جاوا اسکریپت سمت کلاینت ناهمزمان است که می تواند URL ها را برای به دست آوردن پارامترها و قطعه URL فعلی جستجو کند. این API از google.script.history API پشتیبانی می کند. این فقط در زمینه یک برنامه وب که از IFRAME استفاده می کند قابل استفاده است. این برای استفاده با نوارهای کناری و گفتگو در یک متن افزودنی یا اسکریپت کانتینری در نظر گرفته نشده است. برای اطلاعات بیشتر، راهنمای استفاده از سابقه مرورگر در برنامه‌های وب را ببینید.
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|
getLocation(function) | void | یک شی مکان URL را دریافت می کند و آن را به تابع بازخوانی مشخص شده ارسال می کند. |
مستندات دقیق
getLocation(function)
یک شی مکان URL را دریافت می کند و آن را به تابع callback مشخص شده (به عنوان تنها آرگومان) ارسال می کند.
Index.html
google.script.url.getLocation(function(location) {
console.log(location.parameters);
console.log(location.hash);
}); پارامترها
| نام | تایپ کنید | توضیحات |
|---|
function | Function | یک تابع فراخوانی سمت کلاینت برای اجرا، با استفاده از شی مکان به عنوان تنها آرگومان. |
شی مکان
جدول زیر نمونه‌هایی از عناصر مکان را نشان می‌دهد که در صورت درخواست 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"]} |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003e\u003ccode\u003egoogle.script.url\u003c/code\u003e is a client-side JavaScript API for querying URLs to get parameters and fragments within web apps.\u003c/p\u003e\n"],["\u003cp\u003eThis API works with \u003ccode\u003egoogle.script.history\u003c/code\u003e and requires the use of \u003ccode\u003eIFRAME\u003c/code\u003e in your web app.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetLocation()\u003c/code\u003e method retrieves a URL location object containing parameters and hash information, passing it to a callback function.\u003c/p\u003e\n"],["\u003cp\u003eThe location object provides access to URL components like hash, individual parameters, and all parameter values.\u003c/p\u003e\n"]]],[],null,["# Class google.script.url (Client-side API)\n\n`google.script.url` is an asynchronous client-side JavaScript\nAPI that can query URLs to obtain the current URL parameters and fragment.\nThis API supports the [`google.script.history`](/apps-script/guides/html/reference/history)\nAPI. It can only be used in the context of a web app that uses\n[`IFRAME`](/apps-script/reference/html/sandbox-mode#properties).\nIt is not intended for use with sidebars and dialogs in an add-on or\ncontainer-script context. For more information, see the\n[guide to using browser\nhistory in web apps](/apps-script/guides/web#web_apps_and_browser_history). \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------|-------------|------------------------------------------------------------------------------|\n| [getLocation(function)](#getLocation(Function)) | `void` | Gets a URL location object and passes it to the specified callback function. |\n\nDetailed documentation\n----------------------\n\n### `getLocation(function)`\n\nGets a [URL location object](#locationObject) and passes it to the specified callback\nfunction (as the only argument). \n\n### Index.html\n\n```html\ngoogle.script.url.getLocation(function(location) {\n console.log(location.parameters);\n console.log(location.hash);\n});\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|------------|------------|------------------------------------------------------------------------------------------------------------|\n| `function` | `Function` | a client-side callback function to run, using the [location object](#locationObject) as the only argument. |\n\n#### Location object\n\nThe following table shows examples of the location elements that would be specified if the following URL was queried: `http://www.example.com?n=1&name=alice&n=2#headingAnchor`\n\n| Fields ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `location.hash` | The string value of URL fragment after the `#` character, or an empty string if no URL fragment is present ``` headingAnchor ``` |\n| `location.parameter` | An object of key/value pairs that correspond to the URL request parameters. Only the first value will be returned for parameters that have multiple values. If no parameters are present, this will be an empty object. ``` {\"name\": \"alice\", \"n\": \"1\"} ``` |\n| `location.parameters` | An object similar to `location.parameter`, but with an array of values for each key. If no parameters are present, this will be an empty object. ``` {\"name\": [\"alice\"], \"n\": [\"1\", \"2\"]} ``` |\n\n*** ** * ** ***"]]
