با REST API پیوندهای پویا ایجاد کنید

شما می‌توانید با استفاده از API REST مربوط به Firebase Dynamic Links، Dynamic Links کوتاه ایجاد کنید. این API یا یک Dynamic Link بلند یا یک شیء حاوی پارامترهای Dynamic Link را می‌پذیرد و یک URL مانند مثال زیر برمی‌گرداند:

https://example.page.link/WXYZ

Dynamic Links کوتاه ایجاد شده با API و SDK کلاینت (اندروید/اپل) در کنسول Firebase نمایش داده نمی‌شوند. چنین Dynamic Links برای اشتراک‌گذاری کاربر به کاربر در نظر گرفته شده‌اند. برای موارد استفاده بازاریابی، به ایجاد لینک‌های خود مستقیماً از طریق صفحه Dynamic Links در کنسول Firebase ادامه دهید.

قبل از اینکه شروع کنی

  1. کلید API خود را دریافت کنید. برای تأیید اعتبار درخواست‌های خود به API، به یک کلید API نیاز دارید. برای یافتن کلید API خود:
    1. صفحه تنظیمات کنسول Firebase را باز کنید. اگر از شما خواسته شد که یک پروژه انتخاب کنید، پروژه Firebase خود را از منو انتخاب کنید.
    2. به مقدار فیلد Web API Key توجه کنید.
  2. در کنسول Firebase ، بخش Dynamic Links را باز کنید.

  3. اگر قبلاً شرایط خدمات را نپذیرفته‌اید و دامنه‌ای برای Dynamic Links خود تنظیم نکرده‌اید، در صورت درخواست این کار را انجام دهید.

    اگر از قبل یک دامنه Dynamic Links دارید، به آن توجه کنید. هنگام ایجاد Dynamic Links به صورت برنامه‌نویسی، باید یک دامنه Dynamic Links ارائه دهید.

شما می‌توانید از API مربوط به لینک‌های پویای فایربیس برای کوتاه کردن یک Dynamic Link طولانی استفاده کنید. برای انجام این کار، یک درخواست HTTP POST به نقطه پایانی shortLinks ارسال کنید و Dynamic Link طولانی را در پارامتر longDynamicLink مشخص کنید. برای مثال:

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

{
   "longDynamicLink": "https://example.page.link/?link=https://www.example.com/&apn=com.example.android&ibi=com.example.ios"
}

برای یادگیری نحوه ایجاد Dynamic Links طولانی، به بخش ساخت دستی URL مراجعه کنید.

همچنین می‌توانید با مشخص کردن مستقیم پارامترهای Dynamic Link ، یک Short Dynamic Link ایجاد کنید. برای انجام این کار، یک درخواست HTTP POST به نقطه پایانی shortLinks ارسال کنید و پارامترهای Dynamic Link را در پارامتر dynamicLinkInfo مشخص کنید. برای مثال:

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

{
  "dynamicLinkInfo": {
    "domainUriPrefix": "https://example.page.link",
    "link": "https://www.example.com/",
    "androidInfo": {
      "androidPackageName": "com.example.android"
    },
    "iosInfo": {
      "iosBundleId": "com.example.ios"
    }
  }
}

برای مشخصات کامل شیء dynamicLinkInfo ، به مرجع API مراجعه کنید.

طول یک Dynamic Link کوتاه را تنظیم کنید

همچنین می‌توانید پارامتر suffix را برای مشخص کردن نحوه تولید مؤلفه مسیر Dynamic Link کوتاه تنظیم کنید.

به طور پیش‌فرض، یا اگر پارامتر را روی "UNGUESSABLE" تنظیم کنید، مؤلفه مسیر یک رشته ۱۷ کاراکتری خواهد بود، مانند مثال زیر:

https://example.page.link/UVWXYZuvwxyz12345

چنین رشته‌هایی با کدگذاری base62 و اعداد تصادفی ۹۶ بیتی ایجاد می‌شوند. از این تنظیم برای جلوگیری از حدس زدن و خزش آدرس‌های اینترنتی Dynamic Links خود استفاده کنید، که می‌تواند به طور بالقوه اطلاعات حساس را در معرض دریافت‌کنندگان ناخواسته قرار دهد.

اگر پارامتر را روی "SHORT" تنظیم کنید، مؤلفه مسیر رشته‌ای خواهد بود که فقط به اندازه‌ای که برای منحصر به فرد بودن لازم است، طول دارد و حداقل طول آن ۴ کاراکتر است.

https://example.page.link/WXYZ

اگر در صورت حدس زدن یک URL کوتاه Dynamic Link اطلاعات حساس فاش نشود، از این روش استفاده کنید.

مثال زیر نحوه تنظیم پارامتر suffix را نشان می‌دهد:

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

{
   "longDynamicLink": "https://example.page.link/?link=http://www.example.com/&apn=com.example.android&ibi=com.example.ios",
   "suffix": {
     "option": "UNGUESSABLE"
   }
}

حداقل، مقدار deep-link ارائه شده باید با طرح‌های http:// یا https:// شروع شود. همچنین باید با هر الگوی URL که در لیست سفید کنسول وارد شده است، مطابقت داشته باشد. در غیر این صورت، API ایجاد با کد خطای HTTP 400 از کار می‌افتد.

مراحل بعدی

حالا که Dynamic Links ایجاد کرده‌اید، باید برنامه خود را طوری تنظیم کنید که Dynamic Links دریافت کند و پس از باز شدن توسط کاربر، آنها را به مکان مناسب در برنامه شما ارسال کند.

برای دریافت Dynamic Links در برنامه خود، به مستندات مربوط به iOS ، اندروید ، C++ و Unity مراجعه کنید.

درخواست‌ها به ۵ درخواست در هر آدرس IP در ثانیه و ۲۰۰۰۰۰ درخواست در روز محدود شده‌اند. در صورت تجاوز از این تعداد، پاسخ خطای HTTP با کد ۴۲۹ را برمی‌گرداند. برای درخواست سهمیه بیشتر، این فرم را پر کنید.