क्वेरी रिपोर्ट

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 तरीकों के लिए, फ़ील्ड मास्क के ज़्यादा उदाहरण यहां दिए गए हैं:

Get

एक्सप्रेशन आउटपुट
* सभी फ़ील्ड की वैल्यू वापस मिलती हैं.
name,checks name और checks के सभी नेस्ट किए गए फ़ील्ड की वैल्यू वापस मिलती हैं.
name,checks(type,state) name, checks.type, और checks.state की वैल्यू वापस मिलती हैं.
name,dataMonitoring name और dataMonitoring के सभी नेस्ट किए गए फ़ील्ड की वैल्यू वापस मिलती हैं.

List

एक्सप्रेशन आउटपुट
* सभी फ़ील्ड की वैल्यू वापस मिलती हैं.
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 सिर्फ़ जीडीपीआर से जुड़ी वे जांचें शामिल होती हैं जो फ़ेल हो गई हैं.
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 तरीके से पास करें.