Cloud Search API

Cloud Search は、Google Workspace データに対してクラウドベースの検索機能を提供します。Cloud Search API を使用すると、Google Workspace 以外のデータを Cloud Search にインデックス登録できます。

サービス: cloudsearch.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストを行うときに次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次の検索ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在する場合があります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://cloudsearch.googleapis.com

REST リソース: v1

Methods
initializeCustomer POST /v1:initializeCustomer
Google Cloud Search で third party サポートを有効にします。

REST リソース: v1.debug.datasources.items

Methods
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
指定されたプリンシパルがアイテムにアクセスできるかどうかを確認します。
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
viewUrl がリクエストで指定された URL と完全に一致するアイテムを取得します。

REST リソース: v1.debug.datasources.items.unmappedids

Methods
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
特定のアイテムにマッピングされていないすべての ID を一覧表示します。

REST リソース: v1.debug.identitysources.items

Methods
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
マッピングされていない ID に関連付けられているアイテムの名前を一覧表示します。

REST リソース: v1.debug.identitysources.unmappedids

Methods
list GET /v1/debug/{parent=identitysources/*}/unmappedids
ID ソースのマッピングされていないユーザー ID を一覧表示します。

REST リソース: v1.indexing.datasources

Methods
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
データソースのスキーマを削除します。
getSchema GET /v1/indexing/{name=datasources/*}/schema
データソースのスキーマを取得します。
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
データソースのスキーマを更新します。

REST リソース: v1.indexing.datasources.items

Methods
delete DELETE /v1/indexing/{name=datasources/*/items/*}
指定されたリソース名の Item resource を削除します。
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
キュー内のすべてのアイテムを削除します。
get GET /v1/indexing/{name=datasources/*/items/*}
アイテム名別に Item resource を取得します。
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Item ACL、メタデータ、コンテンツを更新します。
list GET /v1/indexing/{name=datasources/*}/items
Item resources のすべてまたはサブセットを一覧表示します。
poll POST /v1/indexing/{name=datasources/*}/items:poll
インデックスのキューから予約されていないアイテムをポーリングし、セットを予約済みとしてマークします。優先度が最も高い ItemStatus から最も古いタイムスタンプを持つアイテムから始めます。
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
後でポーリングと更新を行うために、アイテムをキューに push します。
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
キューからすべてのアイテムを予約せずに、ポーリングの対象にします。
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
アイテム コンテンツをアップロードするアップロード セッションを作成します。

REST リソース: v1.media

Methods
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
インデックス登録用のメディアをアップロードします。

REST リソース: v1.operations

Methods
get GET /v1/{name=operations/**}
長時間実行オペレーションの最新状態を取得します。

REST リソース: v1.query

Methods
search POST /v1/query/search
Cloud Search Query API では、ユーザーのクエリから最も関連性の高い結果を返す検索メソッドを使用できます。
suggest POST /v1/query/suggest
クエリをオートコンプリートするための候補を表示します。

REST リソース: v1.query.sources

Methods
list GET /v1/query/sources
ユーザーが検索とサジェスト API に使用できるソースのリストを返します。

REST リソース: v1.settings

Methods
getCustomer GET /v1/settings/customer
顧客の設定を取得します。
updateCustomer PATCH /v1/settings/customer
顧客の設定を更新します。

REST リソース: v1.settings.datasources

Methods
create POST /v1/settings/datasources
データソースを作成します。
delete DELETE /v1/settings/{name=datasources/*}
データソースを削除します。
get GET /v1/settings/{name=datasources/*}
データソースを取得します。
list GET /v1/settings/datasources
データソースを一覧表示します。
patch PATCH /v1/settings/{source.name=datasources/*}
データソースを更新します。
update PUT /v1/settings/{source.name=datasources/*}
データソースを更新します。

REST リソース: v1.settings.searchapplications

Methods
create POST /v1/settings/searchapplications
検索アプリケーションを作成します。
delete DELETE /v1/settings/{name=searchapplications/*}
検索アプリケーションを削除します。
get GET /v1/settings/{name=searchapplications/*}
指定した検索アプリケーションを取得します。
list GET /v1/settings/searchapplications
すべての検索アプリケーションを一覧表示します。
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
検索アプリケーションを更新します。
reset POST /v1/settings/{name=searchapplications/*}:reset
検索アプリケーションをデフォルトの設定にリセットします。
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
検索アプリケーションを更新します。

REST リソース: v1.stats

Methods
getIndex GET /v1/stats/index
すべてのデータソースで集計された、アイテムのインデックス登録の統計情報を取得します。
getQuery GET /v1/stats/query
顧客のクエリ統計を取得します。
getSearchapplication GET /v1/stats/searchapplication
顧客の検索アプリケーションの統計情報を取得します。
getSession GET /v1/stats/session
顧客によるクリッククエリの統計情報とともに、検索セッションの数、成功したセッションの割合（%）を取得します。
getUser GET /v1/stats/user
お客様のユーザー統計情報を取得します。

REST リソース: v1.stats.index.datasources

Methods
get GET /v1/stats/index/{name=datasources/*}
1 つのデータソースのインデックス登録されたアイテムの統計情報を取得します。

REST リソース: v1.stats.query.searchapplications

Methods
get GET /v1/stats/query/{name=searchapplications/*}
検索アプリケーションのクエリ統計情報を取得します。

REST リソース: v1.stats.session.searchapplications

Methods
get GET /v1/stats/session/{name=searchapplications/*}
検索アプリケーションのクリック クエリ統計情報とともに、検索セッションの数、成功したセッションの割合（%）を取得します。

REST リソース: v1.stats.user.searchapplications

Methods
get GET /v1/stats/user/{name=searchapplications/*}
検索アプリケーションのユーザー統計情報を取得します。