검색어 보고서

Report에는 단일 앱 번들 분석 결과가 포함되며 규정 준수 확인 및 데이터 모니터링 결과가 포함됩니다. Checks Console의 규정 준수 및 데이터 모니터링 페이지를 통해 제공되는 거의 모든 데이터는 보고서를 통해 프로그래매틱 방식으로 액세스할 수 있습니다.

Checks API는 보고서에 액세스하기 위한 표준 Get 및 List 메서드를 제공합니다.

반환할 필드 선택

보고서에는 많은 데이터가 포함되어 있으므로 기본적으로 name 및 resultsUri 필드만 반환됩니다. 다른 필드 집합을 반환하려면 fields URL 쿼리 매개변수에 명시적으로 나열합니다.

예:

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의 모든 중첩 필드를 반환합니다.

보고서 필터링

filter URL 쿼리 매개변수를 사용하여 필터 표현식을 전달하여 List 메서드에서 반환된 보고서를 필터링할 수 있습니다.

예를 들면 다음과 같습니다.

표현식 출력
appBundle.releaseType = PRE_RELEASE 출시 전 App Bundle 보고서만 반환합니다.
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 GDPR과 관련된 검사만 포함됩니다.
state = FAILED AND citations.type:GDPR GDRP와 관련된 실패한 검사만 포함합니다.
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개의 보고서를 반환합니다. pageSize URL 쿼리 매개변수를 설정하여 이를 변경할 수 있습니다. 최댓값은 50입니다.

List 메서드는 가져올 결과가 더 있는 경우 nextPageToken을 반환합니다.

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

pageToken URL 쿼리 매개변수를 사용하여 이 토큰을 List 메서드에 전달하여 결과의 다음 페이지를 가져옵니다.