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

Récupère un WidgetConfig.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{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 la configuration du widget peut être chargée à 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 reflétées en production si votre widget est en cours de développement.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

Facultatif. Options pour GetWidgetConfigRequest.

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 champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la 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.