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 .

Параметры пути

Параметры
name

string

Полное имя ресурса шага. Например, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Необходимый.

Параметры запроса

Параметры
locale

string

Принятый формат — канонический формат 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 )

Последовательность предложений по доступности, сгруппированных в кластеры. Внутри последовательности кластеры, принадлежащие к одной и той же категории предложений, должны быть соседними. Внутри каждой категории кластеры должны быть упорядочены по их приоритету предложения (сначала ОШИБКИ). Категории следует отсортировать по кластеру с наивысшим приоритетом.

Области авторизации

Требуется следующая область действия 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 )

Последовательность предложений. Все предложения в кластере должны иметь один и тот же OfferionPriority и принадлежать к одной и той же OfferionCategory. Предложения с одинаковым 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

Идентификатор экрана с предложением. Он используется для получения соответствующего пути к скриншоту. Например, 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

Ширина в пикселях. Всегда устанавливайте.