- HTTP अनुरोध
- पथ पैरामीटर
- क्वेरी पैरामीटर
- निकाय से अनुरोध करें
- प्रतिक्रिया निकाय
- प्राधिकरण के दायरे
- सुझावक्लस्टरप्रोटो
- सुझावश्रेणी
- सुझाव प्रोटो
- सेफएचटीएमएलप्रोटो
- सुझाव प्राथमिकता
- रीजनप्रोटो
- इसे अजमाएं!
किसी दिए गए चरण के लिए पहुंच-योग्यता क्लस्टरों को सूचीबद्ध करता है
निम्नलिखित में से कोई भी विहित त्रुटि कोड लौटा सकता है:
- PERMISSION_DENIED - यदि उपयोगकर्ता प्रोजेक्ट पढ़ने के लिए अधिकृत नहीं है
- INVALID_ARGUMENT - यदि अनुरोध विकृत है
- FAILED_PRECONDITION - यदि अनुरोध में कोई तर्क अमान्य होता है; उदाहरण के लिए यदि स्थानीय प्रारूप गलत है
- NOT_FOUND - यदि युक्त चरण मौजूद नहीं है
HTTP अनुरोध
GET https://toolresults.googleapis.com/toolresults/v1beta3/{name=projects/*/histories/*/executions/*/steps/*}:accessibilityClusters
यूआरएल जीआरपीसी ट्रांसकोडिंग सिंटैक्स का उपयोग करता है।
पथ पैरामीटर
पैरामीटर | |
---|---|
name | चरण का पूर्ण संसाधन नाम. उदाहरण के लिए, प्रोजेक्ट/मेरा-प्रोजेक्ट/इतिहास/बीएच.1234567890एबीसीडीईएफ/निष्पादन/ 1234567890123456789/स्टेप्स/बीएस.1234567890एबीसीडीईएफ आवश्यक। |
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
locale | स्वीकृत प्रारूप सीमांकक के रूप में हाइफ़न के साथ विहित यूनिकोड प्रारूप है। भाषा लोअरकेस होनी चाहिए, भाषा लिपि - बड़े अक्षरों में, क्षेत्र - अपरकेस होना चाहिए। विवरण के लिए http://www.unicode.org/reports/tr35/#Unicode_locale_identifier देखें। आवश्यक। |
निकाय से अनुरोध करें
अनुरोध का मुख्य भाग खाली होना चाहिए.
प्रतिक्रिया निकाय
AccessibilityService.ListStepAccessibilityClusters के लिए प्रतिक्रिया संदेश।
सफल होने पर, प्रतिक्रिया निकाय में निम्नलिखित संरचना वाला डेटा शामिल होता है:
JSON प्रतिनिधित्व |
---|
{
"name": string,
"clusters": [
{
object ( |
खेत | |
---|---|
name | चरण का पूर्ण संसाधन नाम. उदाहरण के लिए, प्रोजेक्ट/मेरा-प्रोजेक्ट/इतिहास/बीएच.1234567890एबीसीडीईएफ/निष्पादन/ 1234567890123456789/स्टेप्स/बीएस.1234567890एबीसीडीईएफ हमेशा प्रस्तुत करता है. |
clusters[] | सुगम्यता सुझावों का एक क्रम, समूहों में समूहीकृत। अनुक्रम के भीतर, समान सुझाव श्रेणी से संबंधित क्लस्टर आसन्न होने चाहिए। प्रत्येक श्रेणी के भीतर, समूहों को उनकी सुझाव प्राथमिकता (पहले त्रुटियाँ) के अनुसार क्रमित किया जाना चाहिए। श्रेणियों को उनके सर्वोच्च प्राथमिकता वाले क्लस्टर के अनुसार क्रमित किया जाना चाहिए। |
प्राधिकरण के दायरे
निम्नलिखित OAuth दायरे की आवश्यकता है:
-
https://www.googleapis.com/auth/cloud-platform
अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।
सुझावक्लस्टरप्रोटो
ऐसे ही सुझावों का एक सेट जिसके बारे में हमें संदेह है कि वे आपस में घनिष्ठ रूप से संबंधित हैं।
यह प्रोटो और अधिकांश नेस्टेड प्रोटोज़ फॉक्सएंडक्राउन.प्रिलॉन्चरेपोर्ट.सर्विस.सुगेस्टियनक्लस्टरप्रोटो से शाखाबद्ध हैं, जो पीएलआर की निर्भरता को एफटीएल से प्रतिस्थापित करते हैं।
JSON प्रतिनिधित्व |
---|
{ "category": enum ( |
खेत | |
---|---|
category | वह श्रेणी जिसमें इस प्रकार के सुझाव आने चाहिए. हमेशा सेट करें. |
suggestions[] | सुझावों का एक क्रम. क्लस्टर के सभी सुझावों में समान सुझाव प्राथमिकता होनी चाहिए और वे समान सुझाव श्रेणी से संबंधित होने चाहिए। समान स्क्रीनशॉट यूआरएल वाले सुझाव आसन्न होने चाहिए। |
सुझावश्रेणी
एनम्स | |
---|---|
unknownCategory | |
contentLabeling | |
touchTargetSize | |
lowContrast | |
implementation |
सुझाव प्रोटो
JSON प्रतिनिधित्व |
---|
{ "title": string, "shortMessage": { object ( |
खेत | |
---|---|
title | सुझाव के लिए सामान्य शीर्षक, उपयोगकर्ता की भाषा में, बिना किसी मार्कअप के। हमेशा सेट करें. |
shortMessage | उपयोगकर्ता की भाषा में संक्षिप्त संदेश, सुझाव का प्रतिनिधित्व करता है, जिसमें मार्कअप हो सकता है। हमेशा सेट करें. |
longMessage | संदेश, उपयोगकर्ता की भाषा में, सुझाव को समझाते हुए, जिसमें मार्कअप हो सकता है। हमेशा सेट करें. |
priority | किसी सुझाव का सापेक्ष महत्व. हमेशा सेट करें. |
helpUrl | इस प्रकार के सुझाव से संबंधित सहायता केंद्र लेख का संदर्भ। हमेशा सेट करें. |
region | स्क्रीनशॉट के भीतर वह क्षेत्र जो इस सुझाव के लिए प्रासंगिक है। वैकल्पिक। |
secondaryPriority | समान प्राथमिकता और श्रेणी वाले अन्य सुझावों की तुलना में किसी सुझाव का सापेक्ष महत्व। यह एक अर्थहीन मूल्य है जिसका उपयोग उन सुझावों को ऑर्डर करने के लिए किया जा सकता है जो समान श्रेणी में हैं और जिनकी प्राथमिकता समान है। बड़े मूल्यों की प्राथमिकता अधिक होती है (अर्थात, वे अधिक महत्वपूर्ण होते हैं)। वैकल्पिक। |
screenId | सुझाव के लिए स्क्रीन की आईडी. इसका उपयोग संबंधित स्क्रीनशॉट पथ प्राप्त करने के लिए किया जाता है। उदाहरण के लिए, स्क्रीनआईडी "1" जीसीएस में "1.png" फ़ाइल से मेल खाती है। हमेशा सेट करें. |
यूनियन फ़ील्ड | |
resourceName | किसी दृश्य तत्व का संदर्भ, उसके संसाधन नाम से पहचाना जाता है, यदि उसमें कोई तत्व है। |
pseudoResourceId | स्रोत दृश्य का कुछ हद तक मानवीय पठनीय पहचानकर्ता, यदि इसमें कोई संसाधन नाम नहीं है। यह अभिगम्यता पदानुक्रम के भीतर एक पथ है, संसाधन नाम वाला एक तत्व; XPath के समान. |
सेफएचटीएमएलप्रोटो
महत्वपूर्ण: किसी अविश्वसनीय स्रोत से इस संदेश को स्वीकार करना असुरक्षित है, क्योंकि किसी हमलावर के लिए ऐसे क्रमबद्ध संदेश बनाना मामूली बात है जो प्रकार के सुरक्षा अनुबंध को पूरा नहीं करते हैं - उदाहरण के लिए, इसमें हमलावर नियंत्रित स्क्रिप्ट हो सकती है। एक सिस्टम जो SafeHtmlProto प्राप्त करता है, वह SafeHtmlProto के निर्माता पर स्पष्ट रूप से भरोसा करता है। इसलिए, इस संदेश को आरपीसी प्रतिक्रियाओं में वापस करना आम तौर पर सुरक्षित है, लेकिन आरपीसी अनुरोधों में इसे स्वीकार करना आम तौर पर असुरक्षित है।
JSON प्रतिनिधित्व |
---|
{ "privateDoNotAccessOrElseSafeHtmlWrappedValue": string } |
खेत | |
---|---|
privateDoNotAccessOrElseSafeHtmlWrappedValue | महत्वपूर्ण: इस फ़ील्ड को कभी भी सेट या पढ़ें नहीं, यहां तक कि परीक्षणों से भी, यह निजी है। इस संदेश को बनाने या पढ़ने के लिए प्रोग्रामिंग भाषा पैकेज के लिए .proto फ़ाइल के शीर्ष पर दस्तावेज़ देखें। |
सुझाव प्राथमिकता
एनम्स | |
---|---|
unknownPriority | |
error | |
warning | |
info |
रीजनप्रोटो
एक आयताकार क्षेत्र.
JSON प्रतिनिधित्व |
---|
{ "topPx": integer, "leftPx": integer, "heightPx": integer, "widthPx": integer } |
खेत | |
---|---|
topPx | आयत का शीर्ष, पिक्सेल में. हमेशा सेट करें. |
leftPx | आयत का बाईं ओर, पिक्सेल में. हमेशा सेट करें. |
heightPx | ऊँचाई, पिक्सेल में. हमेशा सेट करें. |
widthPx | चौड़ाई, पिक्सेल में. हमेशा सेट करें. |
- HTTP अनुरोध
- पथ पैरामीटर
- क्वेरी पैरामीटर
- निकाय से अनुरोध करें
- प्रतिक्रिया निकाय
- प्राधिकरण के दायरे
- सुझावक्लस्टरप्रोटो
- सुझावश्रेणी
- सुझाव प्रोटो
- सेफएचटीएमएलप्रोटो
- सुझाव प्राथमिकता
- रीजनप्रोटो
- इसे अजमाएं!
किसी दिए गए चरण के लिए पहुंच-योग्यता क्लस्टरों को सूचीबद्ध करता है
निम्नलिखित में से कोई भी विहित त्रुटि कोड लौटा सकता है:
- PERMISSION_DENIED - यदि उपयोगकर्ता प्रोजेक्ट पढ़ने के लिए अधिकृत नहीं है
- INVALID_ARGUMENT - यदि अनुरोध विकृत है
- FAILED_PRECONDITION - यदि अनुरोध में कोई तर्क अमान्य होता है; उदाहरण के लिए यदि स्थानीय प्रारूप गलत है
- NOT_FOUND - यदि युक्त चरण मौजूद नहीं है
HTTP अनुरोध
GET https://toolresults.googleapis.com/toolresults/v1beta3/{name=projects/*/histories/*/executions/*/steps/*}:accessibilityClusters
यूआरएल जीआरपीसी ट्रांसकोडिंग सिंटैक्स का उपयोग करता है।
पथ पैरामीटर
पैरामीटर | |
---|---|
name | चरण का पूर्ण संसाधन नाम. उदाहरण के लिए, प्रोजेक्ट/मेरा-प्रोजेक्ट/इतिहास/बीएच.1234567890एबीसीडीईएफ/निष्पादन/ 1234567890123456789/स्टेप्स/बीएस.1234567890एबीसीडीईएफ आवश्यक। |
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
locale | स्वीकृत प्रारूप सीमांकक के रूप में हाइफ़न के साथ विहित यूनिकोड प्रारूप है। भाषा लोअरकेस होनी चाहिए, भाषा लिपि - बड़े अक्षरों में, क्षेत्र - अपरकेस होना चाहिए। विवरण के लिए http://www.unicode.org/reports/tr35/#Unicode_locale_identifier देखें। आवश्यक। |
निकाय से अनुरोध करें
अनुरोध का मुख्य भाग खाली होना चाहिए.
प्रतिक्रिया निकाय
AccessibilityService.ListStepAccessibilityClusters के लिए प्रतिक्रिया संदेश।
सफल होने पर, प्रतिक्रिया निकाय में निम्नलिखित संरचना वाला डेटा शामिल होता है:
JSON प्रतिनिधित्व |
---|
{
"name": string,
"clusters": [
{
object ( |
खेत | |
---|---|
name | चरण का पूर्ण संसाधन नाम. उदाहरण के लिए, प्रोजेक्ट/मेरा-प्रोजेक्ट/इतिहास/बीएच.1234567890एबीसीडीईएफ/निष्पादन/ 1234567890123456789/स्टेप्स/बीएस.1234567890एबीसीडीईएफ हमेशा प्रस्तुत करता है. |
clusters[] | सुगम्यता सुझावों का एक क्रम, समूहों में समूहीकृत। अनुक्रम के भीतर, समान सुझाव श्रेणी से संबंधित क्लस्टर आसन्न होने चाहिए। प्रत्येक श्रेणी के भीतर, समूहों को उनकी सुझाव प्राथमिकता (पहले त्रुटियाँ) के अनुसार क्रमित किया जाना चाहिए। श्रेणियों को उनके सर्वोच्च प्राथमिकता वाले क्लस्टर के अनुसार क्रमित किया जाना चाहिए। |
प्राधिकरण के दायरे
निम्नलिखित OAuth दायरे की आवश्यकता है:
-
https://www.googleapis.com/auth/cloud-platform
अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।
सुझावक्लस्टरप्रोटो
ऐसे ही सुझावों का एक सेट जिसके बारे में हमें संदेह है कि वे आपस में घनिष्ठ रूप से संबंधित हैं।
यह प्रोटो और अधिकांश नेस्टेड प्रोटोज़ फॉक्सएंडक्राउन.प्रिलॉन्चरेपोर्ट.सर्विस.सुगेस्टियनक्लस्टरप्रोटो से शाखाबद्ध हैं, जो पीएलआर की निर्भरता को एफटीएल से प्रतिस्थापित करते हैं।
JSON प्रतिनिधित्व |
---|
{ "category": enum ( |
खेत | |
---|---|
category | वह श्रेणी जिसमें इस प्रकार के सुझाव आने चाहिए. हमेशा सेट करें. |
suggestions[] | सुझावों का एक क्रम. क्लस्टर के सभी सुझावों में समान सुझाव प्राथमिकता होनी चाहिए और वे समान सुझाव श्रेणी से संबंधित होने चाहिए। समान स्क्रीनशॉट यूआरएल वाले सुझाव आसन्न होने चाहिए। |
सुझावश्रेणी
एनम्स | |
---|---|
unknownCategory | |
contentLabeling | |
touchTargetSize | |
lowContrast | |
implementation |
सुझाव प्रोटो
JSON प्रतिनिधित्व |
---|
{ "title": string, "shortMessage": { object ( |
खेत | |
---|---|
title | सुझाव के लिए सामान्य शीर्षक, उपयोगकर्ता की भाषा में, बिना किसी मार्कअप के। हमेशा सेट करें. |
shortMessage | उपयोगकर्ता की भाषा में संक्षिप्त संदेश, सुझाव का प्रतिनिधित्व करता है, जिसमें मार्कअप हो सकता है। हमेशा सेट करें. |
longMessage | संदेश, उपयोगकर्ता की भाषा में, सुझाव को समझाते हुए, जिसमें मार्कअप हो सकता है। हमेशा सेट करें. |
priority | किसी सुझाव का सापेक्ष महत्व. हमेशा सेट करें. |
helpUrl | इस प्रकार के सुझाव से संबंधित सहायता केंद्र लेख का संदर्भ। हमेशा सेट करें. |
region | स्क्रीनशॉट के भीतर वह क्षेत्र जो इस सुझाव के लिए प्रासंगिक है। वैकल्पिक। |
secondaryPriority | समान प्राथमिकता और श्रेणी वाले अन्य सुझावों की तुलना में किसी सुझाव का सापेक्ष महत्व। यह एक अर्थहीन मूल्य है जिसका उपयोग उन सुझावों को ऑर्डर करने के लिए किया जा सकता है जो समान श्रेणी में हैं और जिनकी प्राथमिकता समान है। बड़े मूल्यों की प्राथमिकता अधिक होती है (अर्थात, वे अधिक महत्वपूर्ण होते हैं)। वैकल्पिक। |
screenId | सुझाव के लिए स्क्रीन की आईडी. इसका उपयोग संबंधित स्क्रीनशॉट पथ प्राप्त करने के लिए किया जाता है। उदाहरण के लिए, स्क्रीनआईडी "1" जीसीएस में "1.png" फ़ाइल से मेल खाती है। हमेशा सेट करें. |
यूनियन फ़ील्ड | |
resourceName | किसी दृश्य तत्व का संदर्भ, उसके संसाधन नाम से पहचाना जाता है, यदि उसमें कोई तत्व है। |
pseudoResourceId | स्रोत दृश्य का कुछ हद तक मानवीय पठनीय पहचानकर्ता, यदि इसमें कोई संसाधन नाम नहीं है। यह अभिगम्यता पदानुक्रम के भीतर एक पथ है, संसाधन नाम वाला एक तत्व; XPath के समान. |
सेफएचटीएमएलप्रोटो
महत्वपूर्ण: किसी अविश्वसनीय स्रोत से इस संदेश को स्वीकार करना असुरक्षित है, क्योंकि किसी हमलावर के लिए ऐसे क्रमबद्ध संदेश बनाना मामूली बात है जो प्रकार के सुरक्षा अनुबंध को पूरा नहीं करते हैं - उदाहरण के लिए, इसमें हमलावर नियंत्रित स्क्रिप्ट हो सकती है। एक सिस्टम जो SafeHtmlProto प्राप्त करता है, वह SafeHtmlProto के निर्माता पर स्पष्ट रूप से भरोसा करता है। इसलिए, इस संदेश को आरपीसी प्रतिक्रियाओं में वापस करना आम तौर पर सुरक्षित है, लेकिन आरपीसी अनुरोधों में इसे स्वीकार करना आम तौर पर असुरक्षित है।
JSON प्रतिनिधित्व |
---|
{ "privateDoNotAccessOrElseSafeHtmlWrappedValue": string } |
खेत | |
---|---|
privateDoNotAccessOrElseSafeHtmlWrappedValue | महत्वपूर्ण: इस फ़ील्ड को कभी भी सेट या पढ़ें नहीं, यहां तक कि परीक्षणों से भी, यह निजी है। इस संदेश को बनाने या पढ़ने के लिए प्रोग्रामिंग भाषा पैकेज के लिए .proto फ़ाइल के शीर्ष पर दस्तावेज़ देखें। |
सुझाव प्राथमिकता
एनम्स | |
---|---|
unknownPriority | |
error | |
warning | |
info |
रीजनप्रोटो
एक आयताकार क्षेत्र.
JSON प्रतिनिधित्व |
---|
{ "topPx": integer, "leftPx": integer, "heightPx": integer, "widthPx": integer } |
खेत | |
---|---|
topPx | आयत का शीर्ष, पिक्सेल में. हमेशा सेट करें. |
leftPx | आयत का बाईं ओर, पिक्सेल में. हमेशा सेट करें. |
heightPx | ऊँचाई, पिक्सेल में. हमेशा सेट करें. |
widthPx | चौड़ाई, पिक्सेल में. हमेशा सेट करें. |