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

כתובת האתר משתמשת בתחביר GRPC Transcoding .

פרמטרים של נתיב

פרמטרים
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 )

רצף של הצעות נגישות, מקובצות לאשכולות. בתוך הרצף, אשכולות השייכים לאותה 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

SuggestionProto

ייצוג 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

מזהה קריא אנושי במקצת של תצוגת המקור, אם אין לה resourceName. זהו נתיב בתוך היררכיית הנגישות, אלמנט עם שם משאב; דומה ל-XPath.

SafeHtmlProto

חשוב: זה לא בטוח לקבל הודעה זו ממקור לא מהימן, מכיוון שזה טריוויאלי עבור תוקף לזייף הודעות סדרתיות שאינן עומדות בחוזה הבטיחות של הסוג - למשל, היא יכולה להכיל סקריפט נשלט על ידי תוקף. מערכת שמקבלת SafeHtmlProto סומכת באופן מרומז על היצרן של SafeHtmlProto. לכן, זה בדרך כלל בטוח להחזיר הודעה זו בתגובות RPC, אבל בדרך כלל לא בטוח לקבל אותה בבקשות RPC.

ייצוג JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
שדות
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

חשוב: לעולם אל תגדיר או תקרא את השדה הזה, אפילו מבדיקות, הוא פרטי. עיין בתיעוד בחלק העליון של קובץ .proto עבור חבילות שפות תכנות שבאמצעותן ניתן ליצור או לקרוא הודעה זו.

Suggestion Priority

תקצירים
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

כתובת האתר משתמשת בתחביר GRPC Transcoding .

פרמטרים של נתיב

פרמטרים
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 )

רצף של הצעות נגישות, מקובצות לאשכולות. בתוך הרצף, אשכולות השייכים לאותה 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

SuggestionProto

ייצוג 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

מזהה קריא אנושי במקצת של תצוגת המקור, אם אין לה resourceName. זהו נתיב בתוך היררכיית הנגישות, אלמנט עם שם משאב; דומה ל-XPath.

SafeHtmlProto

חשוב: זה לא בטוח לקבל הודעה זו ממקור לא מהימן, מכיוון שזה טריוויאלי עבור תוקף לזייף הודעות סדרתיות שאינן עומדות בחוזה הבטיחות של הסוג - למשל, היא יכולה להכיל סקריפט נשלט על ידי תוקף. מערכת שמקבלת SafeHtmlProto סומכת באופן מרומז על היצרן של SafeHtmlProto. לכן, זה בדרך כלל בטוח להחזיר הודעה זו בתגובות RPC, אבל בדרך כלל לא בטוח לקבל אותה בבקשות RPC.

ייצוג JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
שדות
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

חשוב: לעולם אל תגדיר או תקרא את השדה הזה, אפילו מבדיקות, הוא פרטי. עיין בתיעוד בחלק העליון של קובץ .proto עבור חבילות שפות תכנות שבאמצעותן ניתן ליצור או לקרוא הודעה זו.

Suggestion Priority

תקצירים
unknownPriority
error
warning
info

RegionProto

אזור מלבני.

ייצוג JSON
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
שדות
topPx

integer

החלק העליון של המלבן, בפיקסלים. תמיד מוגדר.

leftPx

integer

הצד השמאלי של המלבן, בפיקסלים. תמיד מוגדר.

heightPx

integer

הגובה, בפיקסלים. תמיד מוגדר.

widthPx

integer

הרוחב, בפיקסלים. תמיד מוגדר.