Package google.digitalassetlinks.v1

Indeks

Laporan mutasi

Layanan API ini menyajikan "pernyataan", yang merupakan kendaraan yang digunakan oleh pemilik aset untuk memublikasikan informasi tentang tautan aset mereka. API ini dapat digunakan untuk mengambil pernyataan dengan cara yang mudah dan aman, tanpa perlu memperoleh pernyataan langsung dari sumber.

Semua pernyataan yang ditampilkan oleh API ini telah dibuat atas nama aset digital (misalnya, situs atau aplikasi Android) tentang aset digital lainnya. Setiap pernyataan berisi aset sumber, aset target, dan satu atau beberapa relasi.

Hubungan menjelaskan hubungan antara dua aset seperti yang diklaim oleh aset sumber. Contoh untuk hubungan tersebut adalah delegasi hak istimewa atau izin.

Daftar

rpc List(ListRequest) returns (ListResponse)

Mengambil daftar semua pernyataan dari sumber tertentu yang cocok dengan target dan string pernyataan yang ditentukan.

API menjamin bahwa semua pernyataan dengan aset sumber yang aman, seperti situs HTTPS atau aplikasi Android, telah dibuat dengan cara yang aman oleh pemilik aset tersebut, seperti yang dijelaskan dalam spesifikasi desain teknis Digital Asset Links. Secara khusus, Anda harus mempertimbangkan bahwa untuk situs yang tidak aman (yaitu, jika URL diawali dengan http://, bukan https://), jaminan ini tidak dapat dibuat.

Perintah List paling berguna jika klien API ingin mengetahui semua cara yang menghubungkan dua aset, atau menghitung semua hubungan dari aset sumber tertentu. Contoh: fitur yang membantu pengguna membuka item terkait. Saat aplikasi seluler berjalan di perangkat, fitur tersebut akan mempermudah navigasi ke situs web atau profil Google+ yang sesuai.

AndroidAppAsset

Menjelaskan aset aplikasi android.

Nama kolom Jenis Deskripsi
package_name string Aset Aplikasi Android secara alami diidentifikasi berdasarkan nama paket Java-nya. Misalnya, aplikasi Google Maps menggunakan nama paket com.google.android.apps.maps. WAJIB DIISI
certificate CertificateInfo

Karena tidak ada penerapan global keunikan nama paket, kami juga memerlukan sertifikat penandatanganan, yang jika dikombinasikan dengan nama paket akan mengidentifikasi aplikasi secara unik.

Beberapa kunci penandatanganan aplikasi dirotasi, sehingga kunci tersebut mungkin ditandatangani oleh kunci yang berbeda dari waktu ke waktu. Kami memperlakukan aset ini sebagai aset yang berbeda, karena kami menggunakan (nama paket, sertifikat) sebagai ID unik. Biasanya ini tidak akan menimbulkan masalah karena kedua versi aplikasi akan membuat pernyataan yang sama atau serupa. Namun, pernyataan pembuatan aset lain tentang aplikasi harus diperbarui saat kunci dirotasi.

(Perhatikan bahwa sintaksis untuk memublikasikan dan membuat kueri untuk pernyataan berisi sugar sintaksis agar Anda dapat dengan mudah menentukan aplikasi yang diketahui oleh beberapa sertifikat.) WAJIB DIISI

Info Sertifikat

Menjelaskan sertifikat X509.

Nama kolom Jenis Deskripsi
sha256_fingerprint string

Sidik jari SHA-265 huruf besar pada sertifikat. Dari sertifikat PEM, dapat diperoleh seperti ini:

$ 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

atau seperti ini:

$ 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

Dalam contoh ini, konten kolom ini adalah 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.

Jika alat ini tidak tersedia untuk Anda, Anda dapat mengonversi sertifikat PEM ke dalam format DER, menghitung hash SHA-256 dari string tersebut dan merepresentasikan hasilnya sebagai string heksadesimal (yaitu, representasi heksadesimal huruf besar dari setiap oktet, yang dipisahkan dengan titik dua).

Aset

Secara unik mengidentifikasi aset.

Aset digital adalah entitas online yang dapat diidentifikasi dan dapat dialamatkan yang biasanya menyediakan beberapa layanan atau konten. Contoh aset adalah situs, aplikasi Android, feed Twitter, dan Halaman Plus.

Nama kolom Jenis Deskripsi
Kolom union, hanya salah satu dari yang berikut:
web WebAsset Tetapkan jika ini adalah aset web.
android_app AndroidAppAsset Tetapkan jika ini adalah aset Aplikasi Android.

CheckRequest

Pesan yang digunakan untuk memeriksa keberadaan link aset tertentu.

Nama kolom Jenis Deskripsi
source Asset Sumber yang menghosting daftar pernyataan. Ini digunakan untuk merutekan panggilan Check() ke sumber yang tepat.
relation string

String kueri untuk relasi.

Kami mengidentifikasi hubungan dengan string format <kind>/<detail>, dengan <kind> harus merupakan salah satu dari kumpulan kategori tujuan yang telah ditentukan, dan <detail> adalah string alfanumerik huruf kecil bentuk bebas yang menjelaskan kasus penggunaan tertentu dari pernyataan tersebut.

Lihat dokumentasi API kami untuk mengetahui daftar relasi yang didukung saat ini.

Agar kueri cocok dengan link aset, string relasi link kueri dan link aset harus sama persis.

Contoh: Kueri dengan relasi delegate_permission/common.handle_all_urls cocok dengan link aset terkait relasi delegate_permission/common.handle_all_urls.
target Asset Aset target dari pernyataan.

CheckResponse

Pesan respons untuk panggilan CheckAssetLinks.

Nama kolom Jenis Deskripsi
linked bool Tetapkan ke true jika aset yang ditentukan dalam permintaan ditautkan oleh relasi yang ditentukan dalam permintaan. WAJIB DIISI
max_age Duration Dari waktu penayangan, berapa lama respons harus dianggap valid kecuali jika pembaruan lebih lanjut. WAJIB DIISI
debug_string string

Pesan yang dapat dibaca manusia yang berisi informasi yang dimaksudkan untuk membantu pengguna akhir memahami, mereproduksi, dan men-debug hasilnya.

Pesan tersebut akan menggunakan bahasa Inggris dan saat ini kami tidak berencana untuk menawarkan terjemahan apa pun.

Harap perhatikan bahwa tidak ada jaminan yang dibuat untuk konten atau format string ini. Aspek mana pun dapat berubah tanpa pemberitahuan. Anda tidak boleh mencoba mengurai data ini secara terprogram. Jika Anda merasa bahwa Anda harus melakukan hal ini karena informasi yang diperlukan tidak diekspos oleh API, hubungi kami terlebih dahulu.

PermintaanDaftar

Pesan yang digunakan untuk meminta semua pernyataan yang diketahui yang memiliki sumber dan relasi tertentu.

Nama kolom Jenis Deskripsi
source Asset Sumber yang menghosting daftar pernyataan. Ini digunakan untuk mengarahkan permintaan List() ke sumber yang tepat. WAJIB DIISI
relation string

Hanya gunakan atribusi yang cocok dengan relasi yang ditentukan.

Lihat pesan Statement untuk mengetahui definisi detail string relasi.

Agar kueri cocok dengan pernyataan, salah satu hal berikut harus dipenuhi:

  • string relasi kueri dan pernyataan sama persis, atau
  • String relasi kueri kosong atau tidak ada.

Contoh: Kueri dengan relasi delegate_permission/common.handle_all_urls cocok dengan link aset terkait relasi delegate_permission/common.handle_all_urls.

ListResponse

Pesan respons untuk panggilan List.

Nama kolom Jenis Deskripsi
statements Statement Daftar semua pernyataan yang cocok yang telah ditemukan.
max_age Duration Dari waktu penayangan, berapa lama respons harus dianggap valid kecuali jika pembaruan lebih lanjut. WAJIB DIISI
debug_string string

Pesan yang dapat dibaca manusia yang berisi informasi yang dimaksudkan untuk membantu pengguna akhir memahami, mereproduksi, dan men-debug hasilnya.

Pesan tersebut akan menggunakan bahasa Inggris dan saat ini kami tidak berencana untuk menawarkan terjemahan apa pun.

Harap perhatikan bahwa tidak ada jaminan yang dibuat untuk konten atau format string ini. Aspek mana pun dapat berubah tanpa pemberitahuan. Anda tidak boleh mencoba mengurai data ini secara terprogram. Jika Anda merasa bahwa Anda harus melakukan hal ini karena informasi yang diperlukan tidak diekspos oleh API, hubungi kami terlebih dahulu.

Pernyataan

Menjelaskan pernyataan andal yang telah dibuat tentang hubungan antara aset sumber dan aset target.

Pernyataan selalu dibuat oleh aset sumber, baik secara langsung maupun dengan mendelegasikan ke daftar pernyataan yang disimpan di tempat lain.

Untuk definisi yang lebih mendetail tentang pernyataan dan aset, lihat halaman landing dokumentasi API.

Nama kolom Jenis Deskripsi
source Asset Setiap pernyataan memiliki aset sumber. WAJIB DIISI
relation string

Hubungan mengidentifikasi penggunaan laporan seperti yang diinginkan oleh pemilik aset sumber (yaitu, orang atau entitas yang menerbitkan pernyataan tersebut). Setiap pernyataan yang lengkap memiliki hubungan.

Kami mengidentifikasi hubungan dengan string format <kind>/<detail>, dengan <kind> harus merupakan salah satu dari kumpulan kategori tujuan yang telah ditentukan, dan <detail> adalah string alfanumerik huruf kecil bentuk bebas yang menjelaskan kasus penggunaan tertentu dari pernyataan tersebut.

Lihat dokumentasi API kami untuk mengetahui daftar relasi yang didukung saat ini.

Contoh: delegate_permission/common.handle_all_urls REQUIRED
target Asset Setiap pernyataan memiliki aset target. WAJIB DIISI

AsetWeb

Menjelaskan aset web.

Nama kolom Jenis Deskripsi
site string

Aset web diidentifikasi oleh URL yang hanya berisi skema, nama host, dan bagian port. Formatnya adalah

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

Nama host harus sepenuhnya memenuhi syarat: nama host harus diakhiri dengan satu titik (".").

Hanya skema "http" dan "https" yang saat ini diizinkan.

Nomor port diberikan sebagai angka desimal, dan harus dihilangkan jika nomor port standar digunakan: 80 untuk http dan 443 untuk https.

Kami menyebut URL terbatas ini sebagai "situs". Semua URL yang memiliki skema, nama host, dan port yang sama dianggap sebagai bagian dari situs dan akan menjadi milik aset web.

Contoh: aset dengan situs https://www.google.com berisi semua URL berikut:

  • 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/

Namun, URL tersebut tidak berisi URL berikut:

  • http://www.google.com/ (skema salah)
  • https://google.com/ (nama host tidak cocok)
  • https://www.google.com:444/ (port tidak cocok) WAJIB