Los controles de entrega (también llamados controles) cambian el comportamiento predeterminado de cómo se entrega una solicitud cuando se devuelven resultados. Los controles de publicación actúan a nivel del almacén de datos.
Por ejemplo, los controles pueden aumentar y ocultar resultados, filtrar entradas de los resultados devueltos, asociar cadenas entre sí como sinónimos o redireccionar resultados a URIs especificados.
Acerca de los controles de entrega
Para cambiar los resultados de una solicitud, primero crea un control de entrega. Luego, adjunta ese control a la configuración de entrega de una app. Una configuración de entrega configura los metadatos que se usan para generar resultados en el momento de la entrega, como resultados de la búsqueda o respuestas. Un control de entrega solo afecta las solicitudes que entrega la app si el control está asociado a la configuración de entrega de la app.
Algunos controles, como los de potenciación, dependen de los almacenes de datos. Si se quita un almacén de datos de una app, también se quitarán de esa app los controles que dependen del almacén de datos y se desactivarán, pero no se borrarán.
Tipos de controles de entrega
Los siguientes tipos de controles de entrega están disponibles:
Control | Descripción | Disponible para |
---|---|---|
Control de refuerzo | Cambia el orden de los resultados que se muestran | Apps de búsqueda con almacenes de datos que admiten un esquema, como los que contienen datos estructurados o no estructurados con metadatos |
Control de filtros | Quita entradas de los resultados devueltos | Apps de búsqueda con almacenes de datos que admiten un esquema, como los que contienen datos estructurados o no estructurados con metadatos |
Control de sinónimos | Asocia las búsquedas entre sí | Apps de búsqueda con almacenes de datos estructurados o no estructurados |
Control de redireccionamiento | Redirecciona a un URI especificado | Todas las apps de búsqueda |
Control de promoción | Promueve un vínculo especificado para una búsqueda. | Apps de búsqueda con almacenes de datos estructurados o no estructurados |
Acerca de las condiciones
Cuando creas un control, puedes definir de forma opcional una condición que determine cuándo se aplica el control. Las condiciones se definen con campos de condición. Los siguientes campos de condición están disponibles:
queryTerms
: Es un control opcional que se aplica cuando se buscan consultas específicas. Cuando se usa la condiciónqueryTerms
, el control se aplica cuando el valor dequeryTerms
coincide con un término enSearchRequest.query
. Los términos de búsqueda solo se pueden usar cuandoControl.searchUseCase
se establece comoSOLUTION_TYPE_SEARCH
. Se pueden especificar hasta 10queryTerms
diferentes en un soloControl.condition
. Si no se especifican términos de búsqueda, se ignora el campoqueryTerms
.Para crear un control de promoción correctamente, debes especificar el campo
queryTerms
confullMatch
establecido entrue
ofalse
.activeTimeRange
: Es un control opcional que se aplica cuando se produce una solicitud dentro de un período especificado. Verifica que la hora en que se recibió una solicitud esté entreactiveTimeRange.startTime
yactiveTimeRange.endTime
. Se pueden especificar hasta 10 rangos deactiveTimeRange
en un soloControl.condition
. Si no se especifica el campoactiveTimeRange
, se ignora.
Si se especifican varias condiciones para un control, este se aplica a la solicitud de búsqueda cuando se satisfacen ambos tipos de condiciones. Si se especifican varios valores para la misma condición, solo uno de los valores debe coincidir para que se cumpla esa condición.
Por ejemplo, considera la siguiente condición con dos términos de búsqueda especificados:
"queryTerms": [
{
"value": "gShoe",
"fullMatch": true
},
{
"value": "gBoot",
"fullMatch": true
}
]
La condición se cumplirá para una solicitud con SearchRequest.query="gShoe"
o una solicitud con SearchRequest.query="gBoot"
, pero no se cumplirá con SearchRequest.query="gSandal"
ni con ninguna otra cadena.
Si no se especifican condiciones, el control siempre se aplica.
Para obtener más información, consulta el campo Condition
en la referencia de la API.
Crea y adjunta controles de entrega de refuerzo
Un control de publicación de refuerzo se define como un control con un boostAction
.
Sigue estas instrucciones para crear un control de publicación de refuerzo.
Para obtener detalles sobre los campos, consulta la referencia de la API de engines.controls
y la referencia de la API de engines.controls.create
.
Busca el ID de tu app. Si ya tienes el ID de tu app, ve al siguiente paso.
En la consola de Google Cloud , ve a la página Gemini Enterprise.
Ve a Apps.
En la página Apps, busca el nombre de tu app y obtén su ID en la columna ID.
Ejecuta los siguientes comandos de curl para crear tus controles.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": [ "USE_CASE" ], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": FULL_MATCH } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ] }, "boostAction": { "boost": BOOST_VALUE, "filter": "FILTER", "dataStore": "DATA_STORE_RESOURCE_PATH" } }'
Reemplaza lo siguiente:
PROJECT_ID
: Es el número o ID de tu proyecto de Google Cloud .APP_ID
: ID de la app.CONTROL_ID
: Es un identificador único para el control. El ID puede contener entre 1 y 63 caracteres, que pueden ser letras, dígitos, guiones y guiones bajos.DISPLAY_NAME
: Es el nombre legible del control. Google recomienda que este nombre indique cuándo o por qué usar el control. Debe ser una cadena codificada en UTF-8 con una longitud de [1,128].USE_CASE
: Debe serSEARCH_USE_CASE_SEARCH
oSEARCH_USE_CASE_BROWSE
. Si se especificaSEARCH_USE_CASE_BROWSE
, no se puede usarCondition.queryTerms
en la condición.CONDITION
: Es un campo opcional que define cuándo se debe aplicar el control. Contiene los siguientes campos:VALUE
: Es el valor de la búsqueda específico con el que se realizará la coincidencia. Es una cadena UTF-8 en minúsculas con una longitud de[1, 5000]
. SiFULL_MATCH_1
estrue
, este campo puede tener como máximo tres términos separados por espacios.FULL_MATCH
: Es un valor booleano que indica si la búsqueda debe coincidir exactamente con el término de búsqueda. Cuando se establece entrue
, requiere queSearchRequest.query
coincida completamente conqueryTerm.value
. Cuando se establece enfalse
, requiere queSearchRequest.query
contengaqueryTerm.value
como subcadena.START_TIMESTAMP
: Es una marca de tiempo en formato "Zulu" de UTC según RFC 3339 para indicar el inicio de un período.END_TIMESTAMP
: Es una marca de tiempo en formato "zulu" de UTC según RFC 3339 para indicar el final de un período.
BOOST_VALUE
: un número de punto flotante en el rango [-1,1]. Cuando el valor es negativo, los resultados se degradan (aparecen más abajo en los resultados). Cuando el valor es positivo, los resultados se promocionan (aparecen más arriba en los resultados). Para obtener más información, consultaboostAction
.FILTER
: Es una cadena que especifica los requisitos que debe cumplir el documento. Si el documento cumple con todos los requisitos, se aplica el refuerzo. De lo contrario, no habrá cambios. Si este campo está vacío, el refuerzo se aplica a todos los documentos del almacén de datos. Para conocer la sintaxis de filtrado, consulta Sintaxis de expresión de filtro. Nota: El campo del documentotitle
no se puede filtrar.DATA_STORE_RESOURCE_PATH
: Es la ruta de acceso completa del recurso del almacén de datos cuyos documentos se deben potenciar con este control. El formato de la ruta de acceso completa del recurso esprojects/PROJECT_NUMBER/locations/LOCATION_ID/collections/default_collection/dataStores/DATA_STORE_ID
. Este almacén de datos debe adjuntarse al motor especificado en la solicitud.
Conecta el control a la configuración de entrega de la app con el método
engines.servingConfigs.patch
.curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search?update_mask=boost_control_ids" \ -d '{ "boostControlIds": ["BOOST_ID_1", "BOOST_ID_2"] }'
Reemplaza
BOOST_ID_N
por los IDs de control que creaste en el paso anterior.
Crea y adjunta controles de publicación de filtros
Un control de publicación de filtros se define como un control con un filterAction
.
Sigue estas instrucciones para crear un control de publicación de filtros.
Para obtener detalles sobre los campos, consulta la referencia de la API de engines.controls
y la referencia de la API de engines.controls.create
.
Busca el ID de tu app. Si ya tienes el ID de tu app, ve al siguiente paso.
En la consola de Google Cloud , ve a la página Gemini Enterprise.
Ve a Apps.
En la página Apps, busca el nombre de tu app y obtén su ID en la columna ID.
Ejecuta los siguientes comandos de curl para crear tus controles.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": ["USE_CASE"], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": FULL_MATCH } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ] }, "filterAction": { "filter": "FILTER" } }'
Reemplaza lo siguiente:
PROJECT_ID
: Es el número o ID de tu proyecto de Google Cloud .APP_ID
: ID de la app.CONTROL_ID
: Es un identificador único para el control. El ID puede contener entre 1 y 63 caracteres, que pueden ser letras, dígitos, guiones y guiones bajos.DISPLAY_NAME
: Es el nombre legible del control. Google recomienda que este nombre indique cuándo o por qué usar el control. Debe ser una cadena codificada en UTF-8 con una longitud de [1,128].USE_CASE
: Debe serSEARCH_USE_CASE_SEARCH
oSEARCH_USE_CASE_BROWSE
. Si se especificaSEARCH_USE_CASE_BROWSE
, no se puede usarCondition.queryTerms
en la condición.CONDITION
: Es un campo opcional que define cuándo se debe aplicar el control. Contiene los siguientes campos:VALUE
: Es el valor de la búsqueda específico con el que se realizará la coincidencia. Es una cadena UTF-8 en minúsculas con una longitud de[1, 5000]
. SiFULL_MATCH_1
estrue
, este campo puede tener como máximo tres términos separados por espacios.FULL_MATCH
: Es un valor booleano que indica si la búsqueda debe coincidir exactamente con el término de búsqueda. Cuando se establece entrue
, requiere queSearchRequest.query
coincida completamente conqueryTerm.value
. Cuando se establece enfalse
, requiere queSearchRequest.query
contengaqueryTerm.value
como subcadena.START_TIMESTAMP
: Es una marca de tiempo en formato "Zulu" de UTC según RFC 3339 para indicar el inicio de un período.END_TIMESTAMP
: Es una marca de tiempo en formato "zulu" de UTC según RFC 3339 para indicar el final de un período.
FILTER
: Es una cadena que especifica los requisitos que debe cumplir el documento. Si el documento cumple con todos los requisitos, se mostrará en los resultados. De lo contrario, el documento no aparecerá en los resultados. Para conocer la sintaxis de filtrado, consulta Sintaxis de expresión de filtro. Para obtener más información, consultafilterAction
: Nota: El campo del documentotitle
no se puede filtrar.
Conecta el control a la configuración de entrega de la app con el método
engines.servingConfigs.patch
.curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search?update_mask=filter_control_ids" \ -d '{ "filterControlIds": ["FILTER_ID_1", "FILTER_ID_2"] }'
Reemplaza
FILTER_ID_N
por los IDs de control que creaste en el paso anterior.
Crea y adjunta controles de entrega de sinónimos
Un control de entrega de sinónimos se define como un control con un synonymsAction
.
Sigue estas instrucciones para crear un control de publicación de sinónimos.
Para obtener detalles sobre los campos, consulta la referencia de la API de engines.controls
y la referencia de la API de engines.controls.create
.
Busca el ID de tu app. Si ya tienes el ID de tu app, ve al siguiente paso.
En la consola de Google Cloud , ve a la página Gemini Enterprise.
Ve a Apps.
En la página Apps, busca el nombre de tu app y obtén su ID en la columna ID.
Ejecuta los siguientes comandos de curl para crear tus controles.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": ["USE_CASE"], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": FULL_MATCH } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ] }, "synonymsAction": { "synonyms": ["SYNONYMS_1","SYNONYMS_2"] } }'
Reemplaza lo siguiente:
PROJECT_ID
: Es el número o ID de tu proyecto de Google Cloud .APP_ID
: ID de la app.CONTROL_ID
: Es un identificador único para el control. El ID puede contener entre 1 y 63 caracteres, que pueden ser letras, dígitos, guiones y guiones bajos.DISPLAY_NAME
: Es el nombre legible del control. Google recomienda que este nombre indique cuándo o por qué usar el control. Debe ser una cadena codificada en UTF-8 con una longitud de [1,128].USE_CASE
: Debe serSEARCH_USE_CASE_SEARCH
oSEARCH_USE_CASE_BROWSE
. Si se especificaSEARCH_USE_CASE_BROWSE
, no se puede usarCondition.queryTerms
en la condición.CONDITION
: Es un campo opcional que define cuándo se debe aplicar el control. Contiene los siguientes campos:VALUE
: Es el valor de la búsqueda específico con el que se realizará la coincidencia. Es una cadena UTF-8 en minúsculas con una longitud de[1, 5000]
. SiFULL_MATCH_1
estrue
, este campo puede tener como máximo tres términos separados por espacios.FULL_MATCH
: Es un valor booleano que indica si la búsqueda debe coincidir exactamente con el término de búsqueda. Cuando se establece entrue
, requiere queSearchRequest.query
coincida completamente conqueryTerm.value
. Cuando se establece enfalse
, requiere queSearchRequest.query
contengaqueryTerm.value
como subcadena.START_TIMESTAMP
: Es una marca de tiempo en formato "Zulu" de UTC según RFC 3339 para indicar el inicio de un período.END_TIMESTAMP
: Es una marca de tiempo en formato "zulu" de UTC según RFC 3339 para indicar el final de un período.
SYNONYMS_N
: Es una lista de cadenas que se asocian entre sí, lo que hace que sea más probable que cada una muestre resultados similares. Si bien es más probable que obtengas resultados similares, cuando busques cada una de las entradas de sinónimos, es posible que no recibas todos los resultados relevantes para todos los sinónimos asociados. Debes especificar al menos dos sinónimos y puedes especificar hasta 100. Cada sinónimo debe estar codificado en UTF-8 y en minúsculas. No se permiten cadenas duplicadas. Por ejemplo, puedes agregar "Pixel", "teléfono Android" y "teléfono de Google" como sinónimos. Para obtener más información, consultasynonymsAction
.
Conecta el control a la configuración de entrega de la app con el método
engines.servingConfigs.patch
.curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search?update_mask=synonyms_control_ids" \ -d '{ "synonymsControlIds": ["SYNONYMS_ID_1", "SYNONYMS_ID_2"] }'
Reemplaza
SYNONYMS_ID_N
por los IDs de control que creaste en el paso anterior.
Crea y adjunta controles de entrega de redireccionamientos
Un control de publicación de redireccionamientos permite redireccionar a los usuarios a un URI proporcionado.
Los controles de redireccionamiento se definen como un control con un redirectAction
.
Sigue estas instrucciones para crear un control de publicación de redireccionamientos.
Para obtener detalles sobre los campos, consulta la referencia de la API de engines.controls
y la referencia de la API de engines.controls.create
.
Busca el ID de tu app. Si ya tienes el ID de tu app, ve al siguiente paso.
En la consola de Google Cloud , ve a la página Gemini Enterprise.
Ve a Apps.
En la página Apps, busca el nombre de tu app y obtén su ID en la columna ID.
Ejecuta los siguientes comandos de curl para crear tus controles.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": ["USE_CASE"], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": FULL_MATCH } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ] }, "redirectAction": { "redirectURI": "REDIRECT_URI" } }'
Reemplaza lo siguiente:
PROJECT_ID
: Es el número o ID de tu proyecto de Google Cloud .APP_ID
: ID de la app.CONTROL_ID
: Es un identificador único para el control. El ID puede contener entre 1 y 63 caracteres, que pueden ser letras, dígitos, guiones y guiones bajos.DISPLAY_NAME
: Es el nombre legible del control. Google recomienda que este nombre indique cuándo o por qué usar el control. Debe ser una cadena codificada en UTF-8 con una longitud de [1,128].USE_CASE
: Debe serSEARCH_USE_CASE_SEARCH
oSEARCH_USE_CASE_BROWSE
. Si se especificaSEARCH_USE_CASE_BROWSE
, no se puede usarCondition.queryTerms
en la condición.CONDITION
: Es un campo opcional que define cuándo se debe aplicar el control. Contiene los siguientes campos:VALUE
: Es el valor de la búsqueda específico con el que se realizará la coincidencia. Es una cadena UTF-8 en minúsculas con una longitud de[1, 5000]
. SiFULL_MATCH_1
estrue
, este campo puede tener como máximo tres términos separados por espacios.FULL_MATCH
: Es un valor booleano que indica si la búsqueda debe coincidir exactamente con el término de búsqueda. Cuando se establece entrue
, requiere queSearchRequest.query
coincida completamente conqueryTerm.value
. Cuando se establece enfalse
, requiere queSearchRequest.query
contengaqueryTerm.value
como subcadena.START_TIMESTAMP
: Es una marca de tiempo en formato "Zulu" de UTC según RFC 3339 para indicar el inicio de un período.END_TIMESTAMP
: Es una marca de tiempo en formato "zulu" de UTC según RFC 3339 para indicar el final de un período.
REDIRECT_URI_N
: Es un URI al que se te redirecciona. Puede tener una longitud máxima de 2,000 caracteres. Por ejemplo, si el valor del término de búsqueda es "asistencia", puedes establecer un redireccionamiento a tu página de asistencia técnica en lugar de mostrar (o no mostrar) los resultados de la búsqueda de "asistencia". En este ejemplo, el URI de redireccionamiento se convierte en"https://www.example.com/support"
. Para obtener más información, consultaredirectAction
:
Conecta el control a la configuración de entrega de la app con el método
engines.servingConfigs.patch
.curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search?update_mask=redirect_control_ids" \ -d '{ "redirectControlIds": ["REDIRECT_ID_1", "REDIRECT_ID_2"] }'
Reemplaza
REDIRECT_ID_N
por los IDs de control que creaste en el paso anterior.
Crea y adjunta controles de publicación de la promoción
Un control de entrega de promoción te permite mostrar un vínculo como resultado promocionado. Este control está disponible para las apps de búsqueda con almacenes de datos estructurados o no estructurados, y para las apps de búsqueda combinada.
Para que el control de promoción surta efecto, debes adjuntarlo a la configuración de publicación de la app.
Los controles de promoción se definen con un promoteAction
.
Para crear un control de promoción correctamente, debes especificar el campo queryTerms
con fullMatch
establecido en true
o false
.
Sigue estas instrucciones para crear un control de publicación de la promoción.
Para obtener detalles sobre los campos, consulta la referencia de la API de engines.controls
y la referencia de la API de engines.controls.create
.
Busca el ID de tu app. Si ya tienes el ID de tu app, ve al siguiente paso.
En la consola de Google Cloud , ve a la página Gemini Enterprise.
Ve a Apps.
En la página Apps, busca el nombre de tu app y obtén su ID en la columna ID.
Ejecuta los siguientes comandos de curl para crear tus controles.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": ["USE_CASE"], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": FULL_MATCH_TRUE|FALSE } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ], }, "promoteAction": { "dataStore": "DATA_STORE_RESOURCE_PATH", "searchLinkPromotion": { "document": "DOCUMENT_RESOURCE_PATH", "title": "TITLE", "uri": "URI", "description": "URI_DESCRIPTION", } } }'
Reemplaza lo siguiente:
PROJECT_ID
: Es el número o ID de tu proyecto de Google Cloud .APP_ID
: ID de la app.CONTROL_ID
: Es un identificador único para el control. El ID puede contener entre 1 y 63 caracteres, que pueden ser letras, dígitos, guiones y guiones bajos.DISPLAY_NAME
: Es el nombre legible del control. Google recomienda que este nombre indique cuándo o por qué usar el control. Debe ser una cadena codificada en UTF-8 con una longitud de [1,128].USE_CASE
: Debe serSEARCH_USE_CASE_SEARCH
oSEARCH_USE_CASE_BROWSE
. Si se especificaSEARCH_USE_CASE_BROWSE
, no se puede usarCondition.queryTerms
en la condición.Condition
: Es un objeto opcional que define cuándo se debe aplicar el control. Contiene los siguientes campos:queryTerms
:VALUE
: Es el valor de la búsqueda específico con el que se realizará la coincidencia. Es una cadena UTF-8 en minúsculas con una longitud de[1, 5000]
.FULL_MATCH_TRUE|FALSE
: Es un valor booleano que indica si el término de búsqueda debe coincidir por completo.
activeTimeRange
:START_TIMESTAMP
: Es una marca de tiempo en formato "Zulu" de UTC según RFC 3339 para indicar el inicio de un período.END_TIMESTAMP
: Es una marca de tiempo en formato "zulu" de UTC según RFC 3339 para indicar el final de un período.
DATA_STORE_RESOURCE_PATH
: Es la ruta de acceso completa del almacén de datos cuyos resultados de búsqueda contienen la URL promocionada. El formato de la ruta de acceso completa del recurso esprojects/PROJECT_NUMBER/locations/LOCATION_ID/collections/default_collection/dataStores/DATA_STORE_ID
. Este almacén de datos debe adjuntarse al motor especificado en la solicitud.DOCUMENT_RESOURCE_PATH
: Es un campo para especificar la ruta de acceso del recurso del documento que se promocionará. Debes proporcionar el ID del documento en el campoDOCUMENT_RESOURCE_PATH
, el URI en el campoURI
o ambos.El formato de la ruta de acceso completa al recurso es
projects/PROJECT_NUMBER/locations/LOCATION_ID/collections/default_collection/dataStores/DATA_STORE_ID/branches/0/documents/DOCUMENT_ID
.TITLE
: Es un campo obligatorio para especificar el título del documento o la página web que se promocionará. Este título se muestra en el resultado de la búsqueda.URI
: Es un campo para especificar el URI al que dirige el resultado de la búsqueda al usuario. Debes proporcionar el ID del documento en el campoDOCUMENT_RESOURCE_PATH
, el URI en el campoURI
o ambos.URI_DESCRIPTION
: Es un campo opcional para describir el URI, que se muestra en el resultado de la búsqueda.
La respuesta contiene los IDs de control de promoción que necesitas para adjuntar tu control de promoción a tu app de búsqueda.
Conecta el control a la configuración de entrega de la app con el método
engines.servingConfigs.patch
. El orden en el que adjuntas elpromoteControlIds
en la siguiente solicitud es el orden en el que se devuelven los resultados promocionados.curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search?update_mask=promote_control_ids" \ -d '{ "promoteControlIds": ["PROMOTE_ID_1", "PROMOTE_ID_2"] }'
Reemplaza
PROMOTE_ID_N
por los IDs de control que recibiste en el paso anterior.
¿Qué sigue?
- Para comprender el impacto de un control de publicación en la calidad de la búsqueda de una app, evalúa la calidad de la búsqueda.