Cloud Firestore API (firestore:v1beta1)

2022-05-09

1 new method

Additions

    Methods
  • firestore.projects.databases.documents.runAggregationQuery

      Path : v1beta1/{+parent}:runAggregationQuery

      HTTP Method : POST

      Parameter Order : parent

      Description : Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example: ``` -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true ); ```

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/datastore
    • Flat Path : v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runAggregationQuery

      Parameters :

        parent

          Type : string

          Location : path

          Description : Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

          Required : Yes

          Pattern : ^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$