- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- PushItem
- PushItem.Type
- Wypróbuj
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 |
Nazwa zasobu 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 ( |
Pola | |
---|---|
item.type |
Typ operacji push, który określa sposób wypychania. |
item.metadataHash |
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 |
item.structuredDataHash |
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 |
item.contentHash |
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 |
item.payload |
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 |
Kolejka, do której należy ten element. Jeśli to pole nie zostanie określone, wybierana jest kolejka |
item.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 |
connectorName |
Nazwa oprogramowania sprzęgającego wykonującego to wywołanie. Format: źródła danych/{sourceId}/oprogramowanie sprzęgające/{ID} |
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 ( |
Pola | |
---|---|
name |
Nazwa zasobu Format: źródła danych/{sourceId}/items/{ID} To pole jest wymagane. Maksymalna długość to 1536 znaków. |
type |
Typ operacji push, który określa sposób wypychania. |
metadataHash |
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 |
structuredDataHash |
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 |
contentHash |
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 |
payload |
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 |
Kolejka, do której należy ten element. Jeśli to pole nie zostanie określone, wybierana jest kolejka |
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 |
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. |