پیوندهای دینامیک Firebase پیوندهای کوتاه مرجع API

می توانید از این API REST برای ایجاد پیوندهای پویا کوتاه استفاده کنید. برای شروع به راهنمای توسعه دهنده مراجعه کنید.

درخواست HTTP

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

request_body

درخواست بدن

بدنه درخواست شبیه یکی از موارد زیر است، بسته به اینکه می‌خواهید پارامترهای 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 تنظیم نکرده باشید، الزامی است. دامنه پیوندهای پویا پروژه Firebase شما. می توانید این مقدار را در بخش Dynamic Links کنسول Firebase پیدا کنید.
ارتباط دادن اگر مقداری برای پارامتر longDynamicLink تنظیم نکرده باشید، الزامی است.

پیوندی که برنامه شما باز خواهد شد. نشانی اینترنتی را مشخص کنید که برنامه شما بتواند آن را مدیریت کند، معمولاً محتوای برنامه یا بارگذاری بار، که منطق خاص برنامه را آغاز می کند (مانند اعتبار دادن به کاربر با یک کوپن یا نمایش صفحه خوش آمدگویی). این پیوند باید یک URL با قالب بندی مناسب باشد، به درستی کدگذاری URL داشته باشد، از HTTP یا HTTPS استفاده کند و نمی تواند پیوند پویا دیگری باشد.

پسوند

نحوه ایجاد مولفه مسیر یک پیوند پویا کوتاه را مشخص می کند. به طور پیش فرض، Firebase Dynamic Links پسوندهای رشته ای 17 کاراکتری تولید می کند.

پارامتر را روی { "option": "SHORT" } تنظیم کنید تا رشته های مسیری را ایجاد کنید که تنها تا زمانی که لازم است منحصر به فرد باشند، با حداقل طول 4 کاراکتر. اگر در صورت حدس زدن URL کوتاه پویا لینک، اطلاعات حساس در معرض دید قرار نگرفت از این روش استفاده کنید.

این پارامتر را حذف کنید یا پارامتر را روی { "option": "UNGUESSABLE" } تنظیم کنید تا مسیر یک رشته غیرقابل حدس زدن را کوتاه کنید. چنین رشته هایی با کدگذاری پایه 62 به صورت تصادفی اعداد 96 بیتی ایجاد می شوند و از 17 کاراکتر الفبایی عددی تشکیل شده اند. از رشته های غیرقابل حدس زدن برای جلوگیری از خزیدن پیوندهای پویا خود استفاده کنید، که به طور بالقوه می تواند اطلاعات حساس را در معرض دید قرار دهد.

پارامترهای اندروید
androidPackageName نام بسته برنامه Android برای استفاده برای باز کردن پیوند. برنامه باید از صفحه نمای کلی کنسول Firebase به پروژه شما متصل شود. برای باز کردن یک برنامه اندروید، پیوند پویا لازم است.
androidFallback Link پیوندی که وقتی برنامه نصب نشده باشد باز می شود. این را برای انجام کاری غیر از نصب برنامه خود از فروشگاه Play در زمانی که برنامه نصب نشده است مشخص کنید، مانند باز کردن نسخه وب تلفن همراه محتوا، یا نمایش یک صفحه تبلیغاتی برای برنامه شما.
androidMinPackageVersionCode versionCode حداقل نسخه برنامه شما که می تواند پیوند را باز کند. اگر برنامه نصب‌شده نسخه قدیمی‌تر باشد، کاربر برای ارتقای برنامه به فروشگاه Play منتقل می‌شود.
پارامترهای iOS
iosBundleId شناسه بسته برنامه iOS برای استفاده برای باز کردن پیوند. برنامه باید از صفحه نمای کلی کنسول Firebase به پروژه شما متصل شود. برای باز کردن یک برنامه iOS برای Dynamic Link مورد نیاز است.
iosFallbackLink پیوندی که وقتی برنامه نصب نشده باشد باز می شود. این را برای انجام کاری غیر از نصب برنامه از App Store در زمانی که برنامه نصب نشده است مشخص کنید، مانند باز کردن نسخه وب موبایل محتوا یا نمایش صفحه تبلیغاتی برای برنامه خود.
iOSCustomScheme طرح URL سفارشی برنامه شما، اگر چیزی غیر از شناسه بسته برنامه شما تعریف شده باشد
iosIpadFallbackLink پیوندی که وقتی برنامه نصب نشده باشد در iPad باز می شود. برای انجام کاری غیر از نصب برنامه از App Store زمانی که برنامه نصب نشده است، این مورد را مشخص کنید، مانند باز کردن نسخه وب محتوا یا نمایش یک صفحه تبلیغاتی برای برنامه خود.
iosIpadBundleId شناسه بسته برنامه iOS برای استفاده در iPad برای باز کردن پیوند. برنامه باید از صفحه نمای کلی کنسول Firebase به پروژه شما متصل شود.
iosAppStoreId شناسه App Store برنامه شما، برای ارسال کاربران به App Store زمانی که برنامه نصب نشده باشد استفاده می‌شود
پارامترهای ناوبری
را فعال کنید اگر روی «1» تنظیم شده است، وقتی پیوند پویا باز شد، از صفحه پیش‌نمایش برنامه رد شوید و در عوض به برنامه یا فروشگاه هدایت شوید. صفحه پیش‌نمایش برنامه (به طور پیش‌فرض فعال است) می‌تواند کاربران را با باز کردن پیوندهای پویا در برنامه‌ها با اطمینان بیشتری به مناسب‌ترین مقصد بفرستد. با این حال، اگر انتظار دارید پیوند پویا فقط در برنامه‌هایی باز شود که می‌توانند لینک‌های پویا را بدون این صفحه به طور قابل اعتماد باز کنند، می‌توانید با این پارامتر آن را غیرفعال کنید. این پارامتر فقط روی رفتار Dynamic Link در iOS تأثیر می گذارد.
پارامترهای متا تگ اجتماعی
عنوان اجتماعی عنوانی که هنگام اشتراک گذاری پیوند پویا در یک پست اجتماعی استفاده می شود.
توصیف اجتماعی توضیحاتی که باید هنگام اشتراک گذاری پیوند پویا در یک پست اجتماعی استفاده شود.
socialImageLink نشانی وب یک تصویر مربوط به این پیوند.
پارامترهای تجزیه و تحلیل
utmSource
utmMedium
utmCampaign
utmTerm
utmContent		 پارامترهای تجزیه و تحلیل گوگل پلی
در
ct
mt
pt		 پارامترهای تجزیه و تحلیل iTunes Connect.

بدن پاسخگو

پاسخ به یک درخواست یک شی JSON مانند زیر است:

{
  "shortLink": string,
  "previewLink": string
}
فیلدهای پاسخ
لینک کوتاه پیوند پویا کوتاه ایجاد شده.
پیش نمایش پیوند پیوندی به فلوچارت رفتار پیوند پویا.