Method: indexing.datasources.items.index

Aktualizuje listę kontroli dostępu, metadane i treści Item. 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.

Ten interfejs API wymaga do działania konta administratora lub konta usługi. Używane konto usługi jest kontem umieszczonym 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

string

Nazwa elementu. Format: źródła danych/{sourceId}/items/{itemId}

To pole jest wymagane. Maksymalna długość wynosi 1536 znaków.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "item": {
    "name": string,
    "acl": {
      "inheritAclFrom": string,
      "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "title": string,
      "sourceRepositoryUrl": string,
      "containerName": string,
      "objectType": string,
      "createTime": string,
      "updateTime": string,
      "interactions": [
        {
          object (Interaction)
        }
      ],
      "contentLanguage": string,
      "mimeType": string,
      "searchQualityMetadata": {
        object (SearchQualityMetadata)
      },
      "keywords": [
        string
      ],
      "hash": string,
      "contextAttributes": [
        {
          object (ContextAttribute)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "contentFormat": enum (ItemContent.ContentFormat),
      "hash": string,

      // Union field content can be only one of the following:
      "inlineContent": string,
      "contentDataRef": {
        object (UploadItemRef)
      }
      // End of list of possible types for union field content.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
Pola
item.acl

object (ItemAcl)

Lista kontroli dostępu do tego elementu.
item.metadata

object (ItemMetadata)

Informacje o metadanych.
item.structuredData

object (ItemStructuredData)

Uporządkowane dane produktu, które powinny być zgodne z definicją zarejestrowanego obiektu w schemacie źródła danych.
item.content

object (ItemContent)

Zawartość elementu do zindeksowania i udostępnienia do przeszukiwania.
item.version

string (bytes format)

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.
item.status

object (ItemStatus)

Stan produktu. Pole tylko dane wyjściowe.
item.queue

string

Element, do którego należy ten element, znajduje się w kolejce. Maksymalna długość to 100 znaków.
item.payload

string (bytes format)

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.
item.itemType

enum (Item.ItemType)

Typ elementu.
connectorName

string

Nazwa oprogramowania sprzęgającego tworzącego to wywołanie.

Format: źródła danych/{sourceId}/łączniki/{ID}
mode

enum (RequestMode.Mode)

Wymagane. Tryb żądania dla tego żądania.
debugOptions

object (DebugOptions)

Typowe opcje debugowania.
indexItemOptions

object (IndexItemOptions)

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.

IndexItemOptions

Zapis JSON 
{
  "allowUnknownGsuitePrincipals": boolean
}
Pola
allowUnknownGsuitePrincipals

boolean

Określa, czy żądanie indeksowania powinno zezwalać podmiotom zabezpieczeń Google Workspace, które nie istnieją lub zostały usunięte.