Package google.digitalassetlinks.v1

ดัชนี

ใบแจ้งยอดประจำเดือน

บริการ API นี้แสดง "ใบแจ้งยอด" ซึ่งเป็นยานพาหนะที่เจ้าของเนื้อหาใช้เพื่อเผยแพร่ข้อมูลเกี่ยวกับลิงก์เนื้อหา คุณสามารถใช้ API เพื่อเรียกข้อมูลใบแจ้งยอดได้ง่ายๆ และปลอดภัย โดยไม่ต้องขอรับคําสั่งจากแหล่งที่มาโดยตรง

ข้อความทั้งหมดที่ API นี้ส่งมาในนามของเนื้อหาดิจิทัล (เช่น เว็บไซต์หรือแอป Android) เกี่ยวกับเนื้อหาดิจิทัลอื่นๆ แต่ละข้อความมีเนื้อหาแหล่งที่มา เนื้อหาเป้าหมาย และความสัมพันธ์อย่างน้อย 1 รายการ

ความสัมพันธ์อธิบายความสัมพันธ์ระหว่างเนื้อหา 2 รายการนี้ตามที่มีการอ้างสิทธิ์โดยเนื้อหาแหล่งที่มา ตัวอย่างความสัมพันธ์ดังกล่าว ได้แก่ การมอบสิทธิ์หรือสิทธิ์ต่างๆ

รายการ

rpc List(ListRequest) returns (ListResponse)

เรียกรายการคําสั่งทั้งหมดจากแหล่งที่มาที่ระบุซึ่งตรงกับสตริงเป้าหมายและสตริงข้อความที่ระบุ

API รับประกันได้ว่าคําแถลงทั้งหมดซึ่งมีชิ้นงานแหล่งที่มาที่ปลอดภัย เช่น เว็บไซต์ HTTPS หรือแอป Android ได้ดําเนินการอย่างปลอดภัยโดยเจ้าของเนื้อหาเหล่านั้น ตามที่อธิบายไว้ในข้อกําหนดการออกแบบทางเทคนิคของลิงก์เนื้อหาดิจิทัล โดยเฉพาะอย่างยิ่ง คุณควรคํานึงถึงว่าเว็บไซต์ที่ไม่ปลอดภัย (เช่น ที่ URL ขึ้นต้นด้วย http:// แทนที่จะเป็น https://) ไม่สามารถรับประกันได้

คําสั่ง List มีประโยชน์มากที่สุดในกรณีที่ไคลเอ็นต์ API ต้องการทราบวิธีต่างๆ ที่เกี่ยวข้องกับชิ้นงาน 2 รายการหรือแจกแจงความสัมพันธ์ทั้งหมดจากชิ้นงานแหล่งที่มาหนึ่งๆ ตัวอย่าง: ฟีเจอร์ที่ช่วยให้ผู้ใช้ไปยังรายการที่เกี่ยวข้องได้ เมื่อแอปบนอุปกรณ์เคลื่อนที่กําลังทํางาน ฟีเจอร์นี้จะช่วยให้คุณไปที่เว็บไซต์หรือโปรไฟล์ Google+ ที่เกี่ยวข้องได้อย่างง่ายดาย

เนื้อหาแอป Android

อธิบายชิ้นงานแอป Android

ชื่อช่อง ประเภท คำอธิบาย
package_name string ปกติแล้วเนื้อหาแอป Android จะอิงตามชื่อแพ็กเกจ Java เช่น แอป Google Maps ใช้ชื่อแพ็กเกจ com.google.android.apps.maps ต้องระบุ
certificate CertificateInfo

เนื่องจากมีการบังคับใช้ความเป็นเอกลักษณ์ของชื่อแพ็กเกจที่ไม่ซ้ํากัน เราจึงกําหนดให้ต้องมีใบรับรองการลงนามร่วมกับชื่อแพ็กเกจเพื่อระบุแอปที่ไม่ซ้ํากัน

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

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

ข้อมูลใบรับรอง

อธิบายใบรับรอง X509

ชื่อช่อง ประเภท คำอธิบาย
sha256_fingerprint string

ลายนิ้วมือ SHA-265 ตัวพิมพ์ใหญ่ของใบรับรอง จากใบรับรอง PEM ดได้ดังต่อไปนี้

$ keytool -printcert -file $CERTFILE | grep SHA256:
SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \
    42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5

หรือแบบนี้

$ openssl x509 -in $CERTFILE -noout -fingerprint -sha256
SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \
    16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5

ในตัวอย่างนี้ เนื้อหาในช่องนี้จะเป็น 14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5

หากเครื่องมือเหล่านี้ไม่พร้อมใช้งาน คุณอาจแปลงใบรับรอง PEM เป็นรูปแบบ DER คํานวณแฮช SHA-256 ของสตริงนั้นและแสดงผลลัพธ์เป็นเลขฐานสิบหก (กล่าวคือ เลขฐานสิบหกตัวพิมพ์ใหญ่ของเลขฐานแต่ละอ็อกเท็ต โดยคั่นด้วยโคลอน)

ชิ้นงาน

ระบุเนื้อหาที่ไม่ซ้ํา

เนื้อหาดิจิทัลคือเอนทิตีออนไลน์ที่ระบุตัวบุคคลนั้นได้และจัดการได้ ซึ่งโดยทั่วไปแล้วจะมีบริการหรือเนื้อหาบางอย่าง ตัวอย่างเนื้อหา ได้แก่ เว็บไซต์, แอป Android, ฟีด Twitter และเพจ Plus

ชื่อช่อง ประเภท คำอธิบาย
ช่อง Union เพียงช่องใดช่องหนึ่งต่อไปนี้
web WebAsset กําหนดว่านี่คือเนื้อหาบนเว็บหรือไม่
android_app AndroidAppAsset กําหนดว่านี่คือชิ้นงานแอป Android หรือไม่

ตรวจสอบคําขอ

ข้อความที่ใช้สําหรับตรวจสอบว่ามีลิงก์เนื้อหานั้นๆ หรือไม่

ชื่อช่อง ประเภท คำอธิบาย
source Asset แหล่งที่มาที่โฮสต์รายการคําสั่ง ใช้เพื่อกําหนดเส้นทางการเรียก Check() ไปยังแหล่งที่มาที่เหมาะสม
relation string

สตริงการค้นหาสําหรับความสัมพันธ์

เราระบุความสัมพันธ์กับสตริงรูปแบบ <kind>/<detail> โดยที่ <kind> ต้องเป็นหนึ่งในชุดหมวดหมู่วัตถุประสงค์ที่กําหนดไว้ล่วงหน้า และ <detail> เป็นสตริงที่เป็นตัวอักษรและตัวเลขคละกันแบบอิสระซึ่งอธิบาย Use Case ที่เจาะจงของใบแจ้งยอด

โปรดดูรายการเอกสารสนับสนุนที่รองรับในปัจจุบันจากเอกสารประกอบเกี่ยวกับ API

คําค้นหาต้องตรงกับลิงก์ชิ้นงาน ทั้งสตริงความสัมพันธ์ของสตริงการค้นหาและคําค้นหาต้องตรงกันทุกประการ

ตัวอย่าง: คําค้นหาที่มีความสัมพันธ์ delegate_permission/common.handle_all_urls ตรงกับลิงก์ของเนื้อหาที่มีความสัมพันธ์ delegate_permission/common.handle_all_urls
target Asset ชิ้นงานเป้าหมายของใบแจ้งยอด

การตอบกลับ

ข้อความตอบกลับสําหรับการเรียก CheckASSETLinks

ชื่อช่อง ประเภท คำอธิบาย
linked bool ตั้งค่าเป็นจริงหากชิ้นงานที่ระบุในคําขอลิงก์ด้วยความสัมพันธ์ที่ระบุไว้ในคําขอ ต้องระบุ
max_age Duration จากเวลาให้บริการ ระยะเวลาการตอบสนองควรถือว่าถูกต้องหากยังมีการอัปเดตเพิ่มเติม ต้องระบุ
debug_string string

ข้อความที่ผู้ใช้อ่านได้ซึ่งมีข้อมูลที่ช่วยให้ผู้ใช้ปลายทางเข้าใจ ทําซ้ํา และแก้ไขข้อบกพร่องของผลลัพธ์ได้

ข้อความจะเป็นภาษาอังกฤษ และขณะนี้เราไม่ได้วางแผนที่จะเสนอการแปล

โปรดทราบว่าไม่มีการรับประกันเกี่ยวกับเนื้อหาหรือรูปแบบของสตริงนี้ อาจมีการเปลี่ยนแปลงในด้านต่างๆ โดยไม่ต้องแจ้งให้ทราบ คุณไม่ควรพยายามแยกวิเคราะห์ข้อมูลนี้แบบเป็นโปรแกรม หากคุณรู้สึกว่าต้องทําเช่นนี้เนื่องจาก API ไม่ได้เปิดเผยข้อมูลที่คุณต้องการ โปรดติดต่อเราก่อน

คําขอรายการ

ข้อความที่ใช้เพื่อขอใบแจ้งยอดทั้งหมดที่ทราบซึ่งมีแหล่งที่มาและความสัมพันธ์ที่ระบุ

ชื่อช่อง ประเภท คำอธิบาย
source Asset แหล่งที่มาที่โฮสต์รายการคําสั่ง ใช้เพื่อเปลี่ยนเส้นทางคําขอ List() ไปยังแหล่งที่มาที่ถูกต้อง ต้องระบุ
relation string

ใช้เฉพาะการเชื่อมโยงที่ตรงกับความสัมพันธ์ที่ระบุเท่านั้น

โปรดดูข้อความ Statement สําหรับคําจํากัดความโดยละเอียดของสตริงความสัมพันธ์

หากต้องการให้การค้นหาตรงกับใบแจ้งยอด เงื่อนไขข้อใดข้อหนึ่งต่อไปนี้ต้องเป็นจริง

  • ทั้งสตริงคําค้นหาและสตริงความสัมพันธ์ของคําสั่งนั้นตรงกันทุกประการ หรือ
  • สตริงความสัมพันธ์ของการค้นหาว่างเปล่าหรือขาดหายไป

ตัวอย่าง: คําค้นหาที่มีความสัมพันธ์ delegate_permission/common.handle_all_urls ตรงกับลิงก์ของเนื้อหาที่มีความสัมพันธ์ delegate_permission/common.handle_all_urls

รายการคําตอบ

ข้อความตอบกลับสําหรับรายการนี้

ชื่อช่อง ประเภท คำอธิบาย
statements Statement รายการข้อความที่ตรงกันทั้งหมดที่พบ
max_age Duration จากเวลาให้บริการ ระยะเวลาการตอบสนองควรถือว่าถูกต้องหากยังมีการอัปเดตเพิ่มเติม ต้องระบุ
debug_string string

ข้อความที่ผู้ใช้อ่านได้ซึ่งมีข้อมูลที่ช่วยให้ผู้ใช้ปลายทางเข้าใจ ทําซ้ํา และแก้ไขข้อบกพร่องของผลลัพธ์ได้

ข้อความจะเป็นภาษาอังกฤษ และขณะนี้เราไม่ได้วางแผนที่จะเสนอการแปล

โปรดทราบว่าไม่มีการรับประกันเกี่ยวกับเนื้อหาหรือรูปแบบของสตริงนี้ อาจมีการเปลี่ยนแปลงในด้านต่างๆ โดยไม่ต้องแจ้งให้ทราบ คุณไม่ควรพยายามแยกวิเคราะห์ข้อมูลนี้แบบเป็นโปรแกรม หากคุณรู้สึกว่าต้องทําเช่นนี้เนื่องจาก API ไม่ได้เปิดเผยข้อมูลที่คุณต้องการ โปรดติดต่อเราก่อน

คำสั่ง

อธิบายคําชี้แจงที่เชื่อถือได้เกี่ยวกับความสัมพันธ์ระหว่างเนื้อหาแหล่งที่มากับเนื้อหาเป้าหมาย

คําสั่งจะสร้างตามเนื้อหาแหล่งที่มาเสมอ ไม่ว่าจะโดยตรงหรือกําหนดให้ใช้กับรายการคําสั่งที่เก็บไว้ในที่อื่น

สําหรับคําจํากัดความโดยละเอียดของใบแจ้งยอดและเนื้อหา โปรดดูหน้า Landing Page ของเอกสาร API ของเรา

ชื่อช่อง ประเภท คำอธิบาย
source Asset ทุกคําสั่งมีเนื้อหาแหล่งที่มา ต้องระบุ
relation string

ความสัมพันธ์จะระบุการใช้ข้อความตามที่เจ้าของเนื้อหาต้นทางต้องการ (กล่าวคือ บุคคลหรือนิติบุคคลที่ออกใบแจ้งยอด) ทุกข้อความสมบูรณ์มีความสัมพันธ์

เราระบุความสัมพันธ์กับสตริงรูปแบบ <kind>/<detail> โดยที่ <kind> ต้องเป็นหนึ่งในชุดหมวดหมู่วัตถุประสงค์ที่กําหนดไว้ล่วงหน้า และ <detail> เป็นสตริงที่เป็นตัวอักษรและตัวเลขคละกันแบบอิสระซึ่งอธิบาย Use Case ที่เจาะจงของใบแจ้งยอด

โปรดดูรายการเอกสารสนับสนุนที่รองรับในปัจจุบันจากเอกสารประกอบเกี่ยวกับ API

ตัวอย่าง: delegate_permission/common.handle_all_urls จําเป็น
target Asset ทุกคําสั่งมีเนื้อหาเป้าหมาย ต้องระบุ

เนื้อหาบนเว็บ

อธิบายเนื้อหาบนเว็บ

ชื่อช่อง ประเภท คำอธิบาย
site string

ชิ้นงานเว็บจะระบุโดย URL ที่มีเฉพาะรูปแบบของสคีม ชื่อโฮสต์ และส่วนพอร์ตเท่านั้น รูปแบบคือ

http[s]://<hostname>[:<port>]

ชื่อโฮสต์ต้องสมบูรณ์แบบ: ชื่อโฮสต์ต้องลงท้ายด้วยเครื่องหมายจุดเดียว (".")

อนุญาตให้ใช้เฉพาะรูปแบบ "http" และ "https" เท่านั้น

หมายเลขพอร์ตจะกําหนดให้เป็นตัวเลขทศนิยม และต้องละเว้นไว้หากใช้หมายเลขพอร์ตมาตรฐานคือ 80 สําหรับ http และ 443 สําหรับ https

ซึ่งเราเรียก URL นี้ว่า "เว็บไซต์" URL ทั้งหมดที่ใช้สคีม ชื่อโฮสต์ และพอร์ตเดียวกันนั้นเหมือนกันจะถือว่าเป็นส่วนหนึ่งของเว็บไซต์ และเป็นของชิ้นงานบนเว็บ

ตัวอย่าง: เนื้อหาที่มีเว็บไซต์ https://www.google.com มี URL ต่อไปนี้ทั้งหมด

  • https://www.google.com/
  • https://www.google.com:443/
  • https://www.google.com/foo
  • https://www.google.com/foo?bar
  • https://www.google.com/foo#bar
  • https://user@password:www.google.com/

แต่ไม่มี URL เหล่านี้

  • http://www.google.com/ (รูปแบบไม่ถูกต้อง)
  • https://google.com/ (ชื่อโฮสต์ไม่ตรงกัน)
  • https://www.google.com:444/ (พอร์ตไม่ตรงกัน) ต้องระบุ