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

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 यूआरएल क्वेरी पैरामीटर का इस्तेमाल करके, फ़िल्टर एक्सप्रेशन पास करके 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 तरीके पर पास करें.