Method: indexing.datasources.items.push

Umieszcza element w kolejce w celu późniejszego odpytywania i aktualizowania.

Do wykonania tego interfejsu API wymagane jest konto administratora lub konto usługi. Użyte konto usługi znajduje się na białej liście w odpowiednim źródle danych.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
item.name

string

Nazwa zasobu item do przekazania do kolejki indeksowania.

Format: źródła danych/{sourceId}/items/{ID}

To pole jest wymagane. Maksymalna długość to 1536 znaków.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis 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)
  }
}
Pola
item.type

enum (PushItem.Type)

Typ operacji push, który określa sposób wypychania.
item.metadataHash

string

Skrót metadanych elementu zgodnie z repozytorium. Jeśli podasz wartość, użyjemy jej do określenia, jak zmienić stan tego produktu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
item.structuredDataHash

string

Skrót uporządkowanych danych elementu zgodnie z repozytorium. Jeśli podasz wartość, użyjemy jej do określenia, jak zmienić stan tego produktu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
item.contentHash

string

Skrót treści elementu zgodnie z repozytorium. Jeśli podasz wartość, użyjemy jej do określenia, jak zmienić stan tego produktu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
item.payload

string (bytes format)

Zapewnia dodatkowe informacje o stanie dokumentu dla oprogramowania sprzęgającego, takie jak identyfikator alternatywnego repozytorium i inne metadane. Maksymalna długość to 8192 bajty.

Ciąg zakodowany w formacie base64.
item.queue

string

Kolejka, do której należy ten element. Jeśli to pole nie zostanie określone, wybierana jest kolejka default. Maksymalna długość to 512 znaków.
item.repositoryError

object (RepositoryError)

Wypełnij to pole, aby przechowywać szczegóły błędu oprogramowania sprzęgającego lub repozytorium. Te informacje są wyświetlane w konsoli administracyjnej. To pole można wypełnić tylko wtedy, gdy type ma wartość REPOSITORY_ERROR.
connectorName

string

Nazwa oprogramowania sprzęgającego wykonującego to wywołanie.

Format: źródła danych/{sourceId}/oprogramowanie sprzęgające/{ID}
debugOptions

object (DebugOptions)

Typowe opcje debugowania.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Item.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

PushItem

Reprezentuje element do przekazania do kolejki indeksowania.

Zapis JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Pola
name

string

Nazwa zasobu item do przekazania do kolejki indeksowania.

Format: źródła danych/{sourceId}/items/{ID}

To pole jest wymagane. Maksymalna długość to 1536 znaków.
type

enum (PushItem.Type)

Typ operacji push, który określa sposób wypychania.
metadataHash

string

Skrót metadanych elementu zgodnie z repozytorium. Jeśli podasz wartość, użyjemy jej do określenia, jak zmienić stan tego produktu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
structuredDataHash

string

Skrót uporządkowanych danych elementu zgodnie z repozytorium. Jeśli podasz wartość, użyjemy jej do określenia, jak zmienić stan tego produktu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
contentHash

string

Skrót treści elementu zgodnie z repozytorium. Jeśli podasz wartość, użyjemy jej do określenia, jak zmienić stan tego produktu. Ustawienie tego pola i pola type powoduje błąd argumentu. Maksymalna długość to 2048 znaków.
payload

string (bytes format)

Zapewnia dodatkowe informacje o stanie dokumentu dla oprogramowania sprzęgającego, takie jak identyfikator alternatywnego repozytorium i inne metadane. Maksymalna długość to 8192 bajty.

Ciąg zakodowany w formacie base64.
queue

string

Kolejka, do której należy ten element. Jeśli to pole nie zostanie określone, wybierana jest kolejka default. Maksymalna długość to 512 znaków.
repositoryError

object (RepositoryError)

Wypełnij to pole, aby przechowywać szczegóły błędu oprogramowania sprzęgającego lub repozytorium. Te informacje są wyświetlane w konsoli administracyjnej. To pole można wypełnić tylko wtedy, gdy type ma wartość REPOSITORY_ERROR.

PushItem.Type

Typ operacji push, który określa sposób wypychania.

Wartości w polu enum
UNSPECIFIED Wartość domyślna to NIE OKREŚLONY. Określa, że operacja push nie powinna modyfikować elementu ItemStatus
MODIFIED Wskazuje, że dokument repozytorium został zmodyfikowany lub zaktualizowany od poprzedniego wywołania update. Spowoduje to zmianę stanu istniejącego elementu na MODIFIED. Jeśli wywołanie dotyczy nieistniejącego elementu, stan zmienia się na NEW_ITEM.
NOT_MODIFIED Element w repozytorium nie został zmodyfikowany od ostatniego wywołania aktualizacji. Ta operacja push ustawi stan na ACCEPTED.
REPOSITORY_ERROR W oprogramowaniu sprzęgającym wystąpił błąd repozytorium w przypadku tego elementu. Zmień stan na REPOSITORY_ERROR. Element nie jest zarezerwowany i jest zmieniany na przyszły, co zależy od wykładniczego ponowienia.
REQUEUE Wywołanie wywołania REQUEUE tylko dla elementów, które zostały zarezerwowane. To działanie anuluje rezerwację elementu i zresetuje jego dostępny czas na zegar ścienny.