Method: projects.histories.executions.steps.accessibilityClusters

แสดงรายการคลัสเตอร์การเข้าถึงสำหรับขั้นตอนที่กำหนด

อาจส่งคืนรหัสข้อผิดพลาดตามรูปแบบบัญญัติต่อไปนี้:

  • PERMISSION_DENIED - หากผู้ใช้ไม่ได้รับอนุญาตให้อ่านโครงการ
  • INVALID_ARGUMENT - หากคำขอมีรูปแบบไม่ถูกต้อง
  • FAILED_PRCONDITION - หากอาร์กิวเมนต์ในคำขอเกิดขึ้นไม่ถูกต้อง เช่นหากรูปแบบสถานที่ไม่ถูกต้อง
  • NOT_FOUND - หากไม่มีขั้นตอนที่มีอยู่

คำขอ HTTP

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

URL ใช้ไวยากรณ์ การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
name

string

ชื่อทรัพยากรแบบเต็มของขั้นตอน ตัวอย่างเช่นprojects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

ที่จำเป็น.

พารามิเตอร์แบบสอบถาม

พารามิเตอร์
locale

string

รูปแบบที่ยอมรับคือรูปแบบ Canonical Unicode โดยมีขีดกลางเป็นตัวคั่น ภาษาจะต้องเป็นตัวพิมพ์เล็ก สคริปต์ภาษา - ตัวพิมพ์ใหญ่ ภูมิภาค - ตัวพิมพ์ใหญ่ ดู http://www.unicode.org/reports/tr35/#Unicode_locale_identifier สำหรับรายละเอียด

ที่จำเป็น.

ขอร่างกาย

เนื้อความของคำขอจะต้องว่างเปล่า

ร่างกายตอบสนอง

ข้อความตอบกลับสำหรับ AccessibilityService.ListStepAccessibilityClusters

หากสำเร็จ เนื้อหาการตอบสนองจะมีข้อมูลที่มีโครงสร้างดังต่อไปนี้:

การเป็นตัวแทน JSON
{
  "name": string,
  "clusters": [
    {
      object (SuggestionClusterProto)
    }
  ]
}
เขตข้อมูล
name

string

ชื่อทรัพยากรแบบเต็มของขั้นตอน ตัวอย่างเช่นprojects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

นำเสนออยู่เสมอ

clusters[]

object ( SuggestionClusterProto )

ลำดับคำแนะนำในการเข้าถึงที่จัดกลุ่มเป็นกลุ่ม ภายในลำดับ คลัสเตอร์ที่อยู่ใน SuggestionCategory เดียวกันควรอยู่ติดกัน ภายในแต่ละหมวดหมู่ ควรเรียงลำดับคลัสเตอร์ตาม SuggestionPriority (ข้อผิดพลาดก่อน) หมวดหมู่ควรเรียงลำดับตามคลัสเตอร์ที่มีลำดับความสำคัญสูงสุด

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth ต่อไปนี้:

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

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์

SuggestionClusterProto

ชุดคำแนะนำที่คล้ายกันซึ่งเราสงสัยว่ามีความเกี่ยวข้องกันอย่างใกล้ชิด

โปรโตนี้และโปรโตที่ซ้อนกันส่วนใหญ่แยกจาก foxandcrown.prelaunchreport.service.SuggestionClusterProto โดยแทนที่การขึ้นต่อกันของ PLR ด้วย FTL

การเป็นตัวแทน JSON
{
  "category": enum (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
เขตข้อมูล
category

enum ( SuggestionCategory )

หมวดหมู่ที่ควรปรากฏคำแนะนำประเภทนี้ ตั้งค่าไว้เสมอ

suggestions[]

object ( SuggestionProto )

ลำดับข้อเสนอแนะ คำแนะนำทั้งหมดภายในคลัสเตอร์จะต้องมี SuggestionPriority เหมือนกันและอยู่ใน SuggestionCategory เดียวกัน คำแนะนำที่มี URL ภาพหน้าจอเดียวกันควรอยู่ติดกัน

หมวดหมู่ข้อเสนอแนะ

เอนัม
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

ข้อแนะนำโปรโต

การเป็นตัวแทน 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.
}
เขตข้อมูล
title

string

ชื่อทั่วไปของคำแนะนำ ในภาษาของผู้ใช้ โดยไม่มีมาร์กอัป ตั้งค่าไว้เสมอ

shortMessage

object ( SafeHtmlProto )

ข้อความที่กระชับในภาษาของผู้ใช้ ซึ่งแสดงถึงข้อเสนอแนะ ซึ่งอาจมีมาร์กอัป ตั้งค่าไว้เสมอ

longMessage

object ( SafeHtmlProto )

ข้อความในภาษาของผู้ใช้ อธิบายคำแนะนำ ซึ่งอาจมีมาร์กอัป ตั้งค่าไว้เสมอ

priority

enum ( SuggestionPriority )

ความสำคัญสัมพัทธ์ของข้อเสนอแนะ ตั้งค่าไว้เสมอ

helpUrl

string

การอ้างอิงถึงบทความในศูนย์ช่วยเหลือเกี่ยวกับคำแนะนำประเภทนี้ ตั้งค่าไว้เสมอ

region

object ( RegionProto )

ภูมิภาคภายในภาพหน้าจอที่เกี่ยวข้องกับคำแนะนำนี้ ไม่จำเป็น.

secondaryPriority

number

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

screenId

string

ID ของหน้าจอสำหรับคำแนะนำ ใช้เพื่อรับเส้นทางภาพหน้าจอที่เกี่ยวข้อง ตัวอย่างเช่น screenId "1" สอดคล้องกับไฟล์ "1.png" ใน GCS ตั้งค่าไว้เสมอ

resource_id

resource_id สามารถมีได้เพียงอย่างใดอย่างหนึ่งต่อไปนี้:

resourceName

string

การอ้างอิงถึงองค์ประกอบมุมมอง ระบุโดยชื่อทรัพยากร ถ้ามี

pseudoResourceId

string

ตัวระบุมุมมองแหล่งที่มาที่ค่อนข้างมนุษย์สามารถอ่านได้ หากไม่มีชื่อทรัพยากร นี่คือเส้นทางภายในลำดับชั้นการเข้าถึง ซึ่งเป็นองค์ประกอบที่มีชื่อทรัพยากร คล้ายกับ XPath

SafeHtmlProto

สิ่งสำคัญ: การยอมรับข้อความนี้จากแหล่งที่ไม่น่าเชื่อถือนั้นไม่ปลอดภัย เนื่องจากผู้โจมตีจะปลอมแปลงข้อความซีเรียลไลซ์ที่ไม่เป็นไปตามสัญญาความปลอดภัยของประเภทนั้นไม่ใช่เรื่องง่าย ตัวอย่างเช่น อาจมีสคริปต์ที่ควบคุมโดยผู้โจมตี ระบบที่ได้รับ SafeHtmlProto จะเชื่อถือผู้สร้าง SafeHtmlProto โดยปริยาย ดังนั้น โดยทั่วไปแล้ว การส่งคืนข้อความนี้ในการตอบกลับ RPC จึงปลอดภัย แต่โดยทั่วไปแล้วจะไม่ปลอดภัยที่จะยอมรับในคำขอ RPC

การเป็นตัวแทน JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
เขตข้อมูล
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

สิ่งสำคัญ: ห้ามตั้งค่าหรืออ่านฟิลด์นี้ แม้ว่าจะมาจากการทดสอบก็ตาม ฟิลด์นี้เป็นฟิลด์ส่วนตัว ดูเอกสารที่ด้านบนของไฟล์ .proto สำหรับแพ็คเกจภาษาการเขียนโปรแกรมที่ใช้สร้างหรืออ่านข้อความนี้

ข้อเสนอแนะลำดับความสำคัญ

เอนัม
unknownPriority
error
warning
info

ภูมิภาคโปรโต

พื้นที่สี่เหลี่ยม

การเป็นตัวแทน JSON
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
เขตข้อมูล
topPx

integer

ด้านบนของสี่เหลี่ยม หน่วยเป็นพิกเซล ตั้งค่าไว้เสมอ

leftPx

integer

ด้านซ้ายของสี่เหลี่ยม หน่วยเป็นพิกเซล ตั้งค่าไว้เสมอ

heightPx

integer

ความสูงเป็นพิกเซล ตั้งค่าไว้เสมอ

widthPx

integer

ความกว้างเป็นพิกเซล ตั้งค่าไว้เสมอ