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

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

https://example.page.link/WXYZ

סרטוני Shorts ב-Dynamic Links שנוצרו באמצעות ה-API וערכת ה-SDK של הלקוח (Android או אפל) לא מופיעים במסוף 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 באופן פרוגרמטי.

אפשר להשתמש ב-API של קישורים דינמיים ב-Firebase כדי לקצר 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 ישירות. כדי לעשות את זה, שולחים בקשת 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

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