Method: projects.locations.dataStores.widgetConfigs.get

Récupère un WidgetConfig.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/dataStores/*/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 s'il est acceptable de charger la configuration du widget à partir du cache. Si la valeur est définie sur "true", les modifications récentes apportées aux configurations des widgets peuvent prendre quelques minutes à s'afficher dans la vue de l'utilisateur final. Nous vous recommandons de définir cette valeur sur "true" pour les widgets bien développés, 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. Tag de langue BCP-47 (par exemple, "en", "fr-CA"). Permet de localiser les chaînes lisibles dans la réponse, comme le sélecteur de modèle displayName / description sur WidgetConfig.UiSettings.ModelConfigInfo. Si la valeur est vide ou non définie, la langue par défaut (anglais) est utilisée.
modelInfoView

enum (ModelInfoView)

Facultatif. Sélectionne la vue de WidgetConfig.UiSettings.ModelConfigInfo que le backend calcule. MODEL_INFO_VIEW_ADMIN est défini sur la page "Gestion des fonctionnalités" de la console d'administration Cloud (écran/4Vn9gQKbN8tb7gm) pour recevoir l'ensemble de modèles présenté à l'administrateur avec ResolvedModel.admin_view renseigné. Si MODEL_INFO_VIEW_ADMIN n'est pas défini ou est défini sur MODEL_INFO_VIEW_WEB, le sélecteur d'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.