Method: settings.datasources.update

データソースを更新します。

注: この API を実行するには、管理者アカウントが必要です。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
source.name

string

データソース リソースの名前。形式: datasources/{sourceId}。

データソースの作成時には、この名前は無視されます。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

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
}
フィールド
source.displayName

string

必須。データソースの表示名。最大長は 300 文字です。
source.shortName

string

ソースの略称またはエイリアス。この値は「source」演算子との一致に使用されます。たとえば、略称が <value> の場合、source:<value> などのクエリでは、このソースの結果のみが返されます。値は、すべてのデータソースで一意である必要があります。値には英数字（a-zA-Z0-9）のみを使用できます。値の先頭を「google」にすることはできません。また、mail、gmail、docs、drive、groups、sites、calendar、hangouts、gplus、keep、people、teams のいずれにもすることはできません。最大文字数は 32 文字です。
source.indexingServiceAccounts[]

string

インデックスへのアクセス権を持つサービス アカウントのリスト。
source.disableServing

boolean

検索結果やアシスト結果の配信を無効にします。
source.disableModifications

boolean

true の場合、データソースを読み取り専用モードに設定します。読み取り専用モードでは、Indexing API は、このソース内のアイテムのインデックス登録または削除リクエストを拒否します。読み取り専用モードを有効にしても、以前に受け入れたデータの処理は停止されません。
source.itemsVisibility[]

object (GSuitePrincipal)

このフィールドは、データソース レベルでアイテムの公開設定を制限します。データソース内のアイテムは、このフィールドに含まれるユーザーとグループの結合に制限されます。ただし、ユーザーが含まれるアイテムに対する ACL 権限を持っている必要があるため、特定のアイテムへのアクセスが保証されるわけではありません。これにより、データソース全体に対する高度なアクセスが確保され、個々のアイテムがこの可視性外に共有されることはありません。
source.returnThumbnailUrls

boolean

ユーザーが、このデータソースにインデックス登録されているアイテムのサムネイル URI の取得をリクエストできますか。
source.operationIds[]

string

このスキーマに対して現在実行中の長時間実行オペレーション（LRO）の ID。
debugOptions

object (DebugOptions)

一般的なデバッグ オプション。
updateMask

string (FieldMask format)

settings.datasources.patch にのみ適用されます。

更新するフィールドを制御するマスクを更新します。フィールドパスの例: name、displayName。

  • updateMask が空でない場合、updateMask で指定されたフィールドのみが更新されます。
  • updateMask でフィールドを指定しても、ソースで値を指定しないと、そのフィールドはクリアされます。
  • updateMask が存在しない場合、空の場合、または値が * の場合、すべてのフィールドが更新されます。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

以下のいずれかの 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

詳しくは、認可ガイドをご覧ください。