- Zasób: Element
- ItemAcl
- ItemAcl.AclInheritanceType
- Podmiot zabezpieczeń
- ItemMetadata
- Interakcje
- Interaction.InteractionType
- SearchQualityMetadata
- ContextAttribute
- ItemStructuredData
- StructuredDataObject
- NamedProperty
- NamedProperty.IntegerValues
- NamedProperty.DoubleValues
- NamedProperty.TimestampValues
- NamedProperty.ObjectValues
- NamedProperty.EnumValues
- NamedProperty.DateValues
- NamedProperty.TextValues
- NamedProperty.HtmlValues
- ItemContent
- ItemContent.ContentFormat
- UploadItemRef
- ItemStatus
- ProcessingError
- ProcessingErrorCode
- FieldViolation
- RepositoryError
- RepositoryError.Type
- Item.ItemType
- Metody
Zasób: Element
Reprezentuje pojedynczy obiekt, który jest elementem w indeksie wyszukiwania, na przykład plik, folder czy rekord bazy danych.
Zapis JSON |
---|
{ "name": string, "acl": { object ( |
Pola | |
---|---|
name |
Nazwa elementu. Format: źródła danych/{sourceId}/items/{itemId} To pole jest wymagane. Maksymalna długość to 1536 znaków. |
acl |
Lista kontroli dostępu do tego elementu. |
metadata |
Informacje o metadanych. |
structuredData |
Uporządkowane dane elementu, które powinny być zgodne z definicją zarejestrowanego obiektu w schemacie źródła danych. |
content |
Treść elementu, która ma zostać zindeksowana i udostępniona do wyszukiwania. |
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. |
status |
Stan elementu. Pole tylko do danych wyjściowych. |
queue |
Dodaj do kolejki ten element. Maksymalna długość to 100 znaków. |
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. |
itemType |
Typ elementu. |
ItemAcl
Informacje o liście kontroli dostępu dotyczące elementu. Więcej informacji znajdziesz w temacie Mapowanie list kontroli dostępu (ACL).
Zapis JSON |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
Pola | |
---|---|
inheritAclFrom |
Nazwa elementu, z którego ma być odziedziczona lista uprawnień dostępu. Uwaga: dziedziczenie ACL zapewnia tylko uprawnienia dostępu do elementów podrzędnych, nie definiuje relacji strukturalnych ani nie zapewnia wygodnych sposobów usuwania dużych grup elementów. Usunięcie elementu nadrzędnego listy kontroli dostępu z indeksu zmienia tylko uprawnienia dostępu do elementów podrzędnych, które odwołują się do elementu nadrzędnego w polu |
aclInheritanceType |
Określa typ reguł dostępu, które mają być stosowane, gdy element dziedziczy listę kontroli dostępu z elementu nadrzędnego. To pole zawsze należy ustawiać w połączeniu z polem |
readers[] |
Lista podmiotów zabezpieczeń, które mogą wyświetlać element w wynikach wyszukiwania. Opcjonalne w przypadku dziedziczenia uprawnień z innego elementu lub gdy element nie powinien być widoczny, na przykład w elemencie |
deniedReaders[] |
Lista podmiotów zabezpieczeń, którym odmówiono dostępu do elementu w wynikach wyszukiwania. Podmioty zabezpieczeń mają domyślnie odmowę dostępu, ale używaj odrzuconych czytelników do obsługi wyjątków i zastępowania użytkowników z listy dozwolonych. Maksymalna liczba elementów to 100. |
owners[] |
Opcjonalnie. Lista właścicieli elementu. To pole nie ma wpływu na uprawnienia dostępu do dokumentu. Zapewnia jednak niewielką poprawę pozycji w rankingu wśród elementów, których właścicielem jest użytkownik, który wysłał zapytanie. Maksymalna liczba elementów to 5. |
ItemAcl.AclInheritanceType
Typy dziedziczenia ACL.
Wartości w polu enum | |
---|---|
NOT_APPLICABLE |
Wartość domyślna, gdy ten element nie dziedziczy listy ACL. Użyj filtra NOT_APPLICABLE, gdy inheritAclFrom jest pusty. Element bez dziedziczenia ACL może nadal mieć listy kontroli dostępu dostarczane przez własne pola readers i deniedReaders . |
CHILD_OVERRIDE |
W trakcie konfliktu autoryzacji lista kontroli dostępu elementu podrzędnego określa jego uprawnienia do odczytu. |
PARENT_OVERRIDE |
W trakcie konfliktu autoryzacji uprawnienia do odczytu zależą od listy kontroli dostępu (ACL) elementu nadrzędnego określonego w polu inheritAclFrom . |
BOTH_PERMIT |
Dostęp jest przyznawany tylko wtedy, gdy zarówno ten element, jak i element nadrzędny określony w polu inheritAclFrom zezwalają na uprawnienia do odczytu. |
Podmiot zabezpieczeń
Odniesienie do użytkownika, grupy lub domeny.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
gsuitePrincipal |
Ten podmiot zabezpieczeń to użytkownik, grupa lub domena Google Workspace. |
userResourceName |
Ten podmiot zabezpieczeń to użytkownik identyfikowany przy użyciu tożsamości zewnętrznej. Pole nazwy musi zawierać nazwę zasobu użytkownika w formacie: identitysources/{sourceId}/users/{ID} |
groupResourceName |
Ten podmiot zabezpieczeń to grupa identyfikowana za pomocą tożsamości zewnętrznej. Pole nazwy musi określać nazwę zasobu grupy w formacie: identitysources/{sourceId}/groups/{ID} |
ItemMetadata
Dostępne pola metadanych elementu.
Zapis JSON |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
Pola | |
---|---|
title |
Tytuł produktu. Jeśli zostanie podany, to będzie wyświetlany tytuł wyniku query.search. Maksymalna długość to 2048 znaków. |
sourceRepositoryUrl |
Link do repozytorium źródłowego obsługującego dane. Wyniki wyszukiwania zastosują ten link do tytułu. Odstępy i znaki specjalne mogą powodować, że linki wyników z Cloud Search będą aktywować powiadomienie o przekierowaniu. Aby tego uniknąć, zakoduj adres URL. Maksymalna długość to 2048 znaków. |
containerName |
Nazwa kontenera dla tego elementu. Usunięcie elementu kontenera spowoduje automatyczne usunięcie tego elementu. Uwaga: listy kontroli dostępu nie są dziedziczone z elementu kontenera. Aby określić dziedziczenie listy ACL elementu, użyj pola |
objectType |
Typ elementu. Powinna odpowiadać nazwie definicji obiektu w schemacie zarejestrowanym dla źródła danych. Jeśli na przykład schemat źródła danych zawiera definicję obiektu o nazwie „document”, w przypadku żądań indeksowania obiektów tego typu należy ustawić obiektObjectType na „document”. Maksymalna długość to 256 znaków. |
createTime |
Czas utworzenia elementu w repozytorium źródłowym. Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: |
updateTime |
Czas ostatniej modyfikacji elementu w repozytorium źródłowym. Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: |
interactions[] |
Lista interakcji związanych z elementem. Interakcje są używane do poprawiania jakości query.search, ale nie są widoczne dla użytkowników. Maksymalna liczba elementów to 1000. |
contentLanguage |
Kod języka produktu w formacie BCP-47, np. „en-US” lub „sr-Latn”. Więcej informacji znajdziesz na stronie http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Maksymalna długość to 32 znaki. |
mimeType |
Oryginalny typ MIME elementu |
searchQualityMetadata |
Dodatkowe metadane dotyczące jakości wyszukiwania elementu |
keywords[] |
Dodatkowe słowa kluczowe lub wyrażenia, które powinny pasować do produktu. Używany wewnętrznie na potrzeby treści użytkowników. Maksymalna liczba elementów to 100. Maksymalna długość to 8192 znaki. |
hash |
Wartość haszowania podana przez element wywołujący interfejs API. Tego parametru można używać z metodą |
contextAttributes[] |
Zestaw nazwanych atrybutów powiązanych z produktem. Pozwala to wpływać na pozycję produktu w rankingu na podstawie kontekstu żądania. Maksymalna liczba elementów to 10. |
Interakcja
Reprezentuje interakcję między użytkownikiem a elementem.
Zapis JSON |
---|
{ "type": enum ( |
Pola | |
---|---|
type |
|
principal |
Użytkownik, który wykonał czynność na elemencie. |
interactionTime |
Czas wykonania przez użytkownika działania na elemencie. Jeśli dla jednego użytkownika istnieje wiele działań tego samego typu, rejestrowane jest tylko ostatnie działanie. Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: |
Interaction.InteractionType
Typ działania, które użytkownik wykonał na elemencie.
Wartości w polu enum | |
---|---|
UNSPECIFIED |
Nieprawidłowa wartość. |
VIEW |
Ta interakcja wskazuje, że użytkownik wyświetlił element. |
EDIT |
Ta interakcja wskazuje, że użytkownik zmodyfikował element. |
SearchQualityMetadata
Dodatkowe metadane dotyczące jakości wyszukiwania elementu.
Zapis JSON |
---|
{ "quality": number } |
Pola | |
---|---|
quality |
Wskaźnik jakości produktu, który wpływa na jakość wyszukiwania. Wartość powinna mieścić się w przedziale od 0,0 (najniższa jakość) do 1,0 (najwyższa jakość). Wartością domyślną jest 0,0. |
ContextAttribute
Nazwany atrybut powiązany z produktem, który może wpływać na pozycję produktu w rankingu na podstawie kontekstu żądania.
Zapis JSON |
---|
{ "name": string, "values": [ string ] } |
Pola | |
---|---|
name |
Nazwa atrybutu. To pole nie może być puste. Maksymalna długość to 32 znaki. Nazwa musi zaczynać się od litery i może zawierać tylko litery (A–Z, a–z) oraz cyfry (0–9). Przed dopasowaniem nazwa zostanie znormalizowana (małą literą). |
values[] |
Wartości tekstowe atrybutu. Maksymalna liczba elementów to 10. Maksymalna długość elementu w tablicy to 32 znaki. Przed dopasowaniem wartość zostanie znormalizowana (małymi literami). |
ItemStructuredData
Dostępne pola danych strukturalnych dla elementu.
Zapis JSON |
---|
{
"object": {
object ( |
Pola | |
---|---|
object |
Obiekt uporządkowanych danych, który powinien spełniać wymagania definicji zarejestrowanego obiektu w schemacie źródła danych. |
hash |
Wartość haszowania podana przez element wywołujący interfejs API. Tego parametru można używać z metodą |
StructuredDataObject
Obiekt uporządkowanych danych składający się z właściwości nazwanych.
Zapis JSON |
---|
{
"properties": [
{
object ( |
Pola | |
---|---|
properties[] |
Właściwości obiektu. Maksymalna liczba elementów to 1000. |
NamedProperty
Wpisana para nazwa-wartość na potrzeby uporządkowanych danych. Typ wartości powinien być taki sam jak zarejestrowany typ właściwości name
w definicji obiektu objectType
.
Zapis JSON |
---|
{ "name": string, // Union field |
Pola | |
---|---|
name |
Nazwa usługi. Ta nazwa powinna odpowiadać nazwie właściwości zarejestrowanej na potrzeby definicji obiektu w schemacie. Maksymalna dopuszczalna długość tej usługi to 256 znaków. |
Pole sumy value . Wartości nazwanej właściwości. Pamiętaj, że usługa może zawierać wartości tylko jednego typu. value może mieć tylko jedną z tych wartości: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
Lista wartości liczb całkowitych.
Zapis JSON |
---|
{ "values": [ string ] } |
Pola | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Lista wartości liczby zmiennoprzecinkowych.
Zapis JSON |
---|
{ "values": [ number ] } |
Pola | |
---|---|
values[] |
|
NamedProperty.TimestampValues
Lista wartości sygnatur czasowych.
Zapis JSON |
---|
{ "values": [ string ] } |
Pola | |
---|---|
values[] |
Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: |
NamedProperty.ObjectValues
Lista wartości obiektów.
Zapis JSON |
---|
{
"values": [
{
object ( |
Pola | |
---|---|
values[] |
|
NamedProperty.EnumValues
Lista wartości wyliczeniowych.
Zapis JSON |
---|
{ "values": [ string ] } |
Pola | |
---|---|
values[] |
Maksymalna dopuszczalna długość wartości ciągu znaków to 32 znaki. |
NamedProperty.DateValues
Lista wartości dat.
Zapis JSON |
---|
{
"values": [
{
object ( |
Pola | |
---|---|
values[] |
|
NamedProperty.TextValues
Lista wartości tekstowych.
Zapis JSON |
---|
{ "values": [ string ] } |
Pola | |
---|---|
values[] |
Maksymalna dopuszczalna długość wartości tekstowych to 2048 znaków. |
NamedProperty.HtmlValues
Lista wartości HTML.
Zapis JSON |
---|
{ "values": [ string ] } |
Pola | |
---|---|
values[] |
Maksymalna dopuszczalna długość wartości HTML to 2048 znaków. |
ItemContent
Treść elementu do indeksowania i wyświetlania przez Cloud Search. Jako inlineContent
dozwolone są tylko ciągi zakodowane w formacie UTF-8. Jeśli przesyłasz treść, a nie plik binarny, musi być zakodowana w formacie UTF-8.
Zapis JSON |
---|
{ "contentFormat": enum ( |
Pola | |
---|---|
contentFormat |
|
hash |
Informacje o szyfrowaniu treści obliczone i dostarczone przez klienta interfejsu API. Można jej używać z metodą items.push do obliczania zmodyfikowanego stanu. Maksymalna długość to 2048 znaków. |
Pole sumy
|
|
inlineContent |
Treści dostarczane w ramach metody aktualizacji. Maksymalna długość to 10 2400 bajtów (100 KiB). Ciąg zakodowany w formacie base64. |
contentDataRef |
Prześlij identyfikator referencyjny wcześniej przesłanych treści za pomocą metody zapisu. |
ItemContent.ContentFormat
Format treści. Jeśli format to RAW, treści powinny być w formacie określonym przez mimeType
.
Wartości w polu enum | |
---|---|
UNSPECIFIED |
Nieprawidłowa wartość. |
HTML |
contentFormat to HTML. |
TEXT |
contentFormat to dowolny tekst. |
RAW |
contentFormat to nieprzetworzone bajty. |
UploadItemRef
Reprezentuje odwołanie do sesji przesyłania. Ten plik referencyjny został utworzony w usłudze upload method
. Ten plik referencyjny jest ważny przez 30 dni od utworzenia. Aktualizacja treści elementu może odnosić się do treści przesłanej przez contentDataRef
.
Zapis JSON |
---|
{ "name": string } |
Pola | |
---|---|
name |
Nazwa odwołania do treści. Maksymalna długość to 2048 znaków. |
ItemStatus
Zawiera stan elementu i wszelkie błędy.
Zapis JSON |
---|
{ "code": enum ( |
Pola | |
---|---|
code |
Kod stanu. |
processingErrors[] |
Szczegóły błędu, jeśli element ma stan BŁĄD. |
repositoryErrors[] |
Oprogramowanie sprzęgające zgłosił błąd repozytorium. |
ProcessingError
Zapis JSON |
---|
{ "code": enum ( |
Pola | |
---|---|
code |
Kod błędu wskazujący charakter błędu. |
errorMessage |
Opis błędu. |
fieldViolations[] |
Jeśli pola elementu są nieprawidłowe, zawiera ono szczegółowe informacje o błędach weryfikacji. |
ProcessingErrorCode
Kody wskazujące błąd, który wystąpił podczas przetwarzania elementów przez serwer Cloud Search. Pojedynczy produkt może zawierać wiele błędów przetwarzania.
Wartości w polu enum | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Wartość tylko wejściowa. Użyj tej wartości w sekcji Elementy. |
MALFORMED_REQUEST |
Lista kontroli dostępu (ACL), metadane lub treść elementu mają nieprawidłowy stan. Naruszenie zasad zawiera więcej informacji na temat miejsca wystąpienia problemu. |
UNSUPPORTED_CONTENT_FORMAT |
Format zliczania nie jest obsługiwany. |
INDIRECT_BROKEN_ACL |
Elementy z niepełnymi informacjami na liście kontroli dostępu ze względu na dziedziczenie innych elementów z uszkodzoną listą kontroli dostępu lub posiadanie grup z niezmapowanymi elementami podrzędnymi. |
ACL_CYCLE |
Wykres dziedziczenia ACL utworzył cykl. |
FieldViolation
Zapis JSON |
---|
{ "field": string, "description": string } |
Pola | |
---|---|
field |
Ścieżka pola z naruszeniem. |
description |
Opis błędu. |
RepositoryError
Błędy podczas komunikacji przez oprogramowanie sprzęgające z repozytorium źródłowym.
Zapis JSON |
---|
{
"type": enum ( |
Pola | |
---|---|
type |
typ błędu; |
httpStatusCode |
Kody błędów. Odpowiada definicji kodów stanu HTTP. |
errorMessage |
Komunikat opisujący błąd. Maksymalna dopuszczalna długość wiadomości to 8192 znaki. |
RepositoryError.Type
Lista kodów błędów związanych z komunikacją z repozytorium.
Wartości w polu enum | |
---|---|
UNKNOWN |
Nieznany błąd. |
NETWORK_ERROR |
Nieznany lub nieosiągalny host. |
DNS_ERROR |
Problem z DNS, na przykład serwer DNS nie odpowiada. |
CONNECTION_ERROR |
Nie można połączyć się z serwerem repozytorium. |
AUTHENTICATION_ERROR |
Uwierzytelnianie nie powiodło się z powodu nieprawidłowych danych logowania. |
AUTHORIZATION_ERROR |
Konto usługi nie ma autoryzacji dla repozytorium. |
SERVER_ERROR |
Błąd serwera repozytorium. |
QUOTA_EXCEEDED |
Przekroczono limit. |
SERVICE_UNAVAILABLE |
Serwer jest tymczasowo niedostępny. |
CLIENT_ERROR |
Błąd związany z klientem, na przykład nieprawidłowe żądanie z oprogramowania sprzęgającego do serwera repozytorium. |
Item.ItemType
Wartości w polu enum | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Element, który jest indeksowany wyłącznie w celu wyświetlania informacji. Nie można odwoływać się do tych elementów w polach containerName ani inheritAclFrom . |
CONTAINER_ITEM |
Indeksowany element, którego celem jest dostarczanie innych elementów za pomocą list kontroli dostępu i/lub zawieranie innych elementów. |
VIRTUAL_CONTAINER_ITEM |
Element, który nie jest indeksowany, ale ma to samo przeznaczenie co CONTAINER_ITEM. |
Metody |
|
---|---|
|
Usuwa Item resource w przypadku określonej nazwy zasobu. |
|
Usuwa wszystkie elementy kolejki. |
|
Pobiera wartość Item resource według nazwy elementu. |
|
Aktualizuje listę kontroli dostępu (ACL) usługi Item , metadane i treść. |
|
Wyświetla wszystkie elementy Item resources lub ich podzbiór. |
|
Wyszukuje niezarezerwowane elementy z kolejki indeksowania i oznacza zestaw jako zarezerwowany, zaczynając od elementów, które mają najstarszą sygnaturę czasową od elementu ItemStatus o najwyższym priorytecie. |
|
Umieszcza element w kolejce w celu późniejszego odpytywania i aktualizowania. |
|
Anuluje rezerwację wszystkich elementów w kolejce, przez co wszystkie kwalifikują się do odpytywania. |
|
Tworzy sesję przesyłania, aby przesłać treść elementu. |