You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/dyn/analyticsdata_v1beta.properties.html
+50
Original file line number
Diff line number
Diff line change
@@ -329,6 +329,17 @@ <h3>Method Details</h3>
329
329
"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report.
330
330
"currencyCode": "A String", # The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179.
331
331
"dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.
332
+
"emptyReason": "A String", # If empty reason is specified, the report is empty for this reason.
333
+
"schemaRestrictionResponse": { # The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). # Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).
334
+
"activeMetricRestrictions": [ # All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's custom role disallows access to `REVENUE_DATA`.
335
+
{ # A metric actively restricted in creating the report.
336
+
"metricName": "A String", # The name of the restricted metric.
337
+
"restrictedMetricTypes": [ # The reason for this metric's restriction.
338
+
"A String",
339
+
],
340
+
},
341
+
],
342
+
},
332
343
"timeZone": "A String", # The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
333
344
},
334
345
"metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
@@ -615,6 +626,17 @@ <h3>Method Details</h3>
615
626
"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report.
616
627
"currencyCode": "A String", # The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179.
617
628
"dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.
629
+
"emptyReason": "A String", # If empty reason is specified, the report is empty for this reason.
630
+
"schemaRestrictionResponse": { # The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). # Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).
631
+
"activeMetricRestrictions": [ # All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's custom role disallows access to `REVENUE_DATA`.
632
+
{ # A metric actively restricted in creating the report.
633
+
"metricName": "A String", # The name of the restricted metric.
634
+
"restrictedMetricTypes": [ # The reason for this metric's restriction.
635
+
"A String",
636
+
],
637
+
},
638
+
],
639
+
},
618
640
"timeZone": "A String", # The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
619
641
},
620
642
"metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
@@ -849,6 +871,9 @@ <h3>Method Details</h3>
849
871
"compatibility": "A String", # The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report.
850
872
"metricMetadata": { # Explains a metric. # The metric metadata contains the API name for this compatibility information. The metric metadata also contains other helpful information like the UI name and description.
851
873
"apiName": "A String", # A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.
874
+
"blockedReasons": [ # If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).
875
+
"A String",
876
+
],
852
877
"category": "A String", # The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.
853
878
"customDefinition": True or False, # True if the metric is a custom metric for this property.
854
879
"deprecatedApiNames": [ # Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`.
@@ -899,6 +924,9 @@ <h3>Method Details</h3>
899
924
"metrics": [ # The metric descriptions.
900
925
{ # Explains a metric.
901
926
"apiName": "A String", # A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.
927
+
"blockedReasons": [ # If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).
928
+
"A String",
929
+
],
902
930
"category": "A String", # The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.
903
931
"customDefinition": True or False, # True if the metric is a custom metric for this property.
904
932
"deprecatedApiNames": [ # Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`.
@@ -1137,6 +1165,17 @@ <h3>Method Details</h3>
1137
1165
"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report.
1138
1166
"currencyCode": "A String", # The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179.
1139
1167
"dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.
1168
+
"emptyReason": "A String", # If empty reason is specified, the report is empty for this reason.
1169
+
"schemaRestrictionResponse": { # The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). # Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).
1170
+
"activeMetricRestrictions": [ # All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's custom role disallows access to `REVENUE_DATA`.
1171
+
{ # A metric actively restricted in creating the report.
1172
+
"metricName": "A String", # The name of the restricted metric.
1173
+
"restrictedMetricTypes": [ # The reason for this metric's restriction.
1174
+
"A String",
1175
+
],
1176
+
},
1177
+
],
1178
+
},
1140
1179
"timeZone": "A String", # The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
1141
1180
},
1142
1181
"metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
@@ -1676,6 +1715,17 @@ <h3>Method Details</h3>
1676
1715
"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report.
1677
1716
"currencyCode": "A String", # The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179.
1678
1717
"dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.
1718
+
"emptyReason": "A String", # If empty reason is specified, the report is empty for this reason.
1719
+
"schemaRestrictionResponse": { # The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). # Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).
1720
+
"activeMetricRestrictions": [ # All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's custom role disallows access to `REVENUE_DATA`.
1721
+
{ # A metric actively restricted in creating the report.
1722
+
"metricName": "A String", # The name of the restricted metric.
1723
+
"restrictedMetricTypes": [ # The reason for this metric's restriction.
1724
+
"A String",
1725
+
],
1726
+
},
1727
+
],
1728
+
},
1679
1729
"timeZone": "A String", # The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
1680
1730
},
1681
1731
"metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
"description": "A metric actively restricted in creating the report.",
321
+
"id": "ActiveMetricRestriction",
322
+
"properties": {
323
+
"metricName": {
324
+
"description": "The name of the restricted metric.",
325
+
"type": "string"
326
+
},
327
+
"restrictedMetricTypes": {
328
+
"description": "The reason for this metric's restriction.",
329
+
"items": {
330
+
"enum": [
331
+
"RESTRICTED_METRIC_TYPE_UNSPECIFIED",
332
+
"COST_DATA",
333
+
"REVENUE_DATA"
334
+
],
335
+
"enumDescriptions": [
336
+
"Unspecified type.",
337
+
"Cost metrics such as `adCost`.",
338
+
"Revenue metrics such as `purchaseRevenue`."
339
+
],
340
+
"type": "string"
341
+
},
342
+
"type": "array"
343
+
}
344
+
},
345
+
"type": "object"
346
+
},
319
347
"BatchRunPivotReportsRequest": {
320
348
"description": "The batch request containing multiple pivot report requests.",
321
349
"id": "BatchRunPivotReportsRequest",
@@ -938,6 +966,23 @@
938
966
"description": "A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.",
939
967
"type": "string"
940
968
},
969
+
"blockedReasons": {
970
+
"description": "If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).",
971
+
"items": {
972
+
"enum": [
973
+
"BLOCKED_REASON_UNSPECIFIED",
974
+
"NO_REVENUE_METRICS",
975
+
"NO_COST_METRICS"
976
+
],
977
+
"enumDescriptions": [
978
+
"Will never be specified in API response.",
979
+
"If present, your access is blocked to revenue related metrics for this property, and this metric is revenue related.",
980
+
"If present, your access is blocked to cost related metrics for this property, and this metric is cost related."
981
+
],
982
+
"type": "string"
983
+
},
984
+
"type": "array"
985
+
},
941
986
"category": {
942
987
"description": "The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.",
943
988
"type": "string"
@@ -1290,6 +1335,14 @@
1290
1335
"description": "If true, indicates some buckets of dimension combinations are rolled into \"(other)\" row. This can happen for high cardinality reports.",
1291
1336
"type": "boolean"
1292
1337
},
1338
+
"emptyReason": {
1339
+
"description": "If empty reason is specified, the report is empty for this reason.",
1340
+
"type": "string"
1341
+
},
1342
+
"schemaRestrictionResponse": {
1343
+
"$ref": "SchemaRestrictionResponse",
1344
+
"description": "Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388)."
1345
+
},
1293
1346
"timeZone": {
1294
1347
"description": "The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example \"America/New_York\" or \"Asia/Tokyo\".",
1295
1348
"type": "string"
@@ -1730,6 +1783,20 @@
1730
1783
},
1731
1784
"type": "object"
1732
1785
},
1786
+
"SchemaRestrictionResponse": {
1787
+
"description": "The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).",
1788
+
"id": "SchemaRestrictionResponse",
1789
+
"properties": {
1790
+
"activeMetricRestrictions": {
1791
+
"description": "All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's custom role disallows access to `REVENUE_DATA`.",
0 commit comments