Method: projects.histories.executions.steps.accessibilityClusters

Mencantumkan cluster aksesibilitas untuk Langkah tertentu

Dapat menampilkan salah satu kode error kanonis berikut:

  • PERMISSION_DENIED - jika pengguna tidak berwenang untuk membaca project
  • INVALID_ARGUMENT - jika permintaan salah format
  • FAILED_PRECONDITION - jika sebuah argumen dalam permintaan kebetulan tidak valid; mis. jika format lokalitas salah
  • NOT_FOUND - jika Langkah yang memuatnya tidak ada

Permintaan HTTP

GET https://toolresults.googleapis.com/toolresults/v1beta3/{name=projects/*/histories/*/executions/*/steps/*}:accessibilityClusters

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Nama resource lengkap langkah. Misalnya, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Wajib diisi.

Parameter kueri

Parameter
locale

string

Format yang diterima adalah format Unicode kanonis dengan tanda hubung sebagai pembatas. Bahasa harus huruf kecil, Language Script - Kapitalisasi, Wilayah - HURUF BESAR. Lihat http://www.unicode.org/reports/tr35/#Unicode_locale_identifier untuk mengetahui detailnya.

Wajib diisi.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk AccessibilityService.ListStepAccessibilityClusters.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "name": string,
  "clusters": [
    {
      object (SuggestionClusterProto)
    }
  ]
}
Kolom
name

string

Nama resource lengkap langkah. Misalnya, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Selalu presentasikan.

clusters[]

object (SuggestionClusterProto)

Urutan saran aksesibilitas, yang dikelompokkan menjadi beberapa cluster. Dalam urutan tersebut, cluster yang termasuk dalam SuggestionCategory yang sama harus berdekatan. Dalam setiap kategori, cluster harus diurutkan berdasarkan SuggestionPriority (ERROR terlebih dahulu). Kategori harus diurutkan berdasarkan cluster prioritas tertingginya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

SuggestionClusterProto

Serangkaian saran serupa yang kami duga memiliki hubungan erat.

Prototipe ini dan sebagian besar proto bertingkat memiliki cabang dari foxandcrown.prelaunchreport.service.SuggestionClusterProto, yang menggantikan dependensi PLR dengan FTL.

Representasi JSON
{
  "category": enum (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
Kolom
category

enum (SuggestionCategory)

Kategori tempat jenis saran ini akan muncul. Selalu tetapkan.

suggestions[]

object (SuggestionProto)

Urutan saran. Semua saran dalam cluster harus memiliki SuggestionPriority yang sama dan termasuk dalam SuggestionCategory yang sama. Saran dengan URL screenshot yang sama harus berdekatan.

Kategori Saran

Enum
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

SaranProto

Representasi JSON
{
  "title": string,
  "shortMessage": {
    object (SafeHtmlProto)
  },
  "longMessage": {
    object (SafeHtmlProto)
  },
  "priority": enum (SuggestionPriority),
  "helpUrl": string,
  "region": {
    object (RegionProto)
  },
  "secondaryPriority": number,
  "screenId": string,

  // Union field resource_id can be only one of the following:
  "resourceName": string,
  "pseudoResourceId": string
  // End of list of possible types for union field resource_id.
}
Kolom
title

string

Judul umum untuk saran, dalam bahasa pengguna, tanpa markup. Selalu tetapkan.

shortMessage

object (SafeHtmlProto)

Pesan singkat, dalam bahasa pengguna, yang mewakili saran, yang mungkin berisi markup. Selalu tetapkan.

longMessage

object (SafeHtmlProto)

Pesan, dalam bahasa pengguna, yang menjelaskan saran, yang mungkin berisi markup. Selalu tetapkan.

priority

enum (SuggestionPriority)

Nilai penting relatif suatu saran. Selalu tetapkan.

helpUrl

string

Referensi ke artikel pusat bantuan terkait jenis saran ini. Selalu tetapkan.

region

object (RegionProto)

Wilayah dalam screenshot yang relevan dengan saran ini. Opsional.

secondaryPriority

number

Nilai penting relatif suatu saran dibandingkan dengan saran lain yang memiliki prioritas dan kategori yang sama. Ini adalah nilai tidak bermakna yang dapat digunakan untuk mengurutkan saran yang ada dalam kategori yang sama dan memiliki prioritas yang sama. Nilai yang lebih besar memiliki prioritas yang lebih tinggi (yaitu, lebih penting). Opsional.

screenId

string

ID layar untuk saran. Ini digunakan untuk mendapatkan jalur screenshot yang sesuai. Misalnya, screenId "1" sesuai dengan "1.png" di GCS. Selalu tetapkan.

Kolom union resource_id.

resource_id hanya dapat berupa salah satu dari yang berikut:

resourceName

string

Rujukan ke elemen tampilan, yang diidentifikasi melalui nama resource-nya, jika ada.

pseudoResourceId

string

ID tampilan sumber yang dapat dibaca manusia, jika tidak memiliki resourceName. Ini adalah jalur dalam hierarki aksesibilitas, yaitu elemen dengan nama resource; mirip dengan XPath.

SafeHtmlProto

PENTING: Menerima pesan ini dari sumber yang tidak tepercaya tidak aman karena mudah bagi penyerang untuk memalsukan pesan serial yang tidak memenuhi kontrak keamanan jenis tersebut -- misalnya, pesan ini dapat berisi skrip yang dikontrol penyerang. Sistem yang menerima SafehtmlProto secara implisit memercayai produser SafehtmlProto. Jadi, umumnya aman untuk menampilkan pesan ini dalam respons RPC, tetapi umumnya tidak aman untuk menerimanya dalam permintaan RPC.

Representasi JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
Kolom
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

PENTING: Jangan pernah menetapkan atau membaca bidang ini, bahkan dari tes, bidang ini bersifat pribadi. Lihat dokumentasi di bagian atas file .proto untuk paket bahasa pemrograman yang akan digunakan untuk membuat atau membaca pesan ini.

Prioritas Saran

Enum
unknownPriority
error
warning
info

RegionProto

Wilayah persegi panjang.

Representasi JSON
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
Kolom
topPx

integer

Bagian atas persegi panjang, dalam piksel. Selalu tetapkan.

leftPx

integer

Sisi kiri persegi panjang, dalam {i>pixel<i}. Selalu tetapkan.

heightPx

integer

Tinggi, dalam piksel. Selalu tetapkan.

widthPx

integer

Lebar dalam piksel. Selalu tetapkan.