Report
में किसी एक ऐप्लिकेशन बंडल के विश्लेषण का नतीजा होता है.
इसमें नीतियों के पालन से जुड़ी जांच और डेटा की निगरानी के नतीजे शामिल होते हैं. Checks Console के अनुपालन और डेटा की निगरानी करने वाले पेजों से मिलने वाला करीब-करीब सारा डेटा, रिपोर्ट के ज़रिए प्रोग्राम के हिसाब से
ऐक्सेस किया जा सकता है.
Checks API, रिपोर्ट ऐक्सेस करने के लिए, स्टैंडर्ड Get
और List
तरीके उपलब्ध कराता है:
चुनें कि कौनसे फ़ील्ड वापस करने हैं
रिपोर्ट में बहुत ज़्यादा डेटा होने की वजह से, डिफ़ॉल्ट तौर पर सिर्फ़ name
और resultsUri
फ़ील्ड ही दिखते हैं. फ़ील्ड के दूसरे सेट दिखाने के लिए, उन्हें
fields
यूआरएल क्वेरी पैरामीटर में साफ़ तौर पर जोड़ें.
उदाहरण:
GET https://checks.googleapis.com/v1alpha/accounts/123/apps/456/reports/789?fields=name,checks(type,state)
वापसी:
{
"name": "accounts/123/apps/456/reports/789",
"checks": [
{
"type": "PRIVACY_POLICY_UPDATE_DATE_RECENT",
"state": "PASSED"
},
...
]
}
नेस्ट किए गए फ़ील्ड को डॉट सिंटैक्स का इस्तेमाल करके या उन्हें ब्रैकेट में रखकर, लिस्ट किया जा सकता है.
उदाहरण के लिए,
fields=checks.type,checks.state
इसके बराबर है
fields=checks(type,state)
ब्रैकेट का इस्तेमाल बार-बार भी किया जा सकता है, जैसे कि:
fields=checks(type,state,evidence(permissions,sdks))
इसकी मदद से, एक्सप्रेशन को ज़्यादा छोटा बनाया जा सकता है.
fields
क्वेरी पैरामीटर की वैल्यू को फ़ील्ड मास्क भी कहा जाता है. ज़्यादा जानने के लिए
फ़ील्ड मास्क देखें.
Get
और List
तरीकों के लिए, फ़ील्ड मास्क के ज़्यादा उदाहरण यहां दिए गए हैं:
पाएं
एक्सप्रेशन | आउटपुट |
---|---|
* |
सभी फ़ील्ड दिखाता है. |
name,checks |
name और checks के नेस्ट किए गए सभी फ़ील्ड दिखाता है. |
name,checks(type,state) |
name , checks.type , और checks.state दिखाता है. |
name,dataMonitoring |
name और dataMonitoring के नेस्ट किए गए सभी फ़ील्ड दिखाता है. |
सूची
एक्सप्रेशन | आउटपुट |
---|---|
* |
सभी फ़ील्ड दिखाता है. |
reports(name,checks) |
name और checks के नेस्ट किए गए सभी फ़ील्ड दिखाता है. |
reports(name,checks(type,state)) |
name , checks.type , और checks.state दिखाता है. |
reports(name,dataMonitoring) |
name और dataMonitoring के नेस्ट किए गए सभी फ़ील्ड दिखाता है. |
रिपोर्ट फ़िल्टर करना
List
तरीके से दिखाई गई रिपोर्ट को फ़िल्टर करने के लिए, filter
यूआरएल क्वेरी पैरामीटर का इस्तेमाल करके फ़िल्टर एक्सप्रेशन पास किया जा सकता है.
यहां कुछ उदाहरण दिए गए हैं:
एक्सप्रेशन | आउटपुट |
---|---|
appBundle.releaseType = PRE_RELEASE |
सिर्फ़ प्री-रिलीज़ ऐप्लिकेशन बंडल की रिपोर्ट दिखाता है. |
appBundle.releaseType = PUBLIC |
सिर्फ़ सार्वजनिक ऐप्लिकेशन बंडल की रिपोर्ट दिखाता है. |
appBundle.codeReferenceId = abc123 |
वे रिपोर्ट दिखाता है जिनमें codeReferenceId abc123 के बराबर है. |
इन फ़ील्ड पाथ के हिसाब से फ़िल्टर नहीं किया जा सकता:
checks.evidence.dataTypes.dataTypeEvidence.endpoints.attributedSdks.sdk.id
checks.evidence.dataTypes.dataTypeEvidence.endpoints.endpointDetails.endpoint.domain
checks.evidence.dataTypes.dataTypeEvidence.privacyPolicyTexts.policyFragment.htmlContent
checks.evidence.privacyPolicyTexts.policyFragment.htmlContent
checks.evidence.sdkIssues.sdk.id
dataMonitoring.dataTypes.dataTypeEvidence.endpoints.attributedSdks.sdk.id
dataMonitoring.dataTypes.dataTypeEvidence.endpoints.endpointDetails.endpoint.domain
dataMonitoring.dataTypes.dataTypeEvidence.privacyPolicyTexts.policyFragment.htmlContent
dataMonitoring.dataTypes.dataTypeEvidence.privacyPolicyTexts.policyFragment.sourceUri
dataMonitoring.permissions.metadata.lastDetectedAppVersion
resultsUri
ज़्यादा फ़िल्टर एक्सप्रेशन बनाने का तरीका जानने के लिए AIP-160 देखें.
रिपोर्ट में फ़िल्टर की जांच करना
रिपोर्ट में जांच को फ़िल्टर करने के लिए, checksFilter
यूआरएल क्वेरी पैरामीटर का इस्तेमाल करके, एक फ़िल्टर एक्सप्रेशन पास किया जा सकता है. जवाब में सिर्फ़ फ़िल्टर एक्सप्रेशन
से मेल खाने वाली जांच को ही शामिल किया जाता है. यह पैरामीटर List
और Get
, दोनों तरीकों से काम करता है.
यहां कुछ उदाहरण दिए गए हैं:
एक्सप्रेशन | आउटपुट |
---|---|
state = FAILED |
इसमें सिर्फ़ पूरे न हो पाने वाले चेक शामिल हैं. |
citations.type:GDPR |
इसमें सिर्फ़ जीडीपीआर से जुड़ी जांच शामिल हैं. |
state = FAILED AND citations.type:GDPR |
इसमें सिर्फ़ GDRP से जुड़ी फ़ेल हो चुकी जांच शामिल हैं. |
regionCodes:CA |
इसमें सिर्फ़ कनाडा से जुड़े चेक शामिल हैं. |
state = FAILED AND severity = PRIORITY |
इसमें सिर्फ़ फ़ेल हो चुकी प्राथमिकता वाली जांच शामिल हैं. |
इन फ़ील्ड पाथ के हिसाब से फ़िल्टर नहीं किया जा सकता:
evidence.dataTypes.dataTypeEvidence.endpoints.attributedSdks.sdk.id
evidence.dataTypes.dataTypeEvidence.endpoints.endpointDetails.endpoint.domain
evidence.dataTypes.dataTypeEvidence.privacyPolicyTexts.policyFragment.htmlContent
evidence.privacyPolicyTexts.policyFragment.htmlContent
evidence.sdkIssues.sdk.id
ज़्यादा फ़िल्टर एक्सप्रेशन बनाने का तरीका जानने के लिए AIP-160 देखें.
पेजों को क्रम में लगाना
डिफ़ॉल्ट रूप से, List
तरीका ज़्यादा से ज़्यादा 10
रिपोर्ट दिखाता है. pageSize
यूआरएल क्वेरी पैरामीटर सेट करके,
इसे बदला जा सकता है. ज़्यादा से ज़्यादा वैल्यू 50
है.
जब फ़ेच करने के लिए ज़्यादा नतीजे होते हैं, तो List
तरीका nextPageToken
दिखाता है:
{
"reports": [
...
],
"nextPageToken": "CAEQ0ITI8K7ngAMaIDY3MThjNjQ3NGZmNzBhZGI4NWI5NjAyN2ViZmQ5MWVh"
}
नतीजों का अगला पेज फ़ेच करने के लिए, pageToken
यूआरएल क्वेरी पैरामीटर का इस्तेमाल करके, इस टोकन को List
तरीके के साथ पास करें.