diff --git a/AnalyticsData/metadata/V1Beta/Data.php b/AnalyticsData/metadata/V1Beta/Data.php index 5001f44249ba..1ffc46acca50 100644 Binary files a/AnalyticsData/metadata/V1Beta/Data.php and b/AnalyticsData/metadata/V1Beta/Data.php differ diff --git a/AnalyticsData/src/V1beta/BetaAnalyticsDataGrpcClient.php b/AnalyticsData/src/V1beta/BetaAnalyticsDataGrpcClient.php index afe075428dc8..b2e157ae4acf 100644 --- a/AnalyticsData/src/V1beta/BetaAnalyticsDataGrpcClient.php +++ b/AnalyticsData/src/V1beta/BetaAnalyticsDataGrpcClient.php @@ -40,6 +40,10 @@ public function __construct($hostname, $opts, $channel = null) { * measurements of user activity on your property, such as active users or * event count. Dimensions break down metrics across some common criteria, * such as country or event name. + * + * For a guide to constructing requests & understanding responses, see + * [Creating a + * Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). * @param \Google\Analytics\Data\V1beta\RunReportRequest $argument input argument * @param array $metadata metadata * @param array $options call options @@ -129,9 +133,15 @@ public function GetMetadata(\Google\Analytics\Data\V1beta\GetMetadataRequest $ar } /** - * The Google Analytics Realtime API returns a customized report of realtime - * event data for your property. These reports show events and usage from the - * last 30 minutes. + * Returns a customized report of realtime event data for your property. + * Events appear in realtime reports seconds after they have been sent to + * the Google Analytics. Realtime reports show events and usage data for the + * periods of time ranging from the present moment to 30 minutes ago (up to + * 60 minutes for Google Analytics 360 properties). + * + * For a guide to constructing realtime requests & understanding responses, + * see [Creating a Realtime + * Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics). * @param \Google\Analytics\Data\V1beta\RunRealtimeReportRequest $argument input argument * @param array $metadata metadata * @param array $options call options diff --git a/AnalyticsData/src/V1beta/Dimension.php b/AnalyticsData/src/V1beta/Dimension.php index 93a1017e240f..4f67e5740a7b 100644 --- a/AnalyticsData/src/V1beta/Dimension.php +++ b/AnalyticsData/src/V1beta/Dimension.php @@ -11,7 +11,7 @@ /** * Dimensions are attributes of your data. For example, the dimension city * indicates the city from which an event originates. Dimension values in report - * responses are strings; for example, city could be "Paris" or "New York". + * responses are strings; for example, the city could be "Paris" or "New York". * Requests are allowed up to 9 dimensions. * * Generated from protobuf message google.analytics.data.v1beta.Dimension diff --git a/AnalyticsData/src/V1beta/Filter.php b/AnalyticsData/src/V1beta/Filter.php index 22dc93d42d05..1f3f91fd1630 100644 --- a/AnalyticsData/src/V1beta/Filter.php +++ b/AnalyticsData/src/V1beta/Filter.php @@ -16,8 +16,11 @@ class Filter extends \Google\Protobuf\Internal\Message { /** - * The dimension name or metric name. Must be a name defined in dimensions - * or metrics. + * The dimension name or metric name. + * In most methods, dimensions & metrics can be used for the first time in + * this field. However in a RunPivotReportRequest, this field must be + * additionally specified by name in the RunPivotReportRequest's dimensions or + * metrics. * * Generated from protobuf field string field_name = 1; */ @@ -31,8 +34,11 @@ class Filter extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $field_name - * The dimension name or metric name. Must be a name defined in dimensions - * or metrics. + * The dimension name or metric name. + * In most methods, dimensions & metrics can be used for the first time in + * this field. However in a RunPivotReportRequest, this field must be + * additionally specified by name in the RunPivotReportRequest's dimensions or + * metrics. * @type \Google\Analytics\Data\V1beta\Filter\StringFilter $string_filter * Strings related filter. * @type \Google\Analytics\Data\V1beta\Filter\InListFilter $in_list_filter @@ -49,8 +55,11 @@ public function __construct($data = NULL) { } /** - * The dimension name or metric name. Must be a name defined in dimensions - * or metrics. + * The dimension name or metric name. + * In most methods, dimensions & metrics can be used for the first time in + * this field. However in a RunPivotReportRequest, this field must be + * additionally specified by name in the RunPivotReportRequest's dimensions or + * metrics. * * Generated from protobuf field string field_name = 1; * @return string @@ -61,8 +70,11 @@ public function getFieldName() } /** - * The dimension name or metric name. Must be a name defined in dimensions - * or metrics. + * The dimension name or metric name. + * In most methods, dimensions & metrics can be used for the first time in + * this field. However in a RunPivotReportRequest, this field must be + * additionally specified by name in the RunPivotReportRequest's dimensions or + * metrics. * * Generated from protobuf field string field_name = 1; * @param string $var diff --git a/AnalyticsData/src/V1beta/Filter/StringFilter/MatchType.php b/AnalyticsData/src/V1beta/Filter/StringFilter/MatchType.php index f2425056f8dd..e8c116345db8 100644 --- a/AnalyticsData/src/V1beta/Filter/StringFilter/MatchType.php +++ b/AnalyticsData/src/V1beta/Filter/StringFilter/MatchType.php @@ -44,13 +44,13 @@ class MatchType */ const CONTAINS = 4; /** - * Full regular expression match with the string value. + * Full match for the regular expression with the string value. * * Generated from protobuf enum FULL_REGEXP = 5; */ const FULL_REGEXP = 5; /** - * Partial regular expression match with the string value. + * Partial match for the regular expression with the string value. * * Generated from protobuf enum PARTIAL_REGEXP = 6; */ diff --git a/AnalyticsData/src/V1beta/FilterExpression.php b/AnalyticsData/src/V1beta/FilterExpression.php index 20503b60517b..99e554d09c3e 100644 --- a/AnalyticsData/src/V1beta/FilterExpression.php +++ b/AnalyticsData/src/V1beta/FilterExpression.php @@ -9,9 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * To express dimension or metric filters. - * The fields in the same FilterExpression need to be either all dimensions or - * all metrics. + * To express dimension or metric filters. The fields in the same + * FilterExpression need to be either all dimensions or all metrics. * * Generated from protobuf message google.analytics.data.v1beta.FilterExpression */ @@ -32,9 +31,8 @@ class FilterExpression extends \Google\Protobuf\Internal\Message * @type \Google\Analytics\Data\V1beta\FilterExpression $not_expression * The FilterExpression is NOT of not_expression. * @type \Google\Analytics\Data\V1beta\Filter $filter - * A primitive filter. - * All fields in filter in same FilterExpression needs to be either all - * dimensions or metrics. + * A primitive filter. In the same FilterExpression, all of the filter's + * field names need to be either all dimensions or all metrics. * } */ public function __construct($data = NULL) { @@ -136,9 +134,8 @@ public function setNotExpression($var) } /** - * A primitive filter. - * All fields in filter in same FilterExpression needs to be either all - * dimensions or metrics. + * A primitive filter. In the same FilterExpression, all of the filter's + * field names need to be either all dimensions or all metrics. * * Generated from protobuf field .google.analytics.data.v1beta.Filter filter = 4; * @return \Google\Analytics\Data\V1beta\Filter|null @@ -154,9 +151,8 @@ public function hasFilter() } /** - * A primitive filter. - * All fields in filter in same FilterExpression needs to be either all - * dimensions or metrics. + * A primitive filter. In the same FilterExpression, all of the filter's + * field names need to be either all dimensions or all metrics. * * Generated from protobuf field .google.analytics.data.v1beta.Filter filter = 4; * @param \Google\Analytics\Data\V1beta\Filter $var diff --git a/AnalyticsData/src/V1beta/Gapic/BetaAnalyticsDataGapicClient.php b/AnalyticsData/src/V1beta/Gapic/BetaAnalyticsDataGapicClient.php index e3510c5f7fbf..91fbbf438097 100644 --- a/AnalyticsData/src/V1beta/Gapic/BetaAnalyticsDataGapicClient.php +++ b/AnalyticsData/src/V1beta/Gapic/BetaAnalyticsDataGapicClient.php @@ -759,9 +759,15 @@ public function runPivotReport(array $optionalArgs = []) } /** - * The Google Analytics Realtime API returns a customized report of realtime - * event data for your property. These reports show events and usage from the - * last 30 minutes. + * Returns a customized report of realtime event data for your property. + * Events appear in realtime reports seconds after they have been sent to + * the Google Analytics. Realtime reports show events and usage data for the + * periods of time ranging from the present moment to 30 minutes ago (up to + * 60 minutes for Google Analytics 360 properties). + * + * For a guide to constructing realtime requests & understanding responses, + * see [Creating a Realtime + * Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics). * * Sample code: * ``` @@ -788,12 +794,10 @@ public function runPivotReport(array $optionalArgs = []) * @type Metric[] $metrics * The metrics requested and displayed. * @type FilterExpression $dimensionFilter - * The filter clause of dimensions. Dimensions must be requested to be used in - * this filter. Metrics cannot be used in this filter. + * The filter clause of dimensions. Metrics cannot be used in this filter. * @type FilterExpression $metricFilter * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Metrics must be requested to be used in this filter. - * Dimensions cannot be used in this filter. + * SQL having-clause. Dimensions cannot be used in this filter. * @type int $limit * The number of rows to return. If unspecified, 10,000 rows are returned. The * API returns a maximum of 100,000 rows per request, no matter how many you @@ -903,6 +907,10 @@ public function runRealtimeReport(array $optionalArgs = []) * event count. Dimensions break down metrics across some common criteria, * such as country or event name. * + * For a guide to constructing requests & understanding responses, see + * [Creating a + * Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). + * * Sample code: * ``` * $betaAnalyticsDataClient = new BetaAnalyticsDataClient(); @@ -941,8 +949,8 @@ public function runRealtimeReport(array $optionalArgs = []) * Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) * for examples. Metrics cannot be used in this filter. * @type FilterExpression $metricFilter - * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Dimensions cannot be used in this filter. + * The filter clause of metrics. Applied after aggregating the report's rows, + * similar to SQL having-clause. Dimensions cannot be used in this filter. * @type int $offset * The row count of the start row. The first row is counted as row 0. * diff --git a/AnalyticsData/src/V1beta/MinuteRange.php b/AnalyticsData/src/V1beta/MinuteRange.php index c19cb24e15c6..5f4a576f6a3e 100644 --- a/AnalyticsData/src/V1beta/MinuteRange.php +++ b/AnalyticsData/src/V1beta/MinuteRange.php @@ -22,8 +22,8 @@ class MinuteRange extends \Google\Protobuf\Internal\Message * event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. * If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics * properties can request up to the last 30 minutes of event data - * (`startMinutesAgo <= 29`), and Google Analytics 360 properties can request - * up to the last 60 minutes of event data (`startMinutesAgo <= 59`). + * (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to + * the last 60 minutes of event data (`startMinutesAgo <= 59`). * * Generated from protobuf field optional int32 start_minutes_ago = 1; */ @@ -35,8 +35,8 @@ class MinuteRange extends \Google\Protobuf\Internal\Message * ago. * If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics * properties can request any minute in the last 30 minutes of event data - * (`endMinutesAgo <= 29`), and Google Analytics 360 properties can request - * any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). + * (`endMinutesAgo <= 29`), and 360 Analytics properties can request any + * minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). * * Generated from protobuf field optional int32 end_minutes_ago = 2; */ @@ -63,8 +63,8 @@ class MinuteRange extends \Google\Protobuf\Internal\Message * event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. * If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics * properties can request up to the last 30 minutes of event data - * (`startMinutesAgo <= 29`), and Google Analytics 360 properties can request - * up to the last 60 minutes of event data (`startMinutesAgo <= 59`). + * (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to + * the last 60 minutes of event data (`startMinutesAgo <= 59`). * @type int $end_minutes_ago * The inclusive end minute for the query as a number of minutes before now. * Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15` @@ -72,8 +72,8 @@ class MinuteRange extends \Google\Protobuf\Internal\Message * ago. * If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics * properties can request any minute in the last 30 minutes of event data - * (`endMinutesAgo <= 29`), and Google Analytics 360 properties can request - * any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). + * (`endMinutesAgo <= 29`), and 360 Analytics properties can request any + * minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). * @type string $name * Assigns a name to this minute range. The dimension `dateRange` is valued to * this name in a report response. If set, cannot begin with `date_range_` or @@ -92,8 +92,8 @@ public function __construct($data = NULL) { * event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. * If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics * properties can request up to the last 30 minutes of event data - * (`startMinutesAgo <= 29`), and Google Analytics 360 properties can request - * up to the last 60 minutes of event data (`startMinutesAgo <= 59`). + * (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to + * the last 60 minutes of event data (`startMinutesAgo <= 59`). * * Generated from protobuf field optional int32 start_minutes_ago = 1; * @return int @@ -119,8 +119,8 @@ public function clearStartMinutesAgo() * event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. * If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics * properties can request up to the last 30 minutes of event data - * (`startMinutesAgo <= 29`), and Google Analytics 360 properties can request - * up to the last 60 minutes of event data (`startMinutesAgo <= 59`). + * (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to + * the last 60 minutes of event data (`startMinutesAgo <= 59`). * * Generated from protobuf field optional int32 start_minutes_ago = 1; * @param int $var @@ -141,8 +141,8 @@ public function setStartMinutesAgo($var) * ago. * If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics * properties can request any minute in the last 30 minutes of event data - * (`endMinutesAgo <= 29`), and Google Analytics 360 properties can request - * any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). + * (`endMinutesAgo <= 29`), and 360 Analytics properties can request any + * minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). * * Generated from protobuf field optional int32 end_minutes_ago = 2; * @return int @@ -169,8 +169,8 @@ public function clearEndMinutesAgo() * ago. * If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics * properties can request any minute in the last 30 minutes of event data - * (`endMinutesAgo <= 29`), and Google Analytics 360 properties can request - * any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). + * (`endMinutesAgo <= 29`), and 360 Analytics properties can request any + * minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). * * Generated from protobuf field optional int32 end_minutes_ago = 2; * @param int $var diff --git a/AnalyticsData/src/V1beta/OrderBy.php b/AnalyticsData/src/V1beta/OrderBy.php index f9b70dc2774c..cc093cbfc73e 100644 --- a/AnalyticsData/src/V1beta/OrderBy.php +++ b/AnalyticsData/src/V1beta/OrderBy.php @@ -9,7 +9,9 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The sort options. + * Order bys define how rows will be sorted in the response. For example, + * ordering rows by descending event count is one ordering, and ordering rows by + * the event name string is a different ordering. * * Generated from protobuf message google.analytics.data.v1beta.OrderBy */ diff --git a/AnalyticsData/src/V1beta/PropertyQuota.php b/AnalyticsData/src/V1beta/PropertyQuota.php index dc454cd35c00..f114976a8d51 100644 --- a/AnalyticsData/src/V1beta/PropertyQuota.php +++ b/AnalyticsData/src/V1beta/PropertyQuota.php @@ -28,8 +28,8 @@ class PropertyQuota extends \Google\Protobuf\Internal\Message /** * Standard Analytics Properties can use up to 5,000 tokens per hour; * Analytics 360 Properties can use 50,000 tokens per hour. An API request - * consumes a single number of tokens, and that number is deducted from both - * the hourly and daily quotas. + * consumes a single number of tokens, and that number is deducted from all of + * the hourly, daily, and per project hourly quotas. * * Generated from protobuf field .google.analytics.data.v1beta.QuotaStatus tokens_per_hour = 2; */ @@ -58,6 +58,17 @@ class PropertyQuota extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.analytics.data.v1beta.QuotaStatus potentially_thresholded_requests_per_hour = 5; */ private $potentially_thresholded_requests_per_hour = null; + /** + * Analytics Properties can use up to 25% of their tokens per project per + * hour. This amounts to standard Analytics Properties can use up to 1,250 + * tokens per project per hour, and Analytics 360 Properties can use 12,500 + * tokens per project per hour. An API request consumes a single number of + * tokens, and that number is deducted from all of the hourly, daily, and per + * project hourly quotas. + * + * Generated from protobuf field .google.analytics.data.v1beta.QuotaStatus tokens_per_project_per_hour = 6; + */ + private $tokens_per_project_per_hour = null; /** * Constructor. @@ -72,8 +83,8 @@ class PropertyQuota extends \Google\Protobuf\Internal\Message * @type \Google\Analytics\Data\V1beta\QuotaStatus $tokens_per_hour * Standard Analytics Properties can use up to 5,000 tokens per hour; * Analytics 360 Properties can use 50,000 tokens per hour. An API request - * consumes a single number of tokens, and that number is deducted from both - * the hourly and daily quotas. + * consumes a single number of tokens, and that number is deducted from all of + * the hourly, daily, and per project hourly quotas. * @type \Google\Analytics\Data\V1beta\QuotaStatus $concurrent_requests * Standard Analytics Properties can send up to 10 concurrent requests; * Analytics 360 Properties can use up to 50 concurrent requests. @@ -86,6 +97,13 @@ class PropertyQuota extends \Google\Protobuf\Internal\Message * thresholded dimensions per hour. In a batch request, each report request * is individually counted for this quota if the request contains potentially * thresholded dimensions. + * @type \Google\Analytics\Data\V1beta\QuotaStatus $tokens_per_project_per_hour + * Analytics Properties can use up to 25% of their tokens per project per + * hour. This amounts to standard Analytics Properties can use up to 1,250 + * tokens per project per hour, and Analytics 360 Properties can use 12,500 + * tokens per project per hour. An API request consumes a single number of + * tokens, and that number is deducted from all of the hourly, daily, and per + * project hourly quotas. * } */ public function __construct($data = NULL) { @@ -136,8 +154,8 @@ public function setTokensPerDay($var) /** * Standard Analytics Properties can use up to 5,000 tokens per hour; * Analytics 360 Properties can use 50,000 tokens per hour. An API request - * consumes a single number of tokens, and that number is deducted from both - * the hourly and daily quotas. + * consumes a single number of tokens, and that number is deducted from all of + * the hourly, daily, and per project hourly quotas. * * Generated from protobuf field .google.analytics.data.v1beta.QuotaStatus tokens_per_hour = 2; * @return \Google\Analytics\Data\V1beta\QuotaStatus|null @@ -160,8 +178,8 @@ public function clearTokensPerHour() /** * Standard Analytics Properties can use up to 5,000 tokens per hour; * Analytics 360 Properties can use 50,000 tokens per hour. An API request - * consumes a single number of tokens, and that number is deducted from both - * the hourly and daily quotas. + * consumes a single number of tokens, and that number is deducted from all of + * the hourly, daily, and per project hourly quotas. * * Generated from protobuf field .google.analytics.data.v1beta.QuotaStatus tokens_per_hour = 2; * @param \Google\Analytics\Data\V1beta\QuotaStatus $var @@ -295,5 +313,51 @@ public function setPotentiallyThresholdedRequestsPerHour($var) return $this; } + /** + * Analytics Properties can use up to 25% of their tokens per project per + * hour. This amounts to standard Analytics Properties can use up to 1,250 + * tokens per project per hour, and Analytics 360 Properties can use 12,500 + * tokens per project per hour. An API request consumes a single number of + * tokens, and that number is deducted from all of the hourly, daily, and per + * project hourly quotas. + * + * Generated from protobuf field .google.analytics.data.v1beta.QuotaStatus tokens_per_project_per_hour = 6; + * @return \Google\Analytics\Data\V1beta\QuotaStatus|null + */ + public function getTokensPerProjectPerHour() + { + return $this->tokens_per_project_per_hour; + } + + public function hasTokensPerProjectPerHour() + { + return isset($this->tokens_per_project_per_hour); + } + + public function clearTokensPerProjectPerHour() + { + unset($this->tokens_per_project_per_hour); + } + + /** + * Analytics Properties can use up to 25% of their tokens per project per + * hour. This amounts to standard Analytics Properties can use up to 1,250 + * tokens per project per hour, and Analytics 360 Properties can use 12,500 + * tokens per project per hour. An API request consumes a single number of + * tokens, and that number is deducted from all of the hourly, daily, and per + * project hourly quotas. + * + * Generated from protobuf field .google.analytics.data.v1beta.QuotaStatus tokens_per_project_per_hour = 6; + * @param \Google\Analytics\Data\V1beta\QuotaStatus $var + * @return $this + */ + public function setTokensPerProjectPerHour($var) + { + GPBUtil::checkMessage($var, \Google\Analytics\Data\V1beta\QuotaStatus::class); + $this->tokens_per_project_per_hour = $var; + + return $this; + } + } diff --git a/AnalyticsData/src/V1beta/ResponseMetaData.php b/AnalyticsData/src/V1beta/ResponseMetaData.php index dcf234214061..35443c89e089 100644 --- a/AnalyticsData/src/V1beta/ResponseMetaData.php +++ b/AnalyticsData/src/V1beta/ResponseMetaData.php @@ -59,6 +59,19 @@ class ResponseMetaData extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string empty_reason = 7; */ private $empty_reason = null; + /** + * If `subjectToThresholding` is true, this report is subject to thresholding + * and only returns data that meets the minimum aggregation thresholds. It is + * possible for a request to be subject to thresholding thresholding and no + * data is absent from the report, and this happens when all data is above the + * thresholds. To learn more, see [Data + * thresholds](https://support.google.com/analytics/answer/9383630) and [About + * Demographics and + * Interests](https://support.google.com/analytics/answer/2799357). + * + * Generated from protobuf field optional bool subject_to_thresholding = 8; + */ + private $subject_to_thresholding = null; /** * Constructor. @@ -90,6 +103,15 @@ class ResponseMetaData extends \Google\Protobuf\Internal\Message * "America/New_York" or "Asia/Tokyo". * @type string $empty_reason * If empty reason is specified, the report is empty for this reason. + * @type bool $subject_to_thresholding + * If `subjectToThresholding` is true, this report is subject to thresholding + * and only returns data that meets the minimum aggregation thresholds. It is + * possible for a request to be subject to thresholding thresholding and no + * data is absent from the report, and this happens when all data is above the + * thresholds. To learn more, see [Data + * thresholds](https://support.google.com/analytics/answer/9383630) and [About + * Demographics and + * Interests](https://support.google.com/analytics/answer/2799357). * } */ public function __construct($data = NULL) { @@ -295,5 +317,55 @@ public function setEmptyReason($var) return $this; } + /** + * If `subjectToThresholding` is true, this report is subject to thresholding + * and only returns data that meets the minimum aggregation thresholds. It is + * possible for a request to be subject to thresholding thresholding and no + * data is absent from the report, and this happens when all data is above the + * thresholds. To learn more, see [Data + * thresholds](https://support.google.com/analytics/answer/9383630) and [About + * Demographics and + * Interests](https://support.google.com/analytics/answer/2799357). + * + * Generated from protobuf field optional bool subject_to_thresholding = 8; + * @return bool + */ + public function getSubjectToThresholding() + { + return isset($this->subject_to_thresholding) ? $this->subject_to_thresholding : false; + } + + public function hasSubjectToThresholding() + { + return isset($this->subject_to_thresholding); + } + + public function clearSubjectToThresholding() + { + unset($this->subject_to_thresholding); + } + + /** + * If `subjectToThresholding` is true, this report is subject to thresholding + * and only returns data that meets the minimum aggregation thresholds. It is + * possible for a request to be subject to thresholding thresholding and no + * data is absent from the report, and this happens when all data is above the + * thresholds. To learn more, see [Data + * thresholds](https://support.google.com/analytics/answer/9383630) and [About + * Demographics and + * Interests](https://support.google.com/analytics/answer/2799357). + * + * Generated from protobuf field optional bool subject_to_thresholding = 8; + * @param bool $var + * @return $this + */ + public function setSubjectToThresholding($var) + { + GPBUtil::checkBool($var); + $this->subject_to_thresholding = $var; + + return $this; + } + } diff --git a/AnalyticsData/src/V1beta/RunRealtimeReportRequest.php b/AnalyticsData/src/V1beta/RunRealtimeReportRequest.php index 4d006e39f90b..9251e3372713 100644 --- a/AnalyticsData/src/V1beta/RunRealtimeReportRequest.php +++ b/AnalyticsData/src/V1beta/RunRealtimeReportRequest.php @@ -38,16 +38,14 @@ class RunRealtimeReportRequest extends \Google\Protobuf\Internal\Message */ private $metrics; /** - * The filter clause of dimensions. Dimensions must be requested to be used in - * this filter. Metrics cannot be used in this filter. + * The filter clause of dimensions. Metrics cannot be used in this filter. * * Generated from protobuf field .google.analytics.data.v1beta.FilterExpression dimension_filter = 4; */ private $dimension_filter = null; /** * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Metrics must be requested to be used in this filter. - * Dimensions cannot be used in this filter. + * SQL having-clause. Dimensions cannot be used in this filter. * * Generated from protobuf field .google.analytics.data.v1beta.FilterExpression metric_filter = 5; */ @@ -113,12 +111,10 @@ class RunRealtimeReportRequest extends \Google\Protobuf\Internal\Message * @type array<\Google\Analytics\Data\V1beta\Metric>|\Google\Protobuf\Internal\RepeatedField $metrics * The metrics requested and displayed. * @type \Google\Analytics\Data\V1beta\FilterExpression $dimension_filter - * The filter clause of dimensions. Dimensions must be requested to be used in - * this filter. Metrics cannot be used in this filter. + * The filter clause of dimensions. Metrics cannot be used in this filter. * @type \Google\Analytics\Data\V1beta\FilterExpression $metric_filter * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Metrics must be requested to be used in this filter. - * Dimensions cannot be used in this filter. + * SQL having-clause. Dimensions cannot be used in this filter. * @type int|string $limit * The number of rows to return. If unspecified, 10,000 rows are returned. The * API returns a maximum of 100,000 rows per request, no matter how many you @@ -236,8 +232,7 @@ public function setMetrics($var) } /** - * The filter clause of dimensions. Dimensions must be requested to be used in - * this filter. Metrics cannot be used in this filter. + * The filter clause of dimensions. Metrics cannot be used in this filter. * * Generated from protobuf field .google.analytics.data.v1beta.FilterExpression dimension_filter = 4; * @return \Google\Analytics\Data\V1beta\FilterExpression|null @@ -258,8 +253,7 @@ public function clearDimensionFilter() } /** - * The filter clause of dimensions. Dimensions must be requested to be used in - * this filter. Metrics cannot be used in this filter. + * The filter clause of dimensions. Metrics cannot be used in this filter. * * Generated from protobuf field .google.analytics.data.v1beta.FilterExpression dimension_filter = 4; * @param \Google\Analytics\Data\V1beta\FilterExpression $var @@ -275,8 +269,7 @@ public function setDimensionFilter($var) /** * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Metrics must be requested to be used in this filter. - * Dimensions cannot be used in this filter. + * SQL having-clause. Dimensions cannot be used in this filter. * * Generated from protobuf field .google.analytics.data.v1beta.FilterExpression metric_filter = 5; * @return \Google\Analytics\Data\V1beta\FilterExpression|null @@ -298,8 +291,7 @@ public function clearMetricFilter() /** * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Metrics must be requested to be used in this filter. - * Dimensions cannot be used in this filter. + * SQL having-clause. Dimensions cannot be used in this filter. * * Generated from protobuf field .google.analytics.data.v1beta.FilterExpression metric_filter = 5; * @param \Google\Analytics\Data\V1beta\FilterExpression $var diff --git a/AnalyticsData/src/V1beta/RunReportRequest.php b/AnalyticsData/src/V1beta/RunReportRequest.php index 37fb8affeb57..0d1027ef5446 100644 --- a/AnalyticsData/src/V1beta/RunReportRequest.php +++ b/AnalyticsData/src/V1beta/RunReportRequest.php @@ -59,8 +59,8 @@ class RunReportRequest extends \Google\Protobuf\Internal\Message */ private $dimension_filter = null; /** - * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Dimensions cannot be used in this filter. + * The filter clause of metrics. Applied after aggregating the report's rows, + * similar to SQL having-clause. Dimensions cannot be used in this filter. * * Generated from protobuf field .google.analytics.data.v1beta.FilterExpression metric_filter = 6; */ @@ -165,8 +165,8 @@ class RunReportRequest extends \Google\Protobuf\Internal\Message * Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) * for examples. Metrics cannot be used in this filter. * @type \Google\Analytics\Data\V1beta\FilterExpression $metric_filter - * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Dimensions cannot be used in this filter. + * The filter clause of metrics. Applied after aggregating the report's rows, + * similar to SQL having-clause. Dimensions cannot be used in this filter. * @type int|string $offset * The row count of the start row. The first row is counted as row 0. * When paging, the first request does not specify offset; or equivalently, @@ -378,8 +378,8 @@ public function setDimensionFilter($var) } /** - * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Dimensions cannot be used in this filter. + * The filter clause of metrics. Applied after aggregating the report's rows, + * similar to SQL having-clause. Dimensions cannot be used in this filter. * * Generated from protobuf field .google.analytics.data.v1beta.FilterExpression metric_filter = 6; * @return \Google\Analytics\Data\V1beta\FilterExpression|null @@ -400,8 +400,8 @@ public function clearMetricFilter() } /** - * The filter clause of metrics. Applied at post aggregation phase, similar to - * SQL having-clause. Dimensions cannot be used in this filter. + * The filter clause of metrics. Applied after aggregating the report's rows, + * similar to SQL having-clause. Dimensions cannot be used in this filter. * * Generated from protobuf field .google.analytics.data.v1beta.FilterExpression metric_filter = 6; * @param \Google\Analytics\Data\V1beta\FilterExpression $var diff --git a/AnalyticsData/src/V1beta/resources/beta_analytics_data_client_config.json b/AnalyticsData/src/V1beta/resources/beta_analytics_data_client_config.json index 4d35a40ab615..f8f00df48736 100644 --- a/AnalyticsData/src/V1beta/resources/beta_analytics_data_client_config.json +++ b/AnalyticsData/src/V1beta/resources/beta_analytics_data_client_config.json @@ -50,13 +50,13 @@ }, "CheckCompatibility": { "timeout_millis": 60000, - "retry_codes_name": "retry_policy_1_codes", - "retry_params_name": "retry_policy_1_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "GetMetadata": { "timeout_millis": 60000, - "retry_codes_name": "retry_policy_1_codes", - "retry_params_name": "retry_policy_1_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "RunPivotReport": { "timeout_millis": 60000,