يمكنك إنشاء Dynamic Links قصيرة أو طويلة باستخدام Firebase Dynamic Links Builder API. تقبل واجهة برمجة التطبيقات هذه إما Dynamic Link طويلة أو كائنًا يحتوي على معلَمات Dynamic Link، وتعرض عناوين URL كالأمثلة التالية:
https://example.com/link/WXYZ https://example.page.link/WXYZ
المتطلبات الأساسية
قبل البدء، تأكَّد من إضافة Firebase إلى مشروعك على iOS .
إعداد Firebase وحزمة تطوير البرامج (SDK) الخاصة بـ "Dynamic Links"
يمكنك استخدام "مدير حزم Swift" لتثبيت اعتماديات Firebase وإدارتها.
- في Xcode، مع فتح مشروع تطبيقك، انتقِل إلى ملف > إضافة حِزم.
- أضِف مستودع حزمة تطوير البرامج (SDK) لمنصّات Apple من Firebase عندما يُطلب منك ذلك:
- اختَر مكتبة Dynamic Links.
- أضِف العلامة
-ObjC
إلى قسم رموز ربط أخرى في إعدادات الإنشاء الخاصة بالهدف. - للحصول على تجربة مثالية مع Dynamic Links، ننصحك بتفعيل Google Analytics في مشروعك على Firebase وإضافة حزمة تطوير البرامج (SDK) لخدمة "إحصاءات Google لبرنامج Firebase" إلى تطبيقك. ويمكنك اختيار المكتبة بدون جمع معرّف جهاز IDFA أو مع جمع معرّف جهاز IDFA.
- عند الانتهاء، سيبدأ Xcode تلقائيًا في حلّ ملفاتك المضمّنة وتنزيلها في الخلفية.
https://github.com/firebase/firebase-ios-sdk.git
والآن، نفِّذ بعض خطوات الضبط:
- في وحدة تحكّم Firebase، افتح قسم Dynamic Links.
-
إذا لم يسبق لك قبول بنود الخدمة وضبط بادئة عنوان URL لـ Dynamic Links، يُرجى إجراء ذلك عندما يُطلب منك ذلك.
إذا كان لديك بادئة معرّف الموارد المنتظم (URI) Dynamic Links من قبل، يُرجى تدوينها. يجب تقديمه عند إنشاء Dynamic Links آليًا.
- إجراء يُنصح به: حدِّد أنماط عناوين URL المسموح بها في الروابط المؤدية إلى صفحات في التطبيق والروابط الاحتياطية. بهذه الطريقة، يمكنك منع الجهات غير المصرّح لها من إنشاء Dynamic Links يعيد توجيه المستخدمين من نطاقك إلى مواقع إلكترونية لا تتحكّم بها. راجِع السماح بأنماط عناوين URL معيّنة.
-
تأكَّد من تحديد رقم تعريف تطبيقك في App Store وبادئة رقم تعريف التطبيق في إعدادات تطبيقك. لعرض إعدادات تطبيقك وتعديلها، انتقِل إلى صفحة الإعدادات في مشروعك على Firebase واختَر تطبيقك المتوافق مع نظام التشغيل iOS.
تأكَّد من ضبط إعدادات مشروعك على Firebase بشكلٍ صحيح لاستخدام Dynamic Links في تطبيقك على iOS من خلال فتح ملف
apple-app-site-association
المستضاف على نطاق Dynamic Links. سيعرض Firebase الملفapple-app-site-association
من جذر النطاق بالإضافة إلى الدليل الفرعي.well-known
. على سبيل المثال:https://example.com/apple-app-site-association https://example.com/.well-known/apple-app-site-association
إذا كان تطبيقك مرتبطًا، يحتوي ملف
apple-app-site-association
على إشارة إلى بادئة معرّف التطبيق ومعرّف الحِزمة لتطبيقك. على سبيل المثال:{"applinks":{"apps":[],"details":[{"appID":"1234567890.com.example.ios","paths":["/*"]}]}}
إذا كان الحقل
details
فارغًا، تحقّق من تحديد بادئة معرّف التطبيق. يُرجى العِلم أنّ بادئة رقم تعريف التطبيق قد لا تكون مطابقة لرقم تعريف الفريق.
إضافة Firebase إلى تطبيقك
- استورِد وحدة
FirebaseCore
فيUIApplicationDelegate
، بالإضافة إلى أي وحدات Firebase أخرى يستخدمها مفوّض تطبيقك. على سبيل المثال، لاستخدام Cloud Firestore وAuthentication:واجهة المستخدم
import SwiftUI import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Swift
import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Objective-C
@import FirebaseCore; @import FirebaseFirestore; @import FirebaseAuth; // ...
- يمكنك ضبط المثيل المشترك ضمن
FirebaseApp
في طريقةapplication(_:didFinishLaunchingWithOptions:)
الخاصة بمفوَّض تطبيقك:SwiftUI
// Use Firebase library to configure APIs FirebaseApp.configure()
Swift
// Use Firebase library to configure APIs FirebaseApp.configure()
Objective-C
// Use Firebase library to configure APIs [FIRApp configure];
- إذا كنت تستخدم SwiftUI، عليك إنشاء تفويض تطبيق وإرفاقه
ببنية
App
من خلالUIApplicationDelegateAdaptor
أوNSApplicationDelegateAdaptor
. ويجب أيضًا إيقاف إيماءة تفويض التطبيق. لمزيد من المعلومات، يمكنك الاطّلاع على تعليمات SwiftUI.SwiftUI
@main struct YourApp: App { // register app delegate for Firebase setup @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate var body: some Scene { WindowGroup { NavigationView { ContentView() } } } }
استخدام وحدة تحكّم Firebase
إذا كنت تريد إنشاء Dynamic Link واحد، إما لأغراض الاختبار أو لفريقك التسويقي لإنشاء رابط بسهولة يمكن استخدامه في مشاركة على وسائل التواصل الاجتماعي مثلاً، ستكون أبسط طريقة للقيام بذلك هي الانتقال إلى وحدة تحكّم Firebase وإنشاء رابط يدويًا باتّباع الخطوات الموضّحة.
استخدام iOS Builder API
يمكنك استخدام iOS Builder API لإنشاء Dynamic Links من المَعلمات، أو لتقصير قيمة Dynamic Link طويلة.
إنشاء Dynamic Link من المَعلمات
لإنشاء Dynamic Link، أنشِئ كائن DynamicLinkComponents
جديدًا وحدِّد معلَمات Dynamic Link من خلال ضبط السمات المقابلة للعنصر. بعد ذلك، يمكنك الحصول على الرابط الطويل من السمة url
الخاصة بالكائن
أو الحصول على الرابط القصير من خلال طلب shorten()
.
في المثال الأدنى التالي، يتم إنشاء سلسلة طويلة من Dynamic Link إلى
https://www.example.com/my-page
يتم فتحها باستخدام تطبيق iOS على
iOS والتطبيق com.example.android
على Android:
Swift
guard let link = URL(string: "https://www.example.com/my-page") else { return } let dynamicLinksDomainURIPrefix = "https://example.com/link" let linkBuilder = DynamicLinkComponents(link: link, domainURIPrefix: dynamicLinksDomainURIPRefix) linkBuilder.iOSParameters = DynamicLinkIOSParameters(bundleID: "com.example.ios") linkBuilder.androidParameters = DynamicLinkAndroidParameters(packageName: "com.example.android") guard let longDynamicLink = linkBuilder.url else { return } print("The long URL is: \(longDynamicLink)")
Objective-C
NSURL *link = [[NSURL alloc] initWithString:@"https://www.example.com/my-page"]; NSString *dynamicLinksDomainURIPrefix = @"https://example.com/link"; FIRDynamicLinkComponents *linkBuilder = [[FIRDynamicLinkComponents alloc] initWithLink:link domainURIPrefix:dynamicLinksDomainURIPrefix]; linkBuilder.iOSParameters = [[FIRDynamicLinkIOSParameters alloc] initWithBundleID:@"com.example.ios"]; linkBuilder.androidParameters = [[FIRDynamicLinkAndroidParameters alloc] initWithPackageName:@"com.example.android"]; NSLog(@"The long URL is: %@", linkBuilder.url);
لإنشاء Dynamic Link قصير، أنشئ DynamicLinkComponents
بالطريقة نفسها، ثم اتصل بـ shorten()
.
يتطلب إنشاء رابط قصير طلبًا من الشبكة، لذا بدلاً من عرض الرابط مباشرةً، يقبل shorten()
معالجًا لإكمال الإجراء، والذي يتم استدعاؤه عند اكتمال الطلب. على سبيل المثال:
Swift
linkBuilder.shorten() { url, warnings, error in guard let url = url, error != nil else { return } print("The short URL is: \(url)") }
Objective-C
[linkBuilder shortenWithCompletion:^(NSURL * _Nullable shortURL, NSArray<NSString *> * _Nullable warnings, NSError * _Nullable error) { if (error || shortURL == nil) { return; } NSLog(@"The short URL is: %@", shortURL); }];
يتم تلقائيًا إنشاء النوع Dynamic Links القصير باستخدام لاحقات روابط مكوّنة من 17 حرفًا، ما يجعل من غير المرجّح على الإطلاق أن يتمكّن مستخدم من تخمين قيمة Dynamic Link صالحة. إذا كان هناك حالة استخدام تسمح بنجاح أحد المستخدمين في تخمين رابط قصير،
قد تفضّل إنشاء لاحقات لا تزيد عن الطول اللازم لتكون
فريدة، ويمكنك إجراء ذلك من خلال ضبط السمة
dynamicLinkComponentsOptions
:
Swift
linkBuilder.options = DynamicLinkComponentsOptions() linkBuilder.options.pathLength = .short linkBuilder.shorten() { url, warnings, error in guard let url = url, error != nil else { return } print("The short URL is: \(url)") }
Objective-C
linkBuilder.dynamicLinkComponentsOptions = [[FIRDynamicLinkComponentsOptions alloc] init]; linkBuilder.dynamicLinkComponentsOptions.pathLength = FIRShortDynamicLinkPathLengthShort; [linkBuilder shortenWithCompletion:^(NSURL * _Nullable shortURL, NSArray<NSString *> * _Nullable warnings, NSError * _Nullable error) { if (error || shortURL == nil) { return; } NSLog(@"The short URL is: %@", shortURL); }];
مَعلمات Dynamic Link
يمكنك استخدام Dynamic Link Builder API لإنشاء Dynamic Links باستخدام أي من المَعلمات المتوافقة. يمكنك الاطّلاع على مرجع واجهة برمجة التطبيقات للحصول على التفاصيل.
ينشئ المثال التالي Dynamic Link يتضمّن عدة مَعلمات شائعة تمّ ضبطها:
Swift
guard let link = URL(string: "https://www.example.com/my-page") else { return } let dynamicLinksDomainURIPrefix = "https://example.com/link" let linkBuilder = DynamicLinkComponents(link: link, domainURIPRefix: dynamicLinksDomainURIPrefix) linkBuilder.iOSParameters = DynamicLinkIOSParameters(bundleID: "com.example.ios") linkBuilder.iOSParameters.appStoreID = "123456789" linkBuilder.iOSParameters.minimumAppVersion = "1.2.3" linkBuilder.androidParameters = DynamicLinkAndroidParameters(packageName: "com.example.android") linkBuilder.androidParameters.minimumVersion = 123 linkBuilder.analyticsParameters = DynamicLinkGoogleAnalyticsParameters(source: "orkut", medium: "social", campaign: "example-promo") linkBuilder.iTunesConnectParameters = DynamicLinkItunesConnectAnalyticsParameters() linkBuilder.iTunesConnectParameters.providerToken = "123456" linkBuilder.iTunesConnectParameters.campaignToken = "example-promo" linkBuilder.socialMetaTagParameters = DynamicLinkSocialMetaTagParameters() linkBuilder.socialMetaTagParameters.title = "Example of a Dynamic Link" linkBuilder.socialMetaTagParameters.descriptionText = "This link works whether the app is installed or not!" linkBuilder.socialMetaTagParameters.imageURL = "https://www.example.com/my-image.jpg" guard let longDynamicLink = linkBuilder.url else { return } print("The long URL is: \(longDynamicLink)")
Objective-C
NSURL *link = [[NSURL alloc] initWithString:@"https://www.example.com/my-page"]; NSString *dynamicLinksDomainURIPrefix = @"https://example.com/link"; FIRDynamicLinkComponents *linkBuilder = [[FIRDynamicLinkComponents alloc] initWithLink:link domainURIPrefix:dynamicLinksDomainURIPrefix]; linkBuilder.iOSParameters = [[FIRDynamicLinkIOSParameters alloc] initWithBundleID:@"com.example.ios"]; linkBuilder.iOSParameters.appStoreID = @"123456789"; linkBuilder.iOSParameters.minimumAppVersion = @"1.2.3"; linkBuilder.androidParameters = [[FIRDynamicLinkAndroidParameters alloc] initWithPackageName:@"com.example.android"]; linkBuilder.androidParameters.minimumVersion = 123; linkBuilder.analyticsParameters = [[FIRDynamicLinkGoogleAnalyticsParameters alloc] initWithSource:@"orkut" medium:@"social" campaign:@"example-promo"]; linkBuilder.iTunesConnectParameters = [[FIRDynamicLinkItunesConnectAnalyticsParameters alloc] init]; linkBuilder.iTunesConnectParameters.providerToken = @"123456"; linkBuilder.iTunesConnectParameters.campaignToken = @"example-promo"; linkBuilder.socialMetaTagParameters = [[FIRDynamicLinkSocialMetaTagParameters alloc] init]; linkBuilder.socialMetaTagParameters.title = @"Example of a Dynamic Link"; linkBuilder.socialMetaTagParameters.descriptionText = @"This link works whether the app is installed or not!"; linkBuilder.socialMetaTagParameters.imageURL = @"https://www.example.com/my-image.jpg"; NSLog(@"The long URL is: %@", linkBuilder.url);
يمكنك ضبط مَعلمات Dynamic Link باستخدام العناصر والسمات التالية:
مكونات DynamicLink | |
---|---|
الرابط |
الرابط الذي سيفتحه تطبيقك عليك تحديد عنوان URL يمكن لتطبيقك التعامل معه، وعادةً ما يكون محتوى التطبيق أو حمولة البيانات التي تبدأ منطقًا خاصًا بالتطبيق (مثل إضافة قسيمة إلى المستخدم أو عرض شاشة ترحيب). يجب أن يكون هذا الرابط عنوان URL بتنسيق جيد، وأن يكون بترميز عنوان URL صحيح، وأن يستخدم إما HTTP أو HTTPS، ولا يمكن أن يكون رابطًا ديناميكيًا آخر. |
domainURIPrefix | بادئة عنوان URL للسمة Dynamic Link، والتي يمكنك العثور عليها في وحدة التحكّم Firebase. يظهر
نطاق Dynamic Link على النحو التالي:
https://example.com/link https://example.page.link |
مَعلمات DynamicLinkAndroid | |
---|---|
عنوان URL الاحتياطي | الرابط الذي يتم فتحه عندما لا يكون التطبيق مثبَّتًا. حدِّد هذا الإجراء لتنفيذ إجراء آخر غير تثبيت التطبيق من "متجر Play" إذا كان التطبيق غير مثبَّت، مثل فتح إصدار الويب على الأجهزة الجوّالة من المحتوى أو عرض صفحة ترويجية لتطبيقك. |
الحد الأدنى للإصدار | تمثّل هذه السمة versionCode من الحد الأدنى لإصدار التطبيق الذي يمكنه فتح الرابط. إذا كان التطبيق المُثبَّت إصدارًا قديمًا، يتم نقل المستخدم إلى "متجر Play" لترقية التطبيق. |
مَعلمات DynamicLinkIOS | |
---|---|
رقم تعريف AppStoreID | رقم تعريف تطبيقك على App Store، يُستخدَم لتوجيه المستخدمين إلى App Store عند عدم تثبيت التطبيق |
عنوان URL الاحتياطي | الرابط الذي يتم فتحه عندما لا يكون التطبيق مثبَّتًا. حدِّد هذا الإجراء لتنفيذ إجراء آخر غير تثبيت تطبيقك من App Store عندما لا يكون التطبيق مثبّتًا، مثل فتح إصدار الويب المتوافق مع الأجهزة الجوّالة من المحتوى أو عرض صفحة ترويجية لتطبيقك. |
customScheme | مخطّط عنوان URL المخصّص لتطبيقك، إذا تم تحديده ليكون شيئًا آخر غير معرّف حزمة تطبيقك |
عنوان iPadFallbackURL | الرابط الذي يتم فتحه على أجهزة iPad عندما يكون التطبيق غير مثبَّت. حدِّد هذا الإجراء لتنفيذ إجراء آخر غير تثبيت تطبيقك من App Store في حال عدم تثبيت التطبيق، مثل فتح إصدار الويب من المحتوى أو عرض صفحة ترويجية لتطبيقك. |
معرِّف الحِزمة iPadBundleID | رقم تعريف حزمة تطبيق iOS المطلوب استخدامه على أجهزة iPad لفتح الرابط يجب ربط التطبيق بمشروعك من صفحة النظرة العامة في وحدة تحكّم Firebase. |
الحد الأدنى من AppVersion | رقم الإصدار من أدنى إصدار من تطبيقك يمكنه فتح الرابط. يتم تمرير هذا العلامة إلى تطبيقك عند فتحه، وعلى تطبيقك تحديد الإجراء الذي يجب اتّخاذه بشأنها. |
DynamicLinkNavigationInfoParameters | |
---|---|
forcedRedirectEnabled | في حال ضبط القيمة على "1"، سيتم تخطّي صفحة معاينة التطبيق عند فتح Dynamic Link، وسيتم بدلاً من ذلك إعادة التوجيه إلى التطبيق أو المتجر. يمكن لصفحة معاينة التطبيق (المفعَّلة تلقائيًا) أن تنقل المستخدمين بشكل أكثر موثوقية إلى الوجهة الأكثر ملاءمةً عند فتح Dynamic Links في التطبيقات، ومع ذلك، إذا كنت تتوقع أن يتم فتح Dynamic Link فقط في التطبيقات التي يمكنها فتح Dynamic Links بشكل موثوق بدون هذه الصفحة، يمكنك إيقافها باستخدام هذه المَعلمة. ستؤثر هذه المَعلمة في سلوك Dynamic Link على نظام التشغيل iOS فقط. |
DynamicLinkSocialMetaTagParameters | |
---|---|
العنوان | العنوان الذي يجب استخدامه عند نشر Dynamic Link في مشاركة على الشبكات الاجتماعية. |
descriptionText | الوصف المستخدم عند نشر Dynamic Link في مشاركة على الشبكات الاجتماعية. |
imageURL (عنوان URL للصورة) | تمثّل هذه السمة عنوان URL لصورة ذات صلة بهذا الرابط. يجب أن تكون الصورة بحجم 300×200 بكسل على الأقل وبحجم أقل من 300 كيلوبايت. |
DynamicLinkGoogleAnalyticsParameters | |
---|---|
source medium campaign term content |
مَعلمات إحصاءات Google Play يتم تمرير هذه المعلمات
(utm_source وutm_medium
وutm_campaign وutm_term وutm_content )
إلى "متجر Play" ويتم إلحاقها بحمولة الروابط.
|
DynamicLinkItunesConnectAnalyticsparameters | |
---|---|
providerToken affiliateToken campaignToken |
مَعلمات إحصاءات iTunes Connect يتمّ تمرير هذه المَعلمات (pt
at ، ct ) إلى App Store. |
تقصير Dynamic Link طويل
لتقصير Dynamic Link طويل، مرِّر Dynamic Link الطويل إلى
shortenURL(url:options:)
مع عنصر
DynamicLinkComponentsOptions
إذا كنت تريد إنشاء
رابط بلاحقة قصيرة:
Swift
DynamicLinkComponents.shortenURL(url: longLinkUrl, options: nil) { url, warnings, error in guard let url = url, error != nil else { return } print("The short URL is: \(url)") }
Objective-C
[FIRDynamicLinkComponents shortenURL:longLinkUrl options:nil completion:^(NSURL * _Nullable shortURL, NSArray<NSString *> * _Nullable warnings, NSError * _Nullable error) { if (error || shortURL == nil) { return; } NSLog(@"The short URL is: %@", shortURL); }];
تحديد مخطّط عنوان URL مخصّص لـ Dynamic Links
يستخدم Dynamic Links تلقائيًا معرِّف حِزمة تطبيقك باعتباره مخطط عنوان URL المطلوب لفتح تطبيقك. ننصحك بالاعتماد على هذه القيمة التلقائية لتبسيط عملية التنفيذ.
ومع ذلك، قد يريد المطوّرون الذين يستخدمون حاليًا مخطّط عنوان URL مخصّصًا لأغراض أخرى استخدام مخطّط عنوان URL المخصّص نفسه في Dynamic Links أيضًا. إذا كنت في هذه الحالة، يمكنك تحديد مخطّط عنوان URL مختلف لتطبيقك Firebase Dynamic Links باتّباع الخطوات التالية:
- عند إعداد تطبيقك، احرص على تحديد مخطّط عنوان URL التلقائي الذي سيستخدمه تطبيقك
قبل ضبط مثيل
FirebaseApp
المشترَك:Swift
ملاحظة: لا يتوفّر منتج Firebase هذا على استهدافات macOS أو Mac Catalyst أو tvOS أو watchOS.func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication .LaunchOptionsKey: Any]?) -> Bool { // Set deepLinkURLScheme to the custom URL scheme you defined in your // Xcode project. FirebaseOptions.defaultOptions()?.deepLinkURLScheme = customURLScheme FirebaseApp.configure() return true }
Objective-C
ملاحظة: لا يتوفّر منتج Firebase هذا على استهدافات macOS أو Mac Catalyst أو tvOS أو watchOS.- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { // Set deepLinkURLScheme to the custom URL scheme you defined in your // Xcode project. [FIROptions defaultOptions].deepLinkURLScheme = CUSTOM_URL_SCHEME; [FIRApp configure]; return YES; }
- عند إنشاء أي Dynamic Link، عليك تحديد مخطط عنوان URL المخصّص الذي يستخدمه تطبيقك. يمكنك إجراء ذلك من خلال وحدة تحكّم Firebase، أو ضبط
customScheme
في Builder API، أو تحديد المَعلمةius
في عنوان URL، أو إرسال المَعلمةiosCustomScheme
إلى REST API.
الخطوات التالية
الآن بعد أن أنشأت Dynamic Links، عليك إعداد تطبيقك لتلقّي Dynamic Links وإرسال المستخدمين إلى المكان المناسب في تطبيقك بعد أن يفتحه المستخدم.
لتلقّي Dynamic Links في تطبيقك، يمكنك الاطّلاع على مستندات iOS وAndroid وC++ و Unity.