Firebase Dynamic Links Short Links API Reference

אתה יכול להשתמש ב- REST API זה כדי ליצור קישורים דינמיים קצרים. עיין במדריך למפתחים כדי להתחיל.

בקשת HTTP

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

request_body

גוף הבקשה

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

כדי לציין את הפרמטרים של קישור דינמי כקישור דינמי ארוך:

{
  "longDynamicLink": string,
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

כדי לציין את הפרמטרים של קישור דינמי כאובייקט JSON:

{
  "dynamicLinkInfo": {
    "domainUriPrefix": string,
    "link": string,
    "androidInfo": {
      "androidPackageName": string,
      "androidFallbackLink": string,
      "androidMinPackageVersionCode": string
    },
    "iosInfo": {
      "iosBundleId": string,
      "iosFallbackLink": string,
      "iosCustomScheme": string,
      "iosIpadFallbackLink": string,
      "iosIpadBundleId": string,
      "iosAppStoreId": string
    },
    "navigationInfo": {
      "enableForcedRedirect": boolean,
    },
    "analyticsInfo": {
      "googlePlayAnalytics": {
        "utmSource": string,
        "utmMedium": string,
        "utmCampaign": string,
        "utmTerm": string,
        "utmContent": string
      },
      "itunesConnectAnalytics": {
        "at": string,
        "ct": string,
        "mt": string,
        "pt": string
      }
    },
    "socialMetaTagInfo": {
      "socialTitle": string,
      "socialDescription": string,
      "socialImageLink": string
    }
  },
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

פרמטרים

כל הפרמטרים הם אופציונליים אלא אם צוין אחרת.

פרמטרים כלליים
domainUriPrefix	נדרש אם לא הגדרת ערך עבור הפרמטר longDynamicLink . תחום הקישורים הדינמיים של פרויקט Firebase שלך. אתה יכול למצוא ערך זה בקטע קישורים דינמיים של מסוף Firebase .
קישור	נדרש אם לא הגדרת ערך עבור הפרמטר longDynamicLink . הקישור שהאפליקציה שלך תיפתח. ציין כתובת אתר שהאפליקציה שלך יכולה לטפל בה, בדרך כלל התוכן או המטען של האפליקציה, אשר יוזמת היגיון ספציפי לאפליקציה (כגון זיכוי של המשתמש בקופון או הצגת מסך פתיחה). קישור זה חייב להיות כתובת אתר בפורמט היטב, מקודד כראוי של כתובת אתר, להשתמש ב-HTTP או ב-HTTPS, ולא יכול להיות קישור דינמי אחר. כאשר משתמשים פותחים קישור דינמי בדפדפן אינטרנט שולחני, הם יטענו כתובת URL זו (אלא אם צוין הפרמטר ofl ). אם אין לך אינטרנט שווה ערך לתוכן המקושר, כתובת האתר לא צריכה להצביע על משאב אינטרנט חוקי. במצב זה, עליך להגדיר הפניה מכתובת אתר זו, למשל, לדף הבית שלך.
סִיוֹמֶת	מציין כיצד ליצור את רכיב הנתיב של קישור דינמי קצר. כברירת מחדל, Firebase Dynamic Links מייצר סיומות מחרוזות של 17 תווים. הגדר את הפרמטר ל- { "option": "SHORT" } כדי ליצור מחרוזות נתיב ארוכות רק ככל הנדרש כדי להיות ייחודיות, באורך מינימלי של 4 תווים. השתמש בשיטה זו אם מידע רגיש לא ייחשף אם תנחש כתובת אתר קצרה של קישור דינמי. השמט פרמטר זה או הגדר את הפרמטר ל- { "option": "UNGUESSABLE" } כדי לקצר את הנתיב למחרוזת בלתי ניתנת לניחוש. מחרוזות כאלה נוצרות על ידי קידוד base62 שנוצרו באקראי של מספרים של 96 סיביות, ומורכבות מ-17 תווים אלפאנומריים. השתמש במחרוזות שלא ניתן לנחש כדי למנוע את סריקת הקישורים הדינמיים שלך, שעלולים לחשוף מידע רגיש.

פרמטרים של אנדרואיד
androidPackageName	שם החבילה של אפליקציית Android לשימוש כדי לפתוח את הקישור. האפליקציה חייבת להיות מחוברת לפרויקט שלך מדף הסקירה הכללית של מסוף Firebase. נדרש כדי שהקישור הדינמי יפתח אפליקציית אנדרואיד.
androidFallbackLink	הקישור שייפתח כאשר האפליקציה לא מותקנת. ציין זאת כדי לעשות משהו אחר מלבד התקנת האפליקציה שלך מחנות Play כאשר האפליקציה אינה מותקנת, כגון פתיחת גרסת האינטרנט לנייד של התוכן, או הצגת דף קידום מכירות עבור האפליקציה שלך.
androidMinPackageVersionCode	versionCode של הגרסה המינימלית של האפליקציה שלך שיכולה לפתוח את הקישור. אם האפליקציה המותקנת היא גרסה ישנה יותר, המשתמש מועבר לחנות Play כדי לשדרג את האפליקציה.

פרמטרים של iOS
iosBundleId	מזהה החבילה של אפליקציית iOS לשימוש לפתיחת הקישור. האפליקציה חייבת להיות מחוברת לפרויקט שלך מדף הסקירה הכללית של מסוף Firebase. נדרש כדי שהקישור הדינמי יפתח אפליקציית iOS.
iosFallbackLink	הקישור שייפתח כאשר האפליקציה לא מותקנת. ציין זאת כדי לעשות משהו אחר מלבד התקנת האפליקציה שלך מ-App Store כאשר האפליקציה לא מותקנת, כגון פתיחת גרסת האינטרנט לנייד של התוכן, או הצגת דף קידום מכירות עבור האפליקציה שלך.
iosCustomScheme	סכימת כתובת האתר המותאמת אישית של האפליקציה שלך, אם היא מוגדרת כמשהו אחר מאשר מזהה החבילה של האפליקציה שלך
iosIpadFallbackLink	הקישור לפתיחה באייפד כשהאפליקציה לא מותקנת. ציין זאת כדי לעשות משהו אחר מלבד התקנת האפליקציה שלך מ-App Store כשהאפליקציה אינה מותקנת, כגון לפתוח את גרסת האינטרנט של התוכן, או להציג דף קידום מכירות עבור האפליקציה שלך.
iosIpadBundleId	מזהה החבילה של אפליקציית iOS לשימוש באייפד לפתיחת הקישור. האפליקציה חייבת להיות מחוברת לפרויקט שלך מדף הסקירה הכללית של מסוף Firebase.
iosAppStoreId	מזהה ה-App Store של האפליקציה שלך, המשמש לשליחת משתמשים ל-App Store כאשר האפליקציה לא מותקנת

פרמטרי ניווט

enableForcedRedirect

אם מוגדר ל'1', דלג על דף התצוגה המקדימה של האפליקציה כאשר הקישור הדינמי נפתח, ובמקום זאת הפנה מחדש לאפליקציה או לחנות. דף התצוגה המקדימה של האפליקציה (מופעל כברירת מחדל) יכול לשלוח משתמשים בצורה מהימנה יותר ליעד המתאים ביותר כאשר הם פותחים קישורים דינמיים באפליקציות; עם זאת, אם אתה מצפה שקישור דינמי ייפתח רק באפליקציות שיכולות לפתוח קישורים דינמיים בצורה מהימנה ללא דף זה, תוכל להשבית אותו עם פרמטר זה. פרמטר זה ישפיע על התנהגות הקישור הדינמי רק ב-iOS.

פרמטרים של מטא תג חברתי
socialTitle	הכותרת לשימוש כאשר הקישור הדינמי משותף בפוסט חברתי.
socialDescription	התיאור לשימוש כאשר הקישור הדינמי משותף בפוסט חברתי.
socialImageLink	כתובת האתר לתמונה הקשורה לקישור הזה.

פרמטרים של אנליטיקה
utmSource utmMedium utmCampaign utmTerm utmContent	פרמטרי ניתוח של Google Play.
בְּ- ct הר pt	פרמטרי ניתוח של iTunes Connect.

גוף תגובה

התגובה לבקשה היא אובייקט JSON כמו הבא:

{
  "shortLink": string,
  "previewLink": string
}

שדות תגובה
קישור קצר	הקישור הדינמי הקצר שנוצר.
תצוגה מקדימה קישור	קישור לתרשים זרימה של התנהגות הקישור הדינמי.