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

يمكنك استخدام واجهة برمجة تطبيقات REST هذه لإنشاء Dynamic Links مختصر. الاطّلاع على دليل المطوِّر لبدء استخدامها

طلب HTTP

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

request_body

نص الطلب

يبدو نص الطلب أيًا مما يلي، بناءً على ما إذا كنت تريد لتحديد معلَمات Dynamic Link على أنّها Dynamic Link طويلة أو ككائن JSON.

لتحديد معلَمات Dynamic Link على أنّها Dynamic Link طويلة:

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

لتحديد مَعلمات Dynamic Link ككائن 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 . النطاق Dynamic Links لمشروعك على Firebase يمكنك العثور على هذه القيمة في قسم "Dynamic Links" من وحدة تحكّم Firebase.
الرابط مطلوب في حال عدم ضبط قيمة في longDynamicLink .

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

تحدِّد هذه السياسة كيفية إنشاء مكوّن مسار في Dynamic Link مختصر. من تلقائيًا، تنشئ Firebase Dynamic Links لاحقات سلاسل مكوّنة من 17 حرفًا.

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

احذف هذه المعلمة أو اضبط المعلمة على { "option": "UNGUESSABLE" } لتقصير المسار إلى سلسلة لا يمكن تخمينها. يتمّ إنشاء مثل هذه السلاسل من خلال ترميز base62 عشوائيًا. يتم إنشاء أرقام بتنسيق 96 بت، وتتألف من 17 حرفًا أبجديًا رقميًا. استخدام سلاسل لا يمكن تخمينها لمنع الزحف إلى Dynamic Links، والتي يكشف عن معلومات حساسة.
مَعلمات Android
اسم الحزمة android اسم حزمة تطبيق Android التي تريد استخدامها لفتح الرابط. يجب ربط التطبيق بمشروعك من صفحة النظرة العامة في وحدة تحكّم Firebase. هذا الإجراء مطلوب لـ Dynamic Link لفتح تطبيق Android.
رابط androidFallbackLink الرابط الذي يتم فتحه عندما لا يكون التطبيق مثبَّتًا. حدِّد هذا الإجراء لتنفيذ إجراء آخر غير تثبيت التطبيق من "متجر Play" إذا كان التطبيق غير مثبَّت، مثل فتح إصدار الويب على الأجهزة الجوّالة من المحتوى أو عرض صفحة ترويجية لتطبيقك.
رمز androidMinPackageVersionCode تمثّل هذه السمة versionCode من الحد الأدنى لإصدار التطبيق الذي يمكنه فتح الرابط. إذا كان التطبيق المُثبَّت إصدارًا قديمًا، يتم نقل المستخدم إلى "متجر Play" لترقية التطبيق.
مَعلمات iOS
معرّف iosBundle رقم تعريف الحزمة الخاص بتطبيق iOS والمطلوب استخدامه لفتح الرابط. يجب ربط التطبيق بمشروعك من صفحة النظرة العامة في وحدة تحكّم Firebase. مطلوب ليتمكّن Dynamic Link من فتح تطبيق iOS.
رابط iosFallbackLink الرابط الذي يتم فتحه عندما لا يكون التطبيق مثبَّتًا. حدِّد هذا الإجراء لتنفيذ إجراء آخر غير تثبيت التطبيق من App Store إذا كان التطبيق غير مُثبَّت، مثل فتح إصدار الويب المتوافق مع الأجهزة الجوّالة من المحتوى أو عرض صفحة ترويجية لتطبيقك.
نظام iOSCustomScheme مخطَّط عنوان URL المخصّص لتطبيقك، إذا تم تحديده على أنّه يختلف عن معرّف حزمة التطبيق
iosIpadFallbackLink الرابط الذي يتم فتحه على أجهزة iPad عندما يكون التطبيق غير مثبَّت. حدِّد هذا الإجراء لتنفيذ إجراء آخر غير تثبيت تطبيقك من App Store في حال عدم تثبيت التطبيق، مثل فتح إصدار الويب من المحتوى أو عرض صفحة ترويجية لتطبيقك.
iosIpadBundleId رقم تعريف الحزمة الخاص بتطبيق iOS والمطلوب استخدامه على أجهزة iPad لفتح الرابط يجب ربط التطبيق بمشروعك من صفحة النظرة العامة في وحدة تحكّم Firebase.
رقم تعريف iosAppStore رقم تعريف تطبيقك على App Store، يُستخدَم لتوجيه المستخدمين إلى App Store عند عدم تثبيت التطبيق
معلمات التنقّل
EnableForcedredirect (إعادة توجيه) في حال الضبط على "1"، يمكنك تخطّي صفحة معاينة التطبيق عند فتح "Dynamic Link"، وإعادة التوجيه إلى التطبيق أو المتجر بدلاً من ذلك. يمكن لصفحة معاينة التطبيق (المفعَّلة تلقائيًا) توجيه المستخدمين إلى الوجهة الأكثر ملاءمةً عند فتح Dynamic Links في التطبيقات. ومع ذلك، إذا كنت تتوقع أن يتم فتح Dynamic Link فقط في التطبيقات التي يمكنها فتح Dynamic Links بشكل موثوق بدون هذه الصفحة، يمكنك إيقافها باستخدام هذه المعلَمة. ستؤثر هذه المَعلمة في سلوك Dynamic Link على نظام التشغيل iOS فقط.
معلمات العلامة الوصفية الاجتماعية
العنوان الاجتماعي العنوان الذي يجب استخدامه عند نشر Dynamic Link في مشاركة على الشبكات الاجتماعية.
وصف الشبكات الاجتماعية الوصف المستخدم عند نشر Dynamic Link في مشاركة على الشبكات الاجتماعية.
رابط صورة التواصل الاجتماعي تمثّل هذه السمة عنوان URL لصورة ذات صلة بهذا الرابط.
مَعلمات "إحصاءات Google"
utmSource
utmMedium
utmCampaign
utmTerm
utmContent		 مَعلمات "إحصاءات Google Play"
عند
ct
mt
نقطة		 معلَمات إحصاءات iTunes Connect

نص الاستجابة

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

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