יצירת קישורים דינמיים באמצעות ה-API ל-REST

אפשר ליצור קישורים מקוצרים Dynamic Links באמצעות Firebase Dynamic Links REST API. ה-API הזה מקבל מחרוזת ארוכה של Dynamic Link או אובייקט שמכיל פרמטרים של Dynamic Link, ומחזיר כתובת URL כמו בדוגמה הבאה:

https://example.page.link/WXYZ

סרטוני Shorts באורך Dynamic Links שנוצרו באמצעות ה-API וערכת הלקוח (Android/Apple) SDK לא מופיעים במסוף Firebase. Dynamic Links כאלה מיועדים לשיתוף בין משתמשים. לתרחישי שימוש שיווקיים, אפשר להמשיך ליצור קישורים ישירות דרך הדף Dynamic Links במסוף Firebase.

לפני שמתחילים

  1. מקבלים את מפתח ה-API. כדי לאמת את הבקשות שלכם ל-API, תצטרכו מפתח API. כדי למצוא את מפתח ה-API:
    1. פותחים את דף ההגדרות של מסוף Firebase. אם מוצגת בקשה לבחור פרויקט, בוחרים את פרויקט Firebase מהתפריט.
    2. רושמים את הערך של השדה מפתח API לאתר.
  2. במסוף Firebase, פותחים את הקטע Dynamic Links.

  3. אם עדיין לא אישרתם את התנאים וההגבלות והגדרתם דומיין ל-Dynamic Links, תתבקשו לעשות זאת.

    אם כבר יש לכם דומיין Dynamic Links, כדאי לרשום אותו. כשיוצרים Dynamic Links באופן פרוגרמטי, צריך לספק דומיין Dynamic Links.

אפשר להשתמש ב-Firebase Dynamic Links API כדי לקצר כתובת URL ארוכה Dynamic Link. כדי לעשות זאת, שולחים בקשת HTTP POST לנקודת הקצה shortLinks ומציינים את הערך הארוך Dynamic Link בפרמטר longDynamicLink. לדוגמה:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
   "longDynamicLink": "https://example.page.link/?link=https://www.example.com/&apn=com.example.android&ibi=com.example.ios"
}

במאמר יצירת כתובת URL באופן ידני מוסבר איך ליצור כתובות URL ארוכות של Dynamic Links.

אפשר גם ליצור קיצור דרך ל-Dynamic Link על ידי ציון הפרמטרים של Dynamic Link ישירות. כדי לעשות זאת, שולחים בקשת HTTP POST לנקודת הקצה shortLinks, ומציינים את הפרמטרים Dynamic Link בפרמטר dynamicLinkInfo. לדוגמה:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
  "dynamicLinkInfo": {
    "domainUriPrefix": "https://example.page.link",
    "link": "https://www.example.com/",
    "androidInfo": {
      "androidPackageName": "com.example.android"
    },
    "iosInfo": {
      "iosBundleId": "com.example.ios"
    }
  }
}

מפרט מלא של אובייקט dynamicLinkInfo זמין בחומר העזר בנושא API.

הגדרת האורך של סרטון Shorts Dynamic Link

אפשר גם להגדיר את הפרמטר suffix כדי לציין איך רכיב הנתיב של כתובת ה-URL הקצרה Dynamic Link נוצר.

כברירת מחדל, או אם מגדירים את הפרמטר לערך "UNGUESSABLE", רכיב הנתיב יהיה מחרוזת של 17 תווים, כמו בדוגמה הבאה:

https://example.page.link/UVWXYZuvwxyz12345

מחרוזות כאלה נוצרות על ידי קידוד base62 של מספרים אקראיים בני 96 ביט. ההגדרה הזו מאפשרת למנוע ניחוש וסריקה של כתובות URL של Dynamic Links, פעולות שעלולות לחשוף מידע רגיש לנמענים לא מכוונים.

אם מגדירים את הפרמטר ל-"SHORT", רכיב הנתיב יהיה מחרוזת באורך המינימלי של 4 תווים, שייקבע לפי האורך שנדרש כדי שהמחרוזת תהיה ייחודית.

https://example.page.link/WXYZ

משתמשים בשיטה הזו אם מידע רגיש לא ייחשף אם מישהו ינחש כתובת URL קצרה של Dynamic Link האתר.

בדוגמה הבאה אפשר לראות איך מגדירים את הפרמטר suffix:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
   "longDynamicLink": "https://example.page.link/?link=http://www.example.com/&apn=com.example.android&ibi=com.example.ios",
   "suffix": {
     "option": "UNGUESSABLE"
   }
}

לפחות, ערך קישור העומק שצוין חייב להתחיל בסכימות http:// ‎ או https:// ‎. היא צריכה גם להתאים לכל תבנית של כתובת URL שנוספה לרשימת ההיתרים במסוף. אחרת, ה-API ליצירה ייכשל עם קוד שגיאת HTTP 400.

השלבים הבאים

אחרי שיצרתם את Dynamic Links, צריך להגדיר את האפליקציה כך שתקבל Dynamic Links ותפנה את המשתמשים למקום הנכון באפליקציה אחרי שהם יפתחו אותם.

כדי לקבל Dynamic Links באפליקציה, אפשר לעיין במסמכים בנושא iOS,‏ Android,‏ C++‎ ו-Unity.

הבקשות מוגבלות ל-5 בקשות לכל כתובת IP לשנייה, ול-200,000 בקשות ביום. אם חורגים מהמכסה, בתגובה יוחזר קוד שגיאת HTTP‏ 429. כדי לבקש מכסה נוספת, צריך למלא את הטופס הזה.