Method: settings.datasources.update

Memperbarui sumber data.

Catatan: API ini memerlukan akun admin untuk dieksekusi.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
source.name

string

Nama resource sumber data. Format: datasources/{sourceId}.

Nama diabaikan saat membuat sumber data.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi 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
}
Kolom
source.displayName

string

Wajib. Nama tampilan sumber data. Panjang maksimumnya adalah 300 karakter.
source.shortName

string

Nama pendek atau alias untuk sumber. Nilai ini akan digunakan untuk mencocokkan operator 'source'. Misalnya, jika nama pendeknya adalah <value>, kueri seperti source:<value> hanya akan menampilkan hasil untuk sumber ini. Nilai harus unik di semua sumber data. Nilai hanya boleh berisi karakter alfanumerik (a-zA-Z0-9). Nilai tidak boleh diawali dengan 'google' dan tidak boleh berupa salah satu dari hal berikut: email, gmail, dokumen, drive, grup, situs, kalender, hangouts, gplus, keep, orang, tim. Panjang maksimumnya adalah 32 karakter.
source.indexingServiceAccounts[]

string

Daftar akun layanan yang memiliki akses pengindeksan.
source.disableServing

boolean

Menonaktifkan penayangan hasil penelusuran atau bantuan.
source.disableModifications

boolean

Jika true, menetapkan sumber data ke mode hanya baca. Dalam mode hanya baca, Indexing API menolak semua permintaan untuk mengindeks atau menghapus item di sumber ini. Mengaktifkan mode hanya baca tidak akan menghentikan pemrosesan data yang sebelumnya diterima.
source.itemsVisibility[]

object (GSuitePrincipal)

Kolom ini membatasi visibilitas ke item di tingkat sumber data. Item dalam sumber data dibatasi untuk gabungan pengguna dan grup yang disertakan dalam kolom ini. Perhatikan bahwa hal ini tidak menjamin akses ke item tertentu, karena pengguna harus memiliki izin ACL pada item yang dimuat. Hal ini memastikan akses tingkat tinggi di seluruh sumber data, dan bahwa setiap item tidak dibagikan di luar visibilitas ini.
source.returnThumbnailUrls

boolean

Dapatkah pengguna meminta untuk mendapatkan URI thumbnail untuk Item yang diindeks di sumber data ini.
source.operationIds[]

string

ID Operasi yang Berjalan Lama (LRO) yang saat ini berjalan untuk skema ini.
debugOptions

object (DebugOptions)

Opsi debug umum.
updateMask

string (FieldMask format)

Hanya berlaku untuk settings.datasources.patch.

Perbarui mask untuk mengontrol kolom yang akan diperbarui. Contoh jalur kolom: name, displayName.

  • Jika updateMask tidak kosong, hanya kolom yang ditentukan dalam updateMask yang akan diperbarui.
  • Jika Anda menentukan kolom di updateMask, tetapi tidak menentukan nilainya di sumber, kolom tersebut akan dihapus.
  • Jika updateMask tidak ada atau kosong atau memiliki nilai *, semua kolom akan diperbarui.

Isi respons

Jika berhasil, isi respons memuat instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.