target_sites

Creates, updates, deletes, gets or lists a target_sites resource.

Overview

Name	target_sites
Type	Resource
Id	google.discoveryengine.target_sites

Fields

Name	Datatype	Description
name	string	Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} The target_site_id is system-generated.
exactMatch	boolean	Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
failureReason	object	Site search indexing failure reasons.
generatedUriPattern	string	Output only. This is system-generated based on the provided_uri_pattern.
indexingStatus	string	Output only. Indexing status.
providedUriPattern	string	Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.
rootDomainUri	string	Output only. Root domain of the provided_uri_pattern.
siteVerificationInfo	object	Verification information for target sites in advanced site search.
type	string	The type of the target site, e.g., whether the site is to be included or excluded.
updateTime	string	Output only. The target site's last updated time.

Methods

Name	Accessible by	Required Params	Description
projects_locations_collections_data_stores_site_search_engine_target_sites_get	SELECT	collectionsId, dataStoresId, locationsId, projectsId, targetSitesId	Gets a TargetSite.
projects_locations_collections_data_stores_site_search_engine_target_sites_list	SELECT	collectionsId, dataStoresId, locationsId, projectsId	Gets a list of TargetSites.
projects_locations_data_stores_site_search_engine_target_sites_get	SELECT	dataStoresId, locationsId, projectsId, targetSitesId	Gets a TargetSite.
projects_locations_data_stores_site_search_engine_target_sites_list	SELECT	dataStoresId, locationsId, projectsId	Gets a list of TargetSites.
projects_locations_collections_data_stores_site_search_engine_target_sites_batch_create	INSERT	collectionsId, dataStoresId, locationsId, projectsId	Creates TargetSite in a batch.
projects_locations_collections_data_stores_site_search_engine_target_sites_create	INSERT	collectionsId, dataStoresId, locationsId, projectsId	Creates a TargetSite.
projects_locations_data_stores_site_search_engine_target_sites_batch_create	INSERT	dataStoresId, locationsId, projectsId	Creates TargetSite in a batch.
projects_locations_data_stores_site_search_engine_target_sites_create	INSERT	dataStoresId, locationsId, projectsId	Creates a TargetSite.
projects_locations_collections_data_stores_site_search_engine_target_sites_delete	DELETE	collectionsId, dataStoresId, locationsId, projectsId, targetSitesId	Deletes a TargetSite.
projects_locations_data_stores_site_search_engine_target_sites_delete	DELETE	dataStoresId, locationsId, projectsId, targetSitesId	Deletes a TargetSite.
projects_locations_collections_data_stores_site_search_engine_target_sites_patch	UPDATE	collectionsId, dataStoresId, locationsId, projectsId, targetSitesId	Updates a TargetSite.
projects_locations_data_stores_site_search_engine_target_sites_patch	UPDATE	dataStoresId, locationsId, projectsId, targetSitesId	Updates a TargetSite.

SELECT examples

Gets a list of TargetSites.

SELECT
name,
exactMatch,
failureReason,
generatedUriPattern,
indexingStatus,
providedUriPattern,
rootDomainUri,
siteVerificationInfo,
type,
updateTime
FROM google.discoveryengine.target_sites
WHERE dataStoresId = '{{ dataStoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new target_sites resource.

All Properties

/*+ create */
INSERT INTO google.discoveryengine.target_sites (
dataStoresId,
locationsId,
projectsId,
requests
)
SELECT 
'{{ dataStoresId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ requests }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: requests
      value:
        - - name: parent
            value: string
          - name: targetSite
            value:
              - name: name
                value: string
              - name: providedUriPattern
                value: string
              - name: type
                value: string
              - name: exactMatch
                value: boolean
              - name: generatedUriPattern
                value: string
              - name: rootDomainUri
                value: string
              - name: siteVerificationInfo
                value:
                  - name: siteVerificationState
                    value: string
                  - name: verifyTime
                    value: string
              - name: indexingStatus
                value: string
              - name: updateTime
                value: string
              - name: failureReason
                value:
                  - name: quotaFailure
                    value:
                      - name: totalRequiredQuota
                        value: string

UPDATE example

Updates a target_sites resource.

/*+ update */
UPDATE google.discoveryengine.target_sites
SET 
providedUriPattern = '{{ providedUriPattern }}',
type = '{{ type }}',
exactMatch = true|false
WHERE 
dataStoresId = '{{ dataStoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND targetSitesId = '{{ targetSitesId }}';

DELETE example

Deletes the specified target_sites resource.

/*+ delete */
DELETE FROM google.discoveryengine.target_sites
WHERE dataStoresId = '{{ dataStoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND targetSitesId = '{{ targetSitesId }}';