google-api-client 0.10.0 → 0.10.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +1 -1
- data/api_names.yaml +37747 -36512
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +1016 -114
- data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +426 -22
- data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +481 -95
- data/generated/google/apis/adexchangebuyer_v1_4.rb +1 -1
- data/generated/google/apis/adexchangebuyer_v1_4/classes.rb +27 -10
- data/generated/google/apis/adexchangebuyer_v1_4/representations.rb +1 -0
- data/generated/google/apis/admin_reports_v1.rb +2 -2
- data/generated/google/apis/adsense_v1_4.rb +1 -1
- data/generated/google/apis/adsensehost_v4_1.rb +1 -1
- data/generated/google/apis/analytics_v3.rb +1 -1
- data/generated/google/apis/analyticsreporting_v4.rb +4 -4
- data/generated/google/apis/analyticsreporting_v4/classes.rb +428 -428
- data/generated/google/apis/analyticsreporting_v4/representations.rb +108 -108
- data/generated/google/apis/androidenterprise_v1.rb +1 -1
- data/generated/google/apis/androidenterprise_v1/classes.rb +60 -66
- data/generated/google/apis/androidenterprise_v1/service.rb +12 -11
- data/generated/google/apis/androidpublisher_v2.rb +1 -1
- data/generated/google/apis/androidpublisher_v2/classes.rb +7 -0
- data/generated/google/apis/androidpublisher_v2/representations.rb +1 -0
- data/generated/google/apis/androidpublisher_v2/service.rb +1 -1
- data/generated/google/apis/appsactivity_v1.rb +3 -3
- data/generated/google/apis/appsactivity_v1/service.rb +1 -1
- data/generated/google/apis/appstate_v1.rb +1 -1
- data/generated/google/apis/bigquery_v2.rb +1 -1
- data/generated/google/apis/bigquery_v2/classes.rb +34 -8
- data/generated/google/apis/bigquery_v2/representations.rb +15 -0
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/calendar_v3/classes.rb +3 -5
- data/generated/google/apis/classroom_v1.rb +25 -22
- data/generated/google/apis/classroom_v1/classes.rb +910 -1001
- data/generated/google/apis/classroom_v1/representations.rb +240 -240
- data/generated/google/apis/classroom_v1/service.rb +1064 -1272
- data/generated/google/apis/cloudbilling_v1.rb +3 -3
- data/generated/google/apis/cloudbilling_v1/classes.rb +76 -75
- data/generated/google/apis/cloudbilling_v1/representations.rb +17 -17
- data/generated/google/apis/cloudbilling_v1/service.rb +117 -110
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1/classes.rb +238 -238
- data/generated/google/apis/cloudbuild_v1/representations.rb +48 -48
- data/generated/google/apis/cloudbuild_v1/service.rb +176 -176
- data/generated/google/apis/clouddebugger_v2.rb +4 -4
- data/generated/google/apis/clouddebugger_v2/classes.rb +315 -315
- data/generated/google/apis/clouddebugger_v2/representations.rb +90 -90
- data/generated/google/apis/clouddebugger_v2/service.rb +152 -152
- data/generated/google/apis/cloudkms_v1.rb +35 -0
- data/generated/google/apis/cloudkms_v1/classes.rb +1039 -0
- data/generated/google/apis/cloudkms_v1/representations.rb +448 -0
- data/generated/google/apis/cloudkms_v1/service.rb +933 -0
- data/generated/google/apis/cloudkms_v1beta1.rb +1 -1
- data/generated/google/apis/cloudkms_v1beta1/classes.rb +645 -605
- data/generated/google/apis/cloudkms_v1beta1/representations.rb +136 -136
- data/generated/google/apis/cloudkms_v1beta1/service.rb +258 -264
- data/generated/google/apis/cloudmonitoring_v2beta2.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +677 -456
- data/generated/google/apis/cloudresourcemanager_v1/representations.rb +154 -89
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +380 -279
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +4 -4
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +247 -114
- data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +72 -40
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +202 -208
- data/generated/google/apis/cloudtrace_v1.rb +4 -4
- data/generated/google/apis/cloudtrace_v1/classes.rb +39 -39
- data/generated/google/apis/cloudtrace_v1/representations.rb +13 -13
- data/generated/google/apis/cloudtrace_v1/service.rb +18 -18
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +813 -82
- data/generated/google/apis/compute_beta/representations.rb +305 -0
- data/generated/google/apis/compute_beta/service.rb +971 -180
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +147 -21
- data/generated/google/apis/compute_v1/representations.rb +38 -0
- data/generated/google/apis/compute_v1/service.rb +347 -65
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +2 -1
- data/generated/google/apis/dataflow_v1b3.rb +1 -1
- data/generated/google/apis/dataflow_v1b3/classes.rb +3352 -3110
- data/generated/google/apis/dataflow_v1b3/representations.rb +812 -730
- data/generated/google/apis/dataflow_v1b3/service.rb +264 -183
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +1200 -1164
- data/generated/google/apis/dataproc_v1/representations.rb +220 -204
- data/generated/google/apis/dataproc_v1/service.rb +299 -299
- data/generated/google/apis/datastore_v1.rb +4 -4
- data/generated/google/apis/datastore_v1/classes.rb +688 -688
- data/generated/google/apis/datastore_v1/representations.rb +167 -167
- data/generated/google/apis/datastore_v1/service.rb +68 -68
- data/generated/google/apis/deploymentmanager_v2.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2/classes.rb +13 -3
- data/generated/google/apis/dns_v1.rb +1 -1
- data/generated/google/apis/dns_v2beta1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +1 -1
- 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 +487 -15
- data/generated/google/apis/drive_v2/representations.rb +120 -0
- data/generated/google/apis/drive_v2/service.rb +355 -38
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/classes.rb +416 -14
- data/generated/google/apis/drive_v3/representations.rb +99 -0
- data/generated/google/apis/drive_v3/service.rb +315 -28
- data/generated/google/apis/games_configuration_v1configuration.rb +1 -1
- data/generated/google/apis/games_management_v1management.rb +1 -1
- data/generated/google/apis/games_v1.rb +1 -1
- data/generated/google/apis/genomics_v1.rb +7 -7
- data/generated/google/apis/genomics_v1/classes.rb +2301 -2301
- data/generated/google/apis/genomics_v1/representations.rb +239 -239
- data/generated/google/apis/genomics_v1/service.rb +599 -599
- data/generated/google/apis/gmail_v1.rb +2 -2
- data/generated/google/apis/gmail_v1/service.rb +18 -1
- data/generated/google/apis/groupssettings_v1.rb +1 -1
- data/generated/google/apis/iam_v1.rb +1 -1
- data/generated/google/apis/iam_v1/classes.rb +440 -440
- data/generated/google/apis/iam_v1/representations.rb +96 -96
- data/generated/google/apis/iam_v1/service.rb +150 -150
- data/generated/google/apis/kgsearch_v1/service.rb +13 -13
- data/generated/google/apis/language_v1beta1.rb +1 -1
- data/generated/google/apis/language_v1beta1/classes.rb +235 -235
- data/generated/google/apis/language_v1beta1/representations.rb +73 -73
- data/generated/google/apis/language_v1beta1/service.rb +49 -49
- data/generated/google/apis/licensing_v1.rb +1 -1
- data/generated/google/apis/logging_v2beta1.rb +1 -1
- data/generated/google/apis/logging_v2beta1/classes.rb +888 -879
- data/generated/google/apis/logging_v2beta1/representations.rb +129 -129
- data/generated/google/apis/logging_v2beta1/service.rb +315 -316
- data/generated/google/apis/manufacturers_v1/classes.rb +139 -139
- data/generated/google/apis/manufacturers_v1/representations.rb +30 -30
- data/generated/google/apis/manufacturers_v1/service.rb +32 -32
- data/generated/google/apis/monitoring_v3.rb +4 -4
- data/generated/google/apis/monitoring_v3/classes.rb +229 -229
- data/generated/google/apis/monitoring_v3/representations.rb +45 -45
- data/generated/google/apis/monitoring_v3/service.rb +141 -141
- data/generated/google/apis/partners_v2.rb +3 -3
- data/generated/google/apis/partners_v2/classes.rb +1837 -483
- data/generated/google/apis/partners_v2/representations.rb +614 -157
- data/generated/google/apis/partners_v2/service.rb +881 -150
- data/generated/google/apis/people_v1.rb +1 -1
- data/generated/google/apis/people_v1/classes.rb +517 -465
- data/generated/google/apis/people_v1/representations.rb +138 -107
- data/generated/google/apis/people_v1/service.rb +56 -49
- 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.rb +1 -1
- data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +529 -458
- data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +98 -97
- data/generated/google/apis/proximitybeacon_v1beta1/service.rb +494 -370
- data/generated/google/apis/pubsub_v1.rb +4 -4
- data/generated/google/apis/pubsub_v1/classes.rb +203 -203
- data/generated/google/apis/pubsub_v1/representations.rb +65 -65
- data/generated/google/apis/pubsub_v1/service.rb +226 -217
- data/generated/google/apis/reseller_v1.rb +1 -1
- data/generated/google/apis/reseller_v1/classes.rb +213 -61
- data/generated/google/apis/reseller_v1/representations.rb +27 -0
- data/generated/google/apis/reseller_v1/service.rb +240 -47
- data/generated/google/apis/script_v1.rb +14 -14
- data/generated/google/apis/script_v1/classes.rb +95 -95
- data/generated/google/apis/script_v1/representations.rb +25 -25
- data/generated/google/apis/sheets_v4.rb +1 -1
- data/generated/google/apis/sheets_v4/classes.rb +4346 -4300
- data/generated/google/apis/sheets_v4/representations.rb +853 -837
- data/generated/google/apis/sheets_v4/service.rb +32 -32
- data/generated/google/apis/slides_v1.rb +1 -1
- data/generated/google/apis/slides_v1/classes.rb +804 -748
- data/generated/google/apis/slides_v1/representations.rb +204 -187
- data/generated/google/apis/slides_v1/service.rb +16 -16
- data/generated/google/apis/speech_v1beta1.rb +1 -1
- data/generated/google/apis/speech_v1beta1/classes.rb +57 -57
- data/generated/google/apis/speech_v1beta1/representations.rb +19 -19
- data/generated/google/apis/speech_v1beta1/service.rb +66 -66
- data/generated/google/apis/sqladmin_v1beta4.rb +1 -1
- data/generated/google/apis/sqladmin_v1beta4/classes.rb +32 -7
- data/generated/google/apis/sqladmin_v1beta4/representations.rb +16 -0
- data/generated/google/apis/sqladmin_v1beta4/service.rb +9 -2
- data/generated/google/apis/storage_v1.rb +1 -1
- data/generated/google/apis/storage_v1/service.rb +10 -7
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +1393 -865
- data/generated/google/apis/vision_v1/representations.rb +367 -102
- data/generated/google/apis/vision_v1/service.rb +4 -4
- data/generated/google/apis/youtube_analytics_v1.rb +1 -1
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtubereporting_v1.rb +4 -4
- data/generated/google/apis/youtubereporting_v1/classes.rb +93 -93
- data/generated/google/apis/youtubereporting_v1/representations.rb +25 -25
- data/generated/google/apis/youtubereporting_v1/service.rb +108 -108
- data/lib/google/apis/version.rb +1 -1
- metadata +34 -30
@@ -26,7 +26,7 @@ module Google
|
|
26
26
|
# @see https://developers.google.com/ad-exchange/buyer-rest
|
27
27
|
module AdexchangebuyerV1_4
|
28
28
|
VERSION = 'V1_4'
|
29
|
-
REVISION = '
|
29
|
+
REVISION = '20170215'
|
30
30
|
|
31
31
|
# Manage your Ad Exchange buyer account configuration
|
32
32
|
AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'
|
@@ -489,7 +489,8 @@ module Google
|
|
489
489
|
# @return [Array<String>]
|
490
490
|
attr_accessor :advertiser_id
|
491
491
|
|
492
|
-
# The name of the company being advertised in the creative.
|
492
|
+
# The name of the company being advertised in the creative. The value provided
|
493
|
+
# must exist in the advertisers.txt file.
|
493
494
|
# Corresponds to the JSON property `advertiserName`
|
494
495
|
# @return [String]
|
495
496
|
attr_accessor :advertiser_name
|
@@ -506,7 +507,9 @@ module Google
|
|
506
507
|
# @return [DateTime]
|
507
508
|
attr_accessor :api_upload_timestamp
|
508
509
|
|
509
|
-
#
|
510
|
+
# List of buyer selectable attributes for the ads that may be shown from this
|
511
|
+
# snippet. Each attribute is represented by an integer as defined in buyer-
|
512
|
+
# declarable-creative-attributes.txt.
|
510
513
|
# Corresponds to the JSON property `attribute`
|
511
514
|
# @return [Array<Fixnum>]
|
512
515
|
attr_accessor :attribute
|
@@ -584,19 +587,23 @@ module Google
|
|
584
587
|
# @return [String]
|
585
588
|
attr_accessor :open_auction_status
|
586
589
|
|
587
|
-
# Detected product categories, if any.
|
588
|
-
# in
|
590
|
+
# Detected product categories, if any. Each category is represented by an
|
591
|
+
# integer as defined in ad-product-categories.txt. Read-only. This field should
|
592
|
+
# not be set in requests.
|
589
593
|
# Corresponds to the JSON property `productCategories`
|
590
594
|
# @return [Array<Fixnum>]
|
591
595
|
attr_accessor :product_categories
|
592
596
|
|
593
597
|
# All restricted categories for the ads that may be shown from this snippet.
|
598
|
+
# Each category is represented by an integer as defined in the ad-restricted-
|
599
|
+
# categories.txt.
|
594
600
|
# Corresponds to the JSON property `restrictedCategories`
|
595
601
|
# @return [Array<Fixnum>]
|
596
602
|
attr_accessor :restricted_categories
|
597
603
|
|
598
|
-
# Detected sensitive categories, if any.
|
599
|
-
# in
|
604
|
+
# Detected sensitive categories, if any. Each category is represented by an
|
605
|
+
# integer as defined in ad-sensitive-categories.txt. Read-only. This field
|
606
|
+
# should not be set in requests.
|
600
607
|
# Corresponds to the JSON property `sensitiveCategories`
|
601
608
|
# @return [Array<Fixnum>]
|
602
609
|
attr_accessor :sensitive_categories
|
@@ -609,7 +616,8 @@ module Google
|
|
609
616
|
# @return [Array<Google::Apis::AdexchangebuyerV1_4::Creative::ServingRestriction>]
|
610
617
|
attr_accessor :serving_restrictions
|
611
618
|
|
612
|
-
#
|
619
|
+
# List of vendor types for the ads that may be shown from this snippet. Each
|
620
|
+
# vendor type is represented by an integer as defined in vendors.txt.
|
613
621
|
# Corresponds to the JSON property `vendorType`
|
614
622
|
# @return [Array<Fixnum>]
|
615
623
|
attr_accessor :vendor_type
|
@@ -774,8 +782,7 @@ module Google
|
|
774
782
|
# @return [String]
|
775
783
|
attr_accessor :filtering_count
|
776
784
|
|
777
|
-
# The filtering status code
|
778
|
-
# for different statuses.
|
785
|
+
# The filtering status code as defined in creative-status-codes.txt.
|
779
786
|
# Corresponds to the JSON property `filteringStatus`
|
780
787
|
# @return [Fixnum]
|
781
788
|
attr_accessor :filtering_status
|
@@ -1035,7 +1042,8 @@ module Google
|
|
1035
1042
|
attr_accessor :context_type
|
1036
1043
|
|
1037
1044
|
# Only set when contextType=LOCATION. Represents the geo criterias this
|
1038
|
-
# restriction applies to.
|
1045
|
+
# restriction applies to. Impressions are considered to match a context if
|
1046
|
+
# either the user location or publisher location matches a given geoCriteriaId.
|
1039
1047
|
# Corresponds to the JSON property `geoCriteriaId`
|
1040
1048
|
# @return [Array<Fixnum>]
|
1041
1049
|
attr_accessor :geo_criteria_id
|
@@ -1180,6 +1188,14 @@ module Google
|
|
1180
1188
|
class DealServingMetadata
|
1181
1189
|
include Google::Apis::Core::Hashable
|
1182
1190
|
|
1191
|
+
# True if alcohol ads are allowed for this deal (read-only). This field is only
|
1192
|
+
# populated when querying for finalized orders using the method
|
1193
|
+
# GetFinalizedOrderDeals
|
1194
|
+
# Corresponds to the JSON property `alcoholAdsAllowed`
|
1195
|
+
# @return [Boolean]
|
1196
|
+
attr_accessor :alcohol_ads_allowed
|
1197
|
+
alias_method :alcohol_ads_allowed?, :alcohol_ads_allowed
|
1198
|
+
|
1183
1199
|
# Tracks which parties (if any) have paused a deal. The deal is considered
|
1184
1200
|
# paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused
|
1185
1201
|
# or the has_seller_paused bits can be set independently.
|
@@ -1193,6 +1209,7 @@ module Google
|
|
1193
1209
|
|
1194
1210
|
# Update properties of this object
|
1195
1211
|
def update!(**args)
|
1212
|
+
@alcohol_ads_allowed = args[:alcohol_ads_allowed] if args.key?(:alcohol_ads_allowed)
|
1196
1213
|
@deal_pause_status = args[:deal_pause_status] if args.key?(:deal_pause_status)
|
1197
1214
|
end
|
1198
1215
|
end
|
@@ -802,6 +802,7 @@ module Google
|
|
802
802
|
class DealServingMetadata
|
803
803
|
# @private
|
804
804
|
class Representation < Google::Apis::Core::JsonRepresentation
|
805
|
+
property :alcohol_ads_allowed, as: 'alcoholAdsAllowed'
|
805
806
|
property :deal_pause_status, as: 'dealPauseStatus', class: Google::Apis::AdexchangebuyerV1_4::DealServingMetadataDealPauseStatus, decorator: Google::Apis::AdexchangebuyerV1_4::DealServingMetadataDealPauseStatus::Representation
|
806
807
|
|
807
808
|
end
|
@@ -28,10 +28,10 @@ module Google
|
|
28
28
|
VERSION = 'ReportsV1'
|
29
29
|
REVISION = '20160704'
|
30
30
|
|
31
|
-
# View audit reports
|
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'
|
33
33
|
|
34
|
-
# View usage reports
|
34
|
+
# View usage reports for your G Suite domain
|
35
35
|
AUTH_ADMIN_REPORTS_USAGE_READONLY = 'https://www.googleapis.com/auth/admin.reports.usage.readonly'
|
36
36
|
end
|
37
37
|
end
|
@@ -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 = '20170304'
|
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 = '20170304'
|
30
30
|
|
31
31
|
# View and manage your AdSense host data and associated accounts
|
32
32
|
AUTH_ADSENSEHOST = 'https://www.googleapis.com/auth/adsensehost'
|
@@ -25,7 +25,7 @@ module Google
|
|
25
25
|
# @see https://developers.google.com/analytics/
|
26
26
|
module AnalyticsV3
|
27
27
|
VERSION = 'V3'
|
28
|
-
REVISION = '
|
28
|
+
REVISION = '20170302'
|
29
29
|
|
30
30
|
# View and manage your Google Analytics data
|
31
31
|
AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics'
|
@@ -25,13 +25,13 @@ module Google
|
|
25
25
|
# @see https://developers.google.com/analytics/devguides/reporting/core/v4/
|
26
26
|
module AnalyticsreportingV4
|
27
27
|
VERSION = 'V4'
|
28
|
-
REVISION = '
|
29
|
-
|
30
|
-
# View and manage your Google Analytics data
|
31
|
-
AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics'
|
28
|
+
REVISION = '20170309'
|
32
29
|
|
33
30
|
# View your Google Analytics data
|
34
31
|
AUTH_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/analytics.readonly'
|
32
|
+
|
33
|
+
# View and manage your Google Analytics data
|
34
|
+
AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics'
|
35
35
|
end
|
36
36
|
end
|
37
37
|
end
|
@@ -22,15 +22,235 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module AnalyticsreportingV4
|
24
24
|
|
25
|
-
#
|
26
|
-
|
25
|
+
# The headers for the each of the metric column corresponding to the metrics
|
26
|
+
# requested in the pivots section of the response.
|
27
|
+
class PivotHeaderEntry
|
27
28
|
include Google::Apis::Core::Hashable
|
28
29
|
|
29
|
-
#
|
30
|
-
# Corresponds to the JSON property `
|
30
|
+
# The name of the dimensions in the pivot response.
|
31
|
+
# Corresponds to the JSON property `dimensionNames`
|
32
|
+
# @return [Array<String>]
|
33
|
+
attr_accessor :dimension_names
|
34
|
+
|
35
|
+
# Header for the metrics.
|
36
|
+
# Corresponds to the JSON property `metric`
|
37
|
+
# @return [Google::Apis::AnalyticsreportingV4::MetricHeaderEntry]
|
38
|
+
attr_accessor :metric
|
39
|
+
|
40
|
+
# The values for the dimensions in the pivot.
|
41
|
+
# Corresponds to the JSON property `dimensionValues`
|
42
|
+
# @return [Array<String>]
|
43
|
+
attr_accessor :dimension_values
|
44
|
+
|
45
|
+
def initialize(**args)
|
46
|
+
update!(**args)
|
47
|
+
end
|
48
|
+
|
49
|
+
# Update properties of this object
|
50
|
+
def update!(**args)
|
51
|
+
@dimension_names = args[:dimension_names] if args.key?(:dimension_names)
|
52
|
+
@metric = args[:metric] if args.key?(:metric)
|
53
|
+
@dimension_values = args[:dimension_values] if args.key?(:dimension_values)
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
# SegmentFilter defines the segment to be either a simple or a sequence
|
58
|
+
# segment. A simple segment condition contains dimension and metric conditions
|
59
|
+
# to select the sessions or users. A sequence segment condition can be used to
|
60
|
+
# select users or sessions based on sequential conditions.
|
61
|
+
class SegmentFilter
|
62
|
+
include Google::Apis::Core::Hashable
|
63
|
+
|
64
|
+
# If true, match the complement of simple or sequence segment.
|
65
|
+
# For example, to match all visits not from "New York", we can define the
|
66
|
+
# segment as follows:
|
67
|
+
# "sessionSegment": `
|
68
|
+
# "segmentFilters": [`
|
69
|
+
# "simpleSegment" :`
|
70
|
+
# "orFiltersForSegment": [`
|
71
|
+
# "segmentFilterClauses":[`
|
72
|
+
# "dimensionFilter": `
|
73
|
+
# "dimensionName": "ga:city",
|
74
|
+
# "expressions": ["New York"]
|
75
|
+
# `
|
76
|
+
# `]
|
77
|
+
# `]
|
78
|
+
# `,
|
79
|
+
# "not": "True"
|
80
|
+
# `]
|
81
|
+
# `,
|
82
|
+
# Corresponds to the JSON property `not`
|
31
83
|
# @return [Boolean]
|
32
|
-
attr_accessor :
|
33
|
-
alias_method :
|
84
|
+
attr_accessor :not
|
85
|
+
alias_method :not?, :not
|
86
|
+
|
87
|
+
# A Simple segment conditions consist of one or more dimension/metric
|
88
|
+
# conditions that can be combined.
|
89
|
+
# Corresponds to the JSON property `simpleSegment`
|
90
|
+
# @return [Google::Apis::AnalyticsreportingV4::SimpleSegment]
|
91
|
+
attr_accessor :simple_segment
|
92
|
+
|
93
|
+
# Sequence conditions consist of one or more steps, where each step is defined
|
94
|
+
# by one or more dimension/metric conditions. Multiple steps can be combined
|
95
|
+
# with special sequence operators.
|
96
|
+
# Corresponds to the JSON property `sequenceSegment`
|
97
|
+
# @return [Google::Apis::AnalyticsreportingV4::SequenceSegment]
|
98
|
+
attr_accessor :sequence_segment
|
99
|
+
|
100
|
+
def initialize(**args)
|
101
|
+
update!(**args)
|
102
|
+
end
|
103
|
+
|
104
|
+
# Update properties of this object
|
105
|
+
def update!(**args)
|
106
|
+
@not = args[:not] if args.key?(:not)
|
107
|
+
@simple_segment = args[:simple_segment] if args.key?(:simple_segment)
|
108
|
+
@sequence_segment = args[:sequence_segment] if args.key?(:sequence_segment)
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
113
|
+
# are combined together with a logical `AND` operation.
|
114
|
+
class SegmentDefinition
|
115
|
+
include Google::Apis::Core::Hashable
|
116
|
+
|
117
|
+
# A segment is defined by a set of segment filters which are combined
|
118
|
+
# together with a logical `AND` operation.
|
119
|
+
# Corresponds to the JSON property `segmentFilters`
|
120
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::SegmentFilter>]
|
121
|
+
attr_accessor :segment_filters
|
122
|
+
|
123
|
+
def initialize(**args)
|
124
|
+
update!(**args)
|
125
|
+
end
|
126
|
+
|
127
|
+
# Update properties of this object
|
128
|
+
def update!(**args)
|
129
|
+
@segment_filters = args[:segment_filters] if args.key?(:segment_filters)
|
130
|
+
end
|
131
|
+
end
|
132
|
+
|
133
|
+
# Header for the metrics.
|
134
|
+
class MetricHeaderEntry
|
135
|
+
include Google::Apis::Core::Hashable
|
136
|
+
|
137
|
+
# The name of the header.
|
138
|
+
# Corresponds to the JSON property `name`
|
139
|
+
# @return [String]
|
140
|
+
attr_accessor :name
|
141
|
+
|
142
|
+
# The type of the metric, for example `INTEGER`.
|
143
|
+
# Corresponds to the JSON property `type`
|
144
|
+
# @return [String]
|
145
|
+
attr_accessor :type
|
146
|
+
|
147
|
+
def initialize(**args)
|
148
|
+
update!(**args)
|
149
|
+
end
|
150
|
+
|
151
|
+
# Update properties of this object
|
152
|
+
def update!(**args)
|
153
|
+
@name = args[:name] if args.key?(:name)
|
154
|
+
@type = args[:type] if args.key?(:type)
|
155
|
+
end
|
156
|
+
end
|
157
|
+
|
158
|
+
# The data part of the report.
|
159
|
+
class ReportData
|
160
|
+
include Google::Apis::Core::Hashable
|
161
|
+
|
162
|
+
# If the results are
|
163
|
+
# [sampled](https://support.google.com/analytics/answer/2637192),
|
164
|
+
# this returns the total number of
|
165
|
+
# samples present, one entry per date range. If the results are not sampled
|
166
|
+
# this field will not be defined. See
|
167
|
+
# [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
|
168
|
+
# for details.
|
169
|
+
# Corresponds to the JSON property `samplingSpaceSizes`
|
170
|
+
# @return [Array<String>]
|
171
|
+
attr_accessor :sampling_space_sizes
|
172
|
+
|
173
|
+
# Minimum and maximum values seen over all matching rows. These are both
|
174
|
+
# empty when `hideValueRanges` in the request is false, or when
|
175
|
+
# rowCount is zero.
|
176
|
+
# Corresponds to the JSON property `minimums`
|
177
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
178
|
+
attr_accessor :minimums
|
179
|
+
|
180
|
+
# For each requested date range, for the set of all rows that match
|
181
|
+
# the query, every requested value format gets a total. The total
|
182
|
+
# for a value format is computed by first totaling the metrics
|
183
|
+
# mentioned in the value format and then evaluating the value
|
184
|
+
# format as a scalar expression. E.g., The "totals" for
|
185
|
+
# `3 / (ga:sessions + 2)` we compute
|
186
|
+
# `3 / ((sum of all relevant ga:sessions) + 2)`.
|
187
|
+
# Totals are computed before pagination.
|
188
|
+
# Corresponds to the JSON property `totals`
|
189
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
190
|
+
attr_accessor :totals
|
191
|
+
|
192
|
+
# If the results are
|
193
|
+
# [sampled](https://support.google.com/analytics/answer/2637192),
|
194
|
+
# this returns the total number of samples read, one entry per date range.
|
195
|
+
# If the results are not sampled this field will not be defined. See
|
196
|
+
# [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
|
197
|
+
# for details.
|
198
|
+
# Corresponds to the JSON property `samplesReadCounts`
|
199
|
+
# @return [Array<String>]
|
200
|
+
attr_accessor :samples_read_counts
|
201
|
+
|
202
|
+
# Total number of matching rows for this query.
|
203
|
+
# Corresponds to the JSON property `rowCount`
|
204
|
+
# @return [Fixnum]
|
205
|
+
attr_accessor :row_count
|
206
|
+
|
207
|
+
# There's one ReportRow for every unique combination of dimensions.
|
208
|
+
# Corresponds to the JSON property `rows`
|
209
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::ReportRow>]
|
210
|
+
attr_accessor :rows
|
211
|
+
|
212
|
+
# Indicates if response to this request is golden or not. Data is
|
213
|
+
# golden when the exact same request will not produce any new results if
|
214
|
+
# asked at a later point in time.
|
215
|
+
# Corresponds to the JSON property `isDataGolden`
|
216
|
+
# @return [Boolean]
|
217
|
+
attr_accessor :is_data_golden
|
218
|
+
alias_method :is_data_golden?, :is_data_golden
|
219
|
+
|
220
|
+
# The last time the data in the report was refreshed. All the hits received
|
221
|
+
# before this timestamp are included in the calculation of the report.
|
222
|
+
# Corresponds to the JSON property `dataLastRefreshed`
|
223
|
+
# @return [String]
|
224
|
+
attr_accessor :data_last_refreshed
|
225
|
+
|
226
|
+
# Minimum and maximum values seen over all matching rows. These are both
|
227
|
+
# empty when `hideValueRanges` in the request is false, or when
|
228
|
+
# rowCount is zero.
|
229
|
+
# Corresponds to the JSON property `maximums`
|
230
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
231
|
+
attr_accessor :maximums
|
232
|
+
|
233
|
+
def initialize(**args)
|
234
|
+
update!(**args)
|
235
|
+
end
|
236
|
+
|
237
|
+
# Update properties of this object
|
238
|
+
def update!(**args)
|
239
|
+
@sampling_space_sizes = args[:sampling_space_sizes] if args.key?(:sampling_space_sizes)
|
240
|
+
@minimums = args[:minimums] if args.key?(:minimums)
|
241
|
+
@totals = args[:totals] if args.key?(:totals)
|
242
|
+
@samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts)
|
243
|
+
@row_count = args[:row_count] if args.key?(:row_count)
|
244
|
+
@rows = args[:rows] if args.key?(:rows)
|
245
|
+
@is_data_golden = args[:is_data_golden] if args.key?(:is_data_golden)
|
246
|
+
@data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed)
|
247
|
+
@maximums = args[:maximums] if args.key?(:maximums)
|
248
|
+
end
|
249
|
+
end
|
250
|
+
|
251
|
+
# Dimension filter specifies the filtering options on a dimension.
|
252
|
+
class DimensionFilter
|
253
|
+
include Google::Apis::Core::Hashable
|
34
254
|
|
35
255
|
# The dimension to filter on. A DimensionFilter must contain a dimension.
|
36
256
|
# Corresponds to the JSON property `dimensionName`
|
@@ -57,17 +277,23 @@ module Google
|
|
57
277
|
# @return [Array<String>]
|
58
278
|
attr_accessor :expressions
|
59
279
|
|
280
|
+
# Should the match be case sensitive? Default is false.
|
281
|
+
# Corresponds to the JSON property `caseSensitive`
|
282
|
+
# @return [Boolean]
|
283
|
+
attr_accessor :case_sensitive
|
284
|
+
alias_method :case_sensitive?, :case_sensitive
|
285
|
+
|
60
286
|
def initialize(**args)
|
61
287
|
update!(**args)
|
62
288
|
end
|
63
289
|
|
64
290
|
# Update properties of this object
|
65
291
|
def update!(**args)
|
66
|
-
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
67
292
|
@dimension_name = args[:dimension_name] if args.key?(:dimension_name)
|
68
293
|
@operator = args[:operator] if args.key?(:operator)
|
69
294
|
@not = args[:not] if args.key?(:not)
|
70
295
|
@expressions = args[:expressions] if args.key?(:expressions)
|
296
|
+
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
71
297
|
end
|
72
298
|
end
|
73
299
|
|
@@ -137,6 +363,17 @@ module Google
|
|
137
363
|
class SegmentDimensionFilter
|
138
364
|
include Google::Apis::Core::Hashable
|
139
365
|
|
366
|
+
# Should the match be case sensitive, ignored for `IN_LIST` operator.
|
367
|
+
# Corresponds to the JSON property `caseSensitive`
|
368
|
+
# @return [Boolean]
|
369
|
+
attr_accessor :case_sensitive
|
370
|
+
alias_method :case_sensitive?, :case_sensitive
|
371
|
+
|
372
|
+
# Minimum comparison values for `BETWEEN` match type.
|
373
|
+
# Corresponds to the JSON property `minComparisonValue`
|
374
|
+
# @return [String]
|
375
|
+
attr_accessor :min_comparison_value
|
376
|
+
|
140
377
|
# Maximum comparison values for `BETWEEN` match type.
|
141
378
|
# Corresponds to the JSON property `maxComparisonValue`
|
142
379
|
# @return [String]
|
@@ -157,29 +394,18 @@ module Google
|
|
157
394
|
# @return [Array<String>]
|
158
395
|
attr_accessor :expressions
|
159
396
|
|
160
|
-
# Should the match be case sensitive, ignored for `IN_LIST` operator.
|
161
|
-
# Corresponds to the JSON property `caseSensitive`
|
162
|
-
# @return [Boolean]
|
163
|
-
attr_accessor :case_sensitive
|
164
|
-
alias_method :case_sensitive?, :case_sensitive
|
165
|
-
|
166
|
-
# Minimum comparison values for `BETWEEN` match type.
|
167
|
-
# Corresponds to the JSON property `minComparisonValue`
|
168
|
-
# @return [String]
|
169
|
-
attr_accessor :min_comparison_value
|
170
|
-
|
171
397
|
def initialize(**args)
|
172
398
|
update!(**args)
|
173
399
|
end
|
174
400
|
|
175
401
|
# Update properties of this object
|
176
402
|
def update!(**args)
|
403
|
+
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
404
|
+
@min_comparison_value = args[:min_comparison_value] if args.key?(:min_comparison_value)
|
177
405
|
@max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value)
|
178
406
|
@dimension_name = args[:dimension_name] if args.key?(:dimension_name)
|
179
407
|
@operator = args[:operator] if args.key?(:operator)
|
180
408
|
@expressions = args[:expressions] if args.key?(:expressions)
|
181
|
-
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
182
|
-
@min_comparison_value = args[:min_comparison_value] if args.key?(:min_comparison_value)
|
183
409
|
end
|
184
410
|
end
|
185
411
|
|
@@ -216,6 +442,18 @@ module Google
|
|
216
442
|
class Metric
|
217
443
|
include Google::Apis::Core::Hashable
|
218
444
|
|
445
|
+
# A metric expression in the request. An expression is constructed from one
|
446
|
+
# or more metrics and numbers. Accepted operators include: Plus (+), Minus
|
447
|
+
# (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
|
448
|
+
# Positive cardinal numbers (0-9), can include decimals and is limited to
|
449
|
+
# 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
|
450
|
+
# metric expression is just a single metric name like `ga:users`.
|
451
|
+
# Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
|
452
|
+
# will result in unexpected results.
|
453
|
+
# Corresponds to the JSON property `expression`
|
454
|
+
# @return [String]
|
455
|
+
attr_accessor :expression
|
456
|
+
|
219
457
|
# Specifies how the metric expression should be formatted, for example
|
220
458
|
# `INTEGER`.
|
221
459
|
# Corresponds to the JSON property `formattingType`
|
@@ -231,27 +469,15 @@ module Google
|
|
231
469
|
# @return [String]
|
232
470
|
attr_accessor :alias
|
233
471
|
|
234
|
-
# A metric expression in the request. An expression is constructed from one
|
235
|
-
# or more metrics and numbers. Accepted operators include: Plus (+), Minus
|
236
|
-
# (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
|
237
|
-
# Positive cardinal numbers (0-9), can include decimals and is limited to
|
238
|
-
# 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
|
239
|
-
# metric expression is just a single metric name like `ga:users`.
|
240
|
-
# Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
|
241
|
-
# will result in unexpected results.
|
242
|
-
# Corresponds to the JSON property `expression`
|
243
|
-
# @return [String]
|
244
|
-
attr_accessor :expression
|
245
|
-
|
246
472
|
def initialize(**args)
|
247
473
|
update!(**args)
|
248
474
|
end
|
249
475
|
|
250
476
|
# Update properties of this object
|
251
477
|
def update!(**args)
|
478
|
+
@expression = args[:expression] if args.key?(:expression)
|
252
479
|
@formatting_type = args[:formatting_type] if args.key?(:formatting_type)
|
253
480
|
@alias = args[:alias] if args.key?(:alias)
|
254
|
-
@expression = args[:expression] if args.key?(:expression)
|
255
481
|
end
|
256
482
|
end
|
257
483
|
|
@@ -278,6 +504,11 @@ module Google
|
|
278
504
|
class Report
|
279
505
|
include Google::Apis::Core::Hashable
|
280
506
|
|
507
|
+
# Column headers.
|
508
|
+
# Corresponds to the JSON property `columnHeader`
|
509
|
+
# @return [Google::Apis::AnalyticsreportingV4::ColumnHeader]
|
510
|
+
attr_accessor :column_header
|
511
|
+
|
281
512
|
# The data part of the report.
|
282
513
|
# Corresponds to the JSON property `data`
|
283
514
|
# @return [Google::Apis::AnalyticsreportingV4::ReportData]
|
@@ -288,20 +519,15 @@ module Google
|
|
288
519
|
# @return [String]
|
289
520
|
attr_accessor :next_page_token
|
290
521
|
|
291
|
-
# Column headers.
|
292
|
-
# Corresponds to the JSON property `columnHeader`
|
293
|
-
# @return [Google::Apis::AnalyticsreportingV4::ColumnHeader]
|
294
|
-
attr_accessor :column_header
|
295
|
-
|
296
522
|
def initialize(**args)
|
297
523
|
update!(**args)
|
298
524
|
end
|
299
525
|
|
300
526
|
# Update properties of this object
|
301
527
|
def update!(**args)
|
528
|
+
@column_header = args[:column_header] if args.key?(:column_header)
|
302
529
|
@data = args[:data] if args.key?(:data)
|
303
530
|
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
304
|
-
@column_header = args[:column_header] if args.key?(:column_header)
|
305
531
|
end
|
306
532
|
end
|
307
533
|
|
@@ -336,57 +562,15 @@ module Google
|
|
336
562
|
class DateRange
|
337
563
|
include Google::Apis::Core::Hashable
|
338
564
|
|
339
|
-
# The end date for the query in the format `YYYY-MM-DD`.
|
340
|
-
# Corresponds to the JSON property `endDate`
|
341
|
-
# @return [String]
|
342
|
-
attr_accessor :end_date
|
343
|
-
|
344
565
|
# The start date for the query in the format `YYYY-MM-DD`.
|
345
566
|
# Corresponds to the JSON property `startDate`
|
346
567
|
# @return [String]
|
347
568
|
attr_accessor :start_date
|
348
569
|
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
# Update properties of this object
|
354
|
-
def update!(**args)
|
355
|
-
@end_date = args[:end_date] if args.key?(:end_date)
|
356
|
-
@start_date = args[:start_date] if args.key?(:start_date)
|
357
|
-
end
|
358
|
-
end
|
359
|
-
|
360
|
-
# MetricFilter specifies the filter on a metric.
|
361
|
-
class MetricFilter
|
362
|
-
include Google::Apis::Core::Hashable
|
363
|
-
|
364
|
-
# The metric that will be filtered on. A metricFilter must contain a metric
|
365
|
-
# name. A metric name can be an alias earlier defined as a metric or it can
|
366
|
-
# also be a metric expression.
|
367
|
-
# Corresponds to the JSON property `metricName`
|
368
|
-
# @return [String]
|
369
|
-
attr_accessor :metric_name
|
370
|
-
|
371
|
-
# The value to compare against.
|
372
|
-
# Corresponds to the JSON property `comparisonValue`
|
373
|
-
# @return [String]
|
374
|
-
attr_accessor :comparison_value
|
375
|
-
|
376
|
-
# Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the
|
377
|
-
# comparisonValue, the default is `EQUAL`. If the operator is
|
378
|
-
# `IS_MISSING`, checks if the metric is missing and would ignore the
|
379
|
-
# comparisonValue.
|
380
|
-
# Corresponds to the JSON property `operator`
|
381
|
-
# @return [String]
|
382
|
-
attr_accessor :operator
|
383
|
-
|
384
|
-
# Logical `NOT` operator. If this boolean is set to true, then the matching
|
385
|
-
# metric values will be excluded in the report. The default is false.
|
386
|
-
# Corresponds to the JSON property `not`
|
387
|
-
# @return [Boolean]
|
388
|
-
attr_accessor :not
|
389
|
-
alias_method :not?, :not
|
570
|
+
# The end date for the query in the format `YYYY-MM-DD`.
|
571
|
+
# Corresponds to the JSON property `endDate`
|
572
|
+
# @return [String]
|
573
|
+
attr_accessor :end_date
|
390
574
|
|
391
575
|
def initialize(**args)
|
392
576
|
update!(**args)
|
@@ -394,10 +578,8 @@ module Google
|
|
394
578
|
|
395
579
|
# Update properties of this object
|
396
580
|
def update!(**args)
|
397
|
-
@
|
398
|
-
@
|
399
|
-
@operator = args[:operator] if args.key?(:operator)
|
400
|
-
@not = args[:not] if args.key?(:not)
|
581
|
+
@start_date = args[:start_date] if args.key?(:start_date)
|
582
|
+
@end_date = args[:end_date] if args.key?(:end_date)
|
401
583
|
end
|
402
584
|
end
|
403
585
|
|
@@ -405,48 +587,6 @@ module Google
|
|
405
587
|
class ReportRequest
|
406
588
|
include Google::Apis::Core::Hashable
|
407
589
|
|
408
|
-
# The dimensions requested.
|
409
|
-
# Requests can have a total of 7 dimensions.
|
410
|
-
# Corresponds to the JSON property `dimensions`
|
411
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::Dimension>]
|
412
|
-
attr_accessor :dimensions
|
413
|
-
|
414
|
-
# Date ranges in the request. The request can have a maximum of 2 date
|
415
|
-
# ranges. The response will contain a set of metric values for each
|
416
|
-
# combination of the dimensions for each date range in the request. So, if
|
417
|
-
# there are two date ranges, there will be two set of metric values, one for
|
418
|
-
# the original date range and one for the second date range.
|
419
|
-
# The `reportRequest.dateRanges` field should not be specified for cohorts
|
420
|
-
# or Lifetime value requests.
|
421
|
-
# If a date range is not provided, the default date range is (startDate:
|
422
|
-
# current date - 7 days, endDate: current date - 1 day). Every
|
423
|
-
# [ReportRequest](#ReportRequest) within a `batchGet` method must
|
424
|
-
# contain the same `dateRanges` definition.
|
425
|
-
# Corresponds to the JSON property `dateRanges`
|
426
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRange>]
|
427
|
-
attr_accessor :date_ranges
|
428
|
-
|
429
|
-
# A continuation token to get the next page of the results. Adding this to
|
430
|
-
# the request will return the rows after the pageToken. The pageToken should
|
431
|
-
# be the value returned in the nextPageToken parameter in the response to
|
432
|
-
# the GetReports request.
|
433
|
-
# Corresponds to the JSON property `pageToken`
|
434
|
-
# @return [String]
|
435
|
-
attr_accessor :page_token
|
436
|
-
|
437
|
-
# The pivot definitions. Requests can have a maximum of 2 pivots.
|
438
|
-
# Corresponds to the JSON property `pivots`
|
439
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::Pivot>]
|
440
|
-
attr_accessor :pivots
|
441
|
-
|
442
|
-
# If set to false, the response does not include rows if all the retrieved
|
443
|
-
# metrics are equal to zero. The default is false which will exclude these
|
444
|
-
# rows.
|
445
|
-
# Corresponds to the JSON property `includeEmptyRows`
|
446
|
-
# @return [Boolean]
|
447
|
-
attr_accessor :include_empty_rows
|
448
|
-
alias_method :include_empty_rows?, :include_empty_rows
|
449
|
-
|
450
590
|
# The metric filter clauses. They are logically combined with the `AND`
|
451
591
|
# operator. Metric filters look at only the first date range and not the
|
452
592
|
# comparing date range. Note that filtering on metrics occurs after the
|
@@ -467,13 +607,6 @@ module Google
|
|
467
607
|
# @return [Fixnum]
|
468
608
|
attr_accessor :page_size
|
469
609
|
|
470
|
-
# If set to true, hides the total of all metrics for all the matching rows,
|
471
|
-
# for every date range. The default false and will return the totals.
|
472
|
-
# Corresponds to the JSON property `hideTotals`
|
473
|
-
# @return [Boolean]
|
474
|
-
attr_accessor :hide_totals
|
475
|
-
alias_method :hide_totals?, :hide_totals
|
476
|
-
|
477
610
|
# If set to true, hides the minimum and maximum across all matching rows.
|
478
611
|
# The default is false and the value ranges are returned.
|
479
612
|
# Corresponds to the JSON property `hideValueRanges`
|
@@ -481,6 +614,13 @@ module Google
|
|
481
614
|
attr_accessor :hide_value_ranges
|
482
615
|
alias_method :hide_value_ranges?, :hide_value_ranges
|
483
616
|
|
617
|
+
# If set to true, hides the total of all metrics for all the matching rows,
|
618
|
+
# for every date range. The default false and will return the totals.
|
619
|
+
# Corresponds to the JSON property `hideTotals`
|
620
|
+
# @return [Boolean]
|
621
|
+
attr_accessor :hide_totals
|
622
|
+
alias_method :hide_totals?, :hide_totals
|
623
|
+
|
484
624
|
# Dimension or metric filters that restrict the data returned for your
|
485
625
|
# request. To use the `filtersExpression`, supply a dimension or metric on
|
486
626
|
# which to filter, followed by the filter expression. For example, the
|
@@ -560,21 +700,58 @@ module Google
|
|
560
700
|
# @return [String]
|
561
701
|
attr_accessor :sampling_level
|
562
702
|
|
703
|
+
# The dimensions requested.
|
704
|
+
# Requests can have a total of 7 dimensions.
|
705
|
+
# Corresponds to the JSON property `dimensions`
|
706
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::Dimension>]
|
707
|
+
attr_accessor :dimensions
|
708
|
+
|
709
|
+
# A continuation token to get the next page of the results. Adding this to
|
710
|
+
# the request will return the rows after the pageToken. The pageToken should
|
711
|
+
# be the value returned in the nextPageToken parameter in the response to
|
712
|
+
# the GetReports request.
|
713
|
+
# Corresponds to the JSON property `pageToken`
|
714
|
+
# @return [String]
|
715
|
+
attr_accessor :page_token
|
716
|
+
|
717
|
+
# Date ranges in the request. The request can have a maximum of 2 date
|
718
|
+
# ranges. The response will contain a set of metric values for each
|
719
|
+
# combination of the dimensions for each date range in the request. So, if
|
720
|
+
# there are two date ranges, there will be two set of metric values, one for
|
721
|
+
# the original date range and one for the second date range.
|
722
|
+
# The `reportRequest.dateRanges` field should not be specified for cohorts
|
723
|
+
# or Lifetime value requests.
|
724
|
+
# If a date range is not provided, the default date range is (startDate:
|
725
|
+
# current date - 7 days, endDate: current date - 1 day). Every
|
726
|
+
# [ReportRequest](#ReportRequest) within a `batchGet` method must
|
727
|
+
# contain the same `dateRanges` definition.
|
728
|
+
# Corresponds to the JSON property `dateRanges`
|
729
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRange>]
|
730
|
+
attr_accessor :date_ranges
|
731
|
+
|
732
|
+
# The pivot definitions. Requests can have a maximum of 2 pivots.
|
733
|
+
# Corresponds to the JSON property `pivots`
|
734
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::Pivot>]
|
735
|
+
attr_accessor :pivots
|
736
|
+
|
737
|
+
# If set to false, the response does not include rows if all the retrieved
|
738
|
+
# metrics are equal to zero. The default is false which will exclude these
|
739
|
+
# rows.
|
740
|
+
# Corresponds to the JSON property `includeEmptyRows`
|
741
|
+
# @return [Boolean]
|
742
|
+
attr_accessor :include_empty_rows
|
743
|
+
alias_method :include_empty_rows?, :include_empty_rows
|
744
|
+
|
563
745
|
def initialize(**args)
|
564
746
|
update!(**args)
|
565
747
|
end
|
566
748
|
|
567
749
|
# Update properties of this object
|
568
750
|
def update!(**args)
|
569
|
-
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
570
|
-
@date_ranges = args[:date_ranges] if args.key?(:date_ranges)
|
571
|
-
@page_token = args[:page_token] if args.key?(:page_token)
|
572
|
-
@pivots = args[:pivots] if args.key?(:pivots)
|
573
|
-
@include_empty_rows = args[:include_empty_rows] if args.key?(:include_empty_rows)
|
574
751
|
@metric_filter_clauses = args[:metric_filter_clauses] if args.key?(:metric_filter_clauses)
|
575
752
|
@page_size = args[:page_size] if args.key?(:page_size)
|
576
|
-
@hide_totals = args[:hide_totals] if args.key?(:hide_totals)
|
577
753
|
@hide_value_ranges = args[:hide_value_ranges] if args.key?(:hide_value_ranges)
|
754
|
+
@hide_totals = args[:hide_totals] if args.key?(:hide_totals)
|
578
755
|
@filters_expression = args[:filters_expression] if args.key?(:filters_expression)
|
579
756
|
@cohort_group = args[:cohort_group] if args.key?(:cohort_group)
|
580
757
|
@view_id = args[:view_id] if args.key?(:view_id)
|
@@ -583,6 +760,55 @@ module Google
|
|
583
760
|
@order_bys = args[:order_bys] if args.key?(:order_bys)
|
584
761
|
@segments = args[:segments] if args.key?(:segments)
|
585
762
|
@sampling_level = args[:sampling_level] if args.key?(:sampling_level)
|
763
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
764
|
+
@page_token = args[:page_token] if args.key?(:page_token)
|
765
|
+
@date_ranges = args[:date_ranges] if args.key?(:date_ranges)
|
766
|
+
@pivots = args[:pivots] if args.key?(:pivots)
|
767
|
+
@include_empty_rows = args[:include_empty_rows] if args.key?(:include_empty_rows)
|
768
|
+
end
|
769
|
+
end
|
770
|
+
|
771
|
+
# MetricFilter specifies the filter on a metric.
|
772
|
+
class MetricFilter
|
773
|
+
include Google::Apis::Core::Hashable
|
774
|
+
|
775
|
+
# The metric that will be filtered on. A metricFilter must contain a metric
|
776
|
+
# name. A metric name can be an alias earlier defined as a metric or it can
|
777
|
+
# also be a metric expression.
|
778
|
+
# Corresponds to the JSON property `metricName`
|
779
|
+
# @return [String]
|
780
|
+
attr_accessor :metric_name
|
781
|
+
|
782
|
+
# The value to compare against.
|
783
|
+
# Corresponds to the JSON property `comparisonValue`
|
784
|
+
# @return [String]
|
785
|
+
attr_accessor :comparison_value
|
786
|
+
|
787
|
+
# Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the
|
788
|
+
# comparisonValue, the default is `EQUAL`. If the operator is
|
789
|
+
# `IS_MISSING`, checks if the metric is missing and would ignore the
|
790
|
+
# comparisonValue.
|
791
|
+
# Corresponds to the JSON property `operator`
|
792
|
+
# @return [String]
|
793
|
+
attr_accessor :operator
|
794
|
+
|
795
|
+
# Logical `NOT` operator. If this boolean is set to true, then the matching
|
796
|
+
# metric values will be excluded in the report. The default is false.
|
797
|
+
# Corresponds to the JSON property `not`
|
798
|
+
# @return [Boolean]
|
799
|
+
attr_accessor :not
|
800
|
+
alias_method :not?, :not
|
801
|
+
|
802
|
+
def initialize(**args)
|
803
|
+
update!(**args)
|
804
|
+
end
|
805
|
+
|
806
|
+
# Update properties of this object
|
807
|
+
def update!(**args)
|
808
|
+
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
809
|
+
@comparison_value = args[:comparison_value] if args.key?(:comparison_value)
|
810
|
+
@operator = args[:operator] if args.key?(:operator)
|
811
|
+
@not = args[:not] if args.key?(:not)
|
586
812
|
end
|
587
813
|
end
|
588
814
|
|
@@ -723,11 +949,6 @@ module Google
|
|
723
949
|
class SegmentFilterClause
|
724
950
|
include Google::Apis::Core::Hashable
|
725
951
|
|
726
|
-
# Metric filter to be used in a segment filter clause.
|
727
|
-
# Corresponds to the JSON property `metricFilter`
|
728
|
-
# @return [Google::Apis::AnalyticsreportingV4::SegmentMetricFilter]
|
729
|
-
attr_accessor :metric_filter
|
730
|
-
|
731
952
|
# Matches the complement (`!`) of the filter.
|
732
953
|
# Corresponds to the JSON property `not`
|
733
954
|
# @return [Boolean]
|
@@ -739,31 +960,39 @@ module Google
|
|
739
960
|
# @return [Google::Apis::AnalyticsreportingV4::SegmentDimensionFilter]
|
740
961
|
attr_accessor :dimension_filter
|
741
962
|
|
963
|
+
# Metric filter to be used in a segment filter clause.
|
964
|
+
# Corresponds to the JSON property `metricFilter`
|
965
|
+
# @return [Google::Apis::AnalyticsreportingV4::SegmentMetricFilter]
|
966
|
+
attr_accessor :metric_filter
|
967
|
+
|
742
968
|
def initialize(**args)
|
743
969
|
update!(**args)
|
744
970
|
end
|
745
971
|
|
746
972
|
# Update properties of this object
|
747
973
|
def update!(**args)
|
748
|
-
@metric_filter = args[:metric_filter] if args.key?(:metric_filter)
|
749
974
|
@not = args[:not] if args.key?(:not)
|
750
975
|
@dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
|
976
|
+
@metric_filter = args[:metric_filter] if args.key?(:metric_filter)
|
751
977
|
end
|
752
978
|
end
|
753
979
|
|
754
|
-
#
|
755
|
-
|
980
|
+
# Represents a group of metric filters.
|
981
|
+
# Set the operator value to specify how the filters are logically combined.
|
982
|
+
class MetricFilterClause
|
756
983
|
include Google::Apis::Core::Hashable
|
757
984
|
|
758
|
-
#
|
759
|
-
#
|
760
|
-
#
|
761
|
-
|
985
|
+
# The operator for combining multiple metric filters. If unspecified, it is
|
986
|
+
# treated as an `OR`.
|
987
|
+
# Corresponds to the JSON property `operator`
|
988
|
+
# @return [String]
|
989
|
+
attr_accessor :operator
|
762
990
|
|
763
|
-
#
|
764
|
-
#
|
765
|
-
#
|
766
|
-
|
991
|
+
# The repeated set of filters. They are logically combined based on the
|
992
|
+
# operator specified.
|
993
|
+
# Corresponds to the JSON property `filters`
|
994
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::MetricFilter>]
|
995
|
+
attr_accessor :filters
|
767
996
|
|
768
997
|
def initialize(**args)
|
769
998
|
update!(**args)
|
@@ -771,8 +1000,8 @@ module Google
|
|
771
1000
|
|
772
1001
|
# Update properties of this object
|
773
1002
|
def update!(**args)
|
774
|
-
@
|
775
|
-
@
|
1003
|
+
@operator = args[:operator] if args.key?(:operator)
|
1004
|
+
@filters = args[:filters] if args.key?(:filters)
|
776
1005
|
end
|
777
1006
|
end
|
778
1007
|
|
@@ -814,22 +1043,19 @@ module Google
|
|
814
1043
|
end
|
815
1044
|
end
|
816
1045
|
|
817
|
-
#
|
818
|
-
|
819
|
-
class MetricFilterClause
|
1046
|
+
# A row in the report.
|
1047
|
+
class ReportRow
|
820
1048
|
include Google::Apis::Core::Hashable
|
821
1049
|
|
822
|
-
#
|
823
|
-
#
|
824
|
-
#
|
825
|
-
|
826
|
-
attr_accessor :operator
|
1050
|
+
# List of metrics for each requested DateRange.
|
1051
|
+
# Corresponds to the JSON property `metrics`
|
1052
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
1053
|
+
attr_accessor :metrics
|
827
1054
|
|
828
|
-
#
|
829
|
-
#
|
830
|
-
#
|
831
|
-
|
832
|
-
attr_accessor :filters
|
1055
|
+
# List of requested dimensions.
|
1056
|
+
# Corresponds to the JSON property `dimensions`
|
1057
|
+
# @return [Array<String>]
|
1058
|
+
attr_accessor :dimensions
|
833
1059
|
|
834
1060
|
def initialize(**args)
|
835
1061
|
update!(**args)
|
@@ -837,8 +1063,8 @@ module Google
|
|
837
1063
|
|
838
1064
|
# Update properties of this object
|
839
1065
|
def update!(**args)
|
840
|
-
@
|
841
|
-
@
|
1066
|
+
@metrics = args[:metrics] if args.key?(:metrics)
|
1067
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
842
1068
|
end
|
843
1069
|
end
|
844
1070
|
|
@@ -941,11 +1167,6 @@ module Google
|
|
941
1167
|
class SequenceSegment
|
942
1168
|
include Google::Apis::Core::Hashable
|
943
1169
|
|
944
|
-
# The list of steps in the sequence.
|
945
|
-
# Corresponds to the JSON property `segmentSequenceSteps`
|
946
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::SegmentSequenceStep>]
|
947
|
-
attr_accessor :segment_sequence_steps
|
948
|
-
|
949
1170
|
# If set, first step condition must match the first hit of the visitor (in
|
950
1171
|
# the date range).
|
951
1172
|
# Corresponds to the JSON property `firstStepShouldMatchFirstHit`
|
@@ -953,20 +1174,39 @@ module Google
|
|
953
1174
|
attr_accessor :first_step_should_match_first_hit
|
954
1175
|
alias_method :first_step_should_match_first_hit?, :first_step_should_match_first_hit
|
955
1176
|
|
1177
|
+
# The list of steps in the sequence.
|
1178
|
+
# Corresponds to the JSON property `segmentSequenceSteps`
|
1179
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::SegmentSequenceStep>]
|
1180
|
+
attr_accessor :segment_sequence_steps
|
1181
|
+
|
956
1182
|
def initialize(**args)
|
957
1183
|
update!(**args)
|
958
1184
|
end
|
959
1185
|
|
960
1186
|
# Update properties of this object
|
961
1187
|
def update!(**args)
|
962
|
-
@segment_sequence_steps = args[:segment_sequence_steps] if args.key?(:segment_sequence_steps)
|
963
1188
|
@first_step_should_match_first_hit = args[:first_step_should_match_first_hit] if args.key?(:first_step_should_match_first_hit)
|
1189
|
+
@segment_sequence_steps = args[:segment_sequence_steps] if args.key?(:segment_sequence_steps)
|
964
1190
|
end
|
965
1191
|
end
|
966
1192
|
|
967
|
-
# Metric filter to be used in a segment filter clause.
|
968
|
-
class SegmentMetricFilter
|
969
|
-
include Google::Apis::Core::Hashable
|
1193
|
+
# Metric filter to be used in a segment filter clause.
|
1194
|
+
class SegmentMetricFilter
|
1195
|
+
include Google::Apis::Core::Hashable
|
1196
|
+
|
1197
|
+
# The metric that will be filtered on. A `metricFilter` must contain a
|
1198
|
+
# metric name.
|
1199
|
+
# Corresponds to the JSON property `metricName`
|
1200
|
+
# @return [String]
|
1201
|
+
attr_accessor :metric_name
|
1202
|
+
|
1203
|
+
# Scope for a metric defines the level at which that metric is defined. The
|
1204
|
+
# specified metric scope must be equal to or greater than its primary scope
|
1205
|
+
# as defined in the data model. The primary scope is defined by if the
|
1206
|
+
# segment is selecting users or sessions.
|
1207
|
+
# Corresponds to the JSON property `scope`
|
1208
|
+
# @return [String]
|
1209
|
+
attr_accessor :scope
|
970
1210
|
|
971
1211
|
# Max comparison value is only used for `BETWEEN` operator.
|
972
1212
|
# Corresponds to the JSON property `maxComparisonValue`
|
@@ -985,31 +1225,17 @@ module Google
|
|
985
1225
|
# @return [String]
|
986
1226
|
attr_accessor :operator
|
987
1227
|
|
988
|
-
# The metric that will be filtered on. A `metricFilter` must contain a
|
989
|
-
# metric name.
|
990
|
-
# Corresponds to the JSON property `metricName`
|
991
|
-
# @return [String]
|
992
|
-
attr_accessor :metric_name
|
993
|
-
|
994
|
-
# Scope for a metric defines the level at which that metric is defined. The
|
995
|
-
# specified metric scope must be equal to or greater than its primary scope
|
996
|
-
# as defined in the data model. The primary scope is defined by if the
|
997
|
-
# segment is selecting users or sessions.
|
998
|
-
# Corresponds to the JSON property `scope`
|
999
|
-
# @return [String]
|
1000
|
-
attr_accessor :scope
|
1001
|
-
|
1002
1228
|
def initialize(**args)
|
1003
1229
|
update!(**args)
|
1004
1230
|
end
|
1005
1231
|
|
1006
1232
|
# Update properties of this object
|
1007
1233
|
def update!(**args)
|
1234
|
+
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
1235
|
+
@scope = args[:scope] if args.key?(:scope)
|
1008
1236
|
@max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value)
|
1009
1237
|
@comparison_value = args[:comparison_value] if args.key?(:comparison_value)
|
1010
1238
|
@operator = args[:operator] if args.key?(:operator)
|
1011
|
-
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
1012
|
-
@scope = args[:scope] if args.key?(:scope)
|
1013
1239
|
end
|
1014
1240
|
end
|
1015
1241
|
|
@@ -1189,232 +1415,6 @@ module Google
|
|
1189
1415
|
@dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses)
|
1190
1416
|
end
|
1191
1417
|
end
|
1192
|
-
|
1193
|
-
# The headers for the each of the metric column corresponding to the metrics
|
1194
|
-
# requested in the pivots section of the response.
|
1195
|
-
class PivotHeaderEntry
|
1196
|
-
include Google::Apis::Core::Hashable
|
1197
|
-
|
1198
|
-
# The name of the dimensions in the pivot response.
|
1199
|
-
# Corresponds to the JSON property `dimensionNames`
|
1200
|
-
# @return [Array<String>]
|
1201
|
-
attr_accessor :dimension_names
|
1202
|
-
|
1203
|
-
# Header for the metrics.
|
1204
|
-
# Corresponds to the JSON property `metric`
|
1205
|
-
# @return [Google::Apis::AnalyticsreportingV4::MetricHeaderEntry]
|
1206
|
-
attr_accessor :metric
|
1207
|
-
|
1208
|
-
# The values for the dimensions in the pivot.
|
1209
|
-
# Corresponds to the JSON property `dimensionValues`
|
1210
|
-
# @return [Array<String>]
|
1211
|
-
attr_accessor :dimension_values
|
1212
|
-
|
1213
|
-
def initialize(**args)
|
1214
|
-
update!(**args)
|
1215
|
-
end
|
1216
|
-
|
1217
|
-
# Update properties of this object
|
1218
|
-
def update!(**args)
|
1219
|
-
@dimension_names = args[:dimension_names] if args.key?(:dimension_names)
|
1220
|
-
@metric = args[:metric] if args.key?(:metric)
|
1221
|
-
@dimension_values = args[:dimension_values] if args.key?(:dimension_values)
|
1222
|
-
end
|
1223
|
-
end
|
1224
|
-
|
1225
|
-
# SegmentFilter defines the segment to be either a simple or a sequence
|
1226
|
-
# segment. A simple segment condition contains dimension and metric conditions
|
1227
|
-
# to select the sessions or users. A sequence segment condition can be used to
|
1228
|
-
# select users or sessions based on sequential conditions.
|
1229
|
-
class SegmentFilter
|
1230
|
-
include Google::Apis::Core::Hashable
|
1231
|
-
|
1232
|
-
# Sequence conditions consist of one or more steps, where each step is defined
|
1233
|
-
# by one or more dimension/metric conditions. Multiple steps can be combined
|
1234
|
-
# with special sequence operators.
|
1235
|
-
# Corresponds to the JSON property `sequenceSegment`
|
1236
|
-
# @return [Google::Apis::AnalyticsreportingV4::SequenceSegment]
|
1237
|
-
attr_accessor :sequence_segment
|
1238
|
-
|
1239
|
-
# If true, match the complement of simple or sequence segment.
|
1240
|
-
# For example, to match all visits not from "New York", we can define the
|
1241
|
-
# segment as follows:
|
1242
|
-
# "sessionSegment": `
|
1243
|
-
# "segmentFilters": [`
|
1244
|
-
# "simpleSegment" :`
|
1245
|
-
# "orFiltersForSegment": [`
|
1246
|
-
# "segmentFilterClauses":[`
|
1247
|
-
# "dimensionFilter": `
|
1248
|
-
# "dimensionName": "ga:city",
|
1249
|
-
# "expressions": ["New York"]
|
1250
|
-
# `
|
1251
|
-
# `]
|
1252
|
-
# `]
|
1253
|
-
# `,
|
1254
|
-
# "not": "True"
|
1255
|
-
# `]
|
1256
|
-
# `,
|
1257
|
-
# Corresponds to the JSON property `not`
|
1258
|
-
# @return [Boolean]
|
1259
|
-
attr_accessor :not
|
1260
|
-
alias_method :not?, :not
|
1261
|
-
|
1262
|
-
# A Simple segment conditions consist of one or more dimension/metric
|
1263
|
-
# conditions that can be combined.
|
1264
|
-
# Corresponds to the JSON property `simpleSegment`
|
1265
|
-
# @return [Google::Apis::AnalyticsreportingV4::SimpleSegment]
|
1266
|
-
attr_accessor :simple_segment
|
1267
|
-
|
1268
|
-
def initialize(**args)
|
1269
|
-
update!(**args)
|
1270
|
-
end
|
1271
|
-
|
1272
|
-
# Update properties of this object
|
1273
|
-
def update!(**args)
|
1274
|
-
@sequence_segment = args[:sequence_segment] if args.key?(:sequence_segment)
|
1275
|
-
@not = args[:not] if args.key?(:not)
|
1276
|
-
@simple_segment = args[:simple_segment] if args.key?(:simple_segment)
|
1277
|
-
end
|
1278
|
-
end
|
1279
|
-
|
1280
|
-
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
1281
|
-
# are combined together with a logical `AND` operation.
|
1282
|
-
class SegmentDefinition
|
1283
|
-
include Google::Apis::Core::Hashable
|
1284
|
-
|
1285
|
-
# A segment is defined by a set of segment filters which are combined
|
1286
|
-
# together with a logical `AND` operation.
|
1287
|
-
# Corresponds to the JSON property `segmentFilters`
|
1288
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::SegmentFilter>]
|
1289
|
-
attr_accessor :segment_filters
|
1290
|
-
|
1291
|
-
def initialize(**args)
|
1292
|
-
update!(**args)
|
1293
|
-
end
|
1294
|
-
|
1295
|
-
# Update properties of this object
|
1296
|
-
def update!(**args)
|
1297
|
-
@segment_filters = args[:segment_filters] if args.key?(:segment_filters)
|
1298
|
-
end
|
1299
|
-
end
|
1300
|
-
|
1301
|
-
# Header for the metrics.
|
1302
|
-
class MetricHeaderEntry
|
1303
|
-
include Google::Apis::Core::Hashable
|
1304
|
-
|
1305
|
-
# The name of the header.
|
1306
|
-
# Corresponds to the JSON property `name`
|
1307
|
-
# @return [String]
|
1308
|
-
attr_accessor :name
|
1309
|
-
|
1310
|
-
# The type of the metric, for example `INTEGER`.
|
1311
|
-
# Corresponds to the JSON property `type`
|
1312
|
-
# @return [String]
|
1313
|
-
attr_accessor :type
|
1314
|
-
|
1315
|
-
def initialize(**args)
|
1316
|
-
update!(**args)
|
1317
|
-
end
|
1318
|
-
|
1319
|
-
# Update properties of this object
|
1320
|
-
def update!(**args)
|
1321
|
-
@name = args[:name] if args.key?(:name)
|
1322
|
-
@type = args[:type] if args.key?(:type)
|
1323
|
-
end
|
1324
|
-
end
|
1325
|
-
|
1326
|
-
# The data part of the report.
|
1327
|
-
class ReportData
|
1328
|
-
include Google::Apis::Core::Hashable
|
1329
|
-
|
1330
|
-
# For each requested date range, for the set of all rows that match
|
1331
|
-
# the query, every requested value format gets a total. The total
|
1332
|
-
# for a value format is computed by first totaling the metrics
|
1333
|
-
# mentioned in the value format and then evaluating the value
|
1334
|
-
# format as a scalar expression. E.g., The "totals" for
|
1335
|
-
# `3 / (ga:sessions + 2)` we compute
|
1336
|
-
# `3 / ((sum of all relevant ga:sessions) + 2)`.
|
1337
|
-
# Totals are computed before pagination.
|
1338
|
-
# Corresponds to the JSON property `totals`
|
1339
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
1340
|
-
attr_accessor :totals
|
1341
|
-
|
1342
|
-
# If the results are
|
1343
|
-
# [sampled](https://support.google.com/analytics/answer/2637192),
|
1344
|
-
# this returns the total number of samples read, one entry per date range.
|
1345
|
-
# If the results are not sampled this field will not be defined. See
|
1346
|
-
# [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
|
1347
|
-
# for details.
|
1348
|
-
# Corresponds to the JSON property `samplesReadCounts`
|
1349
|
-
# @return [Array<String>]
|
1350
|
-
attr_accessor :samples_read_counts
|
1351
|
-
|
1352
|
-
# Total number of matching rows for this query.
|
1353
|
-
# Corresponds to the JSON property `rowCount`
|
1354
|
-
# @return [Fixnum]
|
1355
|
-
attr_accessor :row_count
|
1356
|
-
|
1357
|
-
# There's one ReportRow for every unique combination of dimensions.
|
1358
|
-
# Corresponds to the JSON property `rows`
|
1359
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::ReportRow>]
|
1360
|
-
attr_accessor :rows
|
1361
|
-
|
1362
|
-
# Indicates if response to this request is golden or not. Data is
|
1363
|
-
# golden when the exact same request will not produce any new results if
|
1364
|
-
# asked at a later point in time.
|
1365
|
-
# Corresponds to the JSON property `isDataGolden`
|
1366
|
-
# @return [Boolean]
|
1367
|
-
attr_accessor :is_data_golden
|
1368
|
-
alias_method :is_data_golden?, :is_data_golden
|
1369
|
-
|
1370
|
-
# The last time the data in the report was refreshed. All the hits received
|
1371
|
-
# before this timestamp are included in the calculation of the report.
|
1372
|
-
# Corresponds to the JSON property `dataLastRefreshed`
|
1373
|
-
# @return [String]
|
1374
|
-
attr_accessor :data_last_refreshed
|
1375
|
-
|
1376
|
-
# Minimum and maximum values seen over all matching rows. These are both
|
1377
|
-
# empty when `hideValueRanges` in the request is false, or when
|
1378
|
-
# rowCount is zero.
|
1379
|
-
# Corresponds to the JSON property `maximums`
|
1380
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
1381
|
-
attr_accessor :maximums
|
1382
|
-
|
1383
|
-
# If the results are
|
1384
|
-
# [sampled](https://support.google.com/analytics/answer/2637192),
|
1385
|
-
# this returns the total number of
|
1386
|
-
# samples present, one entry per date range. If the results are not sampled
|
1387
|
-
# this field will not be defined. See
|
1388
|
-
# [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
|
1389
|
-
# for details.
|
1390
|
-
# Corresponds to the JSON property `samplingSpaceSizes`
|
1391
|
-
# @return [Array<String>]
|
1392
|
-
attr_accessor :sampling_space_sizes
|
1393
|
-
|
1394
|
-
# Minimum and maximum values seen over all matching rows. These are both
|
1395
|
-
# empty when `hideValueRanges` in the request is false, or when
|
1396
|
-
# rowCount is zero.
|
1397
|
-
# Corresponds to the JSON property `minimums`
|
1398
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
1399
|
-
attr_accessor :minimums
|
1400
|
-
|
1401
|
-
def initialize(**args)
|
1402
|
-
update!(**args)
|
1403
|
-
end
|
1404
|
-
|
1405
|
-
# Update properties of this object
|
1406
|
-
def update!(**args)
|
1407
|
-
@totals = args[:totals] if args.key?(:totals)
|
1408
|
-
@samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts)
|
1409
|
-
@row_count = args[:row_count] if args.key?(:row_count)
|
1410
|
-
@rows = args[:rows] if args.key?(:rows)
|
1411
|
-
@is_data_golden = args[:is_data_golden] if args.key?(:is_data_golden)
|
1412
|
-
@data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed)
|
1413
|
-
@maximums = args[:maximums] if args.key?(:maximums)
|
1414
|
-
@sampling_space_sizes = args[:sampling_space_sizes] if args.key?(:sampling_space_sizes)
|
1415
|
-
@minimums = args[:minimums] if args.key?(:minimums)
|
1416
|
-
end
|
1417
|
-
end
|
1418
1418
|
end
|
1419
1419
|
end
|
1420
1420
|
end
|