Method: indexing.datasources.items.push

Ajoute un élément à la file d'attente pour une interrogation et une mise à jour ultérieures.

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

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
item.name

string

Nom du item à envoyer à la file d'attente d'indexation.

Format: datasources/{sourceId}/items/{ID}

Champ obligatoire. Il ne doit pas dépasser 1 536 caractères.

Corps de la requête

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

Représentation JSON 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Champs
item.type

enum (PushItem.Type)

Type d'opération d'envoi push qui définit le comportement d'envoi push.
item.metadataHash

string

Hachage des métadonnées de l'élément en fonction du dépôt Si elle est spécifiée, elle permet de déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type génère une erreur d'argument. La longueur maximale est de 2 048 caractères.
item.structuredDataHash

string

Hachage de données structurées de l'élément en fonction du dépôt Si elle est spécifiée, elle permet de déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type génère une erreur d'argument. La longueur maximale est de 2 048 caractères.
item.contentHash

string

Hachage de contenu de l'élément en fonction du dépôt Si elle est spécifiée, elle permet de déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type génère une erreur d'argument. La longueur maximale est de 2 048 caractères.
item.payload

string (bytes format)

Fournit des informations supplémentaires sur l'état des documents pour le connecteur, telles qu'un autre ID de dépôt et d'autres métadonnées. La longueur maximale est de 8 192 octets.

Chaîne encodée en base64.
item.queue

string

File d'attente à laquelle appartient cet élément. Si ce champ n'est pas spécifié, la file d'attente default est choisie. Il ne doit pas dépasser 512 caractères.
item.repositoryError

object (RepositoryError)

Renseignez ce champ pour stocker les détails des erreurs liées au connecteur ou au dépôt. Ces informations sont affichées dans la console d'administration. Ce champ ne peut être renseigné que si type est défini sur REPOSITORY_ERROR.
connectorName

string

Nom du connecteur effectuant cet appel.

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

object (DebugOptions)

Options de débogage courantes

Corps de la réponse

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

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.

PushItem

Représente un élément à placer dans la file d'attente d'indexation.

Représentation JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Champs
name

string

Nom du item à envoyer à la file d'attente d'indexation.

Format: datasources/{sourceId}/items/{ID}

Champ obligatoire. Il ne doit pas dépasser 1 536 caractères.
type

enum (PushItem.Type)

Type d'opération d'envoi push qui définit le comportement d'envoi push.
metadataHash

string

Hachage des métadonnées de l'élément en fonction du dépôt Si elle est spécifiée, elle permet de déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type génère une erreur d'argument. La longueur maximale est de 2 048 caractères.
structuredDataHash

string

Hachage de données structurées de l'élément en fonction du dépôt Si elle est spécifiée, elle permet de déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type génère une erreur d'argument. La longueur maximale est de 2 048 caractères.
contentHash

string

Hachage de contenu de l'élément en fonction du dépôt Si elle est spécifiée, elle permet de déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type génère une erreur d'argument. La longueur maximale est de 2 048 caractères.
payload

string (bytes format)

Fournit des informations supplémentaires sur l'état des documents pour le connecteur, telles qu'un autre ID de dépôt et d'autres métadonnées. La longueur maximale est de 8 192 octets.

Chaîne encodée en base64.
queue

string

File d'attente à laquelle appartient cet élément. Si ce champ n'est pas spécifié, la file d'attente default est choisie. Il ne doit pas dépasser 512 caractères.
repositoryError

object (RepositoryError)

Renseignez ce champ pour stocker les détails des erreurs liées au connecteur ou au dépôt. Ces informations sont affichées dans la console d'administration. Ce champ ne peut être renseigné que si type est défini sur REPOSITORY_ERROR.

PushItem.Type

Type d'opération d'envoi push qui définit le comportement d'envoi push.

Enums
UNSPECIFIED Valeur par défaut "UNSPECIFIED" (NON SPÉCIFIÉE). Indique que l'opération push ne doit pas modifier ItemStatus.
MODIFIED Indique que le document du dépôt a été modifié ou mis à jour depuis l'appel update précédent. L'état d'un élément existant passe alors à l'état MODIFIED. Si cette méthode est appelée sur un article qui n'existe pas, l'état est défini sur NEW_ITEM.
NOT_MODIFIED L'élément du dépôt n'a pas été modifié depuis le dernier appel de mise à jour. Cette opération d'envoi définira l'état sur ACCEPTED.
REPOSITORY_ERROR Le connecteur rencontre une erreur de dépôt concernant cet élément. Passez l'état à l'état REPOSITORY_ERROR. L'élément est annulé et reprogrammé à une date ultérieure déterminée par un intervalle exponentiel entre les tentatives.
REQUEUE Appeler push avec REQUEUE uniquement pour les éléments qui ont été réservés. Cette action annule la réservation de l'élément et rétablit l'heure de disponibilité de l'élément.