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

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

https://example.page.link/WXYZ

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

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

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

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

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

אפשר להשתמש ב-Firebase Dynamic Links API כדי לקצר 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 באופן ידני מוסבר איך יוצרים 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 כדי לציין איך רכיב הנתיב של הקישור המקוצר Dynamic Link נוצר.

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

https://example.page.link/UVWXYZuvwxyz12345

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

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

https://example.page.link/WXYZ

מומלץ להשתמש בשיטה הזו אם מידע רגיש לא ייחשף אם מישהו יזהה כתובת 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 בקשות ליום. אם יחרגו מהמכסה, התגובה תחזיר את קוד השגיאה 429 של HTTP. כדי לבקש הגדלת מכסה, צריך למלא את הטופס הזה.