Laporan kueri

Report berisi hasil dari analisis app bundle tunggal dan menyertakan hasil pemeriksaan kepatuhan dan pemantauan data. Hampir semua data yang ditawarkan melalui halaman Kepatuhan dan Pemantauan Data di Konsol Pemeriksaan dapat diakses secara terprogram melalui laporan.

Checks API menyediakan metode Get dan List standar untuk mengakses laporan:

• accounts.apps.reports.get
• accounts.apps.reports.list

Pilih kolom yang akan ditampilkan

Karena laporan berisi banyak data, hanya kolom name dan resultsUri yang ditampilkan secara default. Untuk menampilkan kumpulan kolom yang berbeda, cantumkan secara eksplisit dalam parameter kueri URL fields.

Contoh:

GET https://checks.googleapis.com/v1alpha/accounts/123/apps/456/reports/789?fields=name,checks(type,state)

Retur:

{
  "name": "accounts/123/apps/456/reports/789",
  "checks": [
    {
      "type": "PRIVACY_POLICY_UPDATE_DATE_RECENT",
      "state": "PASSED"
    },
    ...
  ]
}

Kolom bertingkat dapat dicantumkan menggunakan sintaksis titik atau dengan menyertakannya dalam tanda kurung.

Misalnya,

fields=checks.type,checks.state

setara dengan

fields=checks(type,state)

Tanda kurung juga dapat digunakan secara berulang, seperti di:

fields=checks(type,state,evidence(permissions,sdks))

Hal ini memungkinkan ekspresi menjadi lebih ringkas.

Nilai parameter kueri fields juga dikenal sebagai mask kolom. Lihat Field mask untuk mempelajari lebih lanjut.

Catatan: Jalur kolom yang tercantum dalam parameter kueri fields harus cocok dengan jenis nilai yang ditampilkan dari metode yang dipanggil. Misalnya, saat memilih kolom checks, fields=checks harus digunakan saat memanggil metode Get, sedangkan fields=reports(checks) harus digunakan saat memanggil metode List.

Berikut adalah contoh mask kolom lainnya untuk metode Get dan List:

Dapatkan

Ekspresi	Output
*	Menampilkan semua kolom.
name,checks	Menampilkan name dan semua kolom bertingkat checks.
name,checks(type,state)	Menampilkan name, checks.type, dan checks.state.
name,dataMonitoring	Menampilkan name dan semua kolom bertingkat dataMonitoring.

Daftar

Ekspresi	Output
*	Menampilkan semua kolom.
reports(name,checks)	Menampilkan name dan semua kolom bertingkat checks.
reports(name,checks(type,state))	Menampilkan name, checks.type, dan checks.state.
reports(name,dataMonitoring)	Menampilkan name dan semua kolom bertingkat dataMonitoring.

Filter laporan

Anda dapat memfilter laporan yang ditampilkan oleh metode List dengan meneruskan ekspresi filter menggunakan parameter kueri URL filter.

Berikut beberapa contohnya:

Ekspresi	Output
appBundle.releaseType = PRE_RELEASE	Hanya menampilkan laporan app bundle pra-rilis.
appBundle.releaseType = PUBLIC	Hanya menampilkan laporan app bundle publik.
appBundle.codeReferenceId = abc123	Menampilkan laporan dengan codeReferenceId sama dengan abc123.

Catatan: Saat memfilter menurut kolom berulang, Anda hanya dapat menggunakan operator HAS (ditunjukkan dengan karakter : titik dua) untuk membuat perbandingan. Lihat bagian Memiliki Operator untuk mengetahui info selengkapnya.

Pemfilteran menurut jalur kolom ini tidak didukung:

• 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

Lihat AIP-160 untuk mempelajari cara membuat lebih banyak ekspresi filter.

Memfilter pemeriksaan dalam laporan

Anda dapat memfilter pemeriksaan dalam laporan dengan meneruskan ekspresi filter menggunakan parameter kueri URL checksFilter. Hanya pemeriksaan yang cocok dengan ekspresi filter yang disertakan dalam respons. Parameter ini didukung oleh metode List dan Get.

Berikut beberapa contohnya:

Ekspresi	Output
state = FAILED	Hanya menyertakan pemeriksaan yang gagal.
citations.type:GDPR	Hanya mencakup pemeriksaan yang terkait dengan GDPR.
state = FAILED AND citations.type:GDPR	Menyertakan hanya pemeriksaan yang gagal terkait dengan GDRP.
regionCodes:CA	Hanya mencakup pemeriksaan yang terkait dengan wilayah Kanada.
state = FAILED AND severity = PRIORITY	Hanya mencakup pemeriksaan prioritas yang gagal.

Catatan: Saat memfilter menurut kolom berulang, Anda hanya dapat menggunakan operator HAS (ditunjukkan dengan karakter : titik dua) untuk membuat perbandingan. Lihat bagian Memiliki Operator untuk mengetahui info selengkapnya.

Pemfilteran menurut jalur kolom ini tidak didukung:

• 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

Lihat AIP-160 untuk mempelajari cara membuat lebih banyak ekspresi filter.

Penomoran halaman

Secara default, metode List menampilkan maksimal 10 laporan. Anda dapat mengubahnya dengan menetapkan parameter kueri URL pageSize. Nilai maksimumnya adalah 50.

Metode List menampilkan nextPageToken jika ada lebih banyak hasil yang dapat diambil:

{
  "reports": [
    ...
  ],
  "nextPageToken": "CAEQ0ITI8K7ngAMaIDY3MThjNjQ3NGZmNzBhZGI4NWI5NjAyN2ViZmQ5MWVh"
}

Teruskan token ini ke metode List menggunakan parameter kueri URL pageToken untuk mengambil halaman hasil berikutnya.