การอ้างอิง API ลิงก์สั้นของ Firebase Dynamic Links

คุณสามารถใช้ 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"
  }
}

พารามิเตอร์

พารามิเตอร์ทั้งหมดเป็นทางเลือก เว้นแต่จะระบุไว้เป็นอย่างอื่น

พารามิเตอร์ทั่วไป
โดเมน UriPrefix จำเป็นหากคุณไม่ได้ตั้งค่าสำหรับพารามิเตอร์ longDynamicLink โดเมนลิงก์แบบไดนามิกของโปรเจ็กต์ Firebase ของคุณ คุณสามารถดูค่านี้ได้ในส่วนลิงก์แบบไดนามิกของ คอนโซล Firebase
ลิงค์ จำเป็นหากคุณไม่ได้ตั้งค่าสำหรับพารามิเตอร์ longDynamicLink

ลิงก์ที่แอปของคุณจะเปิดขึ้นมา ระบุ URL ที่แอปของคุณสามารถจัดการได้ ซึ่งโดยทั่วไปคือเนื้อหาหรือเพย์โหลดของแอป ซึ่งเริ่มต้นตรรกะเฉพาะแอป (เช่น การให้เครดิตผู้ใช้ด้วยคูปองหรือการแสดงหน้าจอต้อนรับ) ลิงก์นี้ต้องเป็น URL ที่มีรูปแบบดี มีการเข้ารหัส URL อย่างเหมาะสม ใช้ HTTP หรือ HTTPS และไม่สามารถเป็นไดนามิกลิงก์อื่นได้

คำต่อท้าย

ระบุวิธีการสร้างองค์ประกอบเส้นทางของไดนามิกลิงก์แบบสั้น ตามค่าเริ่มต้น Firebase Dynamic Links จะสร้างส่วนต่อท้ายสตริง 17 อักขระ

ตั้งค่าพารามิเตอร์เป็น { "option": "SHORT" } เพื่อสร้างสตริงเส้นทางที่มีความยาวตราบเท่าที่จำเป็นต้องไม่ซ้ำกัน โดยมีความยาวขั้นต่ำ 4 อักขระ ใช้วิธีนี้หากข้อมูลละเอียดอ่อนจะไม่ถูกเปิดเผยหากคาดเดา URL ลิงก์ไดนามิกแบบสั้น

ละเว้นพารามิเตอร์นี้หรือตั้งค่าพารามิเตอร์เป็น { "option": "UNGUESSABLE" } เพื่อย่อเส้นทางไปยังสตริงที่คาดเดาไม่ได้ สตริงดังกล่าวถูกสร้างขึ้นโดยการเข้ารหัส base62 ที่สร้างขึ้นแบบสุ่มตัวเลข 96 บิต และประกอบด้วยอักขระตัวอักษรและตัวเลข 17 ตัว ใช้สตริงที่คาดเดาไม่ได้เพื่อป้องกันไม่ให้ไดนามิกลิงก์ของคุณถูกรวบรวมข้อมูล ซึ่งอาจเปิดเผยข้อมูลที่ละเอียดอ่อนได้

พารามิเตอร์ของ Android
androidPackageName ชื่อแพ็กเกจของแอป Android ที่จะใช้เปิดลิงก์ แอปจะต้องเชื่อมต่อกับโปรเจ็กต์ของคุณจากหน้าภาพรวมของคอนโซล Firebase จำเป็นสำหรับลิงก์แบบไดนามิกเพื่อเปิดแอป Android
androidFallbackLink ลิงก์สำหรับเปิดเมื่อไม่ได้ติดตั้งแอป ระบุการดำเนินการนี้เพื่อทำอย่างอื่นนอกเหนือจากการติดตั้งแอปของคุณจาก Play Store เมื่อไม่ได้ติดตั้งแอป เช่น เปิดเนื้อหาเวอร์ชันเว็บบนมือถือ หรือแสดงหน้าส่งเสริมการขายสำหรับแอปของคุณ
androidMinPackageVersionCode versionCode ของเวอร์ชันขั้นต่ำของแอปที่สามารถเปิดลิงก์ได้ หากแอปที่ติดตั้งเป็นเวอร์ชันเก่า ผู้ใช้จะถูกพาไปที่ Play Store เพื่ออัปเกรดแอป
พารามิเตอร์ iOS
iosBundleId ID ชุดของแอป iOS ที่จะใช้เปิดลิงก์ แอปจะต้องเชื่อมต่อกับโปรเจ็กต์ของคุณจากหน้าภาพรวมของคอนโซล Firebase จำเป็นสำหรับลิงก์แบบไดนามิกเพื่อเปิดแอป iOS
iosFallbackLink ลิงก์สำหรับเปิดเมื่อไม่ได้ติดตั้งแอป ระบุการดำเนินการนี้เพื่อทำอย่างอื่นนอกเหนือจากการติดตั้งแอปของคุณจาก App Store เมื่อไม่ได้ติดตั้งแอป เช่น เปิดเนื้อหาเวอร์ชันเว็บบนมือถือ หรือแสดงหน้าส่งเสริมการขายสำหรับแอปของคุณ
iosCustomScheme Scheme URL ที่กำหนดเองของแอป หากกำหนดให้เป็นสิ่งอื่นที่ไม่ใช่รหัสชุดของแอป
iOSIpadFallbackLink ลิงก์สำหรับเปิดบน iPad เมื่อไม่ได้ติดตั้งแอป ระบุการดำเนินการนี้เพื่อทำอย่างอื่นนอกเหนือจากการติดตั้งแอปของคุณจาก App Store เมื่อไม่ได้ติดตั้งแอป เช่น เปิดเนื้อหาเวอร์ชันเว็บ หรือแสดงหน้าส่งเสริมการขายสำหรับแอปของคุณ
iOSIpadBundleId ID ชุดของแอพ iOS ที่จะใช้บน iPad เพื่อเปิดลิงก์ แอปจะต้องเชื่อมต่อกับโปรเจ็กต์ของคุณจากหน้าภาพรวมของคอนโซล Firebase
iosAppStoreId รหัส App Store ของแอปของคุณ ซึ่งใช้เพื่อส่งผู้ใช้ไปยัง App Store เมื่อไม่ได้ติดตั้งแอป
พารามิเตอร์การนำทาง
EnableForcedRedirect หากตั้งค่าเป็น '1' ให้ข้ามหน้าแสดงตัวอย่างแอปเมื่อเปิดลิงก์ไดนามิก และเปลี่ยนเส้นทางไปยังแอปหรือร้านค้าแทน หน้าแสดงตัวอย่างแอป (เปิดใช้งานโดยค่าเริ่มต้น) สามารถส่งผู้ใช้ไปยังปลายทางที่เหมาะสมที่สุดได้อย่างน่าเชื่อถือมากขึ้นเมื่อเปิดลิงก์แบบไดนามิกในแอป อย่างไรก็ตาม หากคุณคาดว่าไดนามิกลิงก์จะเปิดได้เฉพาะในแอปที่สามารถเปิดไดนามิกลิงก์ได้อย่างน่าเชื่อถือโดยไม่มีหน้านี้ คุณสามารถปิดใช้งานลิงก์ไดนามิกได้ด้วยพารามิเตอร์นี้ พารามิเตอร์นี้จะส่งผลต่อการทำงานของไดนามิกลิงก์บน iOS เท่านั้น
พารามิเตอร์เมตาแท็กโซเชียล
ชื่อเรื่องทางสังคม ชื่อที่จะใช้เมื่อแชร์ไดนามิกลิงก์ในโพสต์โซเชียล
สังคมDescription คำอธิบายที่จะใช้เมื่อมีการแชร์ลิงก์แบบไดนามิกในโพสต์โซเชียล
โซเชียลอิมเมจลิงก์ URL ไปยังรูปภาพที่เกี่ยวข้องกับลิงก์นี้
พารามิเตอร์การวิเคราะห์
utmSource
utmMedium
utmแคมเปญ
utmTerm
utmContent
พารามิเตอร์การวิเคราะห์ของ Google Play
ที่
กะรัต
ภูเขา
จุด
พารามิเตอร์การวิเคราะห์ของ iTunes Connect

ร่างกายตอบสนอง

การตอบสนองต่อคำขอเป็นออบเจ็กต์ JSON ดังต่อไปนี้:

{
  "shortLink": string,
  "previewLink": string
}
ฟิลด์ตอบกลับ
ลิงค์สั้น ลิงก์ไดนามิกแบบสั้นที่สร้างขึ้น
ดูตัวอย่างลิงก์ ลิงก์ไปยังผังงานพฤติกรรมของลิงก์แบบไดนามิก