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

メソッド
initializeCustomer POST /v1:initializeCustomer
Google Cloud Search で third party のサポートを有効にします。

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

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

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

メソッド
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
特定のアイテムの未マッピングの ID をすべて一覧表示します。

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

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

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

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

REST リソース: v1.indexing.datasources

メソッド
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

メソッド
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

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

REST リソース: v1.operations

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

REST リソース: v1.query

メソッド
debugSearch POST /v1/query:debugSearch
Cloud Search Query API のデバッグ情報を返します。検索メソッドを提供します。
removeActivity POST /v1/query:removeActivity
ユーザーのログに記録されたアクティビティを削除する機能を提供します。
search POST /v1/query/search
Cloud Search Query API には、ユーザーのクエリから最も関連性の高い結果を返す search メソッドが用意されています。
suggest POST /v1/query/suggest
クエリのオートコンプリート候補を提供します。

REST リソース: v1.query.sources

メソッド
list GET /v1/query/sources
ユーザーが Search API と Suggest API で使用できるソースのリストを返します。

REST リソース: v1.settings

メソッド
getCustomer GET /v1/settings/customer
顧客設定を取得します。
updateCustomer PATCH /v1/settings/customer
お客様の設定を更新します。

REST リソース: v1.settings.datasources

メソッド
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

メソッド
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

メソッド
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

メソッド
get GET /v1/stats/index/{name=datasources/*}
単一のデータソースのインデックス登録済みアイテムの統計情報を取得します。

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

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

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

メソッド
get GET /v1/stats/session/{name=searchapplications/*}
検索アプリケーションの検索セッション数、クリック クエリ統計情報を含む成功したセッションの割合を取得します。

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

メソッド
get GET /v1/stats/user/{name=searchapplications/*}
検索アプリのユーザー統計情報を取得します。