Optional. Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format field_<incremental_id++>. For example: AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) OVER ( ... ); becomes: AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS field_2 OVER ( ... ); Requires: * * Must be unique across all aggregation aliases. * * Conform to document field name limitations.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class Aggregation (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.StructuredAggregationQuery.Aggregation)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.StructuredAggregationQuery.Aggregation)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.StructuredAggregationQuery.Aggregation)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.StructuredAggregationQuery.Aggregation)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.StructuredAggregationQuery.Aggregation)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.StructuredAggregationQuery.Aggregation)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.StructuredAggregationQuery.Aggregation)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.StructuredAggregationQuery.Aggregation)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.StructuredAggregationQuery.Aggregation)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.StructuredAggregationQuery.Aggregation) \nReference documentation and code samples for the Cloud Firestore V1 Client class Aggregation.\n\nDefines an aggregation that produces a single result.\n\nGenerated from protobuf message `google.firestore.v1.StructuredAggregationQuery.Aggregation`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1 \\\\ StructuredAggregationQuery\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCount\n\nCount aggregator.\n\n### hasCount\n\n### setCount\n\nCount aggregator.\n\n### getSum\n\nSum aggregator.\n\n### hasSum\n\n### setSum\n\nSum aggregator.\n\n### getAvg\n\nAverage aggregator.\n\n### hasAvg\n\n### setAvg\n\nAverage aggregator.\n\n### getAlias\n\nOptional. Optional name of the field to store the result of the\naggregation into.\n\nIf not provided, Firestore will pick a default name following the format\n`field_\u003cincremental_id++\u003e`. For example: \n\n AGGREGATE\n COUNT_UP_TO(1) AS count_up_to_1,\n COUNT_UP_TO(2),\n COUNT_UP_TO(3) AS count_up_to_3,\n COUNT(*)\n OVER (\n ...\n );\n\nbecomes: \n\n AGGREGATE\n COUNT_UP_TO(1) AS count_up_to_1,\n COUNT_UP_TO(2) AS field_1,\n COUNT_UP_TO(3) AS count_up_to_3,\n COUNT(*) AS field_2\n OVER (\n ...\n );\n\nRequires:\n\n- Must be unique across all aggregation aliases.\n- Conform to [document field name](/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getFields__) limitations.\n\n### setAlias\n\nOptional. Optional name of the field to store the result of the\naggregation into.\n\nIf not provided, Firestore will pick a default name following the format\n`field_\u003cincremental_id++\u003e`. For example: \n\n AGGREGATE\n COUNT_UP_TO(1) AS count_up_to_1,\n COUNT_UP_TO(2),\n COUNT_UP_TO(3) AS count_up_to_3,\n COUNT(*)\n OVER (\n ...\n );\n\nbecomes: \n\n AGGREGATE\n COUNT_UP_TO(1) AS count_up_to_1,\n COUNT_UP_TO(2) AS field_1,\n COUNT_UP_TO(3) AS count_up_to_3,\n COUNT(*) AS field_2\n OVER (\n ...\n );\n\nRequires:\n\n- Must be unique across all aggregation aliases.\n- Conform to [document field name](/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getFields__) limitations.\n\n### getOperator"]]
