Method: projects.histories.executions.steps.accessibilityClusters

يسرد مجموعات تسهيل الاستخدام لخطوة معيّنة

قد يعرض أيًا من رموز الخطأ الأساسية التالية:

  • Permission_DENIED - إذا لم يكن المستخدم مصرحًا له بقراءة المشروع
  • بهدفي_الخطأ - إذا كان الطلب مكتوبًا بطريقة غير صحيحة
  • فشل_PRECondition - إذا كانت إحدى الوسيطات في الطلب غير صالحة، مثلاً: إذا كان تنسيق اللغة غير صحيح
  • NOT_FOUND - إذا كانت الخطوة التي تتضمنها غير موجودة

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
name

string

تمثّل هذه السمة اسم المورد الكامل للخطوة. على سبيل المثال، projects/my-project/hihistory/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

مطلوب.

معامِلات طلب البحث

المَعلمات
locale

string

ويكون التنسيق المقبول هو تنسيق يونيكود المتعارف عليه مع استخدام الواصلة كمحدِّد. يجب أن تكون اللغة بأحرف صغيرة، أو أحرف لغة البرمجة - أحرف كبيرة، منطقة - حالة الأحرف الكبيرة. يمكنك الاطّلاع على http://www.unicode.org/reports/tr35/#Unicode_locale_identifier لمزيد من التفاصيل.

مطلوب.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة ردّ بشأن AccessibilityService.ListStepAccessibilityClusters.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "name": string,
  "clusters": [
    {
      object (SuggestionClusterProto)
    }
  ]
}
الحقول
name

string

تمثّل هذه السمة اسم المورد الكامل للخطوة. على سبيل المثال، projects/my-project/hihistory/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

يقدم دائمًا.

clusters[]

object (SuggestionClusterProto)

يشير ذلك المصطلح إلى سلسلة من اقتراحات تسهيل الاستخدام مجمَّعة في مجموعات. وفي التسلسل، يجب أن تكون المجموعات العنقودية التي تنتمي إلى فئة SuggestionCategory نفسها متجاورة. داخل كل فئة، يجب ترتيب المجموعات حسب أولوية الاقتراح (الأخطاء أولاً). ويجب ترتيب الفئات حسب المجموعة العنقودية ذات الأولوية القصوى.

نطاقات الأذونات

يتطلب نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة حول المصادقة.

حزمة الاقتراحات

يشير هذا المصطلح إلى مجموعة من الاقتراحات المشابهة التي نشك في أنّها ذات صلة وثيقة.

يتفرع هذا النموذج الأوّلي ومعظم النماذج الأولية المتداخلة من foxandcrown.prelaunchreport.service.suggestionClusterProto، والذي يستبدل تبعيات PLR بتبعيات FTL.

تمثيل JSON
{
  "category": enum (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
الحقول
category

enum (SuggestionCategory)

الفئة التي يجب أن تظهر فيها هذه الأنواع من الاقتراحات. الضبط دائمًا.

suggestions[]

object (SuggestionProto)

سلسلة من الاقتراحات يجب أن يكون لجميع الاقتراحات في المجموعة أولوية الاقتراحات نفسها وتنتمي إلى فئة الاقتراحات نفسها. يجب أن تكون الاقتراحات التي لها عنوان 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

رقم تعريف شاشة الاقتراح. ويتم استخدامه للحصول على مسار لقطة الشاشة المقابل. على سبيل المثال، رقم تعريف الشاشة "1" تتجاوب مع "1.png" ملف في GCS. الضبط دائمًا.

حقل الاتحاد resource_id.

يمكن أن يكون resource_id واحدًا فقط مما يلي:

resourceName

string

الإشارة إلى عنصر عرض يتم تحديده بواسطة اسم المورد، في حال توفّره.

pseudoResourceId

string

يشير إلى معرّف يمكن لشخص عادي قراءته بطريقة عرض المصدر، إذا لم يكن يحتوي على resourcesName. هذا مسار ضمن التسلسل الهرمي لإمكانية الوصول، وهو عنصر يحمل اسم مورد؛ مشابه لمسار XPath.

SafeHtmlProto

ملاحظة مهمة: ليس من الآمن قبول هذه الرسالة من مصدر غير موثوق به، لأنه من البديهي أن يزوّر المهاجم رسائل متسلسلة لا تلتزم بعقد الأمان لهذا النوع، على سبيل المثال، قد تحتوي على نص برمجي يتحكّم فيه مهاجم. يشير هذا المصطلح إلى نظام يتلقّى اتفاقية SafeHtmlProto موثوق بها ضمنيًا في منتج SafeHtmlProto. لذلك، من الآمن بشكل عام إرجاع هذه الرسالة في استجابات استدعاء إجراء عن بُعد (RPC)، ولكن قبولها بشكل عام غير آمن في طلبات استدعاء إجراء عن بُعد.

تمثيل JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
الحقول
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

هام: لا يتم تعيين هذا الحقل أو قراءته مطلقًا، حتى من الاختبارات، فهو حقل خاص. راجِع الوثائق في أعلى ملف .proto للتعرُّف على حِزم لغات البرمجة التي يمكن استخدامها لإنشاء هذه الرسالة أو قراءتها.

أولوية الاقتراح

تعدادات
unknownPriority
error
warning
info

RegionProto

منطقة مستطيلة.

تمثيل JSON
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
الحقول
topPx

integer

أعلى المستطيل، بالبكسل. الضبط دائمًا.

leftPx

integer

الجانب الأيسر من المستطيل، بالبكسل. الضبط دائمًا.

heightPx

integer

الارتفاع بالبكسل الضبط دائمًا.

widthPx

integer

العرض بالبكسل. الضبط دائمًا.