Method: settings.datasources.update

Bir veri kaynağını günceller.

Not: Bu API'nin çalıştırılması için yönetici hesabı gerekir.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
source.name

string

Veri kaynağı kaynağının adı. Biçim: datasources/{sourceId}.

Veri kaynağı oluşturulurken ad yoksayılır.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "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
}
Alanlar
source.displayName

string

Zorunlu. Veri kaynağının görünen adı. Maksimum uzunluk 300 karakterdir.

source.shortName

string

Kaynağın kısa adı veya takma adı. Bu değer, "source" operatörüyle eşleştirme yapmak için kullanılır. Örneğin, kısa ad <value> ise source:<value> gibi sorgular yalnızca bu kaynakla ilgili sonuçları döndürür. Değer, tüm veri kaynakları genelinde benzersiz olmalıdır. Değer yalnızca alfanümerik karakterler (a-zA-Z0-9) içermelidir. Değer "google" ile başlayamaz ve aşağıdakilerden biri olamaz: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Maksimum uzunluğu 32 karakterdir.

source.indexingServiceAccounts[]

string

Dizine ekleme erişimi olan hizmet hesaplarının listesi.

source.disableServing

boolean

Arama veya yardım sonuçlarını sunmayı devre dışı bırakın.

source.disableModifications

boolean

Doğru ise veri kaynağını salt okuma moduna ayarlar. Dizine Ekleme API'si, salt okuma modunda bu kaynaktaki öğeleri dizine ekleme veya silme isteklerini reddeder. Salt okuma modunu etkinleştirmek, daha önce kabul edilen verilerin işlenmesini durdurmaz.

source.itemsVisibility[]

object (GSuitePrincipal)

Bu alan, öğelerin görünürlüğünü veri kaynağı düzeyinde kısıtlar. Veri kaynağındaki öğeler, bu alana dahil edilen kullanıcılar ve grupların birleşimiyle sınırlıdır. Kullanıcıların, kapsanan öğelerde ACL izinlerine sahip olması gerektiğinden, bu işlemin belirli bir öğeye erişimi garanti etmediğini unutmayın. Bu, veri kaynağının tamamına yüksek düzeyde erişim sağlar ve öğelerin bu görünürlük dışında paylaşılmamasını sağlar.

source.returnThumbnailUrls

boolean

Kullanıcılar bu veri kaynağında dizine eklenen öğelerin küçük resmi URI'sini isteyebilir.

source.operationIds[]

string

Şu anda bu şema için çalışan uzun süreli işlemlerin (LROs) kimlikleri.

debugOptions

object (DebugOptions)

Sık kullanılan hata ayıklama seçenekleri.

updateMask

string (FieldMask format)

Yalnızca settings.datasources.patch için geçerlidir.

Hangi alanların güncelleneceğini kontrol etmek için maskeyi güncelleyin. Örnek alan yolları: name, displayName.

  • updateMask boş değilse yalnızca updateMask içinde belirtilen alanlar güncellenir.
  • updateMask içinde bir alan belirtirseniz ancak kaynağında değerini belirtmezseniz bu alan temizlenir.
  • updateMask mevcut değilse, boşsa veya * değerine sahipse tüm alanlar güncellenir.

Yanıt gövdesi

Başarılıysa yanıt metni, Operation öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.