Method: projects.histories.executions.steps.accessibilityClusters

خوشه های دسترسی را برای یک مرحله معین فهرست می کند

ممکن است هر یک از کدهای خطای متعارف زیر را برگرداند:

  • PERMISSION_DENIED - اگر کاربر مجاز به خواندن پروژه نباشد
  • INVALID_ARGUMENT - اگر درخواست بد شکل باشد
  • FAILED_PRECONDITION - اگر آرگومان موجود در درخواست نامعتبر باشد. به عنوان مثال اگر قالب محلی نادرست باشد
  • NOT_FOUND - اگر مرحله حاوی وجود نداشته باشد

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
name

string

نام منبع کامل مرحله. مثلا projects/my-project/histories/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/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

همیشه ارائه می دهد.

clusters[]

object ( SuggestionClusterProto )

دنباله ای از پیشنهادات دسترسی، گروه بندی شده در خوشه ها. در داخل دنباله، خوشه‌هایی که به یک SuggestionCategory تعلق دارند باید مجاور باشند. در هر دسته، خوشه‌ها باید بر اساس اولویت پیشنهادی (اول خطاها) مرتب شوند. دسته ها باید بر اساس خوشه با بالاترین اولویت مرتب شوند.

محدوده مجوز

به محدوده 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 )

دنباله ای از پیشنهادات همه پیشنهادات درون یک خوشه باید دارای اولویت پیشنهادی یکسان و متعلق به یک دسته پیشنهاد باشند. پیشنهادهایی با نشانی وب اسکرین شات یکسان باید در مجاورت یکدیگر قرار گیرند.

دسته پیشنهاد

Enums
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

پیشنهاد Proto

نمایندگی 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

ارجاع به یک عنصر view، که با نام منبع آن مشخص می شود، در صورتی که یک عنصر داشته باشد.

pseudoResourceId

string

یک شناسه تا حدی قابل خواندن برای نمای منبع، اگر منبعName نداشته باشد. این یک مسیر در سلسله مراتب دسترسی است، یک عنصر با نام منبع. مشابه XPath

SafeHtmlProto

مهم: پذیرفتن این پیام از منبع نامعتبر ناامن است، زیرا برای مهاجم جعل پیام‌های سریالی که قرارداد ایمنی آن نوع را برآورده نمی‌کنند، امری بی‌اهمیت است - برای مثال، ممکن است حاوی اسکریپت کنترل‌شده مهاجم باشد. سیستمی که SafeHtmlProto را دریافت می کند به طور ضمنی به تولید کننده SafeHtmlProto اعتماد دارد. بنابراین، به طور کلی بازگرداندن این پیام در پاسخ‌های RPC ایمن است، اما پذیرش آن در درخواست‌های RPC عموماً ناامن است.

نمایندگی JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
زمینه های
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

مهم: هرگز این فیلد را تنظیم یا مطالعه نکنید، حتی از طریق آزمایش، خصوصی است. مستندات را در بالای فایل .proto برای بسته های زبان برنامه نویسی که با آن می توان این پیام را ایجاد کرد یا خواند، مشاهده کنید.

پیشنهاد اولویت

Enums
unknownPriority
error
warning
info

RegionProto

یک منطقه مستطیل شکل.

نمایندگی JSON
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
زمینه های
topPx

integer

بالای مستطیل، بر حسب پیکسل. همیشه تنظیم شده است.

leftPx

integer

سمت چپ مستطیل، بر حسب پیکسل. همیشه تنظیم شده است.

heightPx

integer

ارتفاع بر حسب پیکسل همیشه تنظیم شده است.

widthPx

integer

عرض، بر حسب پیکسل همیشه تنظیم شده است.

،

خوشه های دسترسی را برای یک مرحله معین فهرست می کند

ممکن است هر یک از کدهای خطای متعارف زیر را برگرداند:

  • PERMISSION_DENIED - اگر کاربر مجاز به خواندن پروژه نباشد
  • INVALID_ARGUMENT - اگر درخواست بد شکل باشد
  • FAILED_PRECONDITION - اگر آرگومان موجود در درخواست نامعتبر باشد. به عنوان مثال اگر قالب محلی نادرست باشد
  • NOT_FOUND - اگر مرحله حاوی وجود نداشته باشد

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
name

string

نام منبع کامل مرحله. مثلا projects/my-project/histories/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/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

همیشه ارائه می دهد.

clusters[]

object ( SuggestionClusterProto )

دنباله ای از پیشنهادات دسترسی، گروه بندی شده در خوشه ها. در داخل دنباله، خوشه‌هایی که به یک SuggestionCategory تعلق دارند باید مجاور باشند. در هر دسته، خوشه‌ها باید بر اساس اولویت پیشنهادی (اول خطاها) مرتب شوند. دسته ها باید بر اساس خوشه با بالاترین اولویت مرتب شوند.

محدوده مجوز

به محدوده 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 )

دنباله ای از پیشنهادات همه پیشنهادات درون یک خوشه باید دارای اولویت پیشنهادی یکسان و متعلق به یک دسته پیشنهاد باشند. پیشنهادهایی با نشانی وب اسکرین شات یکسان باید در مجاورت یکدیگر قرار گیرند.

دسته پیشنهاد

Enums
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

پیشنهاد Proto

نمایندگی 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

ارجاع به یک عنصر view، که با نام منبع آن مشخص می شود، در صورتی که یک عنصر داشته باشد.

pseudoResourceId

string

یک شناسه تا حدی قابل خواندن برای نمای منبع، اگر منبعName نداشته باشد. این یک مسیر در سلسله مراتب دسترسی است، یک عنصر با نام منبع. مشابه XPath

SafeHtmlProto

مهم: پذیرفتن این پیام از منبع نامعتبر ناامن است، زیرا برای مهاجم جعل پیام‌های سریالی که قرارداد ایمنی آن نوع را برآورده نمی‌کنند، امری بی‌اهمیت است - برای مثال، ممکن است حاوی اسکریپت کنترل‌شده مهاجم باشد. سیستمی که SafeHtmlProto را دریافت می کند به طور ضمنی به تولید کننده SafeHtmlProto اعتماد دارد. بنابراین، به طور کلی بازگرداندن این پیام در پاسخ‌های RPC ایمن است، اما پذیرش آن در درخواست‌های RPC عموماً ناامن است.

نمایندگی JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
زمینه های
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

مهم: هرگز این فیلد را تنظیم یا مطالعه نکنید، حتی از طریق آزمایش، خصوصی است. مستندات را در بالای فایل .proto برای بسته های زبان برنامه نویسی که با آن می توان این پیام را ایجاد کرد یا خواند، مشاهده کنید.

پیشنهاد اولویت

Enums
unknownPriority
error
warning
info

RegionProto

یک منطقه مستطیل شکل.

نمایندگی JSON
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
زمینه های
topPx

integer

بالای مستطیل، بر حسب پیکسل. همیشه تنظیم شده است.

leftPx

integer

سمت چپ مستطیل، بر حسب پیکسل. همیشه تنظیم شده است.

heightPx

integer

ارتفاع بر حسب پیکسل همیشه تنظیم شده است.

widthPx

integer

عرض، بر حسب پیکسل همیشه تنظیم شده است.