Method: projects.locations.collections.engines.widgetConfigs.get

Récupère un WidgetConfig.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/engines/*/widgetConfigs/*}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom complet de la ressource WidgetConfig. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

Paramètres de requête

Paramètres
acceptCache

boolean

Facultatif. Indique si le chargement de la configuration du widget à partir du cache est acceptable. Si la valeur est définie sur "true", les modifications récentes apportées aux configurations de widget peuvent prendre quelques minutes avant d'être visibles pour l'utilisateur final. Il est recommandé de définir cette valeur sur "true" pour les widgets développés de manière mature, car cela améliore leurs performances. Définissez la valeur sur "false" pour que les modifications soient immédiatement visibles en production si votre widget est en cours de développement.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

Facultatif. Options pour GetWidgetConfigRequest.
languageCode

string

Facultatif. Balise de langue BCP-47 (par exemple, "en", "fr-CA"). Permet de localiser les chaînes lisibles par l'homme dans la réponse, telles que le sélecteur de modèle displayName / description sur WidgetConfig.UiSettings.ModelConfigInfo. Si ce champ est vide ou non défini, la langue par défaut (anglais) est utilisée.
modelInfoView

enum (ModelInfoView)

Facultatif. Sélectionne la vue de WidgetConfig.UiSettings.ModelConfigInfo calculée par le backend. MODEL_INFO_VIEW_ADMIN est défini par la page "Gestion des fonctionnalités" de l'administrateur Cloud Console (écran/4Vn9gQKbN8tb7gm) pour recevoir l'ensemble de modèles présenté à l'administrateur avec ResolvedModel.admin_view renseigné. Si ce champ n'est pas défini ou si la valeur MODEL_INFO_VIEW_WEB est utilisée, le sélecteur de l'utilisateur final est renvoyé. La surface mobile est détectée à partir de l'en-tête X-Goog-Gemini-Enterprise-Mobile (voir ModelInfoView).

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de WidgetConfig.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • discoveryengine.widgetConfigs.get

Pour en savoir plus, consultez la documentation IAM.