Sorgu raporları

Report, tek bir uygulama paketi analizinin yanı sıra uygunluk kontrollerini ve veri izleme sonuçlarını da içerir. Checks Console'un Uygunluk ve Veri İzleme sayfalarında sunulan verilerin neredeyse tamamına raporlar aracılığıyla programatik olarak erişilebilir.

Checks API, raporlara erişmek için standart Get ve List yöntemleri sağlar:

Döndürülecek alanları seçin

Raporlar çok fazla veri içerdiğinden, varsayılan olarak yalnızca name ve resultsUri alanları döndürülür. Farklı bir alan grubu döndürmek için bunları fields URL sorgu parametresinde açıkça listeleyin.

Örnek:

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

Dönen:

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

İç içe yerleştirilmiş alanlar, nokta söz dizimi kullanılarak veya parantez içine alınarak listelenebilir.

Örneğin,

fields=checks.type,checks.state

eşittir

fields=checks(type,state)

Parantezler aşağıdaki gibi tekrarlı olarak da kullanılabilir:

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

Bu, ifadelerin daha kısa ve öz olmasını sağlar.

fields sorgu parametresinin değeri, alan maskesi olarak da bilinir. Daha fazla bilgi edinmek için Alan maskeleri bölümüne bakın.

Aşağıda, Get ve List yöntemleri için diğer alan maskesi örnekleri verilmiştir:

Get

İfade Çıkış
* Tüm alanları döndürür.
name,checks name ve checks değerinin iç içe yerleştirilmiş tüm alanlarını döndürür.
name,checks(type,state) name, checks.type ve checks.state döndürür.
name,dataMonitoring name ve dataMonitoring değerinin iç içe yerleştirilmiş tüm alanlarını döndürür.

Liste

İfade Çıkış
* Tüm alanları döndürür.
reports(name,checks) name ve checks değerinin iç içe yerleştirilmiş tüm alanlarını döndürür.
reports(name,checks(type,state)) name, checks.type ve checks.state döndürür.
reports(name,dataMonitoring) name ve dataMonitoring değerinin iç içe yerleştirilmiş tüm alanlarını döndürür.

Raporları filtreleyin

filter URL sorgu parametresini kullanıp bir filtre ifadesi ileterek List yöntemi tarafından döndürülen raporları filtreleyebilirsiniz.

Bazı örnekler:

İfade Çıkış
appBundle.releaseType = PRE_RELEASE Yalnızca yayın öncesi uygulama paketlerinin raporlarını döndürür.
appBundle.releaseType = PUBLIC Yalnızca herkese açık uygulama paketleriyle ilgili raporları döndürür.
appBundle.codeReferenceId = abc123 codeReferenceId değerinin abc123 olduğu raporları döndürür.

Şu alan yollarına göre filtreleme desteklenmez:

  • 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

Daha fazla filtre ifadesini nasıl oluşturacağınızı öğrenmek için AIP-160 sayfasına bakın.

Raporlardaki kontrolleri filtreleme

checksFilter URL sorgu parametresini kullanıp bir filtre ifadesi ileterek raporlardaki kontrolleri filtreleyebilirsiniz. Yalnızca filtre ifadesiyle eşleşen kontroller yanıta dahil edilir. Bu parametre hem List hem de Get yöntemleri tarafından desteklenir.

Bazı örnekler:

İfade Çıkış
state = FAILED Yalnızca başarısız olan kontrolleri içerir.
citations.type:GDPR Yalnızca GDPR ile ilgili kontrolleri içerir.
state = FAILED AND citations.type:GDPR Yalnızca GDRP ile ilgili başarısız kontrolleri içerir.
regionCodes:CA Yalnızca Kanada bölgesiyle ilgili kontrolleri içerir.
state = FAILED AND severity = PRIORITY Yalnızca başarısız olan öncelik kontrollerini içerir.

Şu alan yollarına göre filtreleme desteklenmez:

  • 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

Daha fazla filtre ifadesini nasıl oluşturacağınızı öğrenmek için AIP-160 sayfasına bakın.

Sayfalara ayırma

Varsayılan olarak List yöntemi en fazla 10 rapor döndürür. pageSize URL sorgu parametresini ayarlayarak bunu değiştirebilirsiniz. Maksimum değer 50 olmalıdır.

List yöntemi, getirilecek daha fazla sonuç olduğunda nextPageToken döndürür:

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

Sonraki sonuç sayfasını getirmek için bu jetonu pageToken URL sorgu parametresini kullanarak List yöntemine iletin.