একটি Report একটি একক অ্যাপ বান্ডেল বিশ্লেষণের ফলাফল থাকে এবং এতে কমপ্লায়েন্স চেক ও ডেটা মনিটরিং-এর ফলাফল অন্তর্ভুক্ত থাকে। চেক্স কনসোলের কমপ্লায়েন্স এবং ডেটা মনিটরিং পেজগুলোর মাধ্যমে প্রদত্ত প্রায় সমস্ত ডেটা রিপোর্টের মাধ্যমে প্রোগ্রাম্যাটিকভাবে অ্যাক্সেস করা যায়।
চেকস এপিআই রিপোর্ট অ্যাক্সেস করার জন্য স্ট্যান্ডার্ড Get এবং List মেথড প্রদান করে:
কোন ক্ষেত্রগুলি ফেরত দিতে হবে তা নির্বাচন করুন
যেহেতু রিপোর্টে প্রচুর ডেটা থাকে, তাই ডিফল্টরূপে শুধুমাত্র name এবং resultsUri ফিল্ড দুটি রিটার্ন করা হয়। ভিন্ন কোনো ফিল্ড সেট রিটার্ন করতে চাইলে, fields URL কোয়েরি প্যারামিটারে সেগুলোকে স্পষ্টভাবে তালিকাভুক্ত করুন।
উদাহরণ:
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 | checks name এবং এর অন্তর্ভুক্ত সমস্ত ফিল্ড ফেরত দেয়। |
name,checks(type,state) | name , checks.type এবং checks.state ফেরত দেয়। |
name,dataMonitoring | dataMonitoring এর name এবং এর অন্তর্ভুক্ত সমস্ত ফিল্ড ফেরত দেয়। |
তালিকা
| অভিব্যক্তি | আউটপুট |
|---|---|
* | সমস্ত ফিল্ড ফেরত দেয়। |
reports(name,checks) | checks name এবং এর অন্তর্ভুক্ত সমস্ত ফিল্ড ফেরত দেয়। |
reports(name,checks(type,state)) | name , checks.type এবং checks.state ফেরত দেয়। |
reports(name,dataMonitoring) | dataMonitoring এর name এবং এর অন্তর্ভুক্ত সমস্ত ফিল্ড ফেরত দেয়। |
রিপোর্ট ফিল্টার করুন
আপনি filter URL কোয়েরি প্যারামিটার ব্যবহার করে একটি ফিল্টার এক্সপ্রেশন পাস করার মাধ্যমে List মেথড দ্বারা ফেরত আসা রিপোর্টগুলো ফিল্টার করতে পারেন।
এখানে কয়েকটি উদাহরণ দেওয়া হলো:
| অভিব্যক্তি | আউটপুট |
|---|---|
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 | শুধুমাত্র GDPR সম্পর্কিত যাচাইকরণ অন্তর্ভুক্ত। |
state = FAILED AND citations.type:GDPR | এতে শুধুমাত্র 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 URL কোয়েরি প্যারামিটার সেট করে এটি পরিবর্তন করতে পারেন। এর সর্বোচ্চ মান হলো 50 ।
যখন আরও ফলাফল আনার থাকে, তখন List মেথডটি একটি nextPageToken রিটার্ন করে:
{
"reports": [
...
],
"nextPageToken": "CAEQ0ITI8K7ngAMaIDY3MThjNjQ3NGZmNzBhZGI4NWI5NjAyN2ViZmQ5MWVh"
}
ফলাফলের পরবর্তী পৃষ্ঠাটি আনতে, pageToken URL কোয়েরি প্যারামিটার ব্যবহার করে এই টোকেনটি List মেথডে পাঠান।