Method: projects.locations.requirements.checkRequirement

특정 요구사항을 확인합니다.

HTTP 요청

POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}/requirements:checkRequirement

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
location

string

필수 항목입니다. 위치의 전체 리소스 이름입니다. projects/{project_number_or_id}/locations/{location} 포맷

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
필드
requirementType

string

확인할 요구사항을 지정하는 유형입니다. 지원되는 유형은 다음과 같습니다.

  • discoveryengine.googleapis.com/media_recs/general/all/warning
  • discoveryengine.googleapis.com/media_recs/oyml/cvr/warning
  • discoveryengine.googleapis.com/media_recs/rfy/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mlt/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mp/cvr/warning
  • discoveryengine.googleapis.com/media_recs/oyml/wdps/warning
  • discoveryengine.googleapis.com/media_recs/rfy/wdps/warning
  • discoveryengine.googleapis.com/media_recs/mlt/wdps/warning
resources[]

object (MonitoredResource)

이 요구사항을 확인해야 하는 리소스입니다. 모니터링 리소스에 필요한 유형:

  • discoveryengine.googleapis.com/Branch개

    • 이 리소스에 필요한 라벨입니다.
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • 이 리소스에 필요한 라벨입니다.
      • project_number
      • location_id
      • collection_id
      • datastore_id

응답 본문

requirements.checkRequirement 메서드에 대한 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "requirement": {
    object (Requirement)
  },
  "requirementCondition": {
    object (Expr)
  },
  "metricResults": [
    {
      object (MetricQueryResult)
    }
  ],
  "oldestMetricTimestamp": string,
  "result": string
}
필드
requirement

object (Requirement)

요구사항 정의입니다.
requirementCondition

object (Expr)

요구사항 결과를 평가하는 조건입니다.
metricResults[]

object (MetricQueryResult)

측정항목 결과입니다.
oldestMetricTimestamp

string (Timestamp format)

가장 오래된 산출된 측정항목 (즉, 가장 오래된 측정항목)의 타임스탬프입니다. 이 시간 이후에 실행된 이벤트 및 제품 카탈로그 업데이트가 result에 정확하게 반영되지 않을 수 있음을 나타냅니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
result

string

요구사항의 결과입니다. 요구사항 정의의 severity 필드 중 하나여야 합니다. 평가 중에 오류가 발생하면 UNKNOWN가 됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

자세한 내용은 Authentication Overview를 참조하세요.

요구사항

데이터 요구사항입니다.

JSON 표현 
{
  "type": string,
  "displayName": string,
  "description": string,
  "condition": {
    object (Expr)
  },
  "metricBindings": [
    {
      object (MetricBinding)
    }
  ],
  "thresholdBindings": [
    {
      object (ThresholdBinding)
    }
  ],
  "violationSamplesBindings": [
    {
      object (ViolationSamplesBinding)
    }
  ],
  "severity": [
    string
  ]
}
필드
type

string

식별자로 사용되는 요구사항 유형입니다. 고유한 이름이어야 합니다.

충돌을 방지하기 위해 유형은 서비스 이름으로 시작해야 합니다. 유사한 요구사항에는 자연스러운 계층적 그룹화를 사용하는 것이 좋습니다.

예:

  • library.googleapis.com/books/min_available_books
  • discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate
displayName

string

요구사항의 이름입니다.
description

string

요구사항에 관한 설명입니다.
condition

object (Expr)

요구사항 결과를 평가하는 조건입니다.

표현식의 변수는 metrics_bindings 또는 thresholdBindings에 의해 제공되어야 합니다. 여기서 metrics_bindings는 계산된 측정항목에 사용되고 thresholdBindings는 해당 metricBindings의 기준점을 정의하는 데 사용됩니다.
metricBindings[]

object (MetricBinding)

condition에서 사용할 측정항목 바인딩 목록입니다.
thresholdBindings[]

object (ThresholdBinding)

condition에서 사용할 기준점 바인딩 목록입니다.
violationSamplesBindings[]

object (ViolationSamplesBinding)

condition에서 사용할 측정항목 바인딩 목록입니다.
severity[]

string

요구사항을 충족하지 않는 경우 오류의 심각도입니다. 가장 엄격한 것부터 가장 덜 엄격한 순으로 정렬해야 합니다. 예:

  • BLOCKING
  • CRITICAL
  • WARNING

요구사항의 모든 기준점에는 여기에 모든 심각도가 있어야 합니다.

MetricBinding

측정항목 쿼리를 지정하고 결과를 condition에서 사용할 변수에 바인딩합니다.

JSON 표현 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
필드
variableId

string

condition에서 참조할 변수 ID입니다.
resourceType

string

측정항목에 대해 모니터링되는 리소스입니다.
metricFilter

string

측정항목 쿼리에 사용되는 필터 문자열입니다.

예:

"metric.type = "discoveryengine.googleapis.com/events/day_count" AND " "metric.conditions.time_range = "NINETY_DAYS""
description

string

해당 측정항목 필터에 대한 사람이 읽을 수 있는 설명입니다.
category

string

측정항목의 타겟 리소스 카테고리입니다. 예: '이벤트'

ThresholdBinding

condition CEL 표현식의 metricBindings에 적용할 다단계 기준점을 지정합니다.

JSON 표현 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
필드
variableId

string

condition에서 참조할 변수 ID입니다. 모든 metricBindings 및 thresholdBindings에서 고유해야 합니다.
description

string

해당 기준점 및 하위 요구사항에 대한 사람이 읽을 수 있는 설명입니다.
thresholdValues[]

object (ThresholdValue)

기준점 값입니다. 값은 가장 엄격한 것부터 가장 덜 엄격한 것까지 순서대로 정렬해야 합니다.

ThresholdValue

지정된 심각도의 기준값을 지정합니다.

JSON 표현 
{
  "severity": string,
  "value": number
}
필드
severity

string

기준을 충족하지 않는 경우 오류의 심각도입니다. 요구사항의 severity 필드 중 하나여야 합니다.
value

number

기준값입니다.

ViolationSamplesBinding

샘플 쿼리를 지정하고 결과를 condition에서 사용할 변수에 바인딩합니다.

JSON 표현 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
필드
variableId

string

condition에서 참조할 변수 ID입니다.
sampleFilter

string

샘플 쿼리에 사용되는 필터 문자열입니다.

예: 'sample.type = 'retail.googleapis.com/userEvent' AND ' 'sample.labels.event_type = 'PURCHASE' '
description

string

이 샘플 바인딩에 대한 설명입니다. UI에서 각 요구사항 조건에 대한 사용자 친화적인 설명을 렌더링하는 데 사용됩니다.

길이가 128자(영문 기준) 미만이어야 합니다.

MetricQueryResult

측정항목 결과입니다. 측정항목은 requirementCondition에 있습니다.

JSON 표현 
{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}
필드
name

string

이 측정항목 쿼리 이름은 requirementCondition의 변수에 매핑됩니다.
value

object (TypedValue)

측정항목 쿼리의 값입니다.
timestamp

string (Timestamp format)

이 측정항목 값이 계산된 시간에 해당합니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
unit

string

이 측정항목이 보고되는 단위입니다. 팔로우

측정 단위 통합 코드 표준
metricType

string

이 쿼리 결과에 해당하는 측정항목의 유형 식별자입니다.