Method: projects.databases.collectionGroups.indexes.create

複合インデックスを作成します。これにより、作成のステータスを追跡するために使用できるgoogle.longrunning.Operationが返されます。操作のメタデータはIndexOperationMetadataタイプになります。

HTTPリクエスト

POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
parent

string

必須。 projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}形式の親名

リクエストボディ

リクエストの本文にはIndexのインスタンスが含まれます。

レスポンスボディ

成功した場合、応答本文には新しく作成されたOperationのインスタンスが含まれます。

認可範囲

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

詳細については、 「認証の概要」を参照してください。