- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- IndexItemOptions
- Wypróbuj
Aktualizuje listę kontroli dostępu (ACL) usługi Item
, metadane i treść. Jeśli Item
nie istnieje, wstawi go. Ta metoda nie obsługuje częściowych aktualizacji. Pola bez podanych wartości są czyszczone w indeksie Cloud Search.
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/*}:index
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
item.name |
Nazwa elementu. Format: źródła danych/{sourceId}/items/{itemId} 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, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( |
Pola | |
---|---|
item.acl |
Lista kontroli dostępu do tego elementu. |
item.metadata |
Informacje o metadanych. |
item.structuredData |
Uporządkowane dane elementu, które powinny być zgodne z definicją zarejestrowanego obiektu w schemacie źródła danych. |
item.content |
Treść elementu, która ma zostać zindeksowana i udostępniona do wyszukiwania. |
item.version |
To pole jest wymagane. System indeksowania zapisuje wersję ze źródła danych jako ciąg bajtów i porównuje wersję elementu w indeksie z wersją elementu umieszczonego w kolejce przy użyciu kolejności leksycznej. Indeksowanie Cloud Search nie indeksuje ani nie usuwa żadnych elementów w kolejce, których wersja jest mniejsza lub równa wersji aktualnie zindeksowanego elementu. Maksymalna długość tego pola to 1024 bajty. Więcej informacji o wpływie wersji produktu na proces usuwania znajdziesz w artykule Obsługa zmian po usunięciu ręcznego. Ciąg zakodowany w formacie base64. |
item.status |
Stan elementu. Pole tylko do danych wyjściowych. |
item.queue |
Dodaj do kolejki ten element. Maksymalna długość to 100 znaków. |
item.payload |
Oprogramowanie sprzęgające stanu dodatkowego może przechowywać ten element. Maksymalna długość to 10 000 bajtów. Ciąg zakodowany w formacie base64. |
item.itemType |
Typ elementu. |
connectorName |
Nazwa oprogramowania sprzęgającego wykonującego to wywołanie. Format: źródła danych/{sourceId}/oprogramowanie sprzęgające/{ID} |
mode |
To pole jest wymagane. Tryb żądania dla tego żądania. |
debugOptions |
Typowe opcje debugowania. |
indexItemOptions |
|
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation
.
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.
IndexItemOptions
Zapis JSON |
---|
{ "allowUnknownGsuitePrincipals": boolean } |
Pola | |
---|---|
allowUnknownGsuitePrincipals |
Określa, czy prośba o zindeksowanie powinna zezwalać na podmioty zabezpieczeń Google Workspace, które nie istnieją lub zostały usunięte. |