- Żądanie HTTP
 - Parametry ścieżki
 - Treść żądania
 - Treść odpowiedzi
 - Zakresy autoryzacji
 - PushItem
 - PushItem.Type
 - Wypróbuj
 
Przesyła element do kolejki w celu późniejszego odczytu i aktualizacji.
Do wykonania tej operacji wymagane jest konto administratora lub konto usługi. Używane konto usługi to to, które 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  Format: datasources/{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óra określa zachowanie push.  | 
                
item.metadataHash | 
                  
                     
 Hasz metadanych elementu zgodnie z repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola   | 
                
item.structuredDataHash | 
                  
                     
 Hasz uporządkowanych danych elementu zgodnie z repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola   | 
                
item.contentHash | 
                  
                     
 Hasz treści elementu według repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola   | 
                
item.payload | 
                  
                     
 Zawiera dodatkowe informacje o stanie dokumentu dla danego łącznika, takie jak alternatywne identyfikatory repozytorium i inne metadane. Maksymalna długość to 8192 bajtów. Ciąg znaków zakodowany w formacie Base64.  | 
                
item.queue | 
                  
                     
 Kolejka, do której należy ten element. Jeśli to pole nie zostanie określone, zostanie wybrana kolejka   | 
                
item.repositoryError | 
                  
                     
 Wypełnij to pole, aby przechowywać szczegóły błędów w połączeniu lub repozytorium. Te informacje są wyświetlane w konsoli administracyjnej. To pole może być wypełnione tylko wtedy, gdy   | 
                
connectorName | 
                  
                     
 Nazwa oprogramowania sprzęgającego wykonującego to wywołanie. Format: datasources/{sourceId}/connectors/{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.indexinghttps://www.googleapis.com/auth/cloud_search
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
PushItem
Reprezentuje element, który ma zostać przesłany do kolejki indeksowania.
| Zapis JSON | 
|---|
{ "name": string, "type": enum (  | 
              
| Pola | |
|---|---|
name | 
                
                   
 Nazwa  Format: datasources/{sourceId}/items/{id} To pole jest wymagane. Maksymalna długość to 1536 znaków.  | 
              
type | 
                
                   
 Typ operacji push, która określa zachowanie push.  | 
              
metadataHash | 
                
                   
 Hasz metadanych elementu zgodnie z repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola   | 
              
structuredDataHash | 
                
                   
 Hasz uporządkowanych danych elementu zgodnie z repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola   | 
              
contentHash | 
                
                   
 Hasz treści elementu według repozytorium. Jeśli jest podany, służy do określenia sposobu modyfikacji stanu tego elementu. Ustawienie tego pola i pola   | 
              
payload | 
                
                   
 Zawiera dodatkowe informacje o stanie dokumentu dla danego łącznika, takie jak alternatywne identyfikatory repozytorium i inne metadane. Maksymalna długość to 8192 bajtów. Ciąg znaków zakodowany w formacie Base64.  | 
              
queue | 
                
                   
 Kolejka, do której należy ten element. Jeśli to pole nie zostanie określone, zostanie wybrana kolejka   | 
              
repositoryError | 
                
                   
 Wypełnij to pole, aby przechowywać szczegóły błędów w połączeniu lub repozytorium. Te informacje są wyświetlane w konsoli administracyjnej. To pole może być wypełnione tylko wtedy, gdy   | 
              
PushItem.Type
Typ operacji push, która określa zachowanie push.
| Wartości w polu enum | |
|---|---|
UNSPECIFIED | 
                Domyślnie UNSPECIFIED. Określa, że operacja push nie powinna modyfikować ItemStatus | 
              
MODIFIED | 
                Wskazuje, że dokument repozytorium został zmodyfikowany lub zaktualizowany od czasu poprzedniego wywołania funkcji update. W ten sposób zmienisz stan istniejącego elementu na MODIFIED. Jeśli metoda jest wywoływana w przypadku elementu, którego nie ma, stan zmienia się na NEW_ITEM. | 
              
NOT_MODIFIED | 
                Od ostatniego wywołania funkcji aktualizacji element w repozytorium nie został zmodyfikowany. Ta operacja push spowoduje ustawienie stanu na ACCEPTED. | 
              
REPOSITORY_ERROR | 
                W przypadku tego elementu wystąpił błąd repozytorium. Zmień stan na REPOSITORY_ERROR. Element jest odrezerwowany i zaplanowany na przyszłość zgodnie ze wzrastającym czasem do ponowienia. | 
              
REQUEUE | 
                Wywołania push z opcją REQUEUE tylko w przypadku zasobów, które zostały zarezerwowane. To działanie powoduje anulowanie rezerwacji i zresetowanie czasu dostępności do czasu zegara. |