|
1775 | 1775 | }
|
1776 | 1776 | }
|
1777 | 1777 | },
|
| 1778 | + "calculatedMetrics": { |
| 1779 | + "methods": { |
| 1780 | + "create": { |
| 1781 | + "description": "Creates a CalculatedMetric.", |
| 1782 | + "flatPath": "v1alpha/properties/{propertiesId}/calculatedMetrics", |
| 1783 | + "httpMethod": "POST", |
| 1784 | + "id": "analyticsadmin.properties.calculatedMetrics.create", |
| 1785 | + "parameterOrder": [ |
| 1786 | + "parent" |
| 1787 | + ], |
| 1788 | + "parameters": { |
| 1789 | + "calculatedMetricId": { |
| 1790 | + "description": "Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name. This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, \"calcMetric:{calculated_metric_id}\".", |
| 1791 | + "location": "query", |
| 1792 | + "type": "string" |
| 1793 | + }, |
| 1794 | + "parent": { |
| 1795 | + "description": "Required. Format: properties/{property_id} Example: properties/1234", |
| 1796 | + "location": "path", |
| 1797 | + "pattern": "^properties/[^/]+$", |
| 1798 | + "required": true, |
| 1799 | + "type": "string" |
| 1800 | + } |
| 1801 | + }, |
| 1802 | + "path": "v1alpha/{+parent}/calculatedMetrics", |
| 1803 | + "request": { |
| 1804 | + "$ref": "GoogleAnalyticsAdminV1alphaCalculatedMetric" |
| 1805 | + }, |
| 1806 | + "response": { |
| 1807 | + "$ref": "GoogleAnalyticsAdminV1alphaCalculatedMetric" |
| 1808 | + }, |
| 1809 | + "scopes": [ |
| 1810 | + "https://www.googleapis.com/auth/analytics.edit" |
| 1811 | + ] |
| 1812 | + }, |
| 1813 | + "delete": { |
| 1814 | + "description": "Deletes a CalculatedMetric on a property.", |
| 1815 | + "flatPath": "v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}", |
| 1816 | + "httpMethod": "DELETE", |
| 1817 | + "id": "analyticsadmin.properties.calculatedMetrics.delete", |
| 1818 | + "parameterOrder": [ |
| 1819 | + "name" |
| 1820 | + ], |
| 1821 | + "parameters": { |
| 1822 | + "name": { |
| 1823 | + "description": "Required. The name of the CalculatedMetric to delete. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01", |
| 1824 | + "location": "path", |
| 1825 | + "pattern": "^properties/[^/]+/calculatedMetrics/[^/]+$", |
| 1826 | + "required": true, |
| 1827 | + "type": "string" |
| 1828 | + } |
| 1829 | + }, |
| 1830 | + "path": "v1alpha/{+name}", |
| 1831 | + "response": { |
| 1832 | + "$ref": "GoogleProtobufEmpty" |
| 1833 | + }, |
| 1834 | + "scopes": [ |
| 1835 | + "https://www.googleapis.com/auth/analytics.edit" |
| 1836 | + ] |
| 1837 | + }, |
| 1838 | + "get": { |
| 1839 | + "description": "Lookup for a single CalculatedMetric.", |
| 1840 | + "flatPath": "v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}", |
| 1841 | + "httpMethod": "GET", |
| 1842 | + "id": "analyticsadmin.properties.calculatedMetrics.get", |
| 1843 | + "parameterOrder": [ |
| 1844 | + "name" |
| 1845 | + ], |
| 1846 | + "parameters": { |
| 1847 | + "name": { |
| 1848 | + "description": "Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01", |
| 1849 | + "location": "path", |
| 1850 | + "pattern": "^properties/[^/]+/calculatedMetrics/[^/]+$", |
| 1851 | + "required": true, |
| 1852 | + "type": "string" |
| 1853 | + } |
| 1854 | + }, |
| 1855 | + "path": "v1alpha/{+name}", |
| 1856 | + "response": { |
| 1857 | + "$ref": "GoogleAnalyticsAdminV1alphaCalculatedMetric" |
| 1858 | + }, |
| 1859 | + "scopes": [ |
| 1860 | + "https://www.googleapis.com/auth/analytics.edit", |
| 1861 | + "https://www.googleapis.com/auth/analytics.readonly" |
| 1862 | + ] |
| 1863 | + }, |
| 1864 | + "list": { |
| 1865 | + "description": "Lists CalculatedMetrics on a property.", |
| 1866 | + "flatPath": "v1alpha/properties/{propertiesId}/calculatedMetrics", |
| 1867 | + "httpMethod": "GET", |
| 1868 | + "id": "analyticsadmin.properties.calculatedMetrics.list", |
| 1869 | + "parameterOrder": [ |
| 1870 | + "parent" |
| 1871 | + ], |
| 1872 | + "parameters": { |
| 1873 | + "pageSize": { |
| 1874 | + "description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", |
| 1875 | + "format": "int32", |
| 1876 | + "location": "query", |
| 1877 | + "type": "integer" |
| 1878 | + }, |
| 1879 | + "pageToken": { |
| 1880 | + "description": "Optional. A page token, received from a previous `ListCalculatedMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCalculatedMetrics` must match the call that provided the page token.", |
| 1881 | + "location": "query", |
| 1882 | + "type": "string" |
| 1883 | + }, |
| 1884 | + "parent": { |
| 1885 | + "description": "Required. Example format: properties/1234", |
| 1886 | + "location": "path", |
| 1887 | + "pattern": "^properties/[^/]+$", |
| 1888 | + "required": true, |
| 1889 | + "type": "string" |
| 1890 | + } |
| 1891 | + }, |
| 1892 | + "path": "v1alpha/{+parent}/calculatedMetrics", |
| 1893 | + "response": { |
| 1894 | + "$ref": "GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse" |
| 1895 | + }, |
| 1896 | + "scopes": [ |
| 1897 | + "https://www.googleapis.com/auth/analytics.edit", |
| 1898 | + "https://www.googleapis.com/auth/analytics.readonly" |
| 1899 | + ] |
| 1900 | + }, |
| 1901 | + "patch": { |
| 1902 | + "description": "Updates a CalculatedMetric on a property.", |
| 1903 | + "flatPath": "v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}", |
| 1904 | + "httpMethod": "PATCH", |
| 1905 | + "id": "analyticsadmin.properties.calculatedMetrics.patch", |
| 1906 | + "parameterOrder": [ |
| 1907 | + "name" |
| 1908 | + ], |
| 1909 | + "parameters": { |
| 1910 | + "name": { |
| 1911 | + "description": "Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'", |
| 1912 | + "location": "path", |
| 1913 | + "pattern": "^properties/[^/]+/calculatedMetrics/[^/]+$", |
| 1914 | + "required": true, |
| 1915 | + "type": "string" |
| 1916 | + }, |
| 1917 | + "updateMask": { |
| 1918 | + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", |
| 1919 | + "format": "google-fieldmask", |
| 1920 | + "location": "query", |
| 1921 | + "type": "string" |
| 1922 | + } |
| 1923 | + }, |
| 1924 | + "path": "v1alpha/{+name}", |
| 1925 | + "request": { |
| 1926 | + "$ref": "GoogleAnalyticsAdminV1alphaCalculatedMetric" |
| 1927 | + }, |
| 1928 | + "response": { |
| 1929 | + "$ref": "GoogleAnalyticsAdminV1alphaCalculatedMetric" |
| 1930 | + }, |
| 1931 | + "scopes": [ |
| 1932 | + "https://www.googleapis.com/auth/analytics.edit" |
| 1933 | + ] |
| 1934 | + } |
| 1935 | + } |
| 1936 | + }, |
1778 | 1937 | "channelGroups": {
|
1779 | 1938 | "methods": {
|
1780 | 1939 | "create": {
|
|
4298 | 4457 | }
|
4299 | 4458 | }
|
4300 | 4459 | },
|
4301 |
| - "revision": "20240105", |
| 4460 | + "revision": "20240115", |
4302 | 4461 | "rootUrl": "https://analyticsadmin.googleapis.com/",
|
4303 | 4462 | "schemas": {
|
4304 | 4463 | "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": {
|
|
5444 | 5603 | },
|
5445 | 5604 | "type": "object"
|
5446 | 5605 | },
|
| 5606 | + "GoogleAnalyticsAdminV1alphaCalculatedMetric": { |
| 5607 | + "description": "A definition for a calculated metric.", |
| 5608 | + "id": "GoogleAnalyticsAdminV1alphaCalculatedMetric", |
| 5609 | + "properties": { |
| 5610 | + "calculatedMetricId": { |
| 5611 | + "description": "Output only. The ID to use for the calculated metric. In the UI, this is referred to as the \"API name.\" The calculated_metric_id is used when referencing this calculated metric from external APIs. For example, \"calcMetric:{calculated_metric_id}\".", |
| 5612 | + "readOnly": true, |
| 5613 | + "type": "string" |
| 5614 | + }, |
| 5615 | + "description": { |
| 5616 | + "description": "Optional. Description for this calculated metric. Max length of 4096 characters.", |
| 5617 | + "type": "string" |
| 5618 | + }, |
| 5619 | + "displayName": { |
| 5620 | + "description": "Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.", |
| 5621 | + "type": "string" |
| 5622 | + }, |
| 5623 | + "formula": { |
| 5624 | + "description": "Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: \"( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0\"", |
| 5625 | + "type": "string" |
| 5626 | + }, |
| 5627 | + "invalidMetricReference": { |
| 5628 | + "description": "Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results.", |
| 5629 | + "readOnly": true, |
| 5630 | + "type": "boolean" |
| 5631 | + }, |
| 5632 | + "metricUnit": { |
| 5633 | + "description": "Required. The type for the calculated metric's value.", |
| 5634 | + "enum": [ |
| 5635 | + "METRIC_UNIT_UNSPECIFIED", |
| 5636 | + "STANDARD", |
| 5637 | + "CURRENCY", |
| 5638 | + "FEET", |
| 5639 | + "MILES", |
| 5640 | + "METERS", |
| 5641 | + "KILOMETERS", |
| 5642 | + "MILLISECONDS", |
| 5643 | + "SECONDS", |
| 5644 | + "MINUTES", |
| 5645 | + "HOURS" |
| 5646 | + ], |
| 5647 | + "enumDescriptions": [ |
| 5648 | + "MetricUnit unspecified or missing.", |
| 5649 | + "This metric uses default units.", |
| 5650 | + "This metric measures a currency.", |
| 5651 | + "This metric measures feet.", |
| 5652 | + "This metric measures miles.", |
| 5653 | + "This metric measures meters.", |
| 5654 | + "This metric measures kilometers.", |
| 5655 | + "This metric measures milliseconds.", |
| 5656 | + "This metric measures seconds.", |
| 5657 | + "This metric measures minutes.", |
| 5658 | + "This metric measures hours." |
| 5659 | + ], |
| 5660 | + "type": "string" |
| 5661 | + }, |
| 5662 | + "name": { |
| 5663 | + "description": "Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'", |
| 5664 | + "readOnly": true, |
| 5665 | + "type": "string" |
| 5666 | + }, |
| 5667 | + "restrictedMetricType": { |
| 5668 | + "description": "Output only. Types of restricted data that this metric contains.", |
| 5669 | + "items": { |
| 5670 | + "enum": [ |
| 5671 | + "RESTRICTED_METRIC_TYPE_UNSPECIFIED", |
| 5672 | + "COST_DATA", |
| 5673 | + "REVENUE_DATA" |
| 5674 | + ], |
| 5675 | + "enumDescriptions": [ |
| 5676 | + "Type unknown or unspecified.", |
| 5677 | + "Metric reports cost data.", |
| 5678 | + "Metric reports revenue data." |
| 5679 | + ], |
| 5680 | + "type": "string" |
| 5681 | + }, |
| 5682 | + "readOnly": true, |
| 5683 | + "type": "array" |
| 5684 | + } |
| 5685 | + }, |
| 5686 | + "type": "object" |
| 5687 | + }, |
5447 | 5688 | "GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest": {
|
5448 | 5689 | "description": "Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.",
|
5449 | 5690 | "id": "GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest",
|
|
5509 | 5750 | "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink",
|
5510 | 5751 | "description": "A snapshot of a BigQuery link resource in change history."
|
5511 | 5752 | },
|
| 5753 | + "calculatedMetric": { |
| 5754 | + "$ref": "GoogleAnalyticsAdminV1alphaCalculatedMetric", |
| 5755 | + "description": "A snapshot of a CalculatedMetric resource in change history." |
| 5756 | + }, |
5512 | 5757 | "channelGroup": {
|
5513 | 5758 | "$ref": "GoogleAnalyticsAdminV1alphaChannelGroup",
|
5514 | 5759 | "description": "A snapshot of a ChannelGroup resource in change history."
|
|
7019 | 7264 | },
|
7020 | 7265 | "type": "object"
|
7021 | 7266 | },
|
| 7267 | + "GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse": { |
| 7268 | + "description": "Response message for ListCalculatedMetrics RPC.", |
| 7269 | + "id": "GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse", |
| 7270 | + "properties": { |
| 7271 | + "calculatedMetrics": { |
| 7272 | + "description": "List of CalculatedMetrics.", |
| 7273 | + "items": { |
| 7274 | + "$ref": "GoogleAnalyticsAdminV1alphaCalculatedMetric" |
| 7275 | + }, |
| 7276 | + "type": "array" |
| 7277 | + }, |
| 7278 | + "nextPageToken": { |
| 7279 | + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", |
| 7280 | + "type": "string" |
| 7281 | + } |
| 7282 | + }, |
| 7283 | + "type": "object" |
| 7284 | + }, |
7022 | 7285 | "GoogleAnalyticsAdminV1alphaListChannelGroupsResponse": {
|
7023 | 7286 | "description": "Response message for ListChannelGroups RPC.",
|
7024 | 7287 | "id": "GoogleAnalyticsAdminV1alphaListChannelGroupsResponse",
|
|
7955 | 8218 | "SKADNETWORK_CONVERSION_VALUE_SCHEMA",
|
7956 | 8219 | "ADSENSE_LINK",
|
7957 | 8220 | "AUDIENCE",
|
7958 |
| - "EVENT_CREATE_RULE" |
| 8221 | + "EVENT_CREATE_RULE", |
| 8222 | + "CALCULATED_METRIC" |
7959 | 8223 | ],
|
7960 | 8224 | "enumDescriptions": [
|
7961 | 8225 | "Resource type unknown or not specified.",
|
|
7981 | 8245 | "SKAdNetworkConversionValueSchema resource",
|
7982 | 8246 | "AdSenseLink resource",
|
7983 | 8247 | "Audience resource",
|
7984 |
| - "EventCreateRule resource" |
| 8248 | + "EventCreateRule resource", |
| 8249 | + "CalculatedMetric resource" |
7985 | 8250 | ],
|
7986 | 8251 | "type": "string"
|
7987 | 8252 | },
|
|
0 commit comments