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

- [Resource: TargetSite](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite)
  - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.SCHEMA_REPRESENTATION)
  - [Type](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.Type)
  - [SiteVerificationInfo](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.SiteVerificationInfo)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.SiteVerificationInfo.SCHEMA_REPRESENTATION)
  - [SiteVerificationState](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.SiteVerificationState)
  - [IndexingStatus](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.IndexingStatus)
  - [FailureReason](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.FailureReason)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.FailureReason.SCHEMA_REPRESENTATION)
  - [QuotaFailure](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.QuotaFailure)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.QuotaFailure.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#METHODS_SUMMARY)

## Resource: TargetSite

A target site for the SiteSearchEngine.

| JSON representation |
|---|
| ``` { "name": string, "providedUriPattern": string, "type": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.Type`), "exactMatch": boolean, "generatedUriPattern": string, "rootDomainUri": string, "siteVerificationInfo": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.SiteVerificationInfo`) }, "indexingStatus": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.IndexingStatus`), "updateTime": string, "failureReason": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.FailureReason`) } } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite}` The `target_site_id` is system-generated. |
| `providedUriPattern` | `string` Required. Input only. The user provided URI pattern from which the `generatedUriPattern` is generated. |
| `type` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.Type`)`` The type of the target site, e.g., whether the site is to be included or excluded. |
| `exactMatch` | `boolean` Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the providedUriPattern. If set to true, an uri_pattern is generated to try to be an exact match of the providedUriPattern or just the specific page if the providedUriPattern is a specific one. providedUriPattern is always normalized to generate the URI pattern to be used by the search engine. |
| `generatedUriPattern` | `string` Output only. This is system-generated based on the providedUriPattern. |
| `rootDomainUri` | `string` Output only. Root domain of the providedUriPattern. |
| `siteVerificationInfo` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.SiteVerificationInfo`)`` Output only. Site ownership and validity verification status. |
| `indexingStatus` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.IndexingStatus`)`` Output only. Indexing status. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The target site's last updated time. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `failureReason` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.FailureReason`)`` Output only. Failure reason. |

### Type

Possible target site types.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | This value is unused. In this case, server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.Type.ENUM_VALUES.INCLUDE`. |
| `INCLUDE` | Include the target site. |
| `EXCLUDE` | Exclude the target site. |

### SiteVerificationInfo

Verification information for target sites in advanced site search.

| JSON representation |
|---|
| ``` { "siteVerificationState": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.SiteVerificationState`), "verifyTime": string } ``` |

| Fields ||
|---|---|
| `siteVerificationState` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.SiteVerificationState`)`` Site verification state indicating the ownership and validity. |
| `verifyTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Latest site verification time. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

### SiteVerificationState

Site verification state.

| Enums ||
|---|---|
| `SITE_VERIFICATION_STATE_UNSPECIFIED` | Defaults to VERIFIED. |
| `VERIFIED` | Site ownership verified. |
| `UNVERIFIED` | Site ownership pending verification or verification failed. |
| `EXEMPTED` | Site exempt from verification, e.g., a public website that opens to all. |

### IndexingStatus

Target site indexing status enumeration.

| Enums ||
|---|---|
| `INDEXING_STATUS_UNSPECIFIED` | Defaults to SUCCEEDED. |
| `PENDING` | The target site is in the update queue and will be picked up by indexing pipeline. |
| `FAILED` | The target site fails to be indexed. |
| `SUCCEEDED` | The target site has been indexed. |
| `DELETING` | The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails. |
| `CANCELLABLE` | The target site change is pending but cancellable. |
| `CANCELLED` | The target site change is cancelled. |

### FailureReason

Site search indexing failure reasons.

| JSON representation |
|---|
| ``` { // Union field `failure` can be only one of the following: "quotaFailure": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.QuotaFailure`) } // End of list of possible types for union field `failure`. } ``` |

| Fields ||
|---|---|
| Union field `failure`. Failure reason. `failure` can be only one of the following: ||
| `quotaFailure` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite.QuotaFailure`)`` Failed due to insufficient quota. |

### QuotaFailure

Failed due to insufficient quota.

| JSON representation |
|---|
| ``` { "totalRequiredQuota": string } ``` |

| Fields ||
|---|---|
| `totalRequiredQuota` | `string (https://developers.google.com/discovery/v1/type-format format)` This number is an estimation on how much total quota this project needs to successfully complete indexing. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites/batchCreate` | Creates `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite` in a batch. |
| ### `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites/create` | Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite`. |
| ### `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites/delete` | Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite`. |
| ### `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites/get` | Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite`. |
| ### `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites/list` | Gets a list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite`s. |
| ### `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites/patch` | Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine.targetSites#TargetSite`. |