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}.

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

To pole jest 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. Będzie ona używana do dopasowania operatora „source”. Jeśli np. krótka nazwa to <value>, zapytanie typu source:<wartość> zwróci wyniki tylko dla tego źródła. Wartość musi być niepowtarzalna wśród wszystkich źródeł danych. Wartość może zawierać tylko znaki alfanumeryczne (a–zA–Z0–9). Wartość nie może zaczynać się od „google” i nie może być jednym z tych elementów: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, team. Jego 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 jakichkolwiek wyników wyszukiwania lub wspomaganych.
source.disableModifications

boolean

Jeśli ma wartość prawda, ustawia źródło danych w tryb tylko do odczytu. W trybie „tylko do odczytu” interfejs Indexing API odrzuca wszystkie żądania indeksowania i usuwania elementów w tym źródle. Włączenie trybu tylko do odczytu nie zatrzymuje przetwarzania zaakceptowanych wcześniej 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 sumy użytkowników i grup uwzględnionych w tym polu. Pamiętaj, że nie gwarantuje to dostępu do konkretnego elementu, ponieważ użytkownicy muszą mieć uprawnienia listy kontroli dostępu do elementów składowych. Zapewnia to wysoki poziom dostępu do całego źródła danych i zapobiega udostępnianiu poszczególnych elementów poza tą widocznością.
source.returnThumbnailUrls

boolean

Może prosić użytkownika o pobranie identyfikatora URI miniatury dla elementów zindeksowanych w tym źródle danych.
source.operationIds[]

string

Identyfikatory długo trwających operacji (LRO) uruchomionych obecnie dla tego schematu.
debugOptions

object (DebugOptions)

Typowe opcje debugowania.
updateMask

string (FieldMask format)

Dotyczy tylko settings.datasources.patch.

Zaktualizuj maskę, aby kontrolować pola do aktualizacji. Przykładowe ścieżki pól: name, displayName.

  • Jeśli pole updateMask nie jest puste, zaktualizowane zostaną tylko pola podane w zasadzie updateMask.
  • Jeśli określisz pole w updateMask, ale nie określisz jego wartości w źródle, zostanie ono wyczyszczone.
  • Jeśli pole updateMask nie jest obecne lub puste 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 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 po autoryzacji.