google-api-client 0.10.2 → 0.10.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +25 -0
- data/MIGRATING.md +22 -7
- data/README.md +4 -8
- data/api_names.yaml +1210 -37815
- data/generated/google/apis/acceleratedmobilepageurl_v1.rb +32 -0
- data/generated/google/apis/acceleratedmobilepageurl_v1/classes.rb +144 -0
- data/generated/google/apis/acceleratedmobilepageurl_v1/representations.rb +86 -0
- data/generated/google/apis/acceleratedmobilepageurl_v1/service.rb +90 -0
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +764 -764
- data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +180 -180
- data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +421 -421
- data/generated/google/apis/adexchangebuyer_v1_4/classes.rb +1 -0
- data/generated/google/apis/admin_directory_v1/classes.rb +1 -0
- data/generated/google/apis/admin_reports_v1.rb +1 -1
- data/generated/google/apis/adsense_v1_4.rb +1 -1
- data/generated/google/apis/adsensehost_v4_1.rb +1 -1
- data/generated/google/apis/analyticsreporting_v4/classes.rb +187 -187
- data/generated/google/apis/analyticsreporting_v4/representations.rb +42 -42
- data/generated/google/apis/appengine_v1.rb +40 -0
- data/generated/google/apis/appengine_v1/classes.rb +2251 -0
- data/generated/google/apis/appengine_v1/representations.rb +858 -0
- data/generated/google/apis/appengine_v1/service.rb +894 -0
- data/generated/google/apis/bigquery_v2.rb +1 -1
- data/generated/google/apis/bigquery_v2/classes.rb +11 -6
- data/generated/google/apis/books_v1.rb +1 -1
- data/generated/google/apis/books_v1/classes.rb +26 -0
- data/generated/google/apis/books_v1/representations.rb +15 -0
- data/generated/google/apis/books_v1/service.rb +4 -1
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/classroom_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1/classes.rb +638 -637
- data/generated/google/apis/cloudbuild_v1/representations.rb +110 -110
- data/generated/google/apis/cloudbuild_v1/service.rb +139 -139
- data/generated/google/apis/clouddebugger_v2.rb +3 -3
- data/generated/google/apis/clouddebugger_v2/classes.rb +131 -131
- data/generated/google/apis/clouddebugger_v2/representations.rb +25 -25
- data/generated/google/apis/clouderrorreporting_v1beta1.rb +36 -0
- data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +590 -0
- data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +252 -0
- data/generated/google/apis/clouderrorreporting_v1beta1/service.rb +350 -0
- data/generated/google/apis/cloudfunctions_v1.rb +35 -0
- data/generated/google/apis/cloudfunctions_v1/classes.rb +98 -0
- data/generated/google/apis/cloudfunctions_v1/representations.rb +57 -0
- data/generated/google/apis/cloudfunctions_v1/service.rb +89 -0
- data/generated/google/apis/cloudkms_v1/classes.rb +277 -270
- data/generated/google/apis/cloudkms_v1/representations.rb +73 -73
- data/generated/google/apis/cloudkms_v1/service.rb +194 -194
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +1147 -1144
- data/generated/google/apis/cloudresourcemanager_v1/representations.rb +188 -188
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +513 -936
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +307 -916
- data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +63 -285
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +333 -681
- data/generated/google/apis/cloudtrace_v1/classes.rb +38 -38
- data/generated/google/apis/cloudtrace_v1/representations.rb +13 -13
- data/generated/google/apis/cloudtrace_v1/service.rb +16 -16
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +32 -7
- data/generated/google/apis/compute_beta/representations.rb +2 -0
- data/generated/google/apis/compute_beta/service.rb +11 -11
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +95 -2
- data/generated/google/apis/compute_v1/representations.rb +33 -0
- data/generated/google/apis/dataflow_v1b3/classes.rb +3333 -3333
- data/generated/google/apis/dataflow_v1b3/representations.rb +759 -759
- data/generated/google/apis/dataflow_v1b3/service.rb +154 -154
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +1097 -1097
- data/generated/google/apis/dataproc_v1/representations.rb +200 -200
- data/generated/google/apis/dataproc_v1/service.rb +356 -356
- data/generated/google/apis/datastore_v1.rb +4 -4
- data/generated/google/apis/datastore_v1/classes.rb +701 -690
- data/generated/google/apis/datastore_v1/representations.rb +160 -160
- data/generated/google/apis/datastore_v1/service.rb +52 -52
- data/generated/google/apis/deploymentmanager_v2/classes.rb +4 -0
- data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v2/classes.rb +158 -35
- data/generated/google/apis/drive_v2/representations.rb +39 -0
- data/generated/google/apis/drive_v2/service.rb +4 -4
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/classes.rb +162 -33
- data/generated/google/apis/drive_v3/representations.rb +39 -0
- data/generated/google/apis/drive_v3/service.rb +4 -4
- data/generated/google/apis/firebasedynamiclinks_v1.rb +35 -0
- data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +466 -0
- data/generated/google/apis/firebasedynamiclinks_v1/representations.rb +222 -0
- data/generated/google/apis/firebasedynamiclinks_v1/service.rb +95 -0
- data/generated/google/apis/firebaserules_v1.rb +41 -0
- data/generated/google/apis/firebaserules_v1/classes.rb +425 -0
- data/generated/google/apis/firebaserules_v1/representations.rb +222 -0
- data/generated/google/apis/firebaserules_v1/service.rb +495 -0
- data/generated/google/apis/games_v1/classes.rb +4 -0
- data/generated/google/apis/genomics_v1.rb +7 -7
- data/generated/google/apis/genomics_v1/classes.rb +2336 -2335
- data/generated/google/apis/genomics_v1/representations.rb +387 -387
- data/generated/google/apis/genomics_v1/service.rb +1187 -1187
- data/generated/google/apis/gmail_v1/classes.rb +3 -0
- data/generated/google/apis/iam_v1.rb +1 -1
- data/generated/google/apis/iam_v1/classes.rb +123 -117
- data/generated/google/apis/iam_v1/representations.rb +33 -33
- data/generated/google/apis/iam_v1/service.rb +109 -109
- data/generated/google/apis/identitytoolkit_v3/classes.rb +5 -0
- data/generated/google/apis/kgsearch_v1/classes.rb +6 -6
- data/generated/google/apis/kgsearch_v1/representations.rb +1 -1
- data/generated/google/apis/kgsearch_v1/service.rb +4 -4
- data/generated/google/apis/language_v1.rb +36 -0
- data/generated/google/apis/language_v1/classes.rb +757 -0
- data/generated/google/apis/language_v1/representations.rb +338 -0
- data/generated/google/apis/language_v1/service.rb +185 -0
- data/generated/google/apis/language_v1beta1/classes.rb +407 -407
- data/generated/google/apis/language_v1beta1/representations.rb +103 -103
- data/generated/google/apis/language_v1beta1/service.rb +45 -45
- data/generated/google/apis/logging_v2.rb +46 -0
- data/generated/google/apis/logging_v2/classes.rb +1271 -0
- data/generated/google/apis/logging_v2/representations.rb +421 -0
- data/generated/google/apis/logging_v2/service.rb +1569 -0
- data/generated/google/apis/logging_v2beta1.rb +1 -1
- data/generated/google/apis/logging_v2beta1/classes.rb +886 -886
- data/generated/google/apis/logging_v2beta1/representations.rb +132 -132
- data/generated/google/apis/logging_v2beta1/service.rb +235 -235
- data/generated/google/apis/manufacturers_v1/classes.rb +147 -147
- data/generated/google/apis/manufacturers_v1/representations.rb +29 -29
- data/generated/google/apis/ml_v1.rb +34 -0
- data/generated/google/apis/ml_v1/classes.rb +1617 -0
- data/generated/google/apis/ml_v1/representations.rb +498 -0
- data/generated/google/apis/ml_v1/service.rb +769 -0
- data/generated/google/apis/monitoring_v3.rb +4 -4
- data/generated/google/apis/monitoring_v3/classes.rb +630 -630
- data/generated/google/apis/monitoring_v3/representations.rb +134 -134
- data/generated/google/apis/monitoring_v3/service.rb +240 -240
- data/generated/google/apis/pagespeedonline_v2/classes.rb +1 -0
- data/generated/google/apis/partners_v2.rb +1 -1
- data/generated/google/apis/partners_v2/classes.rb +639 -639
- data/generated/google/apis/partners_v2/representations.rb +168 -168
- data/generated/google/apis/partners_v2/service.rb +381 -381
- data/generated/google/apis/people_v1.rb +10 -10
- data/generated/google/apis/people_v1/classes.rb +524 -524
- data/generated/google/apis/people_v1/representations.rb +143 -143
- data/generated/google/apis/people_v1/service.rb +30 -30
- data/generated/google/apis/plus_domains_v1.rb +1 -1
- data/generated/google/apis/plus_v1.rb +1 -1
- data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +454 -444
- data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +90 -90
- data/generated/google/apis/proximitybeacon_v1beta1/service.rb +110 -110
- data/generated/google/apis/pubsub_v1/classes.rb +175 -173
- data/generated/google/apis/pubsub_v1/representations.rb +53 -53
- data/generated/google/apis/pubsub_v1/service.rb +210 -210
- data/generated/google/apis/replicapool_v1beta2/classes.rb +2 -0
- data/generated/google/apis/runtimeconfig_v1.rb +38 -0
- data/generated/google/apis/runtimeconfig_v1/classes.rb +252 -0
- data/generated/google/apis/runtimeconfig_v1/representations.rb +98 -0
- data/generated/google/apis/runtimeconfig_v1/service.rb +176 -0
- data/generated/google/apis/script_v1.rb +1 -1
- data/generated/google/apis/script_v1/classes.rb +6 -6
- data/generated/google/apis/script_v1/representations.rb +1 -1
- data/generated/google/apis/searchconsole_v1.rb +31 -0
- data/generated/google/apis/searchconsole_v1/classes.rb +205 -0
- data/generated/google/apis/searchconsole_v1/representations.rb +129 -0
- data/generated/google/apis/searchconsole_v1/service.rb +88 -0
- data/generated/google/apis/servicecontrol_v1.rb +38 -0
- data/generated/google/apis/servicecontrol_v1/classes.rb +1675 -0
- data/generated/google/apis/servicecontrol_v1/representations.rb +601 -0
- data/generated/google/apis/servicecontrol_v1/service.rb +337 -0
- data/generated/google/apis/servicemanagement_v1.rb +45 -0
- data/generated/google/apis/servicemanagement_v1/classes.rb +4934 -0
- data/generated/google/apis/servicemanagement_v1/representations.rb +1526 -0
- data/generated/google/apis/servicemanagement_v1/service.rb +860 -0
- data/generated/google/apis/serviceuser_v1.rb +42 -0
- data/generated/google/apis/serviceuser_v1/classes.rb +3746 -0
- data/generated/google/apis/serviceuser_v1/representations.rb +1041 -0
- data/generated/google/apis/serviceuser_v1/service.rb +214 -0
- data/generated/google/apis/sheets_v4.rb +3 -3
- data/generated/google/apis/sheets_v4/classes.rb +4390 -4390
- data/generated/google/apis/sheets_v4/representations.rb +381 -381
- data/generated/google/apis/sheets_v4/service.rb +48 -48
- data/generated/google/apis/slides_v1.rb +3 -3
- data/generated/google/apis/slides_v1/classes.rb +2860 -2860
- data/generated/google/apis/slides_v1/representations.rb +693 -693
- data/generated/google/apis/slides_v1/service.rb +30 -30
- data/generated/google/apis/sourcerepo_v1.rb +34 -0
- data/generated/google/apis/sourcerepo_v1/classes.rb +687 -0
- data/generated/google/apis/sourcerepo_v1/representations.rb +285 -0
- data/generated/google/apis/sourcerepo_v1/service.rb +291 -0
- data/generated/google/apis/spanner_v1.rb +35 -0
- data/generated/google/apis/spanner_v1/classes.rb +3294 -0
- data/generated/google/apis/spanner_v1/representations.rb +984 -0
- data/generated/google/apis/spanner_v1/service.rb +1504 -0
- data/generated/google/apis/speech_v1beta1.rb +1 -1
- data/generated/google/apis/speech_v1beta1/classes.rb +197 -196
- data/generated/google/apis/speech_v1beta1/representations.rb +53 -53
- data/generated/google/apis/speech_v1beta1/service.rb +27 -27
- data/generated/google/apis/storage_v1.rb +1 -1
- data/generated/google/apis/storage_v1/classes.rb +131 -0
- data/generated/google/apis/storage_v1/representations.rb +51 -0
- data/generated/google/apis/storage_v1/service.rb +182 -0
- data/generated/google/apis/storagetransfer_v1.rb +1 -1
- data/generated/google/apis/storagetransfer_v1/classes.rb +732 -661
- data/generated/google/apis/storagetransfer_v1/representations.rb +132 -132
- data/generated/google/apis/storagetransfer_v1/service.rb +174 -197
- data/generated/google/apis/surveys_v2.rb +40 -0
- data/generated/google/apis/surveys_v2/classes.rb +806 -0
- data/generated/google/apis/surveys_v2/representations.rb +347 -0
- data/generated/google/apis/surveys_v2/service.rb +477 -0
- data/generated/google/apis/tagmanager_v2.rb +52 -0
- data/generated/google/apis/tagmanager_v2/classes.rb +2435 -0
- data/generated/google/apis/tagmanager_v2/representations.rb +993 -0
- data/generated/google/apis/tagmanager_v2/service.rb +2865 -0
- data/generated/google/apis/toolresults_v1beta3.rb +34 -0
- data/generated/google/apis/toolresults_v1beta3/classes.rb +2160 -0
- data/generated/google/apis/toolresults_v1beta3/representations.rb +729 -0
- data/generated/google/apis/toolresults_v1beta3/service.rb +1236 -0
- data/generated/google/apis/tracing_v1.rb +40 -0
- data/generated/google/apis/tracing_v1/classes.rb +664 -0
- data/generated/google/apis/tracing_v1/representations.rb +279 -0
- data/generated/google/apis/tracing_v1/service.rb +225 -0
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +1223 -1222
- data/generated/google/apis/vision_v1/representations.rb +234 -234
- data/generated/google/apis/vision_v1/service.rb +10 -10
- data/generated/google/apis/webfonts_v1.rb +33 -0
- data/generated/google/apis/webfonts_v1/classes.rb +113 -0
- data/generated/google/apis/webfonts_v1/representations.rb +62 -0
- data/generated/google/apis/webfonts_v1/service.rb +102 -0
- data/generated/google/apis/youtube_analytics_v1.rb +1 -1
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtube_partner_v1/classes.rb +31 -0
- data/generated/google/apis/youtube_partner_v1/representations.rb +6 -0
- data/generated/google/apis/youtube_partner_v1/service.rb +41 -0
- data/generated/google/apis/youtube_v3/classes.rb +1 -0
- data/generated/google/apis/youtubereporting_v1.rb +4 -4
- data/generated/google/apis/youtubereporting_v1/classes.rb +76 -76
- data/generated/google/apis/youtubereporting_v1/representations.rb +25 -25
- data/generated/google/apis/youtubereporting_v1/service.rb +95 -95
- data/lib/google/apis/generator/annotator.rb +5 -4
- data/lib/google/apis/generator/templates/_class.tmpl +3 -0
- data/lib/google/apis/version.rb +1 -1
- data/samples/cli/lib/samples/adsense.rb +99 -0
- data/samples/cli/lib/samples/analytics.rb +18 -0
- data/samples/cli/lib/samples/gmail.rb +33 -0
- data/samples/cli/lib/samples/vision.rb +69 -0
- metadata +89 -4
- data/sync.rb +0 -71
@@ -3015,6 +3015,7 @@ module Google
|
|
3015
3015
|
|
3016
3016
|
# Base64 encoded photo data
|
3017
3017
|
# Corresponds to the JSON property `photoData`
|
3018
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
3018
3019
|
# @return [String]
|
3019
3020
|
attr_accessor :photo_data
|
3020
3021
|
|
@@ -26,7 +26,7 @@ module Google
|
|
26
26
|
# @see https://developers.google.com/admin-sdk/reports/
|
27
27
|
module AdminReportsV1
|
28
28
|
VERSION = 'ReportsV1'
|
29
|
-
REVISION = '
|
29
|
+
REVISION = '20170320'
|
30
30
|
|
31
31
|
# View audit reports for your G Suite domain
|
32
32
|
AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly'
|
@@ -25,7 +25,7 @@ module Google
|
|
25
25
|
# @see https://developers.google.com/adsense/management/
|
26
26
|
module AdsenseV1_4
|
27
27
|
VERSION = 'V1_4'
|
28
|
-
REVISION = '
|
28
|
+
REVISION = '20170329'
|
29
29
|
|
30
30
|
# View and manage your AdSense data
|
31
31
|
AUTH_ADSENSE = 'https://www.googleapis.com/auth/adsense'
|
@@ -26,7 +26,7 @@ module Google
|
|
26
26
|
# @see https://developers.google.com/adsense/host/
|
27
27
|
module AdsensehostV4_1
|
28
28
|
VERSION = 'V4_1'
|
29
|
-
REVISION = '
|
29
|
+
REVISION = '20170329'
|
30
30
|
|
31
31
|
# View and manage your AdSense host data and associated accounts
|
32
32
|
AUTH_ADSENSEHOST = 'https://www.googleapis.com/auth/adsensehost'
|
@@ -22,11 +22,41 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module AnalyticsreportingV4
|
24
24
|
|
25
|
+
# Column headers.
|
26
|
+
class ColumnHeader
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# The dimension names in the response.
|
30
|
+
# Corresponds to the JSON property `dimensions`
|
31
|
+
# @return [Array<String>]
|
32
|
+
attr_accessor :dimensions
|
33
|
+
|
34
|
+
# The headers for the metrics.
|
35
|
+
# Corresponds to the JSON property `metricHeader`
|
36
|
+
# @return [Google::Apis::AnalyticsreportingV4::MetricHeader]
|
37
|
+
attr_accessor :metric_header
|
38
|
+
|
39
|
+
def initialize(**args)
|
40
|
+
update!(**args)
|
41
|
+
end
|
42
|
+
|
43
|
+
# Update properties of this object
|
44
|
+
def update!(**args)
|
45
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
46
|
+
@metric_header = args[:metric_header] if args.key?(:metric_header)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
25
50
|
# Filter Clause to be used in a segment definition, can be wither a metric or
|
26
51
|
# a dimension filter.
|
27
52
|
class SegmentFilterClause
|
28
53
|
include Google::Apis::Core::Hashable
|
29
54
|
|
55
|
+
# Dimension filter specifies the filtering options on a dimension.
|
56
|
+
# Corresponds to the JSON property `dimensionFilter`
|
57
|
+
# @return [Google::Apis::AnalyticsreportingV4::SegmentDimensionFilter]
|
58
|
+
attr_accessor :dimension_filter
|
59
|
+
|
30
60
|
# Metric filter to be used in a segment filter clause.
|
31
61
|
# Corresponds to the JSON property `metricFilter`
|
32
62
|
# @return [Google::Apis::AnalyticsreportingV4::SegmentMetricFilter]
|
@@ -38,39 +68,31 @@ module Google
|
|
38
68
|
attr_accessor :not
|
39
69
|
alias_method :not?, :not
|
40
70
|
|
41
|
-
# Dimension filter specifies the filtering options on a dimension.
|
42
|
-
# Corresponds to the JSON property `dimensionFilter`
|
43
|
-
# @return [Google::Apis::AnalyticsreportingV4::SegmentDimensionFilter]
|
44
|
-
attr_accessor :dimension_filter
|
45
|
-
|
46
71
|
def initialize(**args)
|
47
72
|
update!(**args)
|
48
73
|
end
|
49
74
|
|
50
75
|
# Update properties of this object
|
51
76
|
def update!(**args)
|
77
|
+
@dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
|
52
78
|
@metric_filter = args[:metric_filter] if args.key?(:metric_filter)
|
53
79
|
@not = args[:not] if args.key?(:not)
|
54
|
-
@dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
|
55
80
|
end
|
56
81
|
end
|
57
82
|
|
58
|
-
#
|
59
|
-
|
60
|
-
class MetricFilterClause
|
83
|
+
# A row in the report.
|
84
|
+
class ReportRow
|
61
85
|
include Google::Apis::Core::Hashable
|
62
86
|
|
63
|
-
#
|
64
|
-
#
|
65
|
-
#
|
66
|
-
|
67
|
-
attr_accessor :operator
|
87
|
+
# List of metrics for each requested DateRange.
|
88
|
+
# Corresponds to the JSON property `metrics`
|
89
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
90
|
+
attr_accessor :metrics
|
68
91
|
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
|
73
|
-
attr_accessor :filters
|
92
|
+
# List of requested dimensions.
|
93
|
+
# Corresponds to the JSON property `dimensions`
|
94
|
+
# @return [Array<String>]
|
95
|
+
attr_accessor :dimensions
|
74
96
|
|
75
97
|
def initialize(**args)
|
76
98
|
update!(**args)
|
@@ -78,8 +100,8 @@ module Google
|
|
78
100
|
|
79
101
|
# Update properties of this object
|
80
102
|
def update!(**args)
|
81
|
-
@
|
82
|
-
@
|
103
|
+
@metrics = args[:metrics] if args.key?(:metrics)
|
104
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
83
105
|
end
|
84
106
|
end
|
85
107
|
|
@@ -89,6 +111,13 @@ module Google
|
|
89
111
|
class Cohort
|
90
112
|
include Google::Apis::Core::Hashable
|
91
113
|
|
114
|
+
# Type of the cohort. The only supported type as of now is
|
115
|
+
# `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated
|
116
|
+
# as `FIRST_VISIT_DATE` type cohort.
|
117
|
+
# Corresponds to the JSON property `type`
|
118
|
+
# @return [String]
|
119
|
+
attr_accessor :type
|
120
|
+
|
92
121
|
# A unique name for the cohort. If not defined name will be auto-generated
|
93
122
|
# with values cohort_[1234...].
|
94
123
|
# Corresponds to the JSON property `name`
|
@@ -102,38 +131,34 @@ module Google
|
|
102
131
|
# @return [Google::Apis::AnalyticsreportingV4::DateRange]
|
103
132
|
attr_accessor :date_range
|
104
133
|
|
105
|
-
# Type of the cohort. The only supported type as of now is
|
106
|
-
# `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated
|
107
|
-
# as `FIRST_VISIT_DATE` type cohort.
|
108
|
-
# Corresponds to the JSON property `type`
|
109
|
-
# @return [String]
|
110
|
-
attr_accessor :type
|
111
|
-
|
112
134
|
def initialize(**args)
|
113
135
|
update!(**args)
|
114
136
|
end
|
115
137
|
|
116
138
|
# Update properties of this object
|
117
139
|
def update!(**args)
|
140
|
+
@type = args[:type] if args.key?(:type)
|
118
141
|
@name = args[:name] if args.key?(:name)
|
119
142
|
@date_range = args[:date_range] if args.key?(:date_range)
|
120
|
-
@type = args[:type] if args.key?(:type)
|
121
143
|
end
|
122
144
|
end
|
123
145
|
|
124
|
-
#
|
125
|
-
|
146
|
+
# Represents a group of metric filters.
|
147
|
+
# Set the operator value to specify how the filters are logically combined.
|
148
|
+
class MetricFilterClause
|
126
149
|
include Google::Apis::Core::Hashable
|
127
150
|
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
|
151
|
+
# The operator for combining multiple metric filters. If unspecified, it is
|
152
|
+
# treated as an `OR`.
|
153
|
+
# Corresponds to the JSON property `operator`
|
154
|
+
# @return [String]
|
155
|
+
attr_accessor :operator
|
132
156
|
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
|
157
|
+
# The repeated set of filters. They are logically combined based on the
|
158
|
+
# operator specified.
|
159
|
+
# Corresponds to the JSON property `filters`
|
160
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::MetricFilter>]
|
161
|
+
attr_accessor :filters
|
137
162
|
|
138
163
|
def initialize(**args)
|
139
164
|
update!(**args)
|
@@ -141,8 +166,8 @@ module Google
|
|
141
166
|
|
142
167
|
# Update properties of this object
|
143
168
|
def update!(**args)
|
144
|
-
@
|
145
|
-
@
|
169
|
+
@operator = args[:operator] if args.key?(:operator)
|
170
|
+
@filters = args[:filters] if args.key?(:filters)
|
146
171
|
end
|
147
172
|
end
|
148
173
|
|
@@ -170,24 +195,24 @@ module Google
|
|
170
195
|
class MetricHeader
|
171
196
|
include Google::Apis::Core::Hashable
|
172
197
|
|
173
|
-
# Headers for the pivots in the response.
|
174
|
-
# Corresponds to the JSON property `pivotHeaders`
|
175
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::PivotHeader>]
|
176
|
-
attr_accessor :pivot_headers
|
177
|
-
|
178
198
|
# Headers for the metrics in the response.
|
179
199
|
# Corresponds to the JSON property `metricHeaderEntries`
|
180
200
|
# @return [Array<Google::Apis::AnalyticsreportingV4::MetricHeaderEntry>]
|
181
201
|
attr_accessor :metric_header_entries
|
182
202
|
|
203
|
+
# Headers for the pivots in the response.
|
204
|
+
# Corresponds to the JSON property `pivotHeaders`
|
205
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::PivotHeader>]
|
206
|
+
attr_accessor :pivot_headers
|
207
|
+
|
183
208
|
def initialize(**args)
|
184
209
|
update!(**args)
|
185
210
|
end
|
186
211
|
|
187
212
|
# Update properties of this object
|
188
213
|
def update!(**args)
|
189
|
-
@pivot_headers = args[:pivot_headers] if args.key?(:pivot_headers)
|
190
214
|
@metric_header_entries = args[:metric_header_entries] if args.key?(:metric_header_entries)
|
215
|
+
@pivot_headers = args[:pivot_headers] if args.key?(:pivot_headers)
|
191
216
|
end
|
192
217
|
end
|
193
218
|
|
@@ -434,12 +459,6 @@ module Google
|
|
434
459
|
class Pivot
|
435
460
|
include Google::Apis::Core::Hashable
|
436
461
|
|
437
|
-
# Specifies the maximum number of groups to return.
|
438
|
-
# The default value is 10, also the maximum value is 1,000.
|
439
|
-
# Corresponds to the JSON property `maxGroupCount`
|
440
|
-
# @return [Fixnum]
|
441
|
-
attr_accessor :max_group_count
|
442
|
-
|
443
462
|
# If k metrics were requested, then the response will contain some
|
444
463
|
# data-dependent multiple of k columns in the report. E.g., if you pivoted
|
445
464
|
# on the dimension `ga:browser` then you'd get k columns for "Firefox", k
|
@@ -480,17 +499,23 @@ module Google
|
|
480
499
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DimensionFilterClause>]
|
481
500
|
attr_accessor :dimension_filter_clauses
|
482
501
|
|
502
|
+
# Specifies the maximum number of groups to return.
|
503
|
+
# The default value is 10, also the maximum value is 1,000.
|
504
|
+
# Corresponds to the JSON property `maxGroupCount`
|
505
|
+
# @return [Fixnum]
|
506
|
+
attr_accessor :max_group_count
|
507
|
+
|
483
508
|
def initialize(**args)
|
484
509
|
update!(**args)
|
485
510
|
end
|
486
511
|
|
487
512
|
# Update properties of this object
|
488
513
|
def update!(**args)
|
489
|
-
@max_group_count = args[:max_group_count] if args.key?(:max_group_count)
|
490
514
|
@start_group = args[:start_group] if args.key?(:start_group)
|
491
515
|
@metrics = args[:metrics] if args.key?(:metrics)
|
492
516
|
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
493
517
|
@dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses)
|
518
|
+
@max_group_count = args[:max_group_count] if args.key?(:max_group_count)
|
494
519
|
end
|
495
520
|
end
|
496
521
|
|
@@ -606,24 +631,24 @@ module Google
|
|
606
631
|
class MetricHeaderEntry
|
607
632
|
include Google::Apis::Core::Hashable
|
608
633
|
|
609
|
-
# The type of the metric, for example `INTEGER`.
|
610
|
-
# Corresponds to the JSON property `type`
|
611
|
-
# @return [String]
|
612
|
-
attr_accessor :type
|
613
|
-
|
614
634
|
# The name of the header.
|
615
635
|
# Corresponds to the JSON property `name`
|
616
636
|
# @return [String]
|
617
637
|
attr_accessor :name
|
618
638
|
|
639
|
+
# The type of the metric, for example `INTEGER`.
|
640
|
+
# Corresponds to the JSON property `type`
|
641
|
+
# @return [String]
|
642
|
+
attr_accessor :type
|
643
|
+
|
619
644
|
def initialize(**args)
|
620
645
|
update!(**args)
|
621
646
|
end
|
622
647
|
|
623
648
|
# Update properties of this object
|
624
649
|
def update!(**args)
|
625
|
-
@type = args[:type] if args.key?(:type)
|
626
650
|
@name = args[:name] if args.key?(:name)
|
651
|
+
@type = args[:type] if args.key?(:type)
|
627
652
|
end
|
628
653
|
end
|
629
654
|
|
@@ -631,12 +656,36 @@ module Google
|
|
631
656
|
class ReportData
|
632
657
|
include Google::Apis::Core::Hashable
|
633
658
|
|
659
|
+
# Total number of matching rows for this query.
|
660
|
+
# Corresponds to the JSON property `rowCount`
|
661
|
+
# @return [Fixnum]
|
662
|
+
attr_accessor :row_count
|
663
|
+
|
664
|
+
# There's one ReportRow for every unique combination of dimensions.
|
665
|
+
# Corresponds to the JSON property `rows`
|
666
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::ReportRow>]
|
667
|
+
attr_accessor :rows
|
668
|
+
|
669
|
+
# Indicates if response to this request is golden or not. Data is
|
670
|
+
# golden when the exact same request will not produce any new results if
|
671
|
+
# asked at a later point in time.
|
672
|
+
# Corresponds to the JSON property `isDataGolden`
|
673
|
+
# @return [Boolean]
|
674
|
+
attr_accessor :is_data_golden
|
675
|
+
alias_method :is_data_golden?, :is_data_golden
|
676
|
+
|
677
|
+
# The last time the data in the report was refreshed. All the hits received
|
678
|
+
# before this timestamp are included in the calculation of the report.
|
679
|
+
# Corresponds to the JSON property `dataLastRefreshed`
|
680
|
+
# @return [String]
|
681
|
+
attr_accessor :data_last_refreshed
|
682
|
+
|
634
683
|
# Minimum and maximum values seen over all matching rows. These are both
|
635
684
|
# empty when `hideValueRanges` in the request is false, or when
|
636
685
|
# rowCount is zero.
|
637
|
-
# Corresponds to the JSON property `
|
686
|
+
# Corresponds to the JSON property `maximums`
|
638
687
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
639
|
-
attr_accessor :
|
688
|
+
attr_accessor :maximums
|
640
689
|
|
641
690
|
# If the results are
|
642
691
|
# [sampled](https://support.google.com/analytics/answer/2637192),
|
@@ -649,6 +698,13 @@ module Google
|
|
649
698
|
# @return [Array<String>]
|
650
699
|
attr_accessor :sampling_space_sizes
|
651
700
|
|
701
|
+
# Minimum and maximum values seen over all matching rows. These are both
|
702
|
+
# empty when `hideValueRanges` in the request is false, or when
|
703
|
+
# rowCount is zero.
|
704
|
+
# Corresponds to the JSON property `minimums`
|
705
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
706
|
+
attr_accessor :minimums
|
707
|
+
|
652
708
|
# For each requested date range, for the set of all rows that match
|
653
709
|
# the query, every requested value format gets a total. The total
|
654
710
|
# for a value format is computed by first totaling the metrics
|
@@ -671,52 +727,21 @@ module Google
|
|
671
727
|
# @return [Array<String>]
|
672
728
|
attr_accessor :samples_read_counts
|
673
729
|
|
674
|
-
# Indicates if response to this request is golden or not. Data is
|
675
|
-
# golden when the exact same request will not produce any new results if
|
676
|
-
# asked at a later point in time.
|
677
|
-
# Corresponds to the JSON property `isDataGolden`
|
678
|
-
# @return [Boolean]
|
679
|
-
attr_accessor :is_data_golden
|
680
|
-
alias_method :is_data_golden?, :is_data_golden
|
681
|
-
|
682
|
-
# There's one ReportRow for every unique combination of dimensions.
|
683
|
-
# Corresponds to the JSON property `rows`
|
684
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::ReportRow>]
|
685
|
-
attr_accessor :rows
|
686
|
-
|
687
|
-
# Total number of matching rows for this query.
|
688
|
-
# Corresponds to the JSON property `rowCount`
|
689
|
-
# @return [Fixnum]
|
690
|
-
attr_accessor :row_count
|
691
|
-
|
692
|
-
# The last time the data in the report was refreshed. All the hits received
|
693
|
-
# before this timestamp are included in the calculation of the report.
|
694
|
-
# Corresponds to the JSON property `dataLastRefreshed`
|
695
|
-
# @return [String]
|
696
|
-
attr_accessor :data_last_refreshed
|
697
|
-
|
698
|
-
# Minimum and maximum values seen over all matching rows. These are both
|
699
|
-
# empty when `hideValueRanges` in the request is false, or when
|
700
|
-
# rowCount is zero.
|
701
|
-
# Corresponds to the JSON property `maximums`
|
702
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
703
|
-
attr_accessor :maximums
|
704
|
-
|
705
730
|
def initialize(**args)
|
706
731
|
update!(**args)
|
707
732
|
end
|
708
733
|
|
709
734
|
# Update properties of this object
|
710
735
|
def update!(**args)
|
711
|
-
@minimums = args[:minimums] if args.key?(:minimums)
|
712
|
-
@sampling_space_sizes = args[:sampling_space_sizes] if args.key?(:sampling_space_sizes)
|
713
|
-
@totals = args[:totals] if args.key?(:totals)
|
714
|
-
@samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts)
|
715
|
-
@is_data_golden = args[:is_data_golden] if args.key?(:is_data_golden)
|
716
|
-
@rows = args[:rows] if args.key?(:rows)
|
717
736
|
@row_count = args[:row_count] if args.key?(:row_count)
|
737
|
+
@rows = args[:rows] if args.key?(:rows)
|
738
|
+
@is_data_golden = args[:is_data_golden] if args.key?(:is_data_golden)
|
718
739
|
@data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed)
|
719
740
|
@maximums = args[:maximums] if args.key?(:maximums)
|
741
|
+
@sampling_space_sizes = args[:sampling_space_sizes] if args.key?(:sampling_space_sizes)
|
742
|
+
@minimums = args[:minimums] if args.key?(:minimums)
|
743
|
+
@totals = args[:totals] if args.key?(:totals)
|
744
|
+
@samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts)
|
720
745
|
end
|
721
746
|
end
|
722
747
|
|
@@ -724,12 +749,6 @@ module Google
|
|
724
749
|
class DimensionFilter
|
725
750
|
include Google::Apis::Core::Hashable
|
726
751
|
|
727
|
-
# Should the match be case sensitive? Default is false.
|
728
|
-
# Corresponds to the JSON property `caseSensitive`
|
729
|
-
# @return [Boolean]
|
730
|
-
attr_accessor :case_sensitive
|
731
|
-
alias_method :case_sensitive?, :case_sensitive
|
732
|
-
|
733
752
|
# The dimension to filter on. A DimensionFilter must contain a dimension.
|
734
753
|
# Corresponds to the JSON property `dimensionName`
|
735
754
|
# @return [String]
|
@@ -755,17 +774,23 @@ module Google
|
|
755
774
|
# @return [Array<String>]
|
756
775
|
attr_accessor :expressions
|
757
776
|
|
777
|
+
# Should the match be case sensitive? Default is false.
|
778
|
+
# Corresponds to the JSON property `caseSensitive`
|
779
|
+
# @return [Boolean]
|
780
|
+
attr_accessor :case_sensitive
|
781
|
+
alias_method :case_sensitive?, :case_sensitive
|
782
|
+
|
758
783
|
def initialize(**args)
|
759
784
|
update!(**args)
|
760
785
|
end
|
761
786
|
|
762
787
|
# Update properties of this object
|
763
788
|
def update!(**args)
|
764
|
-
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
765
789
|
@dimension_name = args[:dimension_name] if args.key?(:dimension_name)
|
766
790
|
@operator = args[:operator] if args.key?(:operator)
|
767
791
|
@not = args[:not] if args.key?(:not)
|
768
792
|
@expressions = args[:expressions] if args.key?(:expressions)
|
793
|
+
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
769
794
|
end
|
770
795
|
end
|
771
796
|
|
@@ -914,18 +939,6 @@ module Google
|
|
914
939
|
class Metric
|
915
940
|
include Google::Apis::Core::Hashable
|
916
941
|
|
917
|
-
# A metric expression in the request. An expression is constructed from one
|
918
|
-
# or more metrics and numbers. Accepted operators include: Plus (+), Minus
|
919
|
-
# (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
|
920
|
-
# Positive cardinal numbers (0-9), can include decimals and is limited to
|
921
|
-
# 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
|
922
|
-
# metric expression is just a single metric name like `ga:users`.
|
923
|
-
# Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
|
924
|
-
# will result in unexpected results.
|
925
|
-
# Corresponds to the JSON property `expression`
|
926
|
-
# @return [String]
|
927
|
-
attr_accessor :expression
|
928
|
-
|
929
942
|
# Specifies how the metric expression should be formatted, for example
|
930
943
|
# `INTEGER`.
|
931
944
|
# Corresponds to the JSON property `formattingType`
|
@@ -941,15 +954,27 @@ module Google
|
|
941
954
|
# @return [String]
|
942
955
|
attr_accessor :alias
|
943
956
|
|
957
|
+
# A metric expression in the request. An expression is constructed from one
|
958
|
+
# or more metrics and numbers. Accepted operators include: Plus (+), Minus
|
959
|
+
# (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
|
960
|
+
# Positive cardinal numbers (0-9), can include decimals and is limited to
|
961
|
+
# 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
|
962
|
+
# metric expression is just a single metric name like `ga:users`.
|
963
|
+
# Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
|
964
|
+
# will result in unexpected results.
|
965
|
+
# Corresponds to the JSON property `expression`
|
966
|
+
# @return [String]
|
967
|
+
attr_accessor :expression
|
968
|
+
|
944
969
|
def initialize(**args)
|
945
970
|
update!(**args)
|
946
971
|
end
|
947
972
|
|
948
973
|
# Update properties of this object
|
949
974
|
def update!(**args)
|
950
|
-
@expression = args[:expression] if args.key?(:expression)
|
951
975
|
@formatting_type = args[:formatting_type] if args.key?(:formatting_type)
|
952
976
|
@alias = args[:alias] if args.key?(:alias)
|
977
|
+
@expression = args[:expression] if args.key?(:expression)
|
953
978
|
end
|
954
979
|
end
|
955
980
|
|
@@ -1034,24 +1059,24 @@ module Google
|
|
1034
1059
|
class DateRange
|
1035
1060
|
include Google::Apis::Core::Hashable
|
1036
1061
|
|
1037
|
-
# The start date for the query in the format `YYYY-MM-DD`.
|
1038
|
-
# Corresponds to the JSON property `startDate`
|
1039
|
-
# @return [String]
|
1040
|
-
attr_accessor :start_date
|
1041
|
-
|
1042
1062
|
# The end date for the query in the format `YYYY-MM-DD`.
|
1043
1063
|
# Corresponds to the JSON property `endDate`
|
1044
1064
|
# @return [String]
|
1045
1065
|
attr_accessor :end_date
|
1046
1066
|
|
1067
|
+
# The start date for the query in the format `YYYY-MM-DD`.
|
1068
|
+
# Corresponds to the JSON property `startDate`
|
1069
|
+
# @return [String]
|
1070
|
+
attr_accessor :start_date
|
1071
|
+
|
1047
1072
|
def initialize(**args)
|
1048
1073
|
update!(**args)
|
1049
1074
|
end
|
1050
1075
|
|
1051
1076
|
# Update properties of this object
|
1052
1077
|
def update!(**args)
|
1053
|
-
@start_date = args[:start_date] if args.key?(:start_date)
|
1054
1078
|
@end_date = args[:end_date] if args.key?(:end_date)
|
1079
|
+
@start_date = args[:start_date] if args.key?(:start_date)
|
1055
1080
|
end
|
1056
1081
|
end
|
1057
1082
|
|
@@ -1059,13 +1084,6 @@ module Google
|
|
1059
1084
|
class MetricFilter
|
1060
1085
|
include Google::Apis::Core::Hashable
|
1061
1086
|
|
1062
|
-
# The metric that will be filtered on. A metricFilter must contain a metric
|
1063
|
-
# name. A metric name can be an alias earlier defined as a metric or it can
|
1064
|
-
# also be a metric expression.
|
1065
|
-
# Corresponds to the JSON property `metricName`
|
1066
|
-
# @return [String]
|
1067
|
-
attr_accessor :metric_name
|
1068
|
-
|
1069
1087
|
# The value to compare against.
|
1070
1088
|
# Corresponds to the JSON property `comparisonValue`
|
1071
1089
|
# @return [String]
|
@@ -1086,16 +1104,23 @@ module Google
|
|
1086
1104
|
attr_accessor :not
|
1087
1105
|
alias_method :not?, :not
|
1088
1106
|
|
1107
|
+
# The metric that will be filtered on. A metricFilter must contain a metric
|
1108
|
+
# name. A metric name can be an alias earlier defined as a metric or it can
|
1109
|
+
# also be a metric expression.
|
1110
|
+
# Corresponds to the JSON property `metricName`
|
1111
|
+
# @return [String]
|
1112
|
+
attr_accessor :metric_name
|
1113
|
+
|
1089
1114
|
def initialize(**args)
|
1090
1115
|
update!(**args)
|
1091
1116
|
end
|
1092
1117
|
|
1093
1118
|
# Update properties of this object
|
1094
1119
|
def update!(**args)
|
1095
|
-
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
1096
1120
|
@comparison_value = args[:comparison_value] if args.key?(:comparison_value)
|
1097
1121
|
@operator = args[:operator] if args.key?(:operator)
|
1098
1122
|
@not = args[:not] if args.key?(:not)
|
1123
|
+
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
1099
1124
|
end
|
1100
1125
|
end
|
1101
1126
|
|
@@ -1103,6 +1128,14 @@ module Google
|
|
1103
1128
|
class ReportRequest
|
1104
1129
|
include Google::Apis::Core::Hashable
|
1105
1130
|
|
1131
|
+
# If set to false, the response does not include rows if all the retrieved
|
1132
|
+
# metrics are equal to zero. The default is false which will exclude these
|
1133
|
+
# rows.
|
1134
|
+
# Corresponds to the JSON property `includeEmptyRows`
|
1135
|
+
# @return [Boolean]
|
1136
|
+
attr_accessor :include_empty_rows
|
1137
|
+
alias_method :include_empty_rows?, :include_empty_rows
|
1138
|
+
|
1106
1139
|
# The metric filter clauses. They are logically combined with the `AND`
|
1107
1140
|
# operator. Metric filters look at only the first date range and not the
|
1108
1141
|
# comparing date range. Note that filtering on metrics occurs after the
|
@@ -1137,18 +1170,6 @@ module Google
|
|
1137
1170
|
attr_accessor :hide_value_ranges
|
1138
1171
|
alias_method :hide_value_ranges?, :hide_value_ranges
|
1139
1172
|
|
1140
|
-
# Dimension or metric filters that restrict the data returned for your
|
1141
|
-
# request. To use the `filtersExpression`, supply a dimension or metric on
|
1142
|
-
# which to filter, followed by the filter expression. For example, the
|
1143
|
-
# following expression selects `ga:browser` dimension which starts with
|
1144
|
-
# Firefox; `ga:browser=~^Firefox`. For more information on dimensions
|
1145
|
-
# and metric filters, see
|
1146
|
-
# [Filters reference](https://developers.google.com/analytics/devguides/
|
1147
|
-
# reporting/core/v3/reference#filters).
|
1148
|
-
# Corresponds to the JSON property `filtersExpression`
|
1149
|
-
# @return [String]
|
1150
|
-
attr_accessor :filters_expression
|
1151
|
-
|
1152
1173
|
# Defines a cohort group.
|
1153
1174
|
# For example:
|
1154
1175
|
# "cohortGroup": `
|
@@ -1166,6 +1187,18 @@ module Google
|
|
1166
1187
|
# @return [Google::Apis::AnalyticsreportingV4::CohortGroup]
|
1167
1188
|
attr_accessor :cohort_group
|
1168
1189
|
|
1190
|
+
# Dimension or metric filters that restrict the data returned for your
|
1191
|
+
# request. To use the `filtersExpression`, supply a dimension or metric on
|
1192
|
+
# which to filter, followed by the filter expression. For example, the
|
1193
|
+
# following expression selects `ga:browser` dimension which starts with
|
1194
|
+
# Firefox; `ga:browser=~^Firefox`. For more information on dimensions
|
1195
|
+
# and metric filters, see
|
1196
|
+
# [Filters reference](https://developers.google.com/analytics/devguides/
|
1197
|
+
# reporting/core/v3/reference#filters).
|
1198
|
+
# Corresponds to the JSON property `filtersExpression`
|
1199
|
+
# @return [String]
|
1200
|
+
attr_accessor :filters_expression
|
1201
|
+
|
1169
1202
|
# The Analytics
|
1170
1203
|
# [view ID](https://support.google.com/analytics/answer/1009618)
|
1171
1204
|
# from which to retrieve data. Every [ReportRequest](#ReportRequest)
|
@@ -1250,26 +1283,19 @@ module Google
|
|
1250
1283
|
# @return [Array<Google::Apis::AnalyticsreportingV4::Pivot>]
|
1251
1284
|
attr_accessor :pivots
|
1252
1285
|
|
1253
|
-
# If set to false, the response does not include rows if all the retrieved
|
1254
|
-
# metrics are equal to zero. The default is false which will exclude these
|
1255
|
-
# rows.
|
1256
|
-
# Corresponds to the JSON property `includeEmptyRows`
|
1257
|
-
# @return [Boolean]
|
1258
|
-
attr_accessor :include_empty_rows
|
1259
|
-
alias_method :include_empty_rows?, :include_empty_rows
|
1260
|
-
|
1261
1286
|
def initialize(**args)
|
1262
1287
|
update!(**args)
|
1263
1288
|
end
|
1264
1289
|
|
1265
1290
|
# Update properties of this object
|
1266
1291
|
def update!(**args)
|
1292
|
+
@include_empty_rows = args[:include_empty_rows] if args.key?(:include_empty_rows)
|
1267
1293
|
@metric_filter_clauses = args[:metric_filter_clauses] if args.key?(:metric_filter_clauses)
|
1268
1294
|
@page_size = args[:page_size] if args.key?(:page_size)
|
1269
1295
|
@hide_totals = args[:hide_totals] if args.key?(:hide_totals)
|
1270
1296
|
@hide_value_ranges = args[:hide_value_ranges] if args.key?(:hide_value_ranges)
|
1271
|
-
@filters_expression = args[:filters_expression] if args.key?(:filters_expression)
|
1272
1297
|
@cohort_group = args[:cohort_group] if args.key?(:cohort_group)
|
1298
|
+
@filters_expression = args[:filters_expression] if args.key?(:filters_expression)
|
1273
1299
|
@view_id = args[:view_id] if args.key?(:view_id)
|
1274
1300
|
@metrics = args[:metrics] if args.key?(:metrics)
|
1275
1301
|
@dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses)
|
@@ -1280,7 +1306,6 @@ module Google
|
|
1280
1306
|
@page_token = args[:page_token] if args.key?(:page_token)
|
1281
1307
|
@date_ranges = args[:date_ranges] if args.key?(:date_ranges)
|
1282
1308
|
@pivots = args[:pivots] if args.key?(:pivots)
|
1283
|
-
@include_empty_rows = args[:include_empty_rows] if args.key?(:include_empty_rows)
|
1284
1309
|
end
|
1285
1310
|
end
|
1286
1311
|
|
@@ -1341,12 +1366,6 @@ module Google
|
|
1341
1366
|
class DynamicSegment
|
1342
1367
|
include Google::Apis::Core::Hashable
|
1343
1368
|
|
1344
|
-
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
1345
|
-
# are combined together with a logical `AND` operation.
|
1346
|
-
# Corresponds to the JSON property `sessionSegment`
|
1347
|
-
# @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
|
1348
|
-
attr_accessor :session_segment
|
1349
|
-
|
1350
1369
|
# The name of the dynamic segment.
|
1351
1370
|
# Corresponds to the JSON property `name`
|
1352
1371
|
# @return [String]
|
@@ -1358,15 +1377,21 @@ module Google
|
|
1358
1377
|
# @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
|
1359
1378
|
attr_accessor :user_segment
|
1360
1379
|
|
1380
|
+
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
1381
|
+
# are combined together with a logical `AND` operation.
|
1382
|
+
# Corresponds to the JSON property `sessionSegment`
|
1383
|
+
# @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
|
1384
|
+
attr_accessor :session_segment
|
1385
|
+
|
1361
1386
|
def initialize(**args)
|
1362
1387
|
update!(**args)
|
1363
1388
|
end
|
1364
1389
|
|
1365
1390
|
# Update properties of this object
|
1366
1391
|
def update!(**args)
|
1367
|
-
@session_segment = args[:session_segment] if args.key?(:session_segment)
|
1368
1392
|
@name = args[:name] if args.key?(:name)
|
1369
1393
|
@user_segment = args[:user_segment] if args.key?(:user_segment)
|
1394
|
+
@session_segment = args[:session_segment] if args.key?(:session_segment)
|
1370
1395
|
end
|
1371
1396
|
end
|
1372
1397
|
|
@@ -1390,31 +1415,6 @@ module Google
|
|
1390
1415
|
@or_filters_for_segment = args[:or_filters_for_segment] if args.key?(:or_filters_for_segment)
|
1391
1416
|
end
|
1392
1417
|
end
|
1393
|
-
|
1394
|
-
# Column headers.
|
1395
|
-
class ColumnHeader
|
1396
|
-
include Google::Apis::Core::Hashable
|
1397
|
-
|
1398
|
-
# The headers for the metrics.
|
1399
|
-
# Corresponds to the JSON property `metricHeader`
|
1400
|
-
# @return [Google::Apis::AnalyticsreportingV4::MetricHeader]
|
1401
|
-
attr_accessor :metric_header
|
1402
|
-
|
1403
|
-
# The dimension names in the response.
|
1404
|
-
# Corresponds to the JSON property `dimensions`
|
1405
|
-
# @return [Array<String>]
|
1406
|
-
attr_accessor :dimensions
|
1407
|
-
|
1408
|
-
def initialize(**args)
|
1409
|
-
update!(**args)
|
1410
|
-
end
|
1411
|
-
|
1412
|
-
# Update properties of this object
|
1413
|
-
def update!(**args)
|
1414
|
-
@metric_header = args[:metric_header] if args.key?(:metric_header)
|
1415
|
-
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
1416
|
-
end
|
1417
|
-
end
|
1418
1418
|
end
|
1419
1419
|
end
|
1420
1420
|
end
|