Migrar de la API Custom Search Site Restricted JSON
Organízate con las colecciones
Guarda y clasifica el contenido según tus preferencias.
Si usas la API JSON Custom Search Site Restricted de Buscador Programable, puedes crear e implementar una búsqueda de calidad de Google restringida a un sitio en cuestión de minutos con Vertex AI Search. Para desplegar tu aplicación, puedes usar el widget de búsqueda copiando el código de la consola Google Cloud directamente en una página web. No es necesario escribir código. También puedes implementar una API para controlar el aspecto de la función de búsqueda en tu sitio web.
Para obtener más información sobre cómo usar la API, consulta la pestaña REST de Obtener resultados de búsqueda de una aplicación con datos de un sitio web y el método servingConfigs.search de la referencia de REST.
Además de los fragmentos cortos estándar que devuelve Vertex AI Search con los resultados de búsqueda, puedes añadir funciones avanzadas a tu búsqueda. Entre ellas, se incluyen resúmenes generados de los resultados de búsqueda, búsquedas con seguimiento para búsquedas contextuales que permiten hacer preguntas de seguimiento y respuestas extractivas para el texto extraído que se devuelve con cada resultado de búsqueda. Para obtener estas funciones avanzadas de búsqueda web, debes verificar tu dominio, lo que conlleva costes de indexación adicionales.
También puedes filtrar u ordenar los resultados de búsqueda y aplicar controles de promoción para mostrar un enlace como resultado promocionado.
Para configurar Vertex AI Search, sigue estos pasos:
En la Google Cloud consola, en la página del selector de proyectos, selecciona el proyecto que has estado usando para la API JSON Custom Search Site Restricted.
En la página Crear aplicación, en Búsqueda en el sitio con el modo IA, haz clic en Crear.
Asegúrate de que la opción Funciones de la edición Enterprise esté activada. Es obligatorio para la búsqueda en el sitio web. Para obtener más información, consulta las funciones de la edición Enterprise.
Desactiva las funciones avanzadas de LLM. Si desactiva esta opción, tendrá una función similar a la API JSON Custom Search Site Restricted del Buscador Programable. Desactiva esta opción si no necesitas resúmenes de búsqueda ni búsquedas con seguimiento. Para obtener más información, consulta Funciones avanzadas de LLM.
En el campo Nombre de tu aplicación, escribe el nombre de tu aplicación.
En el campo Nombre externo de tu empresa u organización, introduce el nombre común de tu empresa u organización.
Selecciona global (Global) como ubicación de tu aplicación y, a continuación, haz clic en Continuar.
En la página Almacenes de datos, haga clic en Crear almacén de datos.
En el panel Seleccionar una fuente de datos, elija Contenido del sitio web.
Desactiva la indexación Indexación avanzada de sitios web. Si desactivas esta opción, tendrás funciones similares a las de la API JSON Custom Search Site Restricted de Buscador Programable. Desactiva esta opción si no necesitas la función de resumen de búsqueda o la de búsqueda con seguimiento, o si no eres el propietario de los dominios que especifiques. Consulta más información en el artículo Indexación avanzada de sitios web.
En el panel Especificar patrones de URL para indexar, en el campo Sitios que incluir, introduzca los patrones de URL de los sitios web en los que quiera buscar y, a continuación, haga clic en Continuar.
En el panel Configurar tu almacén de datos, introduce un nombre visible para tu almacén de datos y, a continuación, haz clic en Crear.
En la página Almacenes de datos, selecciona el nuevo almacén de datos y haz clic en Crear.
Desplegar la aplicación de búsqueda
Decide cómo quieres autenticar tu aplicación de búsqueda de Vertex AI Search: con OAuth 2.0 o con una clave de API. Para obtener información sobre las ventajas y desventajas de cada método, consulte el artículo Acerca de la autenticación.
Despliega tu aplicación de búsqueda de una de las siguientes formas:
Usa el widget de búsqueda. Implementa tu aplicación de búsqueda sin necesidad de escribir código. Para obtener más información, consulta Añadir el widget de búsqueda a una página web.
Si aún no estás en tu proyecto, selecciona el proyecto en la lista de proyectos de la parte superior de la página de la consola. Google Cloud
Haz clic en Crear credenciales y, a continuación, selecciona Clave de API.
No añadas ninguna restricción de referente. Algunos ajustes de privacidad del usuario no
transmiten la URL referente.
Anota la clave de API generada, que usarás al llamar al método searchLite.
Para aumentar la seguridad, añade una restricción HTTP a tu clave de API para restringir el acceso al servicio AI Applications en https://discoveryengine.googleapis.com/*.
La API JSON Custom Search Site Restricted del Buscador Programable se autentica mediante una clave de API. Vertex AI Search requiere OAuth 2.0, salvo un par de excepciones.
Si quieres seguir usando una clave de API para la autenticación, debes usar el método searchLite a través de llamadas a la API.
Si decides autenticarte mediante OAuth 2.0, debes usar el método search y el método answer para consultar tu sitio web. Además, puedes implementar tu aplicación de búsqueda mediante el widget de búsqueda sin código.
En la siguiente tabla se muestran las diferencias entre el uso del método searchLite con la autenticación de clave de API y los métodos search y answer con la autenticación de OAuth 2.0.
[[["Es fácil de entender","easyToUnderstand","thumb-up"],["Me ofreció una solución al problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Es difícil de entender","hardToUnderstand","thumb-down"],["La información o el código de muestra no son correctos","incorrectInformationOrSampleCode","thumb-down"],["Me faltan las muestras o la información que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-08-21 (UTC)."],[[["\u003cp\u003eVertex AI Search enables the creation of site-restricted search functionality, similar to the Custom Search Site Restricted JSON API, with options for both widget-based and API-driven deployment.\u003c/p\u003e\n"],["\u003cp\u003eAdvanced features such as generated summaries, follow-up questions, and extractive answers are available, although they require domain verification and incur additional indexing costs.\u003c/p\u003e\n"],["\u003cp\u003eYou can refine search results through filtering, ordering, and promoting specific links, providing greater control over how information is presented to users.\u003c/p\u003e\n"],["\u003cp\u003eDeploying Vertex AI Search can be done using either OAuth 2.0 or an API key, with OAuth 2.0 supporting the search widget, while API key authentication requires the use of the \u003ccode\u003esearchLite\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eSetting up a website search app involves a series of steps in the Agent Builder console, including selecting website content as the data source and specifying the URL patterns to index.\u003c/p\u003e\n"]]],[],null,["# Migrate from Custom Search Site Restricted JSON API\n\nIf you use the [Custom Search Site Restricted JSON API](https://developers.google.com/custom-search/v1/site_restricted_api) of Programmable Search Engine, you can create and\ndeploy Google-quality, site-restricted search in minutes, using\nVertex AI Search. To deploy your app, you can use the [search\nwidget](/generative-ai-app-builder/docs/add-widget) by copying code from the Google Cloud console directly into a\nweb page---no coding required. Or, you can implement an API\ndeployment to have control over how search functionality looks on your website.\nFor more information about using the API, see the REST tab of [Get search\nresults for an app with website data](/generative-ai-app-builder/docs/preview-search-results#web) and the\n[`servingConfigs.search`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines.servingConfigs/search) method in the REST reference.\n\nIn addition to the standard short snippets that\nVertex AI Search returns with search results, you can add\nadvanced features to your search. These include generated\n[summaries](/generative-ai-app-builder/docs/get-search-summaries) of search results, [search with follow-ups](/generative-ai-app-builder/docs/answer#commands_for_follow-up_questions) for context-aware search that allows follow-up questions,\nand [extractive answers](/generative-ai-app-builder/docs/snippets#extractive-answers) for extracted text returned with\neach search result. Getting these advanced features for your web search requires\n[domain verification](/generative-ai-app-builder/docs/domain-verification) and incurs additional indexing costs.\n\nYou can also [filter](/generative-ai-app-builder/docs/filter-website-search#filter-expressions-basic-indexing) or [order](/generative-ai-app-builder/docs/order-web-search-results#basic-indexing) your\nsearch results and apply [promote controls](/generative-ai-app-builder/docs/configure-serving-controls#promote) to display a link as a promoted result.\n\nFor more information, see the [AI Applications pricing](/generative-ai-app-builder/pricing) page.\n\nSet up Vertex AI Search\n-----------------------\n\nTo set up Vertex AI Search, follow these steps:\n\n1. In the Google Cloud console, on the [project selector\n page](https://console.cloud.google.com/projectselector2/home/dashboard), select the project that you've been\n using for the Custom Search Site Restricted JSON API.\n\n2. [Turn on AI Applications](/generative-ai-app-builder/docs/before-you-begin#turn-on-discovery-engine).\n\nCreate a search app\n-------------------\n\nTo create a search app, follow these steps:\n\n1. In the Google Cloud console, go to the **AI Applications** page.\n\n [AI Applications](https://console.cloud.google.com/gen-app-builder/engines)\n2. Click **Create app**.\n\n3. On the **Create App** page, under **Site search with AI mode** , click\n **Create**.\n\n4. Make sure **Enterprise edition features** is turned on. This is required\n for website search. For more information, see [Enterprise edition\n features](/generative-ai-app-builder/docs/about-advanced-features#enterprise-features).\n\n5. Turn off **Advanced LLM features** . Turning this off gives you\n functionality similar to the Custom Search Site Restricted JSON API of\n Programmable Search Engine. Turn this off if you don't need search\n summarization or search with follow-ups. For more information, see\n [Advanced LLM features](/generative-ai-app-builder/docs/about-advanced-features#advanced-llm-features).\n\n6. In the **Your app name** field, enter a name for your app.\n\n7. In the **External name of your company or organization** field, enter\n the common name for your company or organization.\n\n8. Select **global (Global)** as the location for your app, and then click\n **Continue**.\n\n9. On the **Data Stores** page, click **Create data store**.\n\n10. In the **Select a data source** pane, select **Website Content**.\n\n11. Turn off **Advanced website indexing** indexing. Turning this off gives\n you functionality similar to the Custom Search Site Restricted JSON API\n of Programmable Search Engine. Turn this off if you don't need search\n summarization or search with follow-ups, or if you don't own the\n domains that you specify. For more information, see\n [Advanced website indexing](/generative-ai-app-builder/docs/about-advanced-features#advanced-website-indexing).\n\n12. In the **Specify URL patterns to index** pane, in the **Sites\n to include** field, enter the URL patterns of the websites that you want\n to search, and then click **Continue**.\n\n13. In the **Configure your data store** pane, enter a display name for your\n data store, and then click **Create**.\n\n14. On the **Data Stores** page, select your new data store, and then click\n **Create**.\n\nDeploy the search app\n---------------------\n\nDecide how you plan to authenticate your Vertex AI Search search\napp: using OAuth 2.0 or an API key. For information about the advantages and\ndisadvantages of each method, see [About\nauthentication](#about-authentication).\n\n- [To deploy the search app with OAuth 2.0](#oauth-deploy)\n\n- [To deploy the search app with an API key](#api-key-deploy)\n\n### Deploy the search app (OAuth 2.0)\n\nTo deploy your search app using OAuth 2.0 authentication, follow these steps:\n\n1. To set up OAuth 2.0, see [On Google Cloud](/generative-ai-app-builder/docs/authentication#on-gcp) in *Authenticate to\n AI Applications* . Make sure to add the [Discovery Engine\n User](/generative-ai-app-builder/docs/access-control#discoveryengine.user) or the [Discovery Engine\n Viewer](/generative-ai-app-builder/docs/access-control#discoveryengine.viewer) role to the service account.\n\n2. Deploy your search app in one of the following ways:\n\n - **Use the search widget.** Deploy your search\n app with no coding required. For more information, see\n [Add the search widget to a web page](/generative-ai-app-builder/docs/add-widget).\n\n - **Use the API.** Use the API to control how search functionality looks on\n your website. For more information, see the REST tab of [Get search\n results for an app with website data](/generative-ai-app-builder/docs/preview-search-results#web) and the\n [`servingConfigs.search`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines.servingConfigs/search) method in the REST reference. To\n order the results of your web search queries, see [Order web search\n results](/generative-ai-app-builder/docs/order-web-search-results).\n\n### Deploy the search app (API key)\n\nTo deploy your search app using an API key for authentication, follow these\nsteps:\n\n1. Create the API key:\n\n 1. In the Google Cloud console, go to the **Credentials** page.\n\n [Credentials](https://console.cloud.google.com/apis/credentials)\n 2. If you're not already in your project, in the project list at the top of\n the Google Cloud console page, select your project.\n\n 3. Click **Create credentials** and then select **API key** .\n *Don't add any referrer restrictions*. Some user privacy settings don't\n pass the referrer URL.\n\n - Take note of the generated API key, which you will use when calling the `searchLite` method.\n 4. For increased security, add an\n [HTTP restriction](/docs/authentication/api-keys#api_key_restrictions)\n to your API Key to restrict access to the AI Applications service\n at `https://discoveryengine.googleapis.com/*`.\n\n2. Deploy your search app using the API.\n See [Get search results for an app with website data (API\n key)](/generative-ai-app-builder/docs/preview-search-results#web-api-key) and the\n [`servingConfigs.searchLite`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines.servingConfigs/searchLite) method in the\n REST reference. To order the results of your web search queries, see [Order\n web search results](/generative-ai-app-builder/docs/order-web-search-results).\n\nAbout authentication\n--------------------\n\nThe [Custom Search Site Restricted JSON API](https://developers.google.com/custom-search/v1/site_restricted_api) of\nProgrammable Search Engine authenticates using an API key. While, with a\ncouple of exceptions, Vertex AI Search requires OAuth 2.0.\nIf you want to carry on using an API key for authentication, then you need to\nuse the [`searchLite`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines.servingConfigs/searchLite) method through API calls.\n\nIf you choose to authenticate through OAuth 2.0, then you need to use the\n[`search`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.dataStores.servingConfigs/search) method and the [`answer`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.dataStores.servingConfigs/answer) method to query\nyour website, furthermore, you can deploy your search app through the no-code\nsearch widget.\n\nThe following table lists differences between using the `searchLite` method with\nAPI key authentication and the `search` and `answer` methods with OAuth 2.0\nauthentication.\n\nNext steps\n----------\n\n- If you need to filter the search results, see [Filter expressions\n for basic website search](/generative-ai-app-builder/docs/filter-website-search#filter-expressions-basic-indexing).\n\n- If you need to provide image search, see [Search for images on\n websites](/generative-ai-app-builder/docs/image-search).\n\n- If you need to order the search results, for example by date, see [Order\n search results for basic website search](/generative-ai-app-builder/docs/order-web-search-results#basic-indexing).\n\n- If you need multi-turn search, see [Commands for follow-up\n questions](/generative-ai-app-builder/docs/answer#commands_for_follow-up_questions)."]]
