تحتوي Report
على نتيجة تحليل حِزمة تطبيق واحدة، وتشمل عمليات التحقّق من الامتثال ونتائج مراقبة البيانات. يمكن الوصول آليًا إلى جميع البيانات تقريبًا التي يتم تقديمها من خلال صفحتَي الامتثال ومراقبة البيانات في Checks Console من خلال التقارير.
توفّر واجهة Checks API طريقتَي Get
وList
عاديتَين للوصول إلى التقارير:
اختيار الحقول المطلوب عرضها
بما أنّ التقارير تحتوي على الكثير من البيانات، يتم عرض الحقلَين name
وresultsUri
فقط تلقائيًا. لعرض مجموعة مختلفة من الحقول، يجب إدراجها بشكل صريح في مَعلمة طلب البحث الخاصة بعنوان URL 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
في عنوان URL.
وإليك بعض الأمثلة:
التعبير | الناتج |
---|---|
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
في عنوان URL. لا يتم تضمين سوى عمليات التحقّق التي تتطابق مع تعبير الفلتر في الردّ. تتوافق هذه المَعلمة مع الطريقتَين 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
تقريرًا على الأكثر. يمكنك تغيير ذلك من خلال ضبط مَعلمة طلب البحث الخاصة بعنوان URL pageSize
. الحد الأقصى للقيمة هو 50
.
تعرض الطريقة List
قيمة nextPageToken
عندما يكون هناك المزيد من النتائج التي يمكن جلبها:
{
"reports": [
...
],
"nextPageToken": "CAEQ0ITI8K7ngAMaIDY3MThjNjQ3NGZmNzBhZGI4NWI5NjAyN2ViZmQ5MWVh"
}
مرِّر الرمز المميّز إلى طريقة List
باستخدام مَعلمة طلب البحث pageToken
في عنوان URL
لجلب الصفحة التالية من النتائج.