- Zasób: Item
- ItemAcl
- ItemAcl.AclInheritanceType
- Podmiot zabezpieczeń
- ItemMetadata
- Interakcja
- 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: Item
Reprezentuje pojedynczy obiekt będący elementem w indeksie wyszukiwania, takim jak plik, folder lub 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ść wynosi 1536 znaków. |
acl |
Lista kontroli dostępu do tego elementu. |
metadata |
Informacje o metadanych. |
structuredData |
Uporządkowane dane produktu, które powinny być zgodne z definicją zarejestrowanego obiektu w schemacie źródła danych. |
content |
Zawartość elementu do zindeksowania i udostępnienia do przeszukiwania. |
version |
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 porządku leksycznego. Indeksowanie w Cloud Search nie indeksuje ani nie usuwa żadnego elementu znajdującego się w kolejce, którego wartość wersji jest niższa lub równa wersji obecnie zindeksowanego elementu. Maksymalna długość tego pola to 1024 bajty. Informacje o tym, jak wersja produktu wpływa na proces usuwania, znajdziesz w sekcji Obsługiwanie wersji po usunięciu ręcznego. Ciąg zakodowany w formacie base64. |
status |
Stan produktu. Pole tylko dane wyjściowe. |
queue |
Element, do którego należy ten element, znajduje się w kolejce. Maksymalna długość to 100 znaków. |
payload |
Dodatkowy stan oprogramowania sprzęgającego może przechowywać na potrzeby tego elementu. 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 dla elementu. Więcej informacji znajdziesz w artykule Mapowanie list kontroli dostępu (ACL).
Zapis JSON |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
Pola | |
---|---|
inheritAclFrom |
Nazwa elementu, z którego ma nastąpić dziedziczenie listy uprawnień dostępu (ACL). Uwaga: dziedziczenie ACL zapewnia tylko uprawnienia dostępu do elementów podrzędnych i nie definiuje relacji strukturalnych. Nie zapewnia też wygodnych sposobów usuwania dużych grup elementów. Usunięcie elementu nadrzędnego ACL z indeksu zmienia tylko uprawnienia dostępu elementów podrzędnych, które odwołują się do elementu nadrzędnego w polu |
aclInheritanceType |
Określa typ reguł dostępu, które są stosowane, gdy element dziedziczy listę kontroli dostępu (ACL) z elementu nadrzędnego. Te wartości należy zawsze ustawiać w połączeniu z polem |
readers[] |
Lista podmiotów zabezpieczeń, które mogą zobaczyć element w wynikach wyszukiwania. Opcjonalne, jeśli dziedziczysz uprawnienia z innego elementu lub gdy element nie powinien być widoczny (np. |
deniedReaders[] |
Lista podmiotów zabezpieczeń, którym wyraźnie odmówiono dostępu do elementu w wynikach wyszukiwania. Podmioty zabezpieczeń domyślnie otrzymują odmowę dostępu, ale używaj odmowy dostępu do obsługi wyjątków i zastępowania listy dozwolonych czytelników. 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 to jednak niewielką pozycję w rankingu dla elementów, w przypadku których użytkownik, który wysłał zapytanie, jest ich właścicielem. 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 kontroli dostępu (ACL). Użyj NOT_APPLICABLE, gdy pole inheritAclFrom jest puste. W przypadku elementu bez dziedziczenia ACL listy kontroli dostępu mogą być dostarczane z własnych pól readers i deniedReaders . |
CHILD_OVERRIDE |
W razie konfliktu autoryzacji lista kontroli dostępu elementu podrzędnego określa jego uprawnienia do odczytu. |
PARENT_OVERRIDE |
W przypadku konfliktu autoryzacji lista kontroli dostępu elementu nadrzędnego określonego w polu inheritAclFrom określa uprawnienia do odczytu. |
BOTH_PERMIT |
Dostęp jest przyznawany tylko wtedy, gdy zarówno ten element, jak i element nadrzędny określony w polu inheritAclFrom zapewniają dostęp z uprawnieniami do odczytu. |
Podmiot zabezpieczeń
Odniesienie do użytkownika, grupy lub domeny.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
gsuitePrincipal |
Ten podmiot zabezpieczeń należy do użytkownika, grupy lub domeny Google Workspace. |
userResourceName |
Ten podmiot zabezpieczeń to użytkownik zidentyfikowany za pomocą tożsamości zewnętrznej. Pole nazwy musi określać nazwę zasobu użytkownika w formacie: identitysources/{sourceId}/users/{ID} |
groupResourceName |
Ten podmiot zabezpieczeń to grupa zidentyfikowana za pomocą tożsamości zewnętrznej. Pole name 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, będzie to 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 powodują zastosowanie tego linku do tytułu. Odstępy i znaki specjalne mogą powodować, że linki w wynikach wyszukiwania Cloud powodują wyświetlenie powiadomienia o przekierowaniu. aby tego uniknąć, zakoduj adres URL. Maksymalna długość to 2048 znaków. |
containerName |
Nazwa kontenera tego elementu. Usunięcie elementu kontenera spowoduje jego automatyczne usunięcie. Uwaga: listy kontroli dostępu nie są dziedziczone z elementu kontenera. Aby określić dziedziczenie ACL dla 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”, żądania indeksowania elementów dla obiektów tego typu powinny mieć wartość „document” (obiekt). Maksymalna długość wynosi 256 znaków. |
createTime |
Czas utworzenia elementu w repozytorium źródłowym. Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
updateTime |
Czas ostatniej modyfikacji elementu w repozytorium źródłowym. Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
interactions[] |
Lista interakcji związanych z elementem. Interakcje służą do poprawy jakości zapytania query.search, ale nie są widoczne dla użytkowników. Maksymalna liczba elementów to 1000. |
contentLanguage |
Kod języka BCP-47 produktu, na przykład „en-US”. czy „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 |
searchQualityMetadata |
Dodatkowe metadane dotyczące jakości wyszukiwania elementu |
keywords[] |
Dodatkowe słowa kluczowe lub wyrażenia, które powinny pasować do elementu. Używany wewnętrznie w przypadku treści użytkowników. Maksymalna liczba elementów to 100. Maksymalna długość to 8192 znaki. |
hash |
Wartość haszowania dostarczona przez obiekt wywołujący interfejs API. Można jej używać razem z metodą |
contextAttributes[] |
Zestaw nazwanych atrybutów powiązanych z produktem. Może to mieć wpływ na pozycję produktu w rankingu na podstawie kontekstu żądania. Maksymalna liczba elementów to 10. |
Interakcja
Reprezentuje interakcję między użytkownikiem a produktem.
Zapis JSON |
---|
{ "type": enum ( |
Pola | |
---|---|
type |
|
principal |
Użytkownik, który wykonał działanie na produkcie. |
interactionTime |
Czas, gdy użytkownik zareagował na element. Jeśli 1 użytkownik ma wiele działań tego samego typu, rejestrowane jest tylko najnowsze. Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 jakości wyszukiwania elementu.
Zapis JSON |
---|
{ "quality": number } |
Pola | |
---|---|
quality |
Wskaźnik jakości produktu, który wpływa na jakość wyszukiwania. powinna mieścić się w zakresie 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 elementem, który może mieć wpływ na pozycję produktu w rankingu na podstawie kontekstu żądania.
Zapis JSON |
---|
{ "name": string, "values": [ string ] } |
Pola | |
---|---|
name |
Nazwa atrybutu. 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) i cyfry (0–9). Przed dopasowaniem nazwa zostanie znormalizowana (z małymi literami). |
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 (z małymi literami). |
ItemStructuredData
Dostępne pola uporządkowanych danych dla elementu.
Zapis JSON |
---|
{
"object": {
object ( |
Pola | |
---|---|
object |
Obiekt uporządkowanych danych, który powinien być zgodny z definicją zarejestrowanego obiektu w schemacie źródła danych. |
hash |
Wartość haszowania dostarczona przez obiekt wywołujący interfejs API. Można jej używać razem 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ść dla uporządkowanych danych. Typ wartości powinien być taki sam jak typ zarejestrowany dla właściwości name
w definicji obiektu objectType
.
Zapis JSON |
---|
{ "name": string, // Union field |
Pola | |
---|---|
name |
Nazwa usługi. Ta nazwa powinna być zgodna z nazwą właściwości, która została zarejestrowana na potrzeby definicji obiektu w schemacie. Maksymalna dozwolona długość w przypadku tej właściwości to 256 znaków. |
Pole sumy value . Wartości właściwości nazwanej. Pamiętaj, że właściwość może zawierać tylko wartości 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 całkowitych.
Zapis JSON |
---|
{ "values": [ string ] } |
Pola | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Lista wartości zmiennoprzecinkowych.
Zapis JSON |
---|
{ "values": [ number ] } |
Pola | |
---|---|
values[] |
|
NamedProperty.TimestampValues
Lista wartości sygnatur czasowych.
Zapis JSON |
---|
{ "values": [ string ] } |
Pola | |
---|---|
values[] |
Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 daty.
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
Zawartość elementu, który ma być indeksowany i wyświetlany 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ć w formacie UTF-8.
Zapis JSON |
---|
{ "contentFormat": enum ( |
Pola | |
---|---|
contentFormat |
|
hash |
Informacje dotyczące haszowania obliczone i dostarczone przez klienta interfejsu API dla treści. Może być używana z metodą items.push do obliczania stanu zmodyfikowanego. Maksymalna długość to 2048 znaków. |
Pole sumy
|
|
inlineContent |
Materiały dostarczane w ramach metody aktualizacji. Maksymalna długość to 102 400 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, zawartość powinna 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 jest tworzony w upload method
. Ten plik referencyjny będzie ważny przez 30 dni od jego utworzenia. Aktualizacja treści elementu może odnosić się do tej przesłanej treści w contentDataRef
.
Zapis JSON |
---|
{ "name": string } |
Pola | |
---|---|
name |
Nazwa odniesienia do treści. Maksymalna długość to 2048 znaków. |
ItemStatus
Zawiera stan elementu i wszystkie błędy.
Zapis JSON |
---|
{ "code": enum ( |
Pola | |
---|---|
code |
Kod stanu. |
processingErrors[] |
Szczegóły błędu, który można sprawdzić, 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 produktu są nieprawidłowe, to pole zawiera 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. Jeden produkt może zawierać wiele błędów przetwarzania.
Wartości w polu enum | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Tylko wartość wejściowa. Użyj tej wartości w kolumnie Produkty. |
MALFORMED_REQUEST |
Lista kontroli dostępu, metadane lub treść elementu są uszkodzone lub nieprawidłowy stan. Informacje o naruszeniach pól zawierają więcej informacji o tym, gdzie występuje problem. |
UNSUPPORTED_CONTENT_FORMAT |
Format licznika nie jest obsługiwany. |
INDIRECT_BROKEN_ACL |
Elementy z niepełnymi informacjami o kontroli dostępu (ACL) ze względu na dziedziczenie innych elementów z usuniętą listą kontroli dostępu lub tworzenie 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 oprogramowania sprzęgającego 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 dozwolona długość wiadomości to 8192 znaki. |
RepositoryError.Type
Lista kodów błędów dotyczących problemów z komunikacją z repozytorium.
Wartości w polu enum | |
---|---|
UNKNOWN |
Nieznany błąd. |
NETWORK_ERROR |
Nieznany lub niedostępny host. |
DNS_ERROR |
Problem z DNS, na przykład serwer DNS nie odpowiada. |
CONNECTION_ERROR |
Nie można połączyć się z serwerem repozytoriów. |
AUTHENTICATION_ERROR |
Uwierzytelnianie nie powiodło się z powodu nieprawidłowych danych logowania. |
AUTHORIZATION_ERROR |
Konto usługi nie jest autoryzowane dla repozytorium. |
SERVER_ERROR |
Błąd serwera repozytorium. |
QUOTA_EXCEEDED |
Przekroczono limit. |
SERVICE_UNAVAILABLE |
Serwer tymczasowo niedostępny. |
CLIENT_ERROR |
Błąd związany z klientem, na przykład nieprawidłowe żądanie wysyłane z oprogramowania sprzęgającego do serwera repozytorium. |
Item.ItemType
Wartości w polu enum | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Element, który jest indeksowany tylko w celu udostępniania informacji. Do tych elementów nie można się odwoływać w polach containerName ani inheritAclFrom . |
CONTAINER_ITEM |
Element, który jest indeksowany i przeznaczony do udostępniania innych elementów na listach kontroli dostępu (ACL) lub zawiera inne elementy. |
VIRTUAL_CONTAINER_ITEM |
Element, który nie został zindeksowany, ale ma tę samą funkcję co CONTAINER_ITEM. |
Metody |
|
---|---|
|
Usuwa element Item resource o określonej nazwie zasobu. |
|
Usuwa wszystkie elementy w kolejce. |
|
Pobiera Item resource według nazwy elementu. |
|
Aktualizuje listę kontroli dostępu, metadane i treści Item . |
|
Zawiera wszystkie elementy lub ich podzbiór (Item resources ). |
|
Sonduje o niezarezerwowane elementy z kolejki indeksowania i oznacza zestaw jako zarezerwowany, zaczynając od elementów o najstarszej sygnaturze czasowej o najwyższym priorytecie (ItemStatus ). |
|
Przekazuje element do kolejki na potrzeby późniejszego odpytywania i aktualizowania. |
|
Anuluje rezerwowanie wszystkich elementów z kolejki, przez co wszystkie mogą być badane. |
|
Tworzy sesję przesyłania, podczas której można przesłać zawartość produktu. |