คุณสามารถใช้ API ของ REST นี้เพื่อสร้าง Dynamic Links แบบสั้นได้ ดูคู่มือนักพัฒนาซอฟต์แวร์ เพื่อเริ่มต้นใช้งาน
คำขอ HTTP
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"
}
}
พารามิเตอร์
พารามิเตอร์ทั้งหมดเป็นค่าที่ไม่บังคับ เว้นแต่จะระบุไว้เป็นอย่างอื่น
พารามิเตอร์ทั่วไป | |
---|---|
คำนำหน้า domainUri | ต้องระบุหากคุณไม่ได้กำหนดค่าสำหรับ longDynamicLink
พารามิเตอร์ โดเมน Dynamic Links ของโปรเจ็กต์ Firebase ของคุณ คุณดูค่านี้ได้ในส่วน Dynamic Links ของคอนโซล Firebase |
ลิงก์ | ต้องระบุหากคุณไม่ได้กำหนดค่าสำหรับ longDynamicLink
พารามิเตอร์
ลิงก์ที่แอปของคุณจะเปิดขึ้น ระบุ URL ที่แอปสามารถจัดการได้ ซึ่งโดยทั่วไปจะเป็นเนื้อหาของแอป หรือเพย์โหลด ซึ่งเป็นการเริ่มต้นตรรกะเฉพาะแอป (เช่น ให้เครดิตผู้ใช้ด้วยคูปอง หรือ แสดงหน้าจอต้อนรับ) ลิงก์นี้ต้องเป็น URL ที่มีรูปแบบเหมาะสม มีการเข้ารหัส URL อย่างถูกต้อง ใช้ HTTP หรือ HTTPS และไม่สามารถเป็นลิงก์แบบไดนามิกอื่นได้ |
คำต่อท้าย |
ระบุวิธีสร้างคอมโพเนนต์เส้นทางของ Dynamic Link แบบสั้น โดย ค่าเริ่มต้น Firebase Dynamic Links จะสร้างคำต่อท้ายสตริงที่มีอักขระ 17 ตัว ตั้งค่าพารามิเตอร์เป็น ละเว้นพารามิเตอร์นี้หรือตั้งพารามิเตอร์เป็น
|
พารามิเตอร์ Android | |
---|---|
ชื่อแพ็กเกจ Android | ชื่อแพ็กเกจของแอป Android ที่จะใช้เปิดลิงก์ แอปต้องเชื่อมต่อกับโปรเจ็กต์จากหน้าภาพรวมของคอนโซล Firebase จำเป็นสำหรับ Dynamic Link เพื่อเปิดแอป Android |
ลิงก์สำรอง Android | ลิงก์ที่จะเปิดเมื่อไม่ได้ติดตั้งแอป โดยให้ระบุการดำเนินการนี้เพื่อดำเนินการอื่นที่ไม่ใช่การติดตั้งแอปจาก Play Store เมื่อไม่ได้ติดตั้งแอปดังกล่าว เช่น เปิดเนื้อหาเวอร์ชันเว็บบนอุปกรณ์เคลื่อนที่ หรือแสดงหน้าโปรโมตสำหรับแอป |
รหัสเวอร์ชัน androidMinPackage | versionCode ของแอปเวอร์ชันขั้นต่ำที่สามารถเปิดลิงก์ได้ หากแอปที่ติดตั้งเป็นเวอร์ชันเก่า ระบบจะนำผู้ใช้ไปที่ Play Store เพื่ออัปเกรดแอป |
พารามิเตอร์ iOS | |
---|---|
รหัสแพ็กเกจ iOS | รหัสชุดของแอป iOS ที่จะใช้เปิดลิงก์ แอปต้องเชื่อมต่อกับโปรเจ็กต์จากหน้าภาพรวมของคอนโซล Firebase จำเป็นสำหรับ Dynamic Link เพื่อเปิดแอป iOS |
ลิงก์สำรองของ iOS | ลิงก์ที่จะเปิดเมื่อไม่ได้ติดตั้งแอป ระบุสิ่งนี้เพื่อดำเนินการอื่นนอกเหนือจากการติดตั้งแอปจาก App Store เมื่อไม่มีการติดตั้งแอป เช่น เปิดเนื้อหาเวอร์ชันเว็บบนอุปกรณ์เคลื่อนที่ หรือแสดงหน้าโปรโมตสำหรับแอป |
รูปแบบที่กำหนดเองของ iOS | ชุดรูปแบบ URL ที่กำหนดเองของแอป หากกำหนดให้เป็นรูปแบบอื่นที่ไม่ใช่รหัสชุดของแอป |
ลิงก์สำรอง iOS | ลิงก์ที่จะเปิดใน iPad เมื่อไม่ได้ติดตั้งแอป ระบุสิ่งนี้เพื่อดำเนินการอื่นนอกเหนือจากการติดตั้งแอปจาก App Store เมื่อไม่มีการติดตั้งแอป เช่น เปิดเนื้อหาเวอร์ชันเว็บ หรือแสดงหน้าโปรโมชันสำหรับแอป |
รหัสแพ็กเกจ iOS | รหัสชุดของแอป iOS ที่จะใช้ใน iPad เพื่อเปิดลิงก์ แอปต้องเชื่อมต่อกับโปรเจ็กต์จากหน้าภาพรวมของคอนโซล Firebase |
รหัสร้านค้าแอป iOS | รหัส App Store ของแอปซึ่งใช้เพื่อส่งผู้ใช้ไปยัง App Store เมื่อไม่ได้ติดตั้งแอป |
พารามิเตอร์การนำทาง | |
---|---|
enabledForcedRedirect | หากตั้งค่าเป็น "1" ให้ข้ามหน้าตัวอย่างแอปเมื่อเปิด Dynamic Link และเปลี่ยนเส้นทางไปยังแอปหรือ Store แทน หน้าตัวอย่างแอป (เปิดใช้โดยค่าเริ่มต้น) จะส่งผู้ใช้ไปยังปลายทางที่เหมาะสมที่สุดได้อย่างน่าเชื่อถือมากขึ้นเมื่อเปิด Dynamic Links ในแอป อย่างไรก็ตาม หากคุณคาดว่า Dynamic Link จะเปิดเฉพาะในแอปที่สามารถเปิด Dynamic Links ได้อย่างเสถียรโดยไม่ต้องใช้หน้านี้ คุณก็ปิดใช้ด้วยพารามิเตอร์นี้ได้ พารามิเตอร์นี้จะส่งผลต่อลักษณะการทำงานของ Dynamic Link เฉพาะใน iOS เท่านั้น |
พารามิเตอร์เมตาแท็กโซเชียล | |
---|---|
ชื่อโซเชียล | ชื่อที่จะใช้เมื่อมีการแชร์ Dynamic Link ในโพสต์บนโซเชียลเน็ตเวิร์ก |
คำอธิบายโซเชียล | คำอธิบายที่จะใช้เมื่อมีการแชร์ Dynamic Link ในโพสต์บนโซเชียลเน็ตเวิร์ก |
ลิงก์รูปภาพโซเชียล | URL ไปยังรูปภาพที่เกี่ยวข้องกับลิงก์นี้ |
พารามิเตอร์ Analytics | |
---|---|
utmSource utmMedium utmCampaign utmTerm utmContent |
พารามิเตอร์ Analytics ของ Google Play |
ที่ ct mt pt |
พารามิเตอร์ข้อมูลวิเคราะห์ของ iTunes Connect |
เนื้อหาการตอบกลับ
การตอบกลับคำขอจะเป็นออบเจ็กต์ JSON ที่มีลักษณะดังต่อไปนี้
{
"shortLink": string,
"previewLink": string
}
ช่องคำตอบ | |
---|---|
ลิงก์ย่อ | Dynamic Link แบบย่อที่สร้างขึ้น |
ลิงก์ดูตัวอย่าง | ลิงก์ไปยังโฟลว์ชาร์ตแสดงลักษณะการทำงานของ Dynamic Link |