ดัชนี
AssetLinks
(อินเทอร์เฟซ)Statements
(อินเทอร์เฟซ)AndroidAppAsset
(ข้อความ)AndroidAppAsset.CertificateInfo
(ข้อความ)Asset
(ข้อความ)CheckRequest
(ข้อความ)CheckResponse
(ข้อความ)ListRequest
(ข้อความ)ListResponse
(ข้อความ)Statement
(ข้อความ)WebAsset
(ข้อความ)
AssetLinks
บริการ API นี้ให้สิทธิ์เข้าถึง "ลิงก์ชิ้นงาน" ลิงก์เนื้อหาแต่ละรายการจะแสดงความสัมพันธ์แบบทิศทางเดียวระหว่างชิ้นงานแหล่งที่มาและเนื้อหาเป้าหมาย ลักษณะของความสัมพันธ์จะกำหนดโดยสตริง "relation" เนื้อหาแหล่งที่มาและเป้าหมาย 2 คู่หนึ่งอาจลิงก์กันด้วยความสัมพันธ์หลายรายการ
ไคลเอ็นต์ใช้ API นี้เพื่อตอบคำถามที่เจาะจงเกี่ยวกับความตั้งใจที่เจ้าของเนื้อหาแสดงเกี่ยวกับความสัมพันธ์ระหว่างเนื้อหา 2 รายการ
โปรดทราบว่าลิงก์ชิ้นงานจะไม่ส่งต่อกัน: หากชิ้นงาน ก และ ข ลิงก์กันสำหรับความสัมพันธ์หนึ่งๆ แต่เนื้อหา ข และ ค ลิงก์กันด้วยความสัมพันธ์เดียวกัน ซึ่งไม่ได้หมายความว่าเนื้อหา ก และ ค ลิงก์กัน
ตรวจสอบ |
---|
พิจารณาว่ามีความสัมพันธ์ที่ระบุ (ทิศทาง) ระหว่างชิ้นงานแหล่งที่มาและเป้าหมายที่ระบุหรือไม่ ความสัมพันธ์นี้จะอธิบายเจตนาของการลิงก์ระหว่างเนื้อหาทั้ง 2 รายการตามที่ชิ้นงานแหล่งที่มาอ้างสิทธิ์ ตัวอย่างของความสัมพันธ์ดังกล่าวคือการมอบสิทธิ์หรือสิทธิ์ต่างๆ ระบบโครงสร้างพื้นฐานมักจะใช้คำสั่งนี้เพื่อตรวจสอบเงื่อนไขล่วงหน้าสำหรับการดำเนินการ ตัวอย่างเช่น ลูกค้าอาจต้องการทราบว่าสามารถส่ง URL เว็บไปยังแอปบนอุปกรณ์เคลื่อนที่แอปหนึ่งแทนได้ไหม ลูกค้าสามารถตรวจสอบลิงก์ชิ้นงานที่เกี่ยวข้องจากเว็บไซต์ไปยังแอปบนอุปกรณ์เคลื่อนที่เพื่อตัดสินใจว่าควรอนุญาตให้มีการดําเนินการหรือไม่ หมายเหตุเกี่ยวกับความปลอดภัย: หากคุณระบุแหล่งข้อมูลที่ปลอดภัยเป็นเนื้อหา เช่น เว็บไซต์ HTTPS หรือแอป Android API จะตรวจสอบว่าข้อความที่ใช้สร้างการตอบกลับนั้นสร้างขึ้นด้วยวิธีที่ปลอดภัยโดยเจ้าของเนื้อหานั้น ในทางกลับกัน หากเนื้อหาแหล่งที่มาเป็นเว็บไซต์ HTTP ที่ไม่ปลอดภัย (กล่าวคือ URL ขึ้นต้นด้วย |
คำชี้แจง
บริการ API นี้ให้บริการ "คำสั่ง" ซึ่งเป็นยานพาหนะที่เจ้าของเนื้อหาใช้เพื่อเผยแพร่ข้อมูลเกี่ยวกับลิงก์เนื้อหาของตน API จะใช้เพื่อเรียกใบแจ้งยอดด้วยวิธีที่ง่ายและปลอดภัย โดยไม่จำเป็นต้องขอใบแจ้งยอดจากแหล่งที่มาโดยตรง
คำสั่งทั้งหมดที่แสดงผลโดย API นี้จัดทำขึ้นในนามของเนื้อหาดิจิทัล (เช่น เว็บไซต์หรือแอป Android) เกี่ยวกับเนื้อหาดิจิทัลอื่นๆ แต่ละคำสั่งประกอบด้วยชิ้นงานแหล่งที่มา ชิ้นงานเป้าหมาย และความสัมพันธ์อย่างน้อย 1 รายการ
ความสัมพันธ์จะอธิบายความสัมพันธ์ระหว่างเนื้อหาทั้ง 2 รายการตามที่เนื้อหาแหล่งที่มาอ้างสิทธิ์ ตัวอย่างของความสัมพันธ์ดังกล่าวคือการมอบสิทธิ์หรือสิทธิ์ต่างๆ
รายการ |
---|
ดึงรายการของคำสั่งทั้งหมดจากแหล่งที่มาที่ระบุ ซึ่งตรงกับเป้าหมายและสตริงคำสั่งที่ระบุ API นี้รับประกันว่าข้อความทั้งหมดที่มีชิ้นงานแหล่งที่มาที่ปลอดภัย เช่น เว็บไซต์ HTTPS หรือแอป Android นั้นสร้างขึ้นอย่างปลอดภัยโดยเจ้าของเนื้อหาเหล่านั้น ดังที่อธิบายไว้ในข้อกำหนดทางเทคนิคเกี่ยวกับการออกแบบลิงก์เนื้อหาดิจิทัล (Digital Asset Links) โดยเฉพาะอย่างยิ่ง คุณควรพิจารณาสิ่งนี้สำหรับเว็บไซต์ที่ไม่ปลอดภัย (กล่าวคือ URL ขึ้นต้นด้วย คำสั่ง |
AndroidAppAsset
อธิบายชิ้นงานแอป Android
ชื่อช่อง | ประเภท | คำอธิบาย |
---|---|---|
package_name |
string |
โดยปกติแล้วเนื้อหาแอป Android จะระบุด้วยชื่อแพ็กเกจ Java ตัวอย่างเช่น แอป Google Maps ใช้ชื่อแพ็กเกจ com.google.android.apps.maps ต้องระบุ |
certificate |
|
เนื่องจากไม่มีการบังคับใช้ที่ไม่ซ้ำกันสำหรับชื่อแพ็กเกจทั่วโลก เราจึงกำหนดให้ต้องมีใบรับรองที่ลงนามด้วย ซึ่งเมื่อใช้ร่วมกับชื่อแพ็กเกจจะระบุแอปที่ไม่ซ้ำกัน คีย์ Signing ของบางแอปจะมีการหมุนเวียน ดังนั้นอาจมีการลงชื่อโดยใช้คีย์ต่างๆ เมื่อเวลาผ่านไป เราถือว่าข้อมูลเหล่านี้เป็นเนื้อหาที่แตกต่างกันเนื่องจากเราใช้ (ชื่อแพ็กเกจ ใบรับรอง) เป็นรหัสที่ไม่ซ้ำกัน โดยปกตินี้จะไม่ก่อให้เกิดปัญหาใดๆ เนื่องจากแอปทั้ง 2 เวอร์ชันจะมีข้อความที่เหมือนกันหรือคล้ายกัน อย่างไรก็ตาม เนื้อหาอื่นๆ ที่ระบุข้อความเกี่ยวกับแอปจะต้องได้รับการอัปเดตเมื่อมีการหมุนเวียนคีย์ (โปรดทราบว่าไวยากรณ์สำหรับการเผยแพร่และการค้นหาข้อความจะมีน้ำตาลสังเคราะห์เพื่อให้คุณระบุแอปที่ใบรับรองหลายใบรู้จักได้อย่างง่ายดาย) ต้องระบุ |
CertificateInfo
อธิบายใบรับรอง X509
ชื่อช่อง | ประเภท | คำอธิบาย |
---|---|---|
sha256_fingerprint |
string |
ลายนิ้วมือ SHA-265 ตัวพิมพ์ใหญ่ของใบรับรอง ใบรับรอง PEM จะรับรูปแบบต่อไปนี้ได้
หรือแบบนี้
ในตัวอย่างนี้ เนื้อหาของช่องนี้จะเป็น หากเครื่องมือเหล่านี้ไม่พร้อมใช้งาน คุณสามารถแปลงใบรับรอง PEM เป็นรูปแบบ DER โดยคำนวณแฮช SHA-256 ของสตริงนั้นและแสดงผลลัพธ์เป็นสตริงฐานสิบหก (ซึ่งก็คือเลขฐานสิบหกตัวพิมพ์ใหญ่ของอ็อกเท็ตแต่ละตัว โดยคั่นด้วยโคลอน) |
ชิ้นงาน
ระบุเนื้อหาโดยไม่ซ้ำกัน
เนื้อหาดิจิทัลคือเอนทิตีออนไลน์ที่ระบุตัวบุคคลนั้นได้และเข้าถึงได้ ซึ่งโดยปกติแล้วจะให้บริการหรือเนื้อหาบางอย่าง ตัวอย่างเนื้อหา ได้แก่ เว็บไซต์, แอป Android, ฟีด Twitter และ Plus Pages
ชื่อช่อง | ประเภท | คำอธิบาย |
---|---|---|
ฟิลด์สหภาพ มีเพียงรายการใดรายการหนึ่งต่อไปนี้ | ||
web |
|
กำหนดว่าเนื้อหานี้เป็นเนื้อหาเว็บหรือไม่ |
android_app |
|
กำหนดว่าเป็นชิ้นงานแอป Android หรือไม่ |
CheckRequest
ข้อความที่ใช้ตรวจสอบการมีอยู่ของลิงก์ชิ้นงานที่เฉพาะเจาะจง
ชื่อช่อง | ประเภท | คำอธิบาย |
---|---|---|
source |
|
แหล่งที่มาที่โฮสต์รายการใบแจ้งยอด ใช้เพื่อกำหนดเส้นทางการเรียก Check() ไปยังต้นทางที่เหมาะสม |
relation |
string |
สตริงการค้นหาสำหรับความสัมพันธ์ เราจะระบุความสัมพันธ์กับสตริงของรูปแบบ โปรดดูเอกสารประกอบของ API สำหรับรายการความสัมพันธ์ที่รองรับในปัจจุบัน ในการค้นหาจับคู่ลิงก์เนื้อหา ทั้งสตริงที่เกี่ยวข้องของการค้นหาและลิงก์เนื้อหาต้องตรงกันทุกประการ เช่น การค้นหาที่มีความสัมพันธ์ |
target |
|
เนื้อหาเป้าหมายของใบแจ้งยอด |
CheckResponse
ข้อความตอบกลับสำหรับการโทร CheckAssetLinks
ชื่อช่อง | ประเภท | คำอธิบาย |
---|---|---|
linked |
bool |
ตั้งค่าเป็น "จริง" หากเนื้อหาที่ระบุในคำขอลิงก์ตามความเกี่ยวข้องที่ระบุไว้ในคำขอ ต้องระบุ |
max_age |
|
ตั้งแต่เวลาที่แสดง การตอบกลับควรถือว่านานกว่าระยะเวลาใดหากจำเป็นต้องอัปเดตเพิ่มเติม ต้องระบุ |
debug_string |
string |
ข้อความที่มนุษย์อ่านได้ซึ่งมีข้อมูลเพื่อช่วยให้ผู้ใช้ปลายทางเข้าใจ ทำซ้ำ และแก้ไขข้อบกพร่องของผลลัพธ์ ข้อความจะเป็นภาษาอังกฤษและขณะนี้เราไม่ได้วางแผนที่จะให้บริการแปล โปรดทราบว่าไม่มีการรับประกันเกี่ยวกับเนื้อหาหรือรูปแบบของสตริงนี้ อาจมีการเปลี่ยนแปลงในด้านใดโดยไม่ต้องแจ้งให้ทราบล่วงหน้า คุณไม่ควรพยายามแยกวิเคราะห์ข้อมูลนี้แบบเป็นโปรแกรม หากคุณรู้สึกว่าจำเป็นต้องทำเช่นนี้เนื่องจาก API ไม่ได้เปิดเผยข้อมูลที่คุณต้องการ โปรดติดต่อเราก่อน |
ListRequest
ข้อความที่ใช้ขอคำชี้แจงทั้งหมดที่ทราบซึ่งมีแหล่งที่มาและความเกี่ยวข้องที่ระบุ
ชื่อช่อง | ประเภท | คำอธิบาย |
---|---|---|
source |
|
แหล่งที่มาที่โฮสต์รายการใบแจ้งยอด ใช้เพื่อส่งคำขอ List() ไปยังแหล่งที่มาที่ถูกต้อง ต้องระบุ |
relation |
string |
ใช้เฉพาะการเชื่อมโยงที่ตรงกับความสัมพันธ์ที่ระบุ ดูคำอธิบายโดยละเอียดของสตริงที่เกี่ยวข้องในข้อความ ข้อความค้นหาตรงกับคำสั่ง ข้อใดข้อหนึ่งต่อไปนี้ต้องเป็นจริง
เช่น การค้นหาที่มีความสัมพันธ์ |
ListResponse
ข้อความตอบกลับสำหรับการเรียกรายการ
ชื่อช่อง | ประเภท | คำอธิบาย |
---|---|---|
statements |
|
รายการข้อความที่ตรงกันทั้งหมดที่พบ |
max_age |
|
ตั้งแต่เวลาที่แสดง การตอบกลับควรถือว่านานกว่าระยะเวลาใดหากจำเป็นต้องอัปเดตเพิ่มเติม ต้องระบุ |
debug_string |
string |
ข้อความที่มนุษย์อ่านได้ซึ่งมีข้อมูลเพื่อช่วยให้ผู้ใช้ปลายทางเข้าใจ ทำซ้ำ และแก้ไขข้อบกพร่องของผลลัพธ์ ข้อความจะเป็นภาษาอังกฤษและขณะนี้เราไม่ได้วางแผนที่จะให้บริการแปล โปรดทราบว่าไม่มีการรับประกันเกี่ยวกับเนื้อหาหรือรูปแบบของสตริงนี้ อาจมีการเปลี่ยนแปลงในด้านใดโดยไม่ต้องแจ้งให้ทราบล่วงหน้า คุณไม่ควรพยายามแยกวิเคราะห์ข้อมูลนี้แบบเป็นโปรแกรม หากคุณรู้สึกว่าจำเป็นต้องทำเช่นนี้เนื่องจาก API ไม่ได้เปิดเผยข้อมูลที่คุณต้องการ โปรดติดต่อเราก่อน |
คำสั่ง
อธิบายข้อความที่เชื่อถือได้เกี่ยวกับความสัมพันธ์ระหว่างชิ้นงานแหล่งที่มากับเนื้อหาเป้าหมาย
ใบแจ้งยอดจะสร้างขึ้นโดยเนื้อหาแหล่งที่มาเสมอ ไม่ว่าจะโดยตรงหรือด้วยการมอบสิทธิ์ไปยังรายการใบแจ้งยอดที่จัดเก็บไว้ที่อื่น
ดูคำจำกัดความของข้อความและชิ้นงานโดยละเอียดได้ที่หน้า Landing Page สําหรับเอกสาร API
ชื่อช่อง | ประเภท | คำอธิบาย |
---|---|---|
source |
|
ทุกใบแจ้งยอดจะมีเนื้อหาแหล่งที่มา ต้องระบุ |
relation |
string |
ความเกี่ยวข้องจะระบุถึงการใช้คำสั่งตามที่เจ้าของเนื้อหาแหล่งที่มาต้องการ (กล่าวคือ บุคคลหรือนิติบุคคลที่ออกคำชี้แจง) ทุกถ้อยคำที่สมบูรณ์มีความเกี่ยวข้อง เราจะระบุความสัมพันธ์กับสตริงของรูปแบบ โปรดดูเอกสารประกอบของ API สำหรับรายการความสัมพันธ์ที่รองรับในปัจจุบัน ตัวอย่าง: |
target |
|
ทุกใบแจ้งยอดจะมีเนื้อหาเป้าหมาย ต้องระบุ |
WebAsset
อธิบายเนื้อหาเว็บ
ชื่อช่อง | ประเภท | คำอธิบาย |
---|---|---|
site |
string |
เนื้อหาในเว็บจะระบุโดย URL ที่มีเฉพาะรูปแบบ ชื่อโฮสต์ และส่วนพอร์ต รูปแบบคือ
ชื่อโฮสต์ต้องเป็นแบบเต็ม โดยต้องลงท้ายด้วยจุดเดียว (" เฉพาะรูปแบบ "http" และ "https" เท่านั้นในปัจจุบัน หมายเลขพอร์ตจะระบุเป็นเลขทศนิยม และต้องละเว้นหากใช้หมายเลขพอร์ตมาตรฐาน เช่น 80 สำหรับ http และ 443 สำหรับ https เราเรียก URL ที่จำกัดนี้ว่า "ไซต์" URL ทั้งหมดที่ใช้รูปแบบ ชื่อโฮสต์ และพอร์ตเดียวกันถือว่าเป็นส่วนหนึ่งของเว็บไซต์ ดังนั้นจึงเป็นของเนื้อหาเว็บ ตัวอย่างเช่น เนื้อหาที่มีเว็บไซต์
แต่ไม่มี URL เหล่านี้:
|