Package google.digitalassetlinks.v1

Indeks

Pernyataan

Layanan API ini menampilkan "pernyataan", yaitu kendaraan yang digunakan oleh pemilik aset untuk memublikasikan informasi tentang link aset mereka. API ini dapat digunakan untuk mengambil pernyataan dengan cara yang sederhana dan aman, tanpa perlu memperoleh pernyataan langsung dari sumbernya.

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.

Relasi menjelaskan hubungan antara kedua aset seperti yang diklaim oleh aset sumber. Contoh untuk hubungan tersebut adalah pendelegasian hak istimewa atau izin.

Daftar

rpc List(ListRequest) returns (ListResponse)

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

API menjamin bahwa semua pernyataan dengan aset sumber yang aman, seperti situs HTTPS atau aplikasi Android, 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, dengan URL yang diawali dengan http:// bukan https://), jaminan ini tidak dapat diberikan.

Perintah List paling berguna jika klien API ingin mengetahui semua cara keterkaitan 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 memudahkan Anda untuk menavigasi 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
certificate CertificateInfo

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

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

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

CertificateInfo

Menjelaskan sertifikat X509.

Nama kolom Jenis Deskripsi
sha256_fingerprint string

Sidik jari SHA-265 huruf besar pada sertifikat. Dari sertifikat PEM, sertifikat PEM dapat diperoleh dengan cara berikut:

$ 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 mewakili 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 diberi alamat 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 laporan. 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 berupa salah satu dari kumpulan kategori tujuan yang ditentukan sebelumnya, dan <detail> adalah string alfanumerik huruf kecil bentuk bebas yang menjelaskan kasus penggunaan spesifik pernyataan.

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

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

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

CheckResponse

Pesan respons untuk panggilan CheckAssetLinks.

Nama kolom Jenis Deskripsi
linked bool Tetapkan ke benar jika aset yang ditentukan dalam permintaan ditautkan oleh hubungan yang ditentukan dalam permintaan. WAJIB
max_age Duration Mulai dari waktu penayangan, berapa lama lagi respons akan dianggap valid dengan membatasi update lebih lanjut. WAJIB
debug_string string

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

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

Perlu diketahui bahwa tidak ada jaminan yang dibuat terkait konten atau format string ini. Aspek apa pun dari konten tersebut dapat berubah tanpa pemberitahuan. Anda tidak boleh mencoba mengurai data ini secara terprogram. Jika Anda merasa perlu melakukan hal ini karena informasi yang Anda butuhkan tidak diekspos oleh API, hubungi kami terlebih dahulu.

ListRequest

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 laporan. Ini digunakan untuk mengarahkan permintaan List() ke sumber yang tepat. WAJIB
relation string

Hanya gunakan pengaitan yang cocok dengan relasi yang ditentukan.

Lihat pesan Statement untuk mengetahui definisi mendetail string relasi.

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

  • baik {i>string<i} relasi di kueri maupun pernyataan sama persis, atau
  • {i>string<i} relasi kueri kosong atau hilang.

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

ListResponse

Pesan respons untuk panggilan Daftar.

Nama kolom Jenis Deskripsi
statements Statement Daftar semua pernyataan yang cocok yang telah ditemukan.
max_age Duration Mulai dari waktu penayangan, berapa lama lagi respons akan dianggap valid dengan membatasi update lebih lanjut. WAJIB
debug_string string

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

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

Perlu diketahui bahwa tidak ada jaminan yang dibuat terkait konten atau format string ini. Aspek apa pun dari konten tersebut dapat berubah tanpa pemberitahuan. Anda tidak boleh mencoba mengurai data ini secara terprogram. Jika Anda merasa perlu melakukan hal ini karena informasi yang Anda butuhkan 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 laporan mutasi dan aset, lihat halaman landing dokumentasi API kami.

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

Relasi mengidentifikasi penggunaan pernyataan sebagaimana mestinya 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 berupa salah satu dari kumpulan kategori tujuan yang ditentukan sebelumnya, dan <detail> adalah string alfanumerik huruf kecil bentuk bebas yang menjelaskan kasus penggunaan spesifik pernyataan.

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

WebAsset

Menjelaskan aset web.

Nama kolom Jenis Deskripsi
site string

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

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

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

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 sehingga merupakan 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 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