Method: indexing.datasources.items.list

Liste l'intégralité ou un sous-ensemble de Item resources.

L'exécution de cette API nécessite un compte administrateur ou de service. Le compte de service utilisé est celui qui figure sur la liste blanche de la source de données correspondante.

Requête HTTP

GET https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Nom de la source de données à partir de laquelle répertorier les éléments. Format: datasources/{sourceId}

Paramètres de requête

Paramètres
connectorName

string

Nom du connecteur effectuant cet appel.

Format: datasources/{sourceId}/connectors/{ID}
brief

boolean

Lorsque ce paramètre est défini sur "true", le système d'indexation ne renseigne que les champs suivants: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structuredData.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type

Si cette valeur est "false", tous les champs sont renseignés dans "Item" (Article).
pageToken

string

La valeur nextPageToken affichée par une requête "List" antérieure, le cas échéant.
pageSize

integer

Nombre maximal d'éléments à récupérer dans une requête. La valeur maximale est de 1 000 lorsque "Brief" est "true". La valeur maximale est 10 si "short" est "false".

La valeur par défaut est 10.
debugOptions

object (DebugOptions)

Options de débogage courantes

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 des données présentant la structure suivante :

Représentation JSON 
{
  "items": [
    {
      object (Item)
    }
  ],
  "nextPageToken": string
}
Champs
items[]

object (Item)
nextPageToken

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

Champs d'application des autorisations

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

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

Pour en savoir plus, consultez le guide relatif aux autorisations.