Method: indexing.datasources.items.index

Aktualizuje Item listę kontroli dostępu, metadane i treści. Jeśli nie istnieje, zostanie wstawiona kolumna Item. Ta metoda nie obsługuje częściowych aktualizacji. Pola bez podanych wartości są usuwane z indeksu wyszukiwarki w chmurze.

Do wykonania tej operacji wymagane jest konto administratora lub konto usługi. Używane konto usługi to to, które 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

string

Nazwa produktu. Format: datasources/{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 (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 metadanych.
item.structuredData

object (ItemStructuredData)

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

object (ItemContent)

Treści elementów, które mają zostać zindeksowane i udostępnione do wyszukiwania.
item.version

string (bytes format)

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

object (ItemStatus)

stan produktu. Pole tylko do odczytu.
item.queue

string

kolejka, do której należy ten element. Maksymalna długość to 100 znaków.
item.payload

string (bytes format)

Dodatkowy stan, który może przechowywać łącznik. Maksymalna długość to 10 tys. bajtów.

Ciąg znaków zakodowany w formacie Base64.
item.itemType

enum (Item.ItemType)

Typ tego elementu.
connectorName

string

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

Format: datasources/{sourceId}/connectors/{id}
mode

enum (RequestMode.Mode)

Wymagane. Tryb żą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 OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.

IndexItemOptions

Zapis JSON 
{
  "allowUnknownGsuitePrincipals": boolean
}
Pola
allowUnknownGsuitePrincipals

boolean

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