- Zasób: Item
- ItemAcl
- ItemAcl.AclInheritanceType
- Główny
- 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, który jest elementem w indeksie wyszukiwania, np. plik, folder lub rekord bazy danych.
| Zapis JSON |
|---|
{ "name": string, "acl": { object ( |
| Pola | |
|---|---|
name |
Nazwa produktu. Format: datasources/{sourceId}/items/{itemId} To pole jest wymagane. Maksymalna długość to 1536 znaków. |
acl |
Lista kontroli dostępu do tego elementu. |
metadata |
informacje metadanych. |
structuredData |
Uporządkowane dane dotyczące produktu, które powinny być zgodne ze zdefiniowaną definicją obiektu w schemacie źródła danych. |
content |
Treści elementów, które mają zostać zindeksowane i udostępnione do wyszukiwania. |
version |
Wymagane. System indeksowania przechowuje wersję z źródła danych jako ciąg bajtów i porównuje wersję produktu w indeksie z wersją produktu w kolejce za pomocą sortowania leksykalnego. Wyszukiwanie w chmurze nie indeksuje ani nie usuwa żadnych elementów w kolejce o wartości wersji mniejszej lub równej wersji obecnie indeksowanego elementu. Maksymalna długość tego pola to 1024 bajty. Informacje o tym, jak wersja elementu wpływa na proces usuwania, znajdziesz w artykule Zarządzanie wersjami po ręcznym usunięciu. Ciąg znaków zakodowany w formacie Base64. |
status |
Stan produktu. Pole tylko do odczytu. |
queue |
kolejka, do której należy ten element. Maksymalna długość to 100 znaków. |
payload |
Dodatkowy stan, który może przechowywać łącznik. Maksymalna długość to 10 tys. bajtów. Ciąg znaków zakodowany w formacie Base64. |
itemType |
Typ tego elementu. |
ItemAcl
Informacje o liście kontroli dostępu dla elementu. Więcej informacji znajdziesz w artykule Mapy ACL.
| Zapis JSON |
|---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
| Pola | |
|---|---|
inheritAclFrom |
Nazwa elementu, z którego ma zostać odziedziczona lista uprawnień dostępu (ACL). Uwaga: dziedziczenie listy kontroli dostępu tylko zapewnia uprawnienia dostępu do elementów podrzędnych i nie definiuje relacji strukturalnych ani nie zapewnia wygodnych sposobów usuwania dużych grup elementów. Usunięcie elementu nadrzędnego w zasadach 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 zasad dostępu, które mają być stosowane, gdy element dziedziczy listę ACL od elementu nadrzędnego. Powinien być zawsze ustawiany razem z polem |
readers[] |
Lista osób upoważnionych do wyświetlania elementu w wynikach wyszukiwania. Opcjonalne, jeśli dziedziczysz uprawnienia z innego elementu lub jeśli element nie ma być widoczny, np. |
deniedReaders[] |
Lista podmiotów, którym wyraźnie odmówiono dostępu do produktu w wynikach wyszukiwania. Domyślnie podmiotom zabezpieczeń odmawia się dostępu, ale możesz użyć podmiotów zabezpieczeń odrzuconych, aby obsługiwać wyjątki i zastąpić listę dozwolonych podmiotów zabezpieczeń. 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. W przypadku zapytań wysyłanych przez użytkowników, którzy są właścicielami danego produktu, jego pozycja w rankingu jest jednak nieznacznie podwyższana. Maksymalna liczba elementów to 5. |
ItemAcl.AclInheritanceType
Typy dziedziczenia reguł ACL.
| Wartości w polu enum | |
|---|---|
NOT_APPLICABLE |
Wartość domyślna, gdy ten element nie dziedziczy listy ACL. Użyj NOT_APPLICABLE, gdy inheritAclFrom jest pusty. Element bez dziedziczenia list kontroli dostępu może nadal mieć listy kontroli dostępu podane w polach readers i deniedReaders. |
CHILD_OVERRIDE |
W przypadku konfliktu autoryzacji dostęp do odczytu określa lista ACL obiektu podrzędnego. |
PARENT_OVERRIDE |
W przypadku konfliktu autoryzacji dostęp do odczytu określa lista ACL elementu nadrzędnego określonego w polu inheritAclFrom. |
BOTH_PERMIT |
Dostęp jest przyznawany tylko wtedy, gdy ten element i element nadrzędny określony w polu inheritAclFrom zezwalają na dostęp tylko do odczytu. |
Podmiot zabezpieczeń
Odwołuje się do użytkownika, grupy lub domeny.
| Zapis JSON |
|---|
{ // Union field |
| Pola | |
|---|---|
Pole unii
|
|
gsuitePrincipal |
Ten podmiot zabezpieczeń to użytkownik, grupa lub domena Google Workspace. |
userResourceName |
Ten podmiot to użytkownik zidentyfikowany za pomocą tożsamości zewnętrznej. Pole nazwa musi zawierać nazwę zasobu użytkownika w formacie: identitysources/{sourceId}/users/{id} |
groupResourceName |
Ten podmiot to grupa zidentyfikowana za pomocą tożsamości zewnętrznej. W polu nazwa musisz podać nazwę zasobu grupy w formacie: identitysources/{sourceId}/groups/{id}. |
ItemMetadata
Dostępne pola metadanych dla elementu.
| Zapis JSON |
|---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
| Pola | |
|---|---|
title |
Nazwa produktu. Jeśli zostanie podany, będzie to wyświetlany tytuł wyniku wyszukiwania. Maksymalna długość to 2048 znaków. |
sourceRepositoryUrl |
Link do repozytorium źródłowego, które udostępnia dane. Wyniki wyszukiwania stosują ten link do tytułu. Białe znaki lub znaki specjalne mogą powodować, że linki do wyników wyszukiwania w usłudze Cloud Search będą wywoływać komunikat 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 powoduje automatyczne usunięcie tego elementu. Uwaga: uprawnienia nie są dziedziczone z elementu kontenera. Aby zapewnić dziedziczenie listy kontroli dostępu dla elementu, użyj pola |
objectType |
Typ elementu. Powinna ona 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”, to w prośbach o indeksowanie elementów tego typu należy ustawić parametr objectType na „document”. Maksymalna długość to 256 znaków. |
createTime |
Czas utworzenia elementu w repozytorium źródłowym. Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne są też przesunięcia inne niż „Z”. Przykłady: |
updateTime |
Czas ostatniej modyfikacji elementu w repozytorium źródłowym. Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne są też przesunięcia inne niż „Z”. Przykłady: |
interactions[] |
Lista interakcji z elementem. Interakcje służą do poprawy jakości wyszukiwania, ale nie są widoczne dla użytkowników. Maksymalna liczba elementów to 1000. |
contentLanguage |
Kod języka BCP-47 produktu, np. „pl-PL” 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 |
Pierwotny typ mime |
searchQualityMetadata |
dodatkowe metadane dotyczące jakości wyszukiwania produktu; |
keywords[] |
Dodatkowe słowa kluczowe lub wyrażenia, które powinny pasować do produktu. Używany wewnętrznie do treści użytkowników. Maksymalna liczba elementów to 100. Maksymalna długość to 8192 znaki. |
hash |
Wartość funkcji szyfrowania dostarczona przez wywołującego interfejs API. Można go użyć z metodą |
contextAttributes[] |
Zbiór nazwanych atrybutów powiązanych z elementem. Można go używać do wpływania na pozycję produktu na podstawie kontekstu w żądaniu. Maksymalna liczba elementów to 10. |
Interakcja
Reprezentuje interakcję użytkownika z elementem.
| Zapis JSON |
|---|
{ "type": enum ( |
| Pola | |
|---|---|
type |
|
principal |
Użytkownik, który wykonał działanie związane z elementem. |
interactionTime |
Czas, w którym użytkownik wykonał działanie związane z danym elementem. Jeśli w przypadku jednego użytkownika występuje kilka działań tego samego typu, rejestrowane jest tylko ostatnie działanie. Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne są też przesunięcia inne niż „Z”. Przykłady: |
Interaction.InteractionType
Rodzaj działania użytkownika dotyczącego danego produktu.
| 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 elementu, który wpływa na jakość wyszukiwania. Wartość 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 służyć do wpływania na pozycję elementu na podstawie kontekstu w żądaniu.
| Zapis JSON |
|---|
{ "name": string, "values": [ string ] } |
| Pola | |
|---|---|
name |
Nazwa atrybutu. Nie może być pusty. Maksymalna długość to 32 znaki. Nazwa musi zaczynać się od litery i może zawierać tylko litery (A–Z, a–z) lub cyfry (0–9). Nazwa zostanie ujednolicona (zmieniona na małe litery) przed dopasowaniem. |
values[] |
Tekstowe wartości atrybutu. Maksymalna liczba elementów to 10. Maksymalna długość elementu w tablicy to 32 znaki. Wartość zostanie znormalizowana (przekształcona do małych liter) przed dopasowaniem. |
ItemStructuredData
Dostępne pola uporządkowanych danych dla produktu.
| Zapis JSON |
|---|
{
"object": {
object ( |
| Pola | |
|---|---|
object |
Obiekt danych strukturalnych, który powinien być zgodny ze zdefiniowaną definicją obiektu w schemacie źródła danych. |
hash |
Wartość funkcji szyfrowania dostarczona przez wywołującego interfejs API. Można go użyć z metodą |
StructuredDataObject
Obiekt danych uporządkowanych, który składa się z nazwanych właściwości.
| Zapis JSON |
|---|
{
"properties": [
{
object ( |
| Pola | |
|---|---|
properties[] |
Właściwości obiektu. Maksymalna liczba elementów to 1000. |
NamedProperty
Wpisana para nazwa-wartość danych uporządkowanych. 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 nieruchomości. Nazwa powinna odpowiadać nazwie właściwości zarejestrowanej w definicji obiektu w schemacie. Maksymalna dopuszczalna długość tej właściwości to 256 znaków. |
Pole unii value. Wartości właściwości o nazwie. Pamiętaj, że usługa może zawierać tylko wartości jednego typu. value może być tylko jednym z tych elementów: |
|
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 typu double.
| Zapis JSON |
|---|
{ "values": [ number ] } |
| Pola | |
|---|---|
values[] |
|
NamedProperty.TimestampValues
Lista wartości sygnatury czasowej.
| Zapis JSON |
|---|
{ "values": [ string ] } |
| Pola | |
|---|---|
values[] |
Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne są też przesunięcia inne niż „Z”. Przykłady: |
NamedProperty.ObjectValues
Lista wartości obiektu.
| Zapis JSON |
|---|
{
"values": [
{
object ( |
| Pola | |
|---|---|
values[] |
|
NamedProperty.EnumValues
Lista wartości typu wyliczeniowego.
| 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
Treści elementu, które mają być zindeksowane i wyświetlane przez Cloud Search. Dozwolone są tylko ciągi znaków zakodowane w UTF-8.inlineContent Jeśli przesyłane treści nie są binarne, muszą być zakodowane w formacie UTF-8.
| Zapis JSON |
|---|
{ "contentFormat": enum ( |
| Pola | |
|---|---|
contentFormat |
|
hash |
informacje o zależności od hasha obliczone i dostarczone przez klienta interfejsu API dotyczące treści; Można go używać z metodą items.push do obliczania stanu zmodyfikowanego. Maksymalna długość to 2048 znaków. |
Pole unii
|
|
inlineContent |
Treści podawane w ramach metody aktualizacji. Maksymalna długość to 102400 bajtów (100 KiB). Ciąg znaków zakodowany w formacie Base64. |
contentDataRef |
Przesyłanie identyfikatora referencyjnego wcześniej przesłanych treści za pomocą metody write. |
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 |
Format treści to HTML. |
TEXT |
Format treści to dowolny tekst. |
RAW |
contentFormat to nieprzetworzone bajty. |
UploadItemRef
Reprezentuje odwołanie do sesji przesyłania. Ten element referencyjny został utworzony za pomocą upload method. Ten link jest ważny przez 30 dni od jego utworzenia. Aktualizacja treści produktu może dotyczyć tych przesłanych treści za pomocą contentDataRef.
| Zapis JSON |
|---|
{ "name": string } |
| Pola | |
|---|---|
name |
Nazwa pliku referencyjnego. 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 ERROR; |
repositoryErrors[] |
Oprogramowanie sprzęgające zgłosiło 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 elementów są nieprawidłowe, to pole zawiera informacje o błędach weryfikacji. |
ProcessingErrorCode
Kody wskazujące błąd napotkany podczas przetwarzania elementów przez serwer Cloud Search. Pojedynczy element może zawierać wiele błędów przetwarzania.
| Wartości w polu enum | |
|---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Wpisz tylko wartość. Użyj tej wartości w sekcji Elementy. |
MALFORMED_REQUEST |
ACL, metadane lub zawartość produktu są nieprawidłowo sformatowane lub są w nieprawidłowym stanie. FieldViolations zawiera więcej informacji o miejscu wystąpienia problemu. |
UNSUPPORTED_CONTENT_FORMAT |
Format treści jest nieobsługiwany. |
INDIRECT_BROKEN_ACL |
Elementy z niekompletnymi informacjami o dostępie, ponieważ dziedziczą je od innych elementów z uszkodzonym dostępem lub zawierają grupy z niezmapowanymi elementami potomnymi. |
ACL_CYCLE |
Graf dziedziczenia listy ACL tworzy cykl. |
FieldViolation
| Zapis JSON |
|---|
{ "field": string, "description": string } |
| Pola | |
|---|---|
field |
Ścieżka na polu z naruszeniem |
description |
Opis błędu. |
RepositoryError
Błędy podczas komunikacji łącznika z repozytorium źródłowym.
| Zapis JSON |
|---|
{
"type": enum ( |
| Pola | |
|---|---|
type |
Typ błędu. |
httpStatusCode |
kody błędów. Zgodny z definicją 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 problemami z łącznością z repozytorium.
| Wartości w polu enum | |
|---|---|
UNKNOWN |
Nieznany błąd. |
NETWORK_ERROR |
Nieznany lub niedostępny host. |
DNS_ERROR |
problem z DNS, np. serwer DNS nie odpowiada; |
CONNECTION_ERROR |
Nie można połączyć się z serwerem repozytorium. |
AUTHENTICATION_ERROR |
Uwierzytelnianie się nie powiodło z powodu nieprawidłowych danych logowania. |
AUTHORIZATION_ERROR |
Konto usługi nie ma uprawnień do repozytorium. |
SERVER_ERROR |
Błąd serwera repozytorium. |
QUOTA_EXCEEDED |
Przekroczono limit. |
SERVICE_UNAVAILABLE |
Serwer jest tymczasowo niedostępny. |
CLIENT_ERROR |
błąd po stronie klienta, np. nieprawidłowe żądanie od łącznika do serwera repozytorium; |
Item.ItemType
| Wartości w polu enum | |
|---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Element, który jest indeksowany tylko w celu wyświetlania informacji. tych elementów nie można uwzględniać w polach containerName ani inheritAclFrom; |
CONTAINER_ITEM |
Element, który jest indeksowany i ma na celu dostarczanie innych elementów z zasadami kontroli dostępu lub zawiera inne elementy. |
VIRTUAL_CONTAINER_ITEM |
Element, który nie jest indeksowany, ale w innym zakresie pełni tę samą funkcję co CONTAINER_ITEM. |
Metody |
|
|---|---|
|
Usuwa Item resource dla określonej nazwy zasobu. |
|
Usuwa wszystkie elementy z kolejki. |
|
Pobiera Item resource według nazwy produktu. |
|
Aktualizuje Item listę kontroli dostępu, metadane i treści. |
|
Wyświetla wszystkie lub podzbiór obiektów Item resources. |
|
Wypytuje o niezarezerwowane elementy z kolejki indeksowania i oznacza zestaw jako zarezerwowany, zaczynając od elementów o najstarszym sygnaturze czasowej o najwyższym priorytecie ItemStatus. |
|
Przesyła element do kolejki w celu późniejszego odczytu i aktualizacji. |
|
Odblokowuje wszystkie elementy z kolejki, dzięki czemu można je pobrać. |
|
Tworzy sesję przesyłania do przesyłania treści produktu. |