Method: projects.databases.collectionGroups.fields.get

Gets the metadata and configuration for a Field.

HTTP request

GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. A name of the form projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{field_id}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Field.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.