مرجع واجهة برمجة التطبيقات للارتباطات الديناميكية لـ Firebase

يمكنك استخدام 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 .

الرابط الذي سيفتحه تطبيقك. حدد عنوان URL الذي يمكن لتطبيقك التعامل معه، وهو عادةً محتوى التطبيق أو حمولة التطبيق، والذي يبدأ منطقًا خاصًا بالتطبيق (مثل إضافة قسيمة إلى المستخدم أو عرض شاشة ترحيب). يجب أن يكون هذا الرابط عنوان URL منسقًا بشكل جيد، وأن يكون مشفرًا لعنوان URL بشكل صحيح، وأن يستخدم إما HTTP أو HTTPS، ولا يمكن أن يكون رابطًا ديناميكيًا آخر.

لاحقة

يحدد كيفية إنشاء مكون المسار لارتباط ديناميكي قصير. بشكل افتراضي، تقوم روابط Firebase الديناميكية بإنشاء لاحقات سلسلة مكونة من 17 حرفًا.

قم بتعيين المعلمة على { "option": "SHORT" } لإنشاء سلاسل المسار التي تكون فقط بالقدر المطلوب لتكون فريدة، مع الحد الأدنى لطول 4 أحرف. استخدم هذه الطريقة إذا لم يتم الكشف عن المعلومات الحساسة إذا تم تخمين عنوان URL قصير للارتباط الديناميكي.

احذف هذه المعلمة أو قم بتعيين المعلمة على { "option": "UNGUESSABLE" } لتقصير المسار إلى سلسلة لا يمكن تخمينها. يتم إنشاء هذه السلاسل عن طريق ترميز Base62 بأرقام 96 بت التي تم إنشاؤها عشوائيًا، وتتكون من 17 حرفًا أبجديًا رقميًا. استخدم سلاسل لا يمكن تخمينها لمنع الزحف إلى الارتباطات الديناميكية الخاصة بك، مما قد يؤدي إلى كشف معلومات حساسة.

معلمات أندرويد
androidPackageName اسم حزمة تطبيق Android المطلوب استخدامه لفتح الرابط. يجب أن يكون التطبيق متصلاً بمشروعك من صفحة النظرة العامة في وحدة تحكم Firebase. مطلوب للارتباط الديناميكي لفتح تطبيق Android.
androidFallbackLink الرابط الذي سيتم فتحه عندما لا يكون التطبيق مثبتًا. حدد هذا للقيام بشيء آخر غير تثبيت تطبيقك من متجر Play عندما لا يكون التطبيق مثبتًا، مثل فتح إصدار الويب للجوال من المحتوى، أو عرض صفحة ترويجية لتطبيقك.
androidMinPackageVersionCode versionCode الخاص بالإصدار الأدنى لتطبيقك الذي يمكنه فتح الرابط. إذا كان التطبيق المثبت إصدارًا أقدم، فسيتم نقل المستخدم إلى متجر Play لترقية التطبيق.
معلمات دائرة الرقابة الداخلية
iosBundleId معرف الحزمة لتطبيق iOS المراد استخدامه لفتح الرابط. يجب أن يكون التطبيق متصلاً بمشروعك من صفحة النظرة العامة في وحدة تحكم Firebase. مطلوب للارتباط الديناميكي لفتح تطبيق iOS.
iosFallbackLink الرابط الذي سيتم فتحه عندما لا يكون التطبيق مثبتًا. حدد هذا للقيام بشيء آخر غير تثبيت تطبيقك من App Store عندما لا يكون التطبيق مثبتًا، مثل فتح إصدار الويب للجوال من المحتوى، أو عرض صفحة ترويجية لتطبيقك.
iosCustomScheme نظام عنوان URL المخصص لتطبيقك، إذا تم تعريفه على أنه شيء آخر غير معرف حزمة تطبيقك
iosIpadFallbackLink الرابط الذي سيتم فتحه على أجهزة iPad عندما لا يكون التطبيق مثبتًا. حدد هذا للقيام بشيء آخر غير تثبيت تطبيقك من App Store عندما لا يكون التطبيق مثبتًا، مثل فتح إصدار الويب من المحتوى، أو عرض صفحة ترويجية لتطبيقك.
iosIpadBundleId معرف حزمة تطبيق iOS المراد استخدامه على أجهزة iPad لفتح الرابط. يجب أن يكون التطبيق متصلاً بمشروعك من صفحة النظرة العامة في وحدة تحكم Firebase.
iosAppStoreId معرف متجر التطبيقات الخاص بتطبيقك، والذي يُستخدم لإرسال المستخدمين إلى متجر التطبيقات عندما لا يكون التطبيق مثبتًا
معلمات التنقل
تمكينForcedRedirect إذا تم التعيين على "1"، فتخطى صفحة معاينة التطبيق عند فتح الرابط الديناميكي، وأعد التوجيه بدلاً من ذلك إلى التطبيق أو المتجر. يمكن لصفحة معاينة التطبيق (التي يتم تمكينها افتراضيًا) إرسال المستخدمين بشكل أكثر موثوقية إلى الوجهة الأكثر ملاءمة عند فتح الروابط الديناميكية في التطبيقات؛ ومع ذلك، إذا كنت تتوقع أن يتم فتح الارتباط الديناميكي فقط في التطبيقات التي يمكنها فتح الارتباطات الديناميكية بشكل موثوق بدون هذه الصفحة، فيمكنك تعطيله باستخدام هذه المعلمة. ستؤثر هذه المعلمة على سلوك الارتباط الديناميكي على نظام iOS فقط.
معلمات العلامة التعريفية الاجتماعية
socialTitle العنوان الذي سيتم استخدامه عند مشاركة الارتباط الديناميكي في منشور اجتماعي.
SocialDescription الوصف الذي سيتم استخدامه عند مشاركة الارتباط الديناميكي في منشور اجتماعي.
SocialImageLink عنوان URL للصورة المرتبطة بهذا الرابط.
معلمات التحليلات
utmSource
utmMedium
utmCampaign
utmTerm
utmContent
معلمات تحليلات Google Play.
في
ط م
جبل
نقطة
معلمات تحليلات iTunes Connect.

هيئة الاستجابة

الاستجابة للطلب هي كائن JSON كما يلي:

{
  "shortLink": string,
  "previewLink": string
}
حقول الاستجابة
رابط قصير الارتباط الديناميكي القصير الذي تم إنشاؤه.
رابط المعاينة رابط إلى مخطط انسيابي لسلوك الارتباط الديناميكي.