Method: settings.datasources.update

Aktualizuje źródło danych.

Uwaga: do wykonania tej operacji wymagane jest konto administratora.

Żądanie HTTP

PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
source.name

string

Nazwa zasobu źródła danych. Format: datasources/{sourceId}.

Nazwa jest ignorowana podczas tworzenia źródła danych.

Treść żądania

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

Zapis JSON 
{
  "source": {
    "name": string,
    "displayName": string,
    "shortName": string,
    "indexingServiceAccounts": [
      string
    ],
    "disableServing": boolean,
    "disableModifications": boolean,
    "itemsVisibility": [
      {

        // Union field gsuite_principal can be only one of the following:
        "gsuiteUserEmail": string,
        "gsuiteGroupEmail": string,
        "gsuiteDomain": boolean
        // End of list of possible types for union field gsuite_principal.
      }
    ],
    "returnThumbnailUrls": boolean,
    "operationIds": [
      string
    ]
  },
  "debugOptions": {
    object (DebugOptions)
  },
  "updateMask": string
}
Pola
source.displayName

string

Wymagane. Wyświetlana nazwa źródła danych. Maksymalna długość to 300 znaków.
source.shortName

string

Krótka nazwa lub alias źródła. Ta wartość będzie używana do dopasowania operatora „source”. Jeśli np. krótka nazwa to <value>, zapytania takie jak source:<value> zwracają tylko wyniki dla tego źródła. Wartość musi być niepowtarzalna we wszystkich źródłach danych. Wartość może zawierać tylko znaki alfanumeryczne (a–z, A–Z, 0–9). Wartość nie może zaczynać się od „google” i nie może być jedną z tych nazw: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Maksymalna długość to 32 znaki.
source.indexingServiceAccounts[]

string

Lista kont usługi, które mają dostęp do indeksowania.
source.disableServing

boolean

Wyłącz wyświetlanie wyników wyszukiwania lub asystenta.
source.disableModifications

boolean

Jeśli ma wartość Prawda, powoduje, że dane źródłowe są w trybie tylko do odczytu. W trybie tylko do odczytu interfejs Indexing API odrzuca wszystkie żądania indeksowania lub usuwania elementów z tego źródła. Włączenie trybu tylko do odczytu nie powoduje przerwania przetwarzania wcześniej zaakceptowanych danych.
source.itemsVisibility[]

object (GSuitePrincipal)

To pole ogranicza widoczność do elementów na poziomie źródła danych. Elementy w źródle danych są ograniczone do zbioru użytkowników i grup uwzględnionych w tym polu. Pamiętaj, że nie zapewnia to dostępu do konkretnego elementu, ponieważ użytkownicy muszą mieć uprawnienia ACL do zawartych w nim elementów. Dzięki temu masz dostęp do całego źródła danych na wysokim poziomie i możesz mieć pewność, że poszczególne elementy nie są udostępniane poza widocznością.
source.returnThumbnailUrls

boolean

Użytkownik może poprosić o uzyskanie identyfikatora URI miniatury dla elementów zindeksowanych w tym źródle danych.
source.operationIds[]

string

Identyfikatory długotrwałych operacji (LROs) obecnie wykonywanych w ramach tego schematu.
debugOptions

object (DebugOptions)

Typowe opcje debugowania.
updateMask

string (FieldMask format)

Dotyczy tylko settings.datasources.patch.

Użyj maski aktualizacji, aby określić, które pola mają zostać zaktualizowane. Przykładowe ścieżki pól: name, displayName.

  • Jeśli pole updateMask nie jest puste, zaktualizowane zostaną tylko pola określone w polu updateMask.
  • Jeśli w elemencie updateMask podasz pole, ale nie określisz jego wartości w źródle, to pole zostanie wyczyszczone.
  • Jeśli pole updateMask jest puste, nieobecne lub ma wartość *, zaktualizowane zostaną wszystkie pola.

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.settings.indexing
  • https://www.googleapis.com/auth/cloud_search.settings
  • https://www.googleapis.com/auth/cloud_search

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