Firebase डाइनैमिक लिंक छोटे लिंक एपीआई का रेफ़रंस

इस REST API का इस्तेमाल करके, शॉर्ट Dynamic Links जनरेट किया जा सकता है. डेवलपर गाइड देखें 'प्रॉडक्ट एक्सप्लोर करें' में जाकर Reader Revenue Manager चुनें.

एचटीटीपी अनुरोध

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"
  }
}

पैरामीटर

जब तक अलग से कोई पैरामीटर न दिया गया हो, तब तक सभी पैरामीटर ज़रूरी नहीं होते.

सामान्य पैरामीटर
डोमेनयूरीप्रीफ़िक्स अगर आपने longDynamicLink के लिए कोई वैल्यू सेट नहीं की है, तो ज़रूरी है पैरामीटर. आपके Firebase प्रोजेक्ट का Dynamic Links डोमेन. आपको यह वैल्यू, Firebase कंसोल के Dynamic Links सेक्शन में मिल सकती है.
लिंक अगर आपने longDynamicLink के लिए कोई वैल्यू सेट नहीं की है, तो ज़रूरी है पैरामीटर.

वह लिंक जिससे आपका ऐप्लिकेशन खुलेगा. उस यूआरएल के बारे में बताएं जिसे आपका ऐप्लिकेशन मैनेज कर सकता है. आम तौर पर, इसमें ऐप्लिकेशन के कॉन्टेंट का यूआरएल होता है या पेलोड, जो ऐप्लिकेशन के खास लॉजिक को शुरू करता है (जैसे कि उपयोगकर्ता को कूपन के साथ क्रेडिट देना या वेलकम स्क्रीन दिखेगी). यह लिंक एक सही ढंग से फ़ॉर्मैट किया गया यूआरएल होना चाहिए, सही तरीके से यूआरएल-एन्कोड किया गया होना चाहिए, इसका इस्तेमाल करें जो एचटीटीपी या एचटीटीपीएस में से कोई एक हो और कोई दूसरा डाइनैमिक लिंक न हो.
प्रत्यय

छोटे Dynamic Link का पाथ कॉम्पोनेंट बनाने का तरीका बताता है. इन्होंने बदलाव किया है डिफ़ॉल्ट रूप से, Firebase Dynamic Links 17 वर्णों के स्ट्रिंग सफ़िक्स जनरेट करता है.

जनरेट करने के लिए, पैरामीटर को { "option": "SHORT" } पर सेट करें ऐसी पाथ स्ट्रिंग जो सिर्फ़ तब तक यूनीक हों, जब तक कम से कम 4 वर्ण. अगर संवेदनशील जानकारी है, तो यह तरीका अपनाएं Dynamic Link के छोटे यूआरएल का अनुमान लगाने से, उसे नहीं दिखाया जा सकता.

इस पैरामीटर को छोड़ दें या पैरामीटर को पाथ को छोटा करने के लिए { "option": "UNGUESSABLE" } ऐसी स्ट्रिंग है जिसका अनुमान नहीं लगाया जा सकता. ऐसी स्ट्रिंग, base62-एन्कोडिंग से रैंडम तरीके से बनाई जाती हैं 96-बिट नंबर जनरेट किए जाते हैं. इसमें अक्षर और अंक मिलाकर 17 वर्ण होते हैं. इस्तेमाल की जाने वाली चीज़ें आपके Dynamic Links को क्रॉल किए जाने से रोकने के लिए गैर-भरोसेमंद स्ट्रिंग, जो संवेदनशील जानकारी को बिना अनुमति के सार्वजनिक कर सकता है.
Android के पैरामीटर
androidपैकेजनाम Android ऐप्लिकेशन का पैकेज नाम, जिसका इस्तेमाल लिंक खोलने के लिए किया जाना है. ऐप्लिकेशन, Firebase कंसोल के खास जानकारी देने वाले पेज से आपके प्रोजेक्ट से कनेक्ट होना चाहिए. Dynamic Link को Android ऐप्लिकेशन खोलने के लिए ज़रूरी है.
androidFallbackLink ऐप्लिकेशन इंस्टॉल न होने पर खुलने वाला लिंक. इसके बारे में बताएं कि यह ऐप्लिकेशन इंस्टॉल न होने पर, Play Store से आपका ऐप्लिकेशन इंस्टॉल करने के अलावा कुछ और करेगा. जैसे, कॉन्टेंट का मोबाइल वेब वर्शन खोलना या अपने ऐप्लिकेशन का प्रमोशन करने वाला पेज दिखाना.
androidMinPackageVersionCode आपके ऐप्लिकेशन के कम से कम वर्शन का versionCode, जो लिंक को खोल सकता हो. अगर इंस्टॉल किया गया ऐप्लिकेशन पुराना वर्शन है, तो उपयोगकर्ता को ऐप्लिकेशन अपग्रेड करने के लिए Play Store पर ले जाया जाता है.
iOS पैरामीटर
iOSBundleId iOS ऐप्लिकेशन का बंडल आईडी, जिसका इस्तेमाल लिंक खोलने के लिए किया जाना है. ऐप्लिकेशन, Firebase कंसोल के खास जानकारी देने वाले पेज से आपके प्रोजेक्ट से कनेक्ट होना चाहिए. Dynamic Link को iOS ऐप्लिकेशन खोलने के लिए ज़रूरी है.
iOSFallbackLink ऐप्लिकेशन इंस्टॉल न होने पर खुलने वाला लिंक. इसके बारे में बताएं कि यह ऐप्लिकेशन इंस्टॉल न होने पर, App Store से आपका ऐप्लिकेशन इंस्टॉल करने के अलावा, कुछ और करने के लिए भी निर्देश देगा. जैसे, कॉन्टेंट का मोबाइल वेब वर्शन खोलना या अपने ऐप्लिकेशन का प्रमोशन पेज दिखाना.
iOS कस्टम स्कीम आपके ऐप्लिकेशन के बंडल आईडी की जगह, आपके ऐप्लिकेशन की कस्टम यूआरएल स्कीम
iOSIpadFallbackLink iPad पर, ऐप्लिकेशन इंस्टॉल न होने पर खोलने के लिए लिंक. इसके बारे में बताएं कि यह ऐप्लिकेशन इंस्टॉल न होने पर, App Store से आपका ऐप्लिकेशन इंस्टॉल करने के अलावा, कुछ और करने के लिए भी निर्देश देगा. जैसे, कॉन्टेंट का वेब वर्शन खोलना या अपने ऐप्लिकेशन का प्रमोशन करने वाला पेज दिखाना.
iOSIpadBundleId iPad पर इस्तेमाल करने के लिए, iOS ऐप्लिकेशन का बंडल आईडी. ऐप्लिकेशन, Firebase कंसोल के खास जानकारी देने वाले पेज से आपके प्रोजेक्ट से कनेक्ट होना चाहिए.
iosAppStoreId आपके ऐप्लिकेशन का ऐप स्टोर आईडी, जिसका इस्तेमाल ऐप्लिकेशन के इंस्टॉल न होने पर, उपयोगकर्ताओं को App Store पर भेजने के लिए किया जाता है
नेविगेशन पैरामीटर
enabledForcedredirect अगर यह नीति '1' पर सेट है, तो Dynamic Link के खुलने पर, ऐप्लिकेशन की झलक दिखाने वाले पेज को छोड़कर आगे बढ़ें. इसके बजाय, ऐप्लिकेशन या स्टोर पर रीडायरेक्ट करें. ऐप्लिकेशन में Dynamic Links खोलने पर, ऐप्लिकेशन की झलक दिखाने वाला पेज (डिफ़ॉल्ट रूप से चालू होता है), उपयोगकर्ताओं को सबसे सही डेस्टिनेशन पर भेज सकता है; हालांकि, अगर आपको लगता है कि Dynamic Link को सिर्फ़ ऐसे ऐप्लिकेशन में खोला जाएगा जो Dynamic Links को इस पेज के बिना भरोसेमंद तरीके से खोल सकते हैं, तो इस पैरामीटर की मदद से इसे बंद किया जा सकता है. यह पैरामीटर सिर्फ़ iOS पर Dynamic Link के काम करने के तरीके पर असर डालेगा.
सोशल मेटा टैग पैरामीटर
सोशल टाइटल सोशल मीडिया पर पोस्ट में Dynamic Link शेयर होने पर इस्तेमाल किया जाने वाला टाइटल.
सामाजिक विवरण सोशल मीडिया पर पोस्ट में Dynamic Link शेयर करने के दौरान इस्तेमाल किया जाने वाला ब्यौरा.
सोशल इमेज लिंक इस लिंक से जुड़ी इमेज का यूआरएल.
Analytics पैरामीटर
utmSource
utmMedium
utmCampaign
utmTerm
utmContent		 Google Play के आंकड़ों के पैरामीटर.
कम
ct
mt
pt		 iTunes Connect के आंकड़ों के पैरामीटर.

जवाब का लेख

किसी अनुरोध का रिस्पॉन्स, एक JSON ऑब्जेक्ट होता है. यह इस तरह का होता है:

{
  "shortLink": string,
  "previewLink": string
}
जवाब के फ़ील्ड
शॉर्टलिंक जनरेट किया गया शॉर्ट वीडियो Dynamic Link.
झलक दिखाने का लिंक Dynamic Link के व्यवहार के फ़्लोचार्ट का लिंक.