Ein Report
enthält das Ergebnis einer Analyse eines einzelnen App Bundles sowie die Ergebnisse der Complianceprüfungen und des Datenmonitorings. Auf fast alle Daten, die über die Seiten Compliance und Datenmonitoring der Checks Console angeboten werden, kann programmatisch über Berichte zugegriffen werden.
Die Checks API bietet die Standardmethoden Get
und List
für den Zugriff auf Berichte:
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 andere Felder zurückgegeben werden sollen, müssen Sie sie explizit im URL-Suchparameter fields
auflisten.
Beispiel:
GET https://checks.googleapis.com/v1alpha/accounts/123/apps/456/reports/789?fields=name,checks(type,state)
Retouren:
{
"name": "accounts/123/apps/456/reports/789",
"checks": [
{
"type": "PRIVACY_POLICY_UPDATE_DATE_RECENT",
"state": "PASSED"
},
...
]
}
Verschachtelte Felder können mithilfe der Punktsyntax oder durch Einfügen in Klammern aufgelistet werden.
Beispiel:
fields=checks.type,checks.state
entspricht
fields=checks(type,state)
Klammern können auch rekursiv verwendet werden, zum Beispiel:
fields=checks(type,state,evidence(permissions,sdks))
Dadurch können Ausdrücke prägnanter sein.
Der Wert des Abfrageparameters fields
wird auch als Feldmaske bezeichnet. Weitere Informationen finden Sie unter Feldmasken.
Im Folgenden 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 filtern, die von der Methode List
zurückgegeben werden. Dazu übergeben Sie einen Filterausdruck mit dem URL-Suchparameter filter
.
Beispiele:
Ausdruck | Ausgabe |
---|---|
appBundle.releaseType = PRE_RELEASE |
Gibt nur Berichte zu Vorabveröffentlichungen von 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. |
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
Informationen zum Erstellen weiterer Filterausdrücke finden Sie unter AIP-160.
Überprüfungen in Berichten filtern
Sie können Prüfungen in Berichten filtern, indem Sie mit dem URL-Suchparameter checksFilter
einen Filterausdruck übergeben. Nur Prüfungen, die mit dem Filterausdruck übereinstimmen, werden in die Antwort aufgenommen. Dieser Parameter wird sowohl von der Methode List
als auch von der Methode Get
unterstützt.
Beispiele:
Ausdruck | Ausgabe |
---|---|
state = FAILED |
Umfasst nur fehlgeschlagene Prüfungen. |
citations.type:GDPR |
Umfasst nur Prüfungen im Zusammenhang mit der DSGVO. |
state = FAILED AND citations.type:GDPR |
Umfasst nur fehlgeschlagene Prüfungen im Zusammenhang mit GDRP. |
regionCodes:CA |
Umfasst nur Überprüfungen, die sich auf die Region Kanada beziehen. |
state = FAILED AND severity = PRIORITY |
Umfasst nur fehlgeschlagene Prioritätsprüfungen. |
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
Informationen zum Erstellen weiterer Filterausdrücke finden Sie unter AIP-160.
Seitenumbruch
Standardmäßig gibt die Methode List
höchstens 10
Berichte zurück. Sie können dies ändern, indem Sie den URL-Suchparameter pageSize
festlegen. Der Höchstwert ist 50
.
Die Methode List
gibt ein nextPageToken
zurück, wenn mehr Ergebnisse abgerufen werden müssen:
{
"reports": [
...
],
"nextPageToken": "CAEQ0ITI8K7ngAMaIDY3MThjNjQ3NGZmNzBhZGI4NWI5NjAyN2ViZmQ5MWVh"
}
Übergeben Sie dieses Token mit dem URL-Abfrageparameter pageToken
an die Methode List
, um die nächste Ergebnisseite abzurufen.