הגדרת JavaScript Consumer SDK
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
באמצעות JavaScript Consumer SDK, אפליקציית הצרכן יכולה להציג את המיקום של כלי רכב ומיקומים אחרים שמעניינים את המשתמשים, שמתבצע אחריהם מעקב ב-Fleet Engine, במפה מבוססת-אינטרנט. כך הצרכנים יכולים לראות את התקדמות הנסיעה של הנהג.
המדריך הזה מבוסס על ההנחה שהגדרתם את Fleet Engine עם פרויקט Google Cloud ומפתחות API משויכים. פרטים נוספים זמינים במאמר בנושא Fleet Engine.
כדי להגדיר את JavaScript Consumer SDK:
- הפעלת Maps JavaScript API
- הגדרת הרשאה
הפעלת Maps JavaScript API
מפעילים את Maps JavaScript API במסוף Google Cloud. פרטים נוספים זמינים במאמר בנושא הפעלת ממשקי API במסמכי התיעוד של Google Cloud. הפעולה הזו מפעילה את Consumer SDK ל-JavaScript.
הגדרת הרשאה
ב-Fleet Engine נדרש שימוש באסימוני JWT (JSON Web Tokens) לקריאות ל-API method מסביבות עם רמת אבטחה נמוכה: סמארטפונים ודפדפנים.
אסימון JWT נוצר בשרת שלכם, נחתם, מוצפן ומועבר ללקוח לאינטראקציות עתידיות עם השרת עד שהוא יפוג או עד שהוא לא יהיה תקף יותר.
פרטים חשובים
איך עובד האישור?
ההרשאה לנתוני Fleet Engine כוללת הטמעה בצד השרת ובצד הלקוח.
הרשאה בצד השרת
לפני שמגדירים אימות והרשאה באפליקציה מבוססת-האינטרנט, שרת הקצה העורפי צריך להיות מסוגל להנפיק אסימוני אינטרנט מסוג JSON לאפליקציה מבוססת-האינטרנט כדי לקבל גישה ל-Fleet Engine. האפליקציה מבוססת האינטרנט שולחת את אסימוני ה-JWT האלה עם הבקשות שלה, כדי שמערכת Fleet Engine תזהה את הבקשות כמאומתות וכבעלות הרשאה לגשת לנתונים בבקשה. הוראות להטמעת JWT בצד השרת מופיעות במאמר הנפקת אסימוני אינטרנט מסוג JSON בקטע היסודות של Fleet Engine.
בפרט, חשוב לזכור את הנקודות הבאות לגבי JavaScript Consumer SDK לשיתוף התקדמות הנסיעה:
הרשאה מצד הלקוח
כשמשתמשים ב-JavaScript Consumer SDK, הוא מבקש טוקן מהשרת באמצעות כלי לאחזור טוקן הרשאה. הוא עושה זאת אם אחד מהתנאים הבאים מתקיים:
לא קיים טוקן תקין, למשל כשה-SDK לא קרא ל-fetcher בטעינת דף חדשה, או כשה-fetcher לא החזיר טוקן.
פג תוקפו של הטוקן.
התוקף של הטוקן עומד לפוג תוך דקה.
אחרת, JavaScript Consumer SDK משתמש באסימון הקודם התקף ולא קורא ל-fetcher.
יצירת כלי לאחזור טוקן הרשאה
כדי ליצור את הפונקציה לאחזור אסימון ההרשאה, פועלים לפי ההנחיות הבאות:
המאחזר צריך להחזיר מבנה נתונים עם שני שדות, עטוף ב-Promise
באופן הבא:
הכלי לאחזור נתונים צריך להפעיל כתובת URL בשרת כדי לאחזר אסימון. כתובת ה-URL הזו – SERVER_TOKEN_URL
– תלויה בהטמעה של ה-Backend. כתובת ה-URL הבאה היא של הקצה העורפי של האפליקציה לדוגמה ב-GitHub:
https://SERVER_URL/token/consumer/TRIPID
דוגמה – יצירת כלי לאחזור אסימון אימות
בדוגמאות הבאות מוסבר איך ליצור כלי לאחזור אסימוני הרשאה:
JavaScript
async function authTokenFetcher(options) {
// options is a record containing two keys called
// serviceType and context. The developer should
// generate the correct SERVER_TOKEN_URL and request
// based on the values of these fields.
const response = await fetch(SERVER_TOKEN_URL);
if (!response.ok) {
throw new Error(response.statusText);
}
const data = await response.json();
return {
token: data.Token,
expiresInSeconds: data.ExpiresInSeconds
};
}
TypeScript
function authTokenFetcher(options: {
serviceType: google.maps.journeySharing.FleetEngineServiceType,
context: google.maps.journeySharing.AuthTokenContext,
}): Promise<google.maps.journeySharing.AuthToken> {
// The developer should generate the correct
// SERVER_TOKEN_URL based on options.
const response = await fetch(SERVER_TOKEN_URL);
if (!response.ok) {
throw new Error(response.statusText);
}
const data = await response.json();
return {
token: data.token,
expiresInSeconds: data.ExpiresInSeconds,
};
}
המאמרים הבאים
איך עוקבים אחרי נסיעה באמצעות JavaScript
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-09-04 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-09-04 (שעון UTC)."],[[["\u003cp\u003eThe JavaScript Consumer SDK enables web-based display of vehicle locations and other points of interest tracked within Fleet Engine, letting consumers monitor driver progress.\u003c/p\u003e\n"],["\u003cp\u003eBefore using the SDK, enable the Maps JavaScript API and set up authorization, which in low-trust environments like browsers requires JSON Web Tokens (JWTs) issued by your server.\u003c/p\u003e\n"],["\u003cp\u003eServer-side authorization involves your backend issuing JWTs signed by a service account, while client-side authorization uses an authorization token fetcher within the JavaScript Consumer SDK to request and manage these tokens.\u003c/p\u003e\n"],["\u003cp\u003eYou must create an authorization token fetcher that retrieves a token and its expiry time from your server, ensuring secure access to Fleet Engine data for your web application.\u003c/p\u003e\n"]]],["The JavaScript Consumer SDK allows consumer apps to display vehicle locations from Fleet Engine on a web map. Setup involves enabling the Maps JavaScript API and configuring authorization. Fleet Engine uses JSON Web Tokens (JWTs) for API calls. A backend server must issue JWTs, which the client-side uses for authenticated requests. An authorization token fetcher, created by developers, retrieves JWTs from the server when needed. The fetcher must return a `token` and its `expiresInSeconds`.\n"],null,["Select platform: [Android](/maps/documentation/mobility/journey-sharing/on-demand/android/setup \"View this page for the Android platform docs.\") [iOS](/maps/documentation/mobility/journey-sharing/on-demand/ios/setup \"View this page for the iOS platform docs.\") [JavaScript](/maps/documentation/mobility/journey-sharing/on-demand/javascript/setup \"View this page for the JavaScript platform docs.\")\n\n\u003cbr /\u003e\n\nWith the JavaScript Consumer SDK, your consumer app can show the location of\nvehicles and other locations of interest tracked in Fleet Engine on a web-based\nmap. This allows your consumers to see the progress of the driver's journey.\nThis guide assumes you have set up Fleet Engine with its associated Google Cloud\nproject and API keys. See [Fleet Engine](/maps/documentation/mobility/fleet-engine) for details.\n\nYou set up the JavaScript Consumer SDK following these steps:\n\n1. [Enable the Maps JavaScript API](#enable-api)\n2. [Set up authorization](#set-up-auth)\n\nEnable the Maps JavaScript API\n\nEnable the Maps JavaScript API in the Google Cloud Console. For more details,\nsee [Enable APIs](https://cloud.google.com/apis/docs/getting-started#enabling_apis) in the Google Cloud documentation. This enables the\nConsumer SDK for JavaScript.\n\nSet up authorization\n\nFleet Engine requires the use of **JSON Web Tokens** (JWTs) for API method calls\nfrom **low-trust environments**: smartphones and browsers.\n\nA JWT originates on your server, is signed, encrypted, and passed to the client\nfor subsequent server interactions until it expires or is no longer valid.\n\n**Key details**\n\n- Use [Application Default Credentials](https://google.aip.dev/auth/4110) to authenticate and authorize against Fleet Engine.\n- Use an appropriate service account to sign JWTs. See [Fleet Engine serviceaccount](/maps/documentation/mobility/fleet-engine/essentials/set-up-fleet/service-accounts#fleet_engine_service_account_roles) roles in **Fleet Engine Basics**.\n\nHow does authorization work?\n\nAuthorization with Fleet Engine data involves both server-side and client-side\nimplementation.\n\nServer-side authorization\n\nBefore you set up authentication and authorization in your web-based\napplication, your backend server must be able to issue JSON Web Tokens to your\nweb-based application for access to Fleet Engine. Your web-based application\nsends these JWTs with its requests so Fleet Engine recognizes the requests as\nauthenticated and authorized to access the data in the\nrequest. For instructions on server-side JWT implementation, see [Issue JSON Web\nTokens](/maps/documentation/mobility/fleet-engine/essentials/set-up-fleet/issue-jwt) under **Fleet Engine Essentials**.\nSpecifically, keep in mind the following for the JavaScript Consumer SDK for sharing trip progress:\n\n\u003cbr /\u003e\n\n- [General guidelines](/maps/documentation/mobility/fleet-engine/essentials/set-up-fleet/issue-jwt#general_guidelines) for issuing JSON Web Tokens\n- [On-demand trips JWT guidelines](/maps/documentation/mobility/fleet-engine/essentials/set-up-fleet/issue-jwt#for_on-demand_trips)\n- [Example token for a consumer operation](/maps/documentation/mobility/fleet-engine/essentials/set-up-fleet/issue-jwt#example_token_for_a_consumer_app_operation)\n\nClient-side authorization\n\nWhen you use the JavaScript Consumer SDK, it requests a token from the server using an\nauthorization token fetcher. It does this when any of the following is true:\n\n- No valid token exists, such as when the SDK hasn't called the fetcher on a\n fresh page load, or when the fetcher hasn't returned with a token.\n\n- The token has expired.\n\n- The token is within one minute of expiring.\n\nOtherwise, the JavaScript Consumer SDK uses the previously-issued, valid token and does not\ncall the fetcher.\n\nCreate an authorization token fetcher\n\nCreate your authorization token fetcher using these guidelines:\n\n- **The fetcher must return a data structure with two fields** , wrapped in a\n `Promise` as follows:\n\n - A string `token`.\n\n - A number `expiresInSeconds`. A token expires in this amount of time\n after fetching. The authentication token fetcher must pass the expiry\n time in seconds, from the time of fetching to the library as shown in\n the example.\n\n- **The fetcher should call a URL on your server** to retrieve a token. This\n URL--the `SERVER_TOKEN_URL`--depends on your backend implementation. The\n following example URL is for the [sample app backend on GitHub](https://github.com/googlemaps/last-mile-fleet-solution-samples/tree/main/backend):\n\n - `https://SERVER_URL/token/consumer/TRIPID`\n\nExample -- Create an authentication token fetcher\n\nThe following examples show how to create an authorization token fetcher: \n\nJavaScript \n\n async function authTokenFetcher(options) {\n // options is a record containing two keys called\n // serviceType and context. The developer should\n // generate the correct SERVER_TOKEN_URL and request\n // based on the values of these fields.\n const response = await fetch(SERVER_TOKEN_URL);\n if (!response.ok) {\n throw new Error(response.statusText);\n }\n const data = await response.json();\n return {\n token: data.Token,\n expiresInSeconds: data.ExpiresInSeconds\n };\n }\n\nTypeScript \n\n function authTokenFetcher(options: {\n serviceType: google.maps.journeySharing.FleetEngineServiceType,\n context: google.maps.journeySharing.AuthTokenContext,\n }): Promise\u003cgoogle.maps.journeySharing.AuthToken\u003e {\n // The developer should generate the correct\n // SERVER_TOKEN_URL based on options.\n const response = await fetch(SERVER_TOKEN_URL);\n if (!response.ok) {\n throw new Error(response.statusText);\n }\n const data = await response.json();\n return {\n token: data.token,\n expiresInSeconds: data.ExpiresInSeconds,\n };\n }\n\nWhat's next\n\n[Follow a trip in JavaScript](/maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey)"]]