REST Resource: projects.locations.collections.dataStores.controls

리소스: Control

서빙 중에 사용할 조건부 동작을 정의합니다. 게재 시간에 고려되려면 ServingConfig에 연결되어야 합니다. SolutionType에 따라 허용되는 작업

JSON 표현 
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "useCases": [
    enum (SearchUseCase)
  ],
  "conditions": [
    {
      object (Condition)
    }
  ],

  // Union field action can be only one of the following:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of list of possible types for union field action.
}
필드
name

string

변경할 수 없습니다. 정규화된 이름 projects/*/locations/global/dataStore/*/controls/*
displayName

string

필수 항목입니다. 사람이 읽을 수 있는 이름입니다. UI 뷰에서 사용되는 식별자입니다.

UTF-8로 인코딩된 문자열이어야 합니다. 길이 제한은 128자(영문 기준)입니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
associatedServingConfigIds[]

string

출력 전용입니다. 이 컨트롤이 연결된 모든 ServingConfig ID의 목록입니다. 변경 후 업데이트되는 데 최대 10분이 걸릴 수 있습니다.
solutionType

enum (SolutionType)

필수 항목입니다. 변경할 수 없습니다. 컨트롤이 속한 솔루션입니다.

리소스의 업종과 호환되어야 합니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
useCases[]

enum (SearchUseCase)

제어의 사용 사례를 지정합니다. 설정할 수 있는 조건 필드에 영향을 미칩니다. SOLUTION_TYPE_SEARCH에만 적용됩니다. 현재 컨트롤당 하나의 사용 사례만 허용됩니다. solutionType이 SolutionType.SOLUTION_TYPE_SEARCH인 경우 설정해야 합니다.
conditions[]

object (Condition)

연결된 작업이 트리거되는 시점을 결정합니다.

항상 작업을 적용하려면 생략하세요. 현재는 단일 조건만 지정할 수 있습니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.

통합 필드 action. 작업이 업종 및 솔루션에 따라 제한됨

필수 항목입니다. action는 다음 중 하나여야 합니다.
boostAction

object (BoostAction)

부스트 유형 컨트롤을 정의합니다.
filterAction

object (FilterAction)

필터 유형 컨트롤을 정의합니다. 현재 추천에서 지원되지 않습니다.
redirectAction

object (RedirectAction)

리디렉션 유형 컨트롤을 정의합니다.
synonymsAction

object (SynonymsAction)

일련의 용어를 서로의 동의어로 취급합니다.
promoteAction

object (PromoteAction)

사전 정의된 트리거 쿼리를 기반으로 특정 링크를 홍보합니다.

BoostAction

반환된 목록에서 제품의 순서를 조정합니다.

JSON 표현 
{
  "boost": number,
  "filter": string,
  "dataStore": string,

  // Union field boost_spec can be only one of the following:
  "fixedBoost": number,
  "interpolationBoostSpec": {
    object (InterpolationBoostSpec)
  }
  // End of list of possible types for union field boost_spec.
}
필드
boost
(deprecated)

number

부스트의 강도이며, 범위는 [-1, 1]입니다. 음수 부스팅은 순위를 내리는 것을 의미합니다. 기본값은 0.0 (작업 없음)입니다.
filter

string

필수 항목입니다. 부스트를 적용할 제품을 지정합니다.

필터를 제공하지 않으면 모든 제품이 부스팅됩니다 (작업 없음). 구문 문서: https://cloud.google.com/retail/docs/filter-and-order 최대 길이는 5,000자(영문 기준)입니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
dataStore

string

필수 항목입니다. 이 컨트롤로 확장할 수 있는 데이터 스토어의 문서를 지정합니다. 전체 데이터 스토어 이름(예: projects/123/locations/global/collections/default_collection/dataStores/default_data_store)
통합 필드 boost_spec. 상수 값 부스트 또는 맞춤 순위 지정 기반 부스트 사양입니다. boost_spec은 다음 중 하나여야 합니다.
fixedBoost

number

(선택사항) 부스트의 강도이며, 범위는 [-1, 1]입니다. 음수 부스팅은 순위를 내리는 것을 의미합니다. 기본값은 0.0 (작업 없음)입니다.
interpolationBoostSpec

object (InterpolationBoostSpec)

(선택사항) 고객 정의 속성 값을 기반으로 하는 맞춤 순위 지정의 복잡한 사양입니다.

InterpolationBoostSpec

고객이 지정한 속성 값을 기반으로 한 맞춤 순위 지정 사양입니다. 위의 간단한 (조건, 부스트) 조합보다 맞춤설정된 순위 지정에 더 많은 제어 기능을 제공합니다.

JSON 표현 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
필드
fieldName

string

(선택사항) 값이 부스트 금액을 결정하는 데 사용되는 필드의 이름입니다.
attributeType

enum (AttributeType)

(선택사항) 부스트 금액을 결정하는 데 사용할 속성 유형입니다. 속성 값은 지정된 fieldName의 필드 값에서 파생될 수 있습니다. 숫자의 경우 간단합니다(예: attributeValue = numerical_field_value). 하지만 신선도의 경우 attributeValue = (time.now() - datetime_field_value)입니다.
interpolationType

enum (InterpolationType)

(선택사항) 아래에 나열된 제어점을 연결하는 데 적용할 보간 유형입니다.
controlPoints[]

object (ControlPoint)

(선택사항) 곡선을 정의하는 데 사용되는 제어점입니다. 단조 함수 (위의 interpolationType을 통해 정의됨)는 여기에 나열된 제어점을 통과합니다.

AttributeType

맞춤 순위가 적용될 속성(또는 함수)입니다.

열거형
ATTRIBUTE_TYPE_UNSPECIFIED 지정되지 않은 AttributeType입니다.
NUMERICAL 숫자 필드의 값은 부스트 금액을 동적으로 업데이트하는 데 사용됩니다. 이 경우 제어점의 attributeValue (x 값)는 boostAmount가 지정된 숫자 필드의 실제 값이 됩니다.
FRESHNESS 최신성 사용 사례의 경우 속성 값은 현재 시간과 지정된 datetime 필드의 날짜 사이의 기간입니다. 값은 XSD dayTimeDuration 값 (ISO 8601 기간 값의 제한된 하위 집합)으로 형식이 지정되어야 합니다. 이 패턴은 [nD][T[nH][nM][nS]]입니다. 예를 들면 5D, 3DT12H30M, T24H입니다.

InterpolationType

적용할 보간 유형입니다. 기본값은 선형 (구간별 선형)입니다.

열거형
INTERPOLATION_TYPE_UNSPECIFIED 보간 유형이 지정되지 않았습니다. 이 경우 기본값은 선형입니다.
LINEAR 구간별 선형 보간이 적용됩니다.

ControlPoint

곡선을 정의하는 데 사용되는 제어점입니다. 이러한 제어점을 통해 정의된 곡선은 단조 증가 또는 단조 감소만 가능합니다(상수 값은 허용됨).

JSON 표현 
{
  "attributeValue": string,
  "boostAmount": number
}
필드
attributeValue

string

(선택사항) 다음 중 하나일 수 있습니다. 1. 숫자 필드 값입니다. 2. 새로고침 기간 사양입니다. 값은 XSD dayTimeDuration 값 (ISO 8601 기간 값의 제한된 하위 집합)으로 형식이 지정되어야 합니다. 이 패턴은 [nD][T[nH][nM][nS]]입니다.
boostAmount

number

(선택사항) attributeValue가 위에 지정된 값으로 평가되는 경우 점수를 높이는 데 사용할 -1~1 사이의 값입니다.

FilterAction

결과에 포함될 수 있는 제품을 지정했습니다. 부스트와 동일한 필터를 사용합니다.

JSON 표현 
{
  "filter": string,
  "dataStore": string
}
필드
filter

string

필수 항목입니다. 일치 조건 결과에 적용할 필터입니다.

필수 구문 문서: https://cloud.google.com/retail/docs/filter-and-order 최대 길이는 5,000자(영문 기준)입니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
dataStore

string

필수 항목입니다. 이 컨트롤로 필터링할 수 있는 데이터 스토어의 문서를 지정합니다. 전체 데이터 스토어 이름(예: projects/123/locations/global/collections/default_collection/dataStores/default_data_store)

RedirectAction

쇼핑객을 제공된 URI로 리디렉션합니다.

JSON 표현 
{
  "redirectUri": string
}
필드
redirectUri

string

필수 항목입니다. 쇼핑객이 리디렉션될 URI입니다.

필수 항목입니다. URI의 길이는 2,000자(영문 기준) 이하여야 합니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.

SynonymsAction

서로 동의어로 작동하는 용어 집합을 만듭니다.

예: 'happy'는 'glad'로도 간주되고 'glad'는 'happy'로도 간주됩니다.

JSON 표현 
{
  "synonyms": [
    string
  ]
}
필드
synonyms[]

string

동의어 집합을 정의합니다. 최대 100개의 동의어를 지정할 수 있습니다. 동의어를 2개 이상 지정해야 합니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.

PromoteAction

일부 트리거 쿼리를 기반으로 특정 링크를 홍보합니다.

예: shoe 키워드를 검색할 때 신발 매장 링크를 홍보합니다. 링크는 연결된 데이터 스토어 외부에 있을 수 있습니다.

JSON 표현 
{
  "dataStore": string,
  "searchLinkPromotion": {
    object (SearchLinkPromotion)
  }
}
필드
dataStore

string

필수 항목입니다. 이 프로모션이 연결된 데이터 스토어입니다.

SearchLinkPromotion

프로모션 프로토에는 프로모션을 표시하는 데 도움이 되는 URI 및 기타 정보가 포함됩니다.

JSON 표현 
{
  "title": string,
  "uri": string,
  "document": string,
  "imageUri": string,
  "description": string,
  "enabled": boolean
}
필드
title

string

필수 항목입니다. 프로모션의 제목입니다. 최대 길이: 160자(영문 기준)
uri

string

(선택사항) 사용자가 홍보하려는 페이지의 URL입니다. 사이트 검색에 설정해야 합니다. 다른 업종의 경우 선택사항입니다.
document

string

(선택사항) 사용자가 홍보하기를 원하는 Document입니다. 사이트 검색의 경우 설정되지 않은 상태로 두고 URI만 채웁니다. URI와 함께 설정할 수 있습니다.
imageUri

string

(선택사항) 프로모션 썸네일 이미지 URL입니다.
description

string

(선택사항) 프로모션 설명입니다. 최대 길이: 200자(영문 기준)
enabled

boolean

(선택사항) 사용 설정된 프로모션은 이 프로모션이 연결된 컨트롤의 상위 요소와 연결된 모든 서빙 구성에 대해 반환됩니다.

이 플래그는 기본 사이트 검색에만 사용됩니다.

SearchUseCase

SolutionType의 추가 하위 분류를 정의합니다. SOLUTION_TYPE_SEARCH에 적용됩니다.

열거형
SEARCH_USE_CASE_UNSPECIFIED 설정되지 않은 경우 사용되는 값입니다. CSS에서는 발생하지 않습니다.
SEARCH_USE_CASE_BROWSE 사용 사례를 둘러봅니다. 트래픽에 빈 query가 있다고 가정합니다.

조건

동작을 허용하기 전에 확인해야 하는 상황을 정의합니다.

JSON 표현 
{
  "queryTerms": [
    {
      object (QueryTerm)
    }
  ],
  "activeTimeRange": [
    {
      object (TimeRange)
    }
  ],
  "queryRegex": string
}
필드
queryTerms[]

object (QueryTerm)

검색어 목록만 검색하여 쿼리와 일치시킵니다. Condition.query_regex가 설정된 경우 설정할 수 없습니다.

최대 10개의 쿼리 용어
activeTimeRange[]

object (TimeRange)

조건이 활성 상태인 시간을 지정하는 시간 범위입니다.

시간 범위는 최대 10개입니다.
queryRegex

string

(선택사항) 전체 검색어와 일치하는 정규식을 쿼리합니다. Condition.query_terms가 설정된 경우 설정할 수 없습니다. 기본 사이트 검색 프로모션 게재 관리 기능에만 지원됩니다.

QueryTerm

검색 요청 쿼리의 매처

JSON 표현 
{
  "value": string,
  "fullMatch": boolean
}
필드
value

string

일치시킬 특정 쿼리 값

소문자여야 하며 UTF-8이어야 합니다. fullMatch가 true인 경우 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다. 빈 문자열일 수 없습니다. 최대 길이는 5,000자(영문 기준)입니다.
fullMatch

boolean

검색어가 검색어와 정확하게 일치해야 하는지 여부입니다.

TimeRange

시간 종속 조건에 사용됩니다.

JSON 표현 
{
  "startTime": string,
  "endTime": string
}
필드
startTime

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"입니다.
endTime

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"입니다.

메서드

create

 컨트롤을 만듭니다.

delete

 컨트롤을 삭제합니다.

get

 컨트롤을 가져옵니다.

list

 상위 DataStore별로 모든 컨트롤을 나열합니다.

patch

 Control을 업데이트합니다.