Method: settings.datasources.update

Met à jour une source de données.

Remarque:Pour s'exécuter, cette API nécessite un compte administrateur.

Requête HTTP

PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
source.name

string

Nom de la ressource de source de données. Format: datasources/{sourceId}.

Le nom est ignoré lors de la création d'une source de données.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "source": {
    "name": string,
    "displayName": string,
    "shortName": string,
    "indexingServiceAccounts": [
      string
    ],
    "disableServing": boolean,
    "disableModifications": boolean,
    "itemsVisibility": [
      {

        // Union field gsuite_principal can be only one of the following:
        "gsuiteUserEmail": string,
        "gsuiteGroupEmail": string,
        "gsuiteDomain": boolean
        // End of list of possible types for union field gsuite_principal.
      }
    ],
    "returnThumbnailUrls": boolean,
    "operationIds": [
      string
    ]
  },
  "debugOptions": {
    object (DebugOptions)
  },
  "updateMask": string
}
Champs
source.displayName

string

Obligatoire. Nom à afficher de la source de données. La longueur maximale est de 300 caractères.
source.shortName

string

Nom court ou alias de la source. Cette valeur sera utilisée pour faire correspondre l'opérateur "source". Par exemple, si le nom court est <valeur>, les requêtes telles que source:<valeur> ne renvoient que des résultats pour cette source. La valeur doit être unique dans toutes les sources de données. La valeur ne doit contenir que des caractères alphanumériques (a-zA-Z0-9). La valeur ne doit pas commencer par "google" et ne doit pas être l'une des valeurs suivantes: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people ou teams. Il ne doit pas dépasser 32 caractères.
source.indexingServiceAccounts[]

string

Liste des comptes de service disposant d'un accès à l'indexation.
source.disableServing

boolean

Désactivez l'affichage de résultats de recherche ou d'assistance.
source.disableModifications

boolean

Si la valeur est "true", la source de données est définie en mode lecture seule. En mode lecture seule, l'API d'indexation rejette toutes les requêtes d'indexation ou de suppression d'éléments de cette source. L'activation du mode lecture seule n'arrête pas le traitement des données précédemment acceptées.
source.itemsVisibility[]

object (GSuitePrincipal)

Ce champ limite la visibilité aux éléments au niveau de la source de données. Les éléments de la source de données sont limités à l'union des utilisateurs et des groupes inclus dans ce champ. Notez que cela n'assure pas l'accès à un élément spécifique, car les utilisateurs doivent disposer d'autorisations LCA sur les éléments qu'il contient. Cela garantit un accès de haut niveau à l'ensemble de la source de données et que les éléments individuels ne sont pas partagés en dehors de cette visibilité.
source.returnThumbnailUrls

boolean

Un utilisateur peut demander à obtenir l'URI de la vignette pour les éléments indexés dans cette source de données.
source.operationIds[]

string

ID des opérations de longue durée (LRO) actuellement exécutées pour ce schéma.
debugOptions

object (DebugOptions)

Options de débogage courantes.
updateMask

string (FieldMask format)

Ne s'applique qu'à settings.datasources.patch.

Masque de mise à jour permettant de contrôler les champs à mettre à jour. Exemples de chemins de champ: name, displayName.

  • Si updateMask n'est pas vide, seuls les champs spécifiés dans updateMask sont mis à jour.
  • Si vous spécifiez un champ dans updateMask, mais ne spécifiez pas sa valeur dans la source, ce champ est effacé.
  • Si updateMask n'est pas présent, est vide ou a la valeur *, tous les champs sont mis à jour.

Corps de la réponse

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

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud_search.settings.indexing
  • https://www.googleapis.com/auth/cloud_search.settings
  • https://www.googleapis.com/auth/cloud_search

Pour en savoir plus, consultez le guide d'autorisation.