REST Resource: projects.locations.collections.dataStores.siteSearchEngine.targetSites

리소스: TargetSite

SiteSearchEngine의 타겟 사이트입니다.

JSON 표현 
{
  "name": string,
  "providedUriPattern": string,
  "type": enum (Type),
  "exactMatch": boolean,
  "generatedUriPattern": string,
  "rootDomainUri": string,
  "siteVerificationInfo": {
    object (SiteVerificationInfo)
  },
  "indexingStatus": enum (IndexingStatus),
  "updateTime": string,
  "failureReason": {
    object (FailureReason)
  }
}
필드
name

string

출력 전용입니다. 타겟 사이트의 정규화된 리소스 이름입니다. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} target_site_id는 시스템에서 생성됩니다.
providedUriPattern

string

필수 항목입니다. 입력 전용입니다. generatedUriPattern이 생성된 사용자 제공 URI 패턴입니다.
type

enum (Type)

타겟 사이트의 유형입니다(예: 사이트가 포함되는지 또는 제외되는지).
exactMatch

boolean

변경할 수 없습니다. false로 설정하면 제공된UriPattern이 주소에 포함된 모든 페이지를 포함하는 uri_pattern이 생성됩니다. true로 설정하면 제공된UriPattern과 정확히 일치하거나 제공된UriPattern이 특정 패턴인 경우 특정 페이지와 일치하도록 uri_pattern이 생성됩니다. 제공된UriPattern은 검색엔진에서 사용할 URI 패턴을 생성하기 위해 항상 정규화됩니다.
generatedUriPattern

string

출력 전용입니다. 이는 제공된 uriPattern을 기반으로 시스템에서 생성됩니다.
rootDomainUri

string

출력 전용입니다. providedUriPattern의 루트 도메인입니다.
siteVerificationInfo

object (SiteVerificationInfo)

출력 전용입니다. 사이트 소유권 및 유효성 확인 상태입니다.
indexingStatus

enum (IndexingStatus)

출력 전용입니다. 색인 생성 상태입니다.
updateTime

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

object (FailureReason)

출력 전용입니다. 실패 이유입니다.

유형

가능한 타겟 사이트 유형입니다.

열거형
TYPE_UNSPECIFIED 이 값은 사용되지 않습니다. 이 경우 서버 동작은 기본적으로 Type.INCLUDE입니다.
INCLUDE 타겟 사이트를 포함합니다.
EXCLUDE 타겟 사이트를 제외합니다.

SiteVerificationInfo

고급 사이트 검색의 타겟 사이트에 대한 인증 정보입니다.

JSON 표현 
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
필드
siteVerificationState

enum (SiteVerificationState)

소유권과 유효성을 나타내는 사이트 인증 상태입니다.
verifyTime

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

SiteVerificationState

사이트 인증 상태입니다.

열거형
SITE_VERIFICATION_STATE_UNSPECIFIED 기본값은 VERIFIED입니다.
VERIFIED 사이트 소유권이 확인되었습니다.
UNVERIFIED 사이트 소유권이 인증 대기 중이거나 인증에 실패했습니다.
EXEMPTED 인증이 면제된 사이트(예: 모든 사용자에게 공개된 웹사이트)

IndexingStatus

타겟 사이트 색인 생성 상태 열거형입니다.

열거형
INDEXING_STATUS_UNSPECIFIED 기본값은 SUCCEEDED입니다.
PENDING 타겟 사이트가 업데이트 대기열에 있으며 색인 생성 파이프라인에서 선택됩니다.
FAILED 타겟 사이트의 색인이 생성되지 않습니다.
SUCCEEDED 대상 사이트의 색인이 생성되었습니다.
DELETING 이전에 색인이 생성된 타겟 사이트가 삭제되도록 표시되었습니다. 이는 전환 상태이며, 색인 해제가 성공하면 대상 사이트가 삭제되고 색인 해제가 실패하면 상태가 SUCCEEDED로 되돌아갑니다.
CANCELLABLE 타겟 사이트 변경이 대기 중이지만 취소할 수 있습니다.
CANCELLED 타겟 사이트 변경이 취소됩니다.

FailureReason

사이트 검색 색인 생성 실패 이유입니다.

JSON 표현 
{

  // Union field failure can be only one of the following:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of list of possible types for union field failure.
}
필드
통합 필드 failure. 실패 이유입니다. failure은 다음 중 하나여야 합니다.
quotaFailure

object (QuotaFailure)

할당량이 부족하여 실패했습니다.

QuotaFailure

할당량이 부족하여 실패했습니다.

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

string (int64 format)

이 숫자는 프로젝트에서 색인 생성을 성공적으로 완료하는 데 필요한 총 할당량을 추정한 것입니다.

메서드

batchCreate

 TargetSite를 일괄적으로 만듭니다.

create

 TargetSite를 만듭니다.

delete

 TargetSite를 삭제합니다.

get

 TargetSite을 가져옵니다.

list

 TargetSite 목록을 가져옵니다.

patch

 TargetSite을 업데이트합니다.