Method: settings.datasources.update

Aktualizuje źródło danych.

Uwaga: do uruchomienia tego interfejsu API 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: źródła danych/{sourceId}.

Podczas tworzenia źródła danych nazwa jest ignorowana.

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ść zostanie użyta do dopasowania wartości „source” . Jeśli na przykład krótka nazwa to <value>, zapytania takie jak <value> zwróciją wyniki tylko z tego źródła. Wartość musi być unikalna we wszystkich źródłach danych. Wartość może zawierać tylko znaki alfanumeryczne (a–zA–Z0–9). Wartość nie może zaczynać się od „google” i nie mogą być jednym z tych elementów: poczta, gmail, dokumenty, dysk, grupy, witryny, kalendarz, hangouts, gplus, Keep, osoby, zespoły. Jego maksymalna długość to 32 znaki.
source.indexingServiceAccounts[]

string

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

boolean

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

boolean

Jeśli ma wartość prawda, źródło danych jest w trybie tylko do odczytu. W trybie tylko do odczytu interfejs Indexing API odrzuca wszelkie żądania indeksowania lub usunięcia elementów z tego źródła. Włączenie trybu „tylko do odczytu” nie zatrzymuje przetwarzania wcześniej zaakceptowanych danych.
source.itemsVisibility[]

object (GSuitePrincipal)

To pole ogranicza widoczność do elementów na poziomie źródła danych. Elementy w obrębie źródła danych są ograniczone do grupy 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 na liście kontroli dostępu (ACL) do zawartych w niej elementów. Zapewnia to wysoki poziom dostępu do całego źródła danych i zapewnia, że poszczególne elementy nie są udostępniane poza tę widoczność.
source.returnThumbnailUrls

boolean

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

string

Identyfikatory długotrwałych operacji (LRO) aktualnie uruchomionych dla tego schematu.
debugOptions

object (DebugOptions)

Typowe opcje debugowania.
updateMask

string (FieldMask format)

Ma zastosowanie tylko do settings.datasources.patch.

Zaktualizuj maskę, aby kontrolować, które pola mają być aktualizowane. Przykładowe ścieżki pól: name, displayName.

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

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.