Method: projects.histories.executions.steps.accessibilityClusters

แสดงรายการคลัสเตอร์การช่วยเหลือพิเศษสำหรับขั้นตอนที่ต้องการ

อาจแสดงรหัสข้อผิดพลาด Canonical ต่อไปนี้

  • PERMISSION_DENIED - หากผู้ใช้ไม่ได้รับอนุญาตให้อ่านโปรเจ็กต์
  • INVALID_ARGUMENT - หากคำขอมีรูปแบบไม่ถูกต้อง
  • FAILED_PRECONDITION - หากอาร์กิวเมนต์ในคำขอไม่ถูกต้อง เช่น หากรูปแบบภาษาไม่ถูกต้อง
  • 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

รูปแบบที่ยอมรับคือรูปแบบ Unicode Canonical ที่มีขีดกลางเป็นตัวคั่น ภาษาต้องเป็นตัวพิมพ์เล็ก สคริปต์ภาษา - เป็นตัวพิมพ์ใหญ่ ภูมิภาค - ตัวพิมพ์ใหญ่ ดูรายละเอียดได้ที่ 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)

ลำดับของคำแนะนำการช่วยเหลือพิเศษที่จัดกลุ่มเป็นคลัสเตอร์ ภายในลำดับ คลัสเตอร์ที่อยู่ใน RecommendedCategory เดียวกันควรอยู่ติดกัน ในแต่ละหมวดหมู่ คลัสเตอร์ควรเรียงลำดับตามลำดับความสำคัญของคำแนะนำ (ERROR ก่อน) หมวดหมู่ควรเรียงลำดับตามคลัสเตอร์ที่มีลำดับความสำคัญสูงสุด

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

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

คำแนะนำคลัสเตอร์

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

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

การแสดง JSON 
{
  "category": enum (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
ช่อง
category

enum (SuggestionCategory)

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

object (SuggestionProto)

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

หมวดหมู่คำแนะนำ

Enum
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

รหัสของหน้าจอสำหรับคำแนะนำ ซึ่งใช้เพื่อรับเส้นทางภาพหน้าจอที่เกี่ยวข้อง เช่น ScreenId "1" ตรงกับ "1.png" ใน GCS ตั้งค่าเสมอ

ช่องการรวม resource_id

resource_id ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
resourceName

string

การอ้างอิงองค์ประกอบของข้อมูลพร็อพเพอร์ตี้ ซึ่งระบุตามชื่อทรัพยากร (หากมี)
pseudoResourceId

string

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

SafeHtmlProto

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

การแสดง JSON 
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
ช่อง
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

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

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

Enum
unknownPriority
error
warning
info

RegionProto

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

การแสดง JSON 
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
ช่อง
topPx

integer

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

integer

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

integer

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

integer

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