फायरबेस डायनेमिक लिंक शॉर्ट लिंक एपीआई संदर्भ

आप छोटे डायनामिक लिंक जेनरेट करने के लिए इस REST API का उपयोग कर सकते हैं। आरंभ करने के लिए डेवलपर मार्गदर्शिका देखें.

HTTP अनुरोध

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

request_body

निकाय से अनुरोध करें

अनुरोध निकाय निम्न में से एक जैसा दिखता है, यह इस पर निर्भर करता है कि आप डायनेमिक लिंक पैरामीटर को लंबे डायनेमिक लिंक के रूप में निर्दिष्ट करना चाहते हैं या JSON ऑब्जेक्ट के रूप में।

डायनामिक लिंक पैरामीटर को एक लंबे डायनामिक लिंक के रूप में निर्दिष्ट करने के लिए:

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

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 पैरामीटर के लिए कोई मान सेट नहीं किया है तो यह आवश्यक है। आपके फायरबेस प्रोजेक्ट का डायनेमिक लिंक डोमेन। आप यह मान फ़ायरबेस कंसोल के डायनामिक लिंक अनुभाग में पा सकते हैं।
जोड़ना	यदि आपने longDynamicLink पैरामीटर के लिए कोई मान सेट नहीं किया है तो यह आवश्यक है। आपका ऐप लिंक खुल जाएगा. एक यूआरएल निर्दिष्ट करें जिसे आपका ऐप संभाल सकता है, आमतौर पर ऐप की सामग्री या पेलोड, जो ऐप-विशिष्ट तर्क शुरू करता है (जैसे कि उपयोगकर्ता को कूपन के साथ क्रेडिट करना या स्वागत स्क्रीन प्रदर्शित करना)। यह लिंक एक अच्छी तरह से स्वरूपित यूआरएल होना चाहिए, उचित यूआरएल-एनकोडेड होना चाहिए, HTTP या HTTPS का उपयोग करना चाहिए, और कोई अन्य डायनामिक लिंक नहीं हो सकता। जब उपयोगकर्ता डेस्कटॉप वेब ब्राउज़र पर डायनामिक लिंक खोलते हैं, तो वे इस यूआरएल को लोड करेंगे (जब तक कि ofl पैरामीटर निर्दिष्ट न हो)। यदि आपके पास लिंक की गई सामग्री के बराबर वेब नहीं है, तो यूआरएल को वैध वेब संसाधन को इंगित करने की आवश्यकता नहीं है। इस स्थिति में, आपको इस यूआरएल से, उदाहरण के लिए, अपने होम पेज पर रीडायरेक्ट सेट अप करना चाहिए।
प्रत्यय	निर्दिष्ट करता है कि लघु डायनामिक लिंक का पथ घटक कैसे बनाया जाए। डिफ़ॉल्ट रूप से, फायरबेस डायनेमिक लिंक 17-वर्ण स्ट्रिंग प्रत्यय उत्पन्न करता है। पथ स्ट्रिंग उत्पन्न करने के लिए पैरामीटर को { "option": "SHORT" } पर सेट करें जो अद्वितीय होने के लिए आवश्यक लंबाई तक ही हों, न्यूनतम 4 वर्णों की लंबाई के साथ। यदि एक छोटे डायनामिक लिंक यूआरएल का अनुमान लगाया गया तो संवेदनशील जानकारी उजागर नहीं होगी, तो इस विधि का उपयोग करें। किसी अकल्पनीय स्ट्रिंग के पथ को छोटा करने के लिए इस पैरामीटर को छोड़ दें या पैरामीटर को { "option": "UNGUESSABLE" } पर सेट करें। ऐसी स्ट्रिंग्स बेस 62-एन्कोडिंग द्वारा यादृच्छिक रूप से उत्पन्न 96-बिट संख्याओं द्वारा बनाई जाती हैं, और इसमें 17 अल्फ़ान्यूमेरिक वर्ण होते हैं। अपने डायनामिक लिंक को क्रॉल होने से रोकने के लिए अचूक स्ट्रिंग्स का उपयोग करें, जो संभावित रूप से संवेदनशील जानकारी को उजागर कर सकते हैं।

एंड्रॉइड पैरामीटर
androidPackageName	लिंक खोलने के लिए उपयोग किए जाने वाले एंड्रॉइड ऐप का पैकेज नाम। ऐप को फायरबेस कंसोल के अवलोकन पृष्ठ से आपके प्रोजेक्ट से कनेक्ट होना चाहिए। एंड्रॉइड ऐप खोलने के लिए डायनामिक लिंक की आवश्यकता है।
androidFallbackLink	ऐप इंस्टॉल न होने पर लिंक खुलेगा। जब ऐप इंस्टॉल न हो तो प्ले स्टोर से अपना ऐप इंस्टॉल करने के अलावा कुछ और करने के लिए इसे निर्दिष्ट करें, जैसे सामग्री का मोबाइल वेब संस्करण खोलना, या अपने ऐप के लिए एक प्रचार पृष्ठ प्रदर्शित करना।
androidMinPackageVersionCode	आपके ऐप के न्यूनतम संस्करण का versionCode जो लिंक खोल सकता है। यदि इंस्टॉल किया गया ऐप पुराना संस्करण है, तो ऐप को अपग्रेड करने के लिए उपयोगकर्ता को प्ले स्टोर पर ले जाया जाता है।

आईओएस पैरामीटर
iosBundleId	लिंक खोलने के लिए उपयोग करने हेतु iOS ऐप की बंडल आईडी। ऐप को फायरबेस कंसोल के अवलोकन पृष्ठ से आपके प्रोजेक्ट से कनेक्ट होना चाहिए। iOS ऐप खोलने के लिए डायनामिक लिंक की आवश्यकता है।
iosफ़ॉलबैकलिंक	ऐप इंस्टॉल न होने पर लिंक खुलेगा। जब ऐप इंस्टॉल न हो तो ऐप स्टोर से अपना ऐप इंस्टॉल करने के अलावा कुछ और करने के लिए इसे निर्दिष्ट करें, जैसे सामग्री का मोबाइल वेब संस्करण खोलना, या अपने ऐप के लिए एक प्रचार पृष्ठ प्रदर्शित करना।
iosCustomScheme	आपके ऐप की कस्टम URL योजना, यदि आपके ऐप की बंडल आईडी के अलावा किसी अन्य चीज़ के रूप में परिभाषित की गई है
iosIpadFallbackLink	ऐप इंस्टॉल न होने पर आईपैड पर खुलने वाला लिंक। जब ऐप इंस्टॉल न हो तो ऐप स्टोर से अपना ऐप इंस्टॉल करने के अलावा कुछ और करने के लिए इसे निर्दिष्ट करें, जैसे सामग्री का वेब संस्करण खोलना, या अपने ऐप के लिए एक प्रचार पृष्ठ प्रदर्शित करना।
iosIpadBundleId	लिंक खोलने के लिए आईपैड पर उपयोग करने के लिए आईओएस ऐप की बंडल आईडी। ऐप को फायरबेस कंसोल के अवलोकन पृष्ठ से आपके प्रोजेक्ट से कनेक्ट होना चाहिए।
iosAppStoreId	आपके ऐप की ऐप स्टोर आईडी, ऐप इंस्टॉल न होने पर उपयोगकर्ताओं को ऐप स्टोर पर भेजने के लिए उपयोग की जाती है

नेविगेशन पैरामीटर

EnableForcedRedirect

यदि '1' पर सेट है, तो डायनामिक लिंक खुलने पर ऐप पूर्वावलोकन पृष्ठ को छोड़ दें और इसके बजाय ऐप या स्टोर पर रीडायरेक्ट करें। ऐप पूर्वावलोकन पृष्ठ (डिफ़ॉल्ट रूप से सक्षम) उपयोगकर्ताओं को ऐप्स में डायनामिक लिंक खोलने पर अधिक विश्वसनीय रूप से सबसे उपयुक्त गंतव्य पर भेज सकता है; हालाँकि, यदि आप उम्मीद करते हैं कि डायनामिक लिंक केवल उन ऐप्स में खोला जाएगा जो इस पेज के बिना डायनामिक लिंक को विश्वसनीय रूप से खोल सकते हैं, तो आप इसे इस पैरामीटर के साथ अक्षम कर सकते हैं। यह पैरामीटर केवल iOS पर डायनामिक लिंक के व्यवहार को प्रभावित करेगा।

सामाजिक मेटा टैग पैरामीटर
सामाजिक शीर्षक	किसी सामाजिक पोस्ट में डायनामिक लिंक साझा किए जाने पर उपयोग किया जाने वाला शीर्षक।
सामाजिकविवरण	किसी सामाजिक पोस्ट में डायनामिक लिंक साझा किए जाने पर उपयोग करने का विवरण।
सोशलइमेजलिंक	इस लिंक से संबंधित छवि का URL.

विश्लेषिकी पैरामीटर
utmस्रोत utmMedium utmअभियान utmटर्म utmसामग्री	Google Play विश्लेषण पैरामीटर.
पर सीटी मीट्रिक टन पीटी	आईट्यून्स कनेक्ट एनालिटिक्स पैरामीटर।

प्रतिक्रिया निकाय

किसी अनुरोध की प्रतिक्रिया निम्नलिखित की तरह एक JSON ऑब्जेक्ट है:

{
  "shortLink": string,
  "previewLink": string
}

प्रतिक्रिया क्षेत्र
छोटी कड़ी	उत्पन्न लघु डायनामिक लिंक।
पूर्वावलोकनलिंक	डायनामिक लिंक के व्यवहार के फ़्लोचार्ट का एक लिंक।