Abfrageberichte

Ein Report enthält das Ergebnis einer einzelnen App-Bundle-Analyse, einschließlich der Ergebnisse der Compliance-Prüfungen und der Datenüberwachung. Auf fast alle Daten, die über die Seiten Compliance und Data Monitoring der Checks Console verfügbar sind, kann programmatisch über Berichte zugegriffen werden.

Die Checks API bietet die Standardmethoden Get und List für den Zugriff auf Berichte:

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

Felder auswählen, die zurückgegeben werden sollen

Da Berichte viele Daten enthalten, werden standardmäßig nur die Felder name und resultsUri zurückgegeben. Wenn Sie eine andere Gruppe von Feldern zurückgeben möchten, listen Sie sie explizit im URL-Suchparameter fields auf.

Beispiel:

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

Liefert:

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

Verschachtelte Felder können mit der Punktnotation oder in Klammern angegeben werden.

Beispiel:

fields=checks.type,checks.state

entspricht

fields=checks(type,state)

Klammern können auch rekursiv verwendet werden, wie in:

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

Dadurch können Ausdrücke präziser formuliert werden.

Der Wert des Abfrageparameters fields wird auch als Feldmaske bezeichnet. Weitere Informationen finden Sie unter Feldmasken.

Hinweis :Die im Abfrageparameter fields aufgeführten Feldpfade müssen mit dem Rückgabetyp der aufgerufenen Methode übereinstimmen. Wenn Sie beispielsweise das Feld checks auswählen, sollte fields=checks beim Aufrufen der Methode Get verwendet werden, während fields=reports(checks) beim Aufrufen der Methode List verwendet werden sollte.

Unten finden Sie weitere Beispiele für Feldmasken für die Methoden Get und List:

Get

Ausdruck	Ausgabe
*	Gibt alle Felder zurück.
name,checks	Gibt name und alle verschachtelten Felder von checks zurück.
name,checks(type,state)	Gibt name, checks.type und checks.state zurück.
name,dataMonitoring	Gibt name und alle verschachtelten Felder von dataMonitoring zurück.

Liste

Ausdruck	Ausgabe
*	Gibt alle Felder zurück.
reports(name,checks)	Gibt name und alle verschachtelten Felder von checks zurück.
reports(name,checks(type,state))	Gibt name, checks.type und checks.state zurück.
reports(name,dataMonitoring)	Gibt name und alle verschachtelten Felder von dataMonitoring zurück.

Berichte filtern

Sie können Berichte, die von der Methode List zurückgegeben werden, filtern, indem Sie einen Filterausdruck mit dem URL-Abfrageparameter filter übergeben.

Hier einige Beispiele:

Ausdruck	Ausgabe
appBundle.releaseType = PRE_RELEASE	Gibt nur Berichte zu Vorabveröffentlichungs-App-Bundles zurück.
appBundle.releaseType = PUBLIC	Gibt nur Berichte zu öffentlichen App-Bundles zurück.
appBundle.codeReferenceId = abc123	Gibt Berichte zurück, in denen codeReferenceId gleich abc123 ist.

Hinweis :Wenn Sie nach Feldern mit Wiederholungen filtern, können Sie für Vergleiche nur den Operator HAS (angegeben durch das Doppelpunktzeichen :) verwenden. Weitere Informationen finden Sie unter Has-Operator.

Das Filtern nach diesen Feldpfaden wird nicht unterstützt:

• 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

Prüfungen in Berichten filtern

Sie können Prüfungen in Berichten filtern, indem Sie einen Filterausdruck mit dem URL-Abfrageparameter checksFilter übergeben. In der Antwort sind nur Prüfungen enthalten, die dem Filterausdruck entsprechen. Dieser Parameter wird sowohl von der List- als auch von der Get-Methode unterstützt.

Hier einige Beispiele:

Ausdruck	Ausgabe
state = FAILED	Enthält nur fehlgeschlagene Überprüfungen.
citations.type:GDPR	Enthält nur Prüfungen im Zusammenhang mit der DSGVO.
state = FAILED AND citations.type:GDPR	Enthält nur fehlgeschlagene Prüfungen im Zusammenhang mit der DSGVO.
regionCodes:CA	Enthält nur Prüfungen, die sich auf die Region Kanada beziehen.
state = FAILED AND severity = PRIORITY	Enthält nur fehlgeschlagene Prioritätsprüfungen.

Hinweis :Wenn Sie nach Feldern mit Wiederholungen filtern, können Sie für Vergleiche nur den Operator HAS (angegeben durch das Doppelpunktzeichen :) verwenden. Weitere Informationen finden Sie unter Has-Operator.

Das Filtern nach diesen Feldpfaden wird nicht unterstützt:

• 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

Seitenumbruch

Standardmäßig gibt die Methode List maximal 10 Berichte zurück. Sie können dies ändern, indem Sie den URL-Suchparameter pageSize festlegen. Der Höchstwert ist 50.

Die List-Methode gibt eine nextPageToken zurück, wenn weitere Ergebnisse abgerufen werden müssen:

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

Übergeben Sie dieses Token an die Methode List mit dem URL-Abfrageparameter pageToken, um die nächste Ergebnisseite abzurufen.