google-api-client 0.13.0 → 0.13.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -0
- data/README.md +6 -2
- data/generated/google/apis/acceleratedmobilepageurl_v1/classes.rb +46 -46
- data/generated/google/apis/acceleratedmobilepageurl_v1/representations.rb +15 -15
- data/generated/google/apis/acceleratedmobilepageurl_v1/service.rb +4 -4
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +404 -435
- data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +107 -121
- data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +657 -713
- data/generated/google/apis/admin_directory_v1.rb +1 -1
- data/generated/google/apis/admin_directory_v1/classes.rb +45 -5
- data/generated/google/apis/admin_directory_v1/representations.rb +16 -0
- data/generated/google/apis/admin_directory_v1/service.rb +4 -1
- 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.rb +1 -1
- data/generated/google/apis/analyticsreporting_v4/classes.rb +399 -399
- data/generated/google/apis/analyticsreporting_v4/representations.rb +101 -101
- data/generated/google/apis/analyticsreporting_v4/service.rb +10 -10
- data/generated/google/apis/androidenterprise_v1.rb +1 -1
- data/generated/google/apis/appengine_v1.rb +4 -4
- data/generated/google/apis/appengine_v1/classes.rb +747 -747
- data/generated/google/apis/appengine_v1/representations.rb +158 -158
- data/generated/google/apis/appengine_v1/service.rb +214 -214
- data/generated/google/apis/appsactivity_v1.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 +6 -0
- data/generated/google/apis/bigquery_v2/representations.rb +2 -0
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/classroom_v1.rb +7 -7
- data/generated/google/apis/classroom_v1/classes.rb +517 -515
- data/generated/google/apis/classroom_v1/representations.rb +147 -147
- data/generated/google/apis/classroom_v1/service.rb +1144 -1143
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1/classes.rb +435 -386
- data/generated/google/apis/cloudbuild_v1/representations.rb +133 -115
- data/generated/google/apis/cloudbuild_v1/service.rb +148 -148
- data/generated/google/apis/clouddebugger_v2.rb +1 -1
- data/generated/google/apis/clouddebugger_v2/classes.rb +708 -708
- data/generated/google/apis/clouddebugger_v2/representations.rb +146 -146
- data/generated/google/apis/clouddebugger_v2/service.rb +124 -124
- data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +142 -142
- data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +29 -29
- data/generated/google/apis/clouderrorreporting_v1beta1/service.rb +87 -87
- data/generated/google/apis/cloudfunctions_v1.rb +1 -1
- data/generated/google/apis/cloudfunctions_v1/service.rb +6 -6
- data/generated/google/apis/cloudkms_v1.rb +1 -1
- data/generated/google/apis/cloudkms_v1/classes.rb +692 -675
- data/generated/google/apis/cloudkms_v1/representations.rb +144 -144
- data/generated/google/apis/cloudkms_v1/service.rb +276 -276
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +1168 -1168
- data/generated/google/apis/cloudresourcemanager_v1/representations.rb +190 -190
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +311 -288
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +4 -4
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +406 -406
- data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +95 -95
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +242 -234
- data/generated/google/apis/cloudtrace_v1.rb +4 -4
- data/generated/google/apis/cloudtrace_v1/classes.rb +68 -68
- data/generated/google/apis/cloudtrace_v1/representations.rb +22 -22
- data/generated/google/apis/cloudtrace_v1/service.rb +48 -48
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +82 -6
- data/generated/google/apis/compute_beta/representations.rb +4 -0
- data/generated/google/apis/compute_beta/service.rb +1177 -834
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +371 -1
- data/generated/google/apis/compute_v1/representations.rb +139 -0
- data/generated/google/apis/compute_v1/service.rb +257 -9
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +1122 -826
- data/generated/google/apis/container_v1/representations.rb +279 -135
- data/generated/google/apis/container_v1/service.rb +440 -98
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/service.rb +3 -1
- data/generated/google/apis/customsearch_v1.rb +1 -1
- data/generated/google/apis/dataflow_v1b3.rb +4 -4
- data/generated/google/apis/dataflow_v1b3/classes.rb +3423 -3423
- data/generated/google/apis/dataflow_v1b3/representations.rb +813 -813
- data/generated/google/apis/dataflow_v1b3/service.rb +410 -410
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +450 -431
- data/generated/google/apis/dataproc_v1/representations.rb +92 -92
- data/generated/google/apis/dataproc_v1/service.rb +200 -200
- data/generated/google/apis/datastore_v1.rb +4 -4
- data/generated/google/apis/datastore_v1/classes.rb +397 -397
- data/generated/google/apis/datastore_v1/representations.rb +100 -100
- data/generated/google/apis/datastore_v1/service.rb +62 -62
- data/generated/google/apis/deploymentmanager_v2.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2/classes.rb +79 -3
- data/generated/google/apis/deploymentmanager_v2/representations.rb +33 -0
- data/generated/google/apis/deploymentmanager_v2/service.rb +15 -20
- 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 +2 -2
- data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v2/service.rb +1 -1
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/service.rb +1 -1
- data/generated/google/apis/firebasedynamiclinks_v1.rb +1 -1
- data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +87 -87
- data/generated/google/apis/firebasedynamiclinks_v1/representations.rb +27 -27
- data/generated/google/apis/firebaserules_v1/classes.rb +271 -271
- data/generated/google/apis/firebaserules_v1/representations.rb +82 -82
- data/generated/google/apis/firebaserules_v1/service.rb +151 -151
- 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 +9 -9
- data/generated/google/apis/genomics_v1/classes.rb +2242 -2242
- data/generated/google/apis/genomics_v1/representations.rb +306 -306
- data/generated/google/apis/genomics_v1/service.rb +1172 -1172
- data/generated/google/apis/gmail_v1.rb +1 -1
- data/generated/google/apis/iam_v1.rb +1 -1
- data/generated/google/apis/iam_v1/classes.rb +243 -243
- data/generated/google/apis/iam_v1/representations.rb +79 -79
- data/generated/google/apis/iam_v1/service.rb +137 -137
- data/generated/google/apis/identitytoolkit_v3.rb +1 -1
- data/generated/google/apis/identitytoolkit_v3/classes.rb +18 -0
- data/generated/google/apis/identitytoolkit_v3/representations.rb +3 -0
- data/generated/google/apis/kgsearch_v1/classes.rb +9 -9
- data/generated/google/apis/kgsearch_v1/representations.rb +2 -2
- data/generated/google/apis/kgsearch_v1/service.rb +4 -4
- data/generated/google/apis/language_v1.rb +1 -1
- data/generated/google/apis/language_v1/classes.rb +451 -451
- data/generated/google/apis/language_v1/representations.rb +103 -103
- data/generated/google/apis/language_v1/service.rb +49 -49
- data/generated/google/apis/language_v1beta1.rb +1 -1
- data/generated/google/apis/language_v1beta1/classes.rb +459 -459
- data/generated/google/apis/language_v1beta1/representations.rb +110 -110
- data/generated/google/apis/language_v1beta1/service.rb +43 -43
- data/generated/google/apis/logging_v2.rb +8 -8
- data/generated/google/apis/logging_v2/classes.rb +915 -915
- data/generated/google/apis/logging_v2/representations.rb +142 -142
- data/generated/google/apis/logging_v2/service.rb +415 -415
- data/generated/google/apis/logging_v2beta1.rb +8 -8
- data/generated/google/apis/logging_v2beta1/classes.rb +905 -905
- data/generated/google/apis/logging_v2beta1/representations.rb +150 -150
- data/generated/google/apis/logging_v2beta1/service.rb +221 -221
- data/generated/google/apis/manufacturers_v1.rb +1 -1
- data/generated/google/apis/manufacturers_v1/classes.rb +334 -315
- data/generated/google/apis/manufacturers_v1/representations.rb +99 -87
- data/generated/google/apis/manufacturers_v1/service.rb +101 -4
- data/generated/google/apis/ml_v1.rb +1 -1
- data/generated/google/apis/ml_v1/classes.rb +709 -673
- data/generated/google/apis/ml_v1/representations.rb +154 -151
- data/generated/google/apis/ml_v1/service.rb +341 -354
- data/generated/google/apis/monitoring_v3.rb +6 -6
- data/generated/google/apis/monitoring_v3/classes.rb +869 -869
- data/generated/google/apis/monitoring_v3/representations.rb +171 -171
- data/generated/google/apis/monitoring_v3/service.rb +340 -340
- data/generated/google/apis/partners_v2.rb +1 -1
- data/generated/google/apis/partners_v2/classes.rb +1569 -1569
- data/generated/google/apis/partners_v2/representations.rb +256 -256
- data/generated/google/apis/partners_v2/service.rb +530 -530
- data/generated/google/apis/people_v1.rb +7 -7
- data/generated/google/apis/people_v1/classes.rb +1287 -946
- data/generated/google/apis/people_v1/representations.rb +355 -203
- data/generated/google/apis/people_v1/service.rb +409 -32
- 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 +445 -445
- data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +104 -104
- data/generated/google/apis/proximitybeacon_v1beta1/service.rb +241 -241
- data/generated/google/apis/pubsub_v1.rb +4 -4
- data/generated/google/apis/pubsub_v1/classes.rb +286 -287
- data/generated/google/apis/pubsub_v1/representations.rb +80 -80
- data/generated/google/apis/pubsub_v1/service.rb +178 -178
- data/generated/google/apis/runtimeconfig_v1.rb +1 -1
- data/generated/google/apis/runtimeconfig_v1/classes.rb +52 -52
- data/generated/google/apis/runtimeconfig_v1/representations.rb +15 -15
- data/generated/google/apis/runtimeconfig_v1/service.rb +21 -21
- data/generated/google/apis/script_v1.rb +4 -4
- data/generated/google/apis/script_v1/classes.rb +172 -172
- data/generated/google/apis/script_v1/representations.rb +41 -41
- data/generated/google/apis/script_v1/service.rb +6 -6
- data/generated/google/apis/searchconsole_v1.rb +1 -1
- data/generated/google/apis/searchconsole_v1/classes.rb +6 -6
- data/generated/google/apis/searchconsole_v1/representations.rb +1 -1
- data/generated/google/apis/servicecontrol_v1.rb +1 -1
- data/generated/google/apis/servicecontrol_v1/classes.rb +1110 -1110
- data/generated/google/apis/servicecontrol_v1/representations.rb +215 -215
- data/generated/google/apis/servicecontrol_v1/service.rb +65 -65
- data/generated/google/apis/servicemanagement_v1.rb +6 -6
- data/generated/google/apis/servicemanagement_v1/classes.rb +3594 -3562
- data/generated/google/apis/servicemanagement_v1/representations.rb +564 -562
- data/generated/google/apis/servicemanagement_v1/service.rb +253 -253
- data/generated/google/apis/serviceuser_v1.rb +1 -1
- data/generated/google/apis/serviceuser_v1/classes.rb +2678 -2670
- data/generated/google/apis/serviceuser_v1/representations.rb +269 -268
- data/generated/google/apis/serviceuser_v1/service.rb +59 -59
- data/generated/google/apis/sheets_v4.rb +5 -5
- data/generated/google/apis/sheets_v4/classes.rb +5155 -5104
- data/generated/google/apis/sheets_v4/representations.rb +957 -940
- data/generated/google/apis/sheets_v4/service.rb +175 -175
- data/generated/google/apis/slides_v1.rb +1 -1
- data/generated/google/apis/slides_v1/classes.rb +2932 -2905
- data/generated/google/apis/slides_v1/representations.rb +709 -694
- data/generated/google/apis/slides_v1/service.rb +50 -50
- data/generated/google/apis/sourcerepo_v1/classes.rb +139 -139
- data/generated/google/apis/sourcerepo_v1/representations.rb +40 -40
- data/generated/google/apis/sourcerepo_v1/service.rb +61 -61
- data/generated/google/apis/spanner_v1.rb +7 -1
- data/generated/google/apis/spanner_v1/classes.rb +2362 -2299
- data/generated/google/apis/spanner_v1/representations.rb +342 -323
- data/generated/google/apis/spanner_v1/service.rb +502 -492
- data/generated/google/apis/speech_v1beta1.rb +1 -1
- data/generated/google/apis/speech_v1beta1/classes.rb +244 -244
- data/generated/google/apis/speech_v1beta1/representations.rb +52 -52
- data/generated/google/apis/speech_v1beta1/service.rb +91 -91
- data/generated/google/apis/storage_v1.rb +1 -1
- data/generated/google/apis/storagetransfer_v1.rb +1 -1
- data/generated/google/apis/storagetransfer_v1/classes.rb +784 -781
- data/generated/google/apis/storagetransfer_v1/representations.rb +88 -88
- data/generated/google/apis/storagetransfer_v1/service.rb +154 -154
- data/generated/google/apis/toolresults_v1beta3.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +90 -1
- data/generated/google/apis/toolresults_v1beta3/representations.rb +18 -0
- data/generated/google/apis/translate_v2/classes.rb +107 -107
- data/generated/google/apis/translate_v2/representations.rb +49 -49
- data/generated/google/apis/translate_v2/service.rb +81 -81
- data/generated/google/apis/vision_v1.rb +4 -1
- data/generated/google/apis/vision_v1/classes.rb +527 -527
- data/generated/google/apis/vision_v1/representations.rb +115 -115
- 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 +1 -1
- data/generated/google/apis/youtubereporting_v1/classes.rb +124 -124
- data/generated/google/apis/youtubereporting_v1/representations.rb +30 -30
- data/generated/google/apis/youtubereporting_v1/service.rb +113 -113
- data/lib/google/apis/version.rb +1 -1
- data/samples/cli/lib/samples/analytics.rb +2 -2
- metadata +2 -2
|
@@ -26,7 +26,7 @@ module Google
|
|
|
26
26
|
# @see https://developers.google.com/admin-sdk/directory/
|
|
27
27
|
module AdminDirectoryV1
|
|
28
28
|
VERSION = 'DirectoryV1'
|
|
29
|
-
REVISION = '
|
|
29
|
+
REVISION = '20170530'
|
|
30
30
|
|
|
31
31
|
# View and manage customer related information
|
|
32
32
|
AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer'
|
|
@@ -2423,6 +2423,11 @@ module Google
|
|
|
2423
2423
|
# @return [String]
|
|
2424
2424
|
attr_accessor :kind
|
|
2425
2425
|
|
|
2426
|
+
#
|
|
2427
|
+
# Corresponds to the JSON property `languages`
|
|
2428
|
+
# @return [Object]
|
|
2429
|
+
attr_accessor :languages
|
|
2430
|
+
|
|
2426
2431
|
# User's last login time. (Read-only)
|
|
2427
2432
|
# Corresponds to the JSON property `lastLoginTime`
|
|
2428
2433
|
# @return [DateTime]
|
|
@@ -2542,6 +2547,7 @@ module Google
|
|
|
2542
2547
|
@is_enrolled_in2_sv = args[:is_enrolled_in2_sv] if args.key?(:is_enrolled_in2_sv)
|
|
2543
2548
|
@is_mailbox_setup = args[:is_mailbox_setup] if args.key?(:is_mailbox_setup)
|
|
2544
2549
|
@kind = args[:kind] if args.key?(:kind)
|
|
2550
|
+
@languages = args[:languages] if args.key?(:languages)
|
|
2545
2551
|
@last_login_time = args[:last_login_time] if args.key?(:last_login_time)
|
|
2546
2552
|
@locations = args[:locations] if args.key?(:locations)
|
|
2547
2553
|
@name = args[:name] if args.key?(:name)
|
|
@@ -2814,13 +2820,41 @@ module Google
|
|
|
2814
2820
|
end
|
|
2815
2821
|
end
|
|
2816
2822
|
|
|
2823
|
+
# JSON template for a language entry.
|
|
2824
|
+
class UserLanguage
|
|
2825
|
+
include Google::Apis::Core::Hashable
|
|
2826
|
+
|
|
2827
|
+
# Other language. User can provide own language name if there is no
|
|
2828
|
+
# corresponding Google III language code. If this is set LanguageCode can't be
|
|
2829
|
+
# set
|
|
2830
|
+
# Corresponds to the JSON property `customLanguage`
|
|
2831
|
+
# @return [String]
|
|
2832
|
+
attr_accessor :custom_language
|
|
2833
|
+
|
|
2834
|
+
# Language Code. Should be used for storing Google III LanguageCode string
|
|
2835
|
+
# representation for language. Illegal values cause SchemaException.
|
|
2836
|
+
# Corresponds to the JSON property `languageCode`
|
|
2837
|
+
# @return [String]
|
|
2838
|
+
attr_accessor :language_code
|
|
2839
|
+
|
|
2840
|
+
def initialize(**args)
|
|
2841
|
+
update!(**args)
|
|
2842
|
+
end
|
|
2843
|
+
|
|
2844
|
+
# Update properties of this object
|
|
2845
|
+
def update!(**args)
|
|
2846
|
+
@custom_language = args[:custom_language] if args.key?(:custom_language)
|
|
2847
|
+
@language_code = args[:language_code] if args.key?(:language_code)
|
|
2848
|
+
end
|
|
2849
|
+
end
|
|
2850
|
+
|
|
2817
2851
|
# JSON template for a location entry.
|
|
2818
2852
|
class UserLocation
|
|
2819
2853
|
include Google::Apis::Core::Hashable
|
|
2820
2854
|
|
|
2821
2855
|
# Textual location. This is most useful for display purposes to concisely
|
|
2822
|
-
# describe the location.
|
|
2823
|
-
# 9A209A".
|
|
2856
|
+
# describe the location. For example, "Mountain View, CA", "Near Seattle", "US-
|
|
2857
|
+
# NYC-9TH 9A209A".
|
|
2824
2858
|
# Corresponds to the JSON property `area`
|
|
2825
2859
|
# @return [String]
|
|
2826
2860
|
attr_accessor :area
|
|
@@ -2845,9 +2879,9 @@ module Google
|
|
|
2845
2879
|
# @return [String]
|
|
2846
2880
|
attr_accessor :floor_name
|
|
2847
2881
|
|
|
2848
|
-
# Floor
|
|
2849
|
-
# divided into sections "A", "B", and "C", this field would identify
|
|
2850
|
-
# those values.
|
|
2882
|
+
# Floor section. More specific location within the floor. For example, if a
|
|
2883
|
+
# floor is divided into sections "A", "B", and "C", this field would identify
|
|
2884
|
+
# one of those values.
|
|
2851
2885
|
# Corresponds to the JSON property `floorSection`
|
|
2852
2886
|
# @return [String]
|
|
2853
2887
|
attr_accessor :floor_section
|
|
@@ -2957,6 +2991,11 @@ module Google
|
|
|
2957
2991
|
# @return [String]
|
|
2958
2992
|
attr_accessor :domain
|
|
2959
2993
|
|
|
2994
|
+
# The full-time equivalent percent within the organization (100000 = 100%).
|
|
2995
|
+
# Corresponds to the JSON property `fullTimeEquivalent`
|
|
2996
|
+
# @return [Fixnum]
|
|
2997
|
+
attr_accessor :full_time_equivalent
|
|
2998
|
+
|
|
2960
2999
|
# Location of the organization. This need not be fully qualified address.
|
|
2961
3000
|
# Corresponds to the JSON property `location`
|
|
2962
3001
|
# @return [String]
|
|
@@ -3002,6 +3041,7 @@ module Google
|
|
|
3002
3041
|
@department = args[:department] if args.key?(:department)
|
|
3003
3042
|
@description = args[:description] if args.key?(:description)
|
|
3004
3043
|
@domain = args[:domain] if args.key?(:domain)
|
|
3044
|
+
@full_time_equivalent = args[:full_time_equivalent] if args.key?(:full_time_equivalent)
|
|
3005
3045
|
@location = args[:location] if args.key?(:location)
|
|
3006
3046
|
@name = args[:name] if args.key?(:name)
|
|
3007
3047
|
@primary = args[:primary] if args.key?(:primary)
|
|
@@ -316,6 +316,12 @@ module Google
|
|
|
316
316
|
include Google::Apis::Core::JsonObjectSupport
|
|
317
317
|
end
|
|
318
318
|
|
|
319
|
+
class UserLanguage
|
|
320
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
321
|
+
|
|
322
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
323
|
+
end
|
|
324
|
+
|
|
319
325
|
class UserLocation
|
|
320
326
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
321
327
|
|
|
@@ -993,6 +999,7 @@ module Google
|
|
|
993
999
|
property :is_enrolled_in2_sv, as: 'isEnrolledIn2Sv'
|
|
994
1000
|
property :is_mailbox_setup, as: 'isMailboxSetup'
|
|
995
1001
|
property :kind, as: 'kind'
|
|
1002
|
+
property :languages, as: 'languages'
|
|
996
1003
|
property :last_login_time, as: 'lastLoginTime', type: DateTime
|
|
997
1004
|
|
|
998
1005
|
property :locations, as: 'locations'
|
|
@@ -1074,6 +1081,14 @@ module Google
|
|
|
1074
1081
|
end
|
|
1075
1082
|
end
|
|
1076
1083
|
|
|
1084
|
+
class UserLanguage
|
|
1085
|
+
# @private
|
|
1086
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1087
|
+
property :custom_language, as: 'customLanguage'
|
|
1088
|
+
property :language_code, as: 'languageCode'
|
|
1089
|
+
end
|
|
1090
|
+
end
|
|
1091
|
+
|
|
1077
1092
|
class UserLocation
|
|
1078
1093
|
# @private
|
|
1079
1094
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1111,6 +1126,7 @@ module Google
|
|
|
1111
1126
|
property :department, as: 'department'
|
|
1112
1127
|
property :description, as: 'description'
|
|
1113
1128
|
property :domain, as: 'domain'
|
|
1129
|
+
property :full_time_equivalent, as: 'fullTimeEquivalent'
|
|
1114
1130
|
property :location, as: 'location'
|
|
1115
1131
|
property :name, as: 'name'
|
|
1116
1132
|
property :primary, as: 'primary'
|
|
@@ -286,6 +286,8 @@ module Google
|
|
|
286
286
|
# Maximum number of results to return. Default is 100
|
|
287
287
|
# @param [String] order_by
|
|
288
288
|
# Column to use for sorting results
|
|
289
|
+
# @param [String] org_unit_path
|
|
290
|
+
# Full path of the organization unit or its Id
|
|
289
291
|
# @param [String] page_token
|
|
290
292
|
# Token to specify next page in the list
|
|
291
293
|
# @param [String] projection
|
|
@@ -317,13 +319,14 @@ module Google
|
|
|
317
319
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
318
320
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
319
321
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
320
|
-
def list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
322
|
+
def list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, org_unit_path: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
321
323
|
command = make_simple_command(:get, 'customer/{customerId}/devices/chromeos', options)
|
|
322
324
|
command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevices::Representation
|
|
323
325
|
command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevices
|
|
324
326
|
command.params['customerId'] = customer_id unless customer_id.nil?
|
|
325
327
|
command.query['maxResults'] = max_results unless max_results.nil?
|
|
326
328
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
329
|
+
command.query['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
|
|
327
330
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
328
331
|
command.query['projection'] = projection unless projection.nil?
|
|
329
332
|
command.query['query'] = query unless query.nil?
|
|
@@ -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 = '20170622'
|
|
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 = '20170711'
|
|
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 = '20170711'
|
|
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/devguides/reporting/core/v4/
|
|
26
26
|
module AnalyticsreportingV4
|
|
27
27
|
VERSION = 'V4'
|
|
28
|
-
REVISION = '
|
|
28
|
+
REVISION = '20170705'
|
|
29
29
|
|
|
30
30
|
# View your Google Analytics data
|
|
31
31
|
AUTH_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/analytics.readonly'
|
|
@@ -22,28 +22,150 @@ module Google
|
|
|
22
22
|
module Apis
|
|
23
23
|
module AnalyticsreportingV4
|
|
24
24
|
|
|
25
|
+
# A segment sequence definition.
|
|
26
|
+
class SegmentSequenceStep
|
|
27
|
+
include Google::Apis::Core::Hashable
|
|
28
|
+
|
|
29
|
+
# A sequence is specified with a list of Or grouped filters which are
|
|
30
|
+
# combined with `AND` operator.
|
|
31
|
+
# Corresponds to the JSON property `orFiltersForSegment`
|
|
32
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::OrFiltersForSegment>]
|
|
33
|
+
attr_accessor :or_filters_for_segment
|
|
34
|
+
|
|
35
|
+
# Specifies if the step immediately precedes or can be any time before the
|
|
36
|
+
# next step.
|
|
37
|
+
# Corresponds to the JSON property `matchType`
|
|
38
|
+
# @return [String]
|
|
39
|
+
attr_accessor :match_type
|
|
40
|
+
|
|
41
|
+
def initialize(**args)
|
|
42
|
+
update!(**args)
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Update properties of this object
|
|
46
|
+
def update!(**args)
|
|
47
|
+
@or_filters_for_segment = args[:or_filters_for_segment] if args.key?(:or_filters_for_segment)
|
|
48
|
+
@match_type = args[:match_type] if args.key?(:match_type)
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# [Metrics](https://support.google.com/analytics/answer/1033861)
|
|
53
|
+
# are the quantitative measurements. For example, the metric `ga:users`
|
|
54
|
+
# indicates the total number of users for the requested time period.
|
|
55
|
+
class Metric
|
|
56
|
+
include Google::Apis::Core::Hashable
|
|
57
|
+
|
|
58
|
+
# Specifies how the metric expression should be formatted, for example
|
|
59
|
+
# `INTEGER`.
|
|
60
|
+
# Corresponds to the JSON property `formattingType`
|
|
61
|
+
# @return [String]
|
|
62
|
+
attr_accessor :formatting_type
|
|
63
|
+
|
|
64
|
+
# An alias for the metric expression is an alternate name for the
|
|
65
|
+
# expression. The alias can be used for filtering and sorting. This field
|
|
66
|
+
# is optional and is useful if the expression is not a single metric but
|
|
67
|
+
# a complex expression which cannot be used in filtering and sorting.
|
|
68
|
+
# The alias is also used in the response column header.
|
|
69
|
+
# Corresponds to the JSON property `alias`
|
|
70
|
+
# @return [String]
|
|
71
|
+
attr_accessor :alias
|
|
72
|
+
|
|
73
|
+
# A metric expression in the request. An expression is constructed from one
|
|
74
|
+
# or more metrics and numbers. Accepted operators include: Plus (+), Minus
|
|
75
|
+
# (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
|
|
76
|
+
# Positive cardinal numbers (0-9), can include decimals and is limited to
|
|
77
|
+
# 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
|
|
78
|
+
# metric expression is just a single metric name like `ga:users`.
|
|
79
|
+
# Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
|
|
80
|
+
# will result in unexpected results.
|
|
81
|
+
# Corresponds to the JSON property `expression`
|
|
82
|
+
# @return [String]
|
|
83
|
+
attr_accessor :expression
|
|
84
|
+
|
|
85
|
+
def initialize(**args)
|
|
86
|
+
update!(**args)
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# Update properties of this object
|
|
90
|
+
def update!(**args)
|
|
91
|
+
@formatting_type = args[:formatting_type] if args.key?(:formatting_type)
|
|
92
|
+
@alias = args[:alias] if args.key?(:alias)
|
|
93
|
+
@expression = args[:expression] if args.key?(:expression)
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# The metric values in the pivot region.
|
|
98
|
+
class PivotValueRegion
|
|
99
|
+
include Google::Apis::Core::Hashable
|
|
100
|
+
|
|
101
|
+
# The values of the metrics in each of the pivot regions.
|
|
102
|
+
# Corresponds to the JSON property `values`
|
|
103
|
+
# @return [Array<String>]
|
|
104
|
+
attr_accessor :values
|
|
105
|
+
|
|
106
|
+
def initialize(**args)
|
|
107
|
+
update!(**args)
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Update properties of this object
|
|
111
|
+
def update!(**args)
|
|
112
|
+
@values = args[:values] if args.key?(:values)
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
# The data response corresponding to the request.
|
|
117
|
+
class Report
|
|
118
|
+
include Google::Apis::Core::Hashable
|
|
119
|
+
|
|
120
|
+
# Page token to retrieve the next page of results in the list.
|
|
121
|
+
# Corresponds to the JSON property `nextPageToken`
|
|
122
|
+
# @return [String]
|
|
123
|
+
attr_accessor :next_page_token
|
|
124
|
+
|
|
125
|
+
# The data part of the report.
|
|
126
|
+
# Corresponds to the JSON property `data`
|
|
127
|
+
# @return [Google::Apis::AnalyticsreportingV4::ReportData]
|
|
128
|
+
attr_accessor :data
|
|
129
|
+
|
|
130
|
+
# Column headers.
|
|
131
|
+
# Corresponds to the JSON property `columnHeader`
|
|
132
|
+
# @return [Google::Apis::AnalyticsreportingV4::ColumnHeader]
|
|
133
|
+
attr_accessor :column_header
|
|
134
|
+
|
|
135
|
+
def initialize(**args)
|
|
136
|
+
update!(**args)
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# Update properties of this object
|
|
140
|
+
def update!(**args)
|
|
141
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
142
|
+
@data = args[:data] if args.key?(:data)
|
|
143
|
+
@column_header = args[:column_header] if args.key?(:column_header)
|
|
144
|
+
end
|
|
145
|
+
end
|
|
146
|
+
|
|
25
147
|
# The headers for each of the pivot sections defined in the request.
|
|
26
148
|
class PivotHeader
|
|
27
149
|
include Google::Apis::Core::Hashable
|
|
28
150
|
|
|
29
|
-
# A single pivot section header.
|
|
30
|
-
# Corresponds to the JSON property `pivotHeaderEntries`
|
|
31
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::PivotHeaderEntry>]
|
|
32
|
-
attr_accessor :pivot_header_entries
|
|
33
|
-
|
|
34
151
|
# The total number of groups for this pivot.
|
|
35
152
|
# Corresponds to the JSON property `totalPivotGroupsCount`
|
|
36
153
|
# @return [Fixnum]
|
|
37
154
|
attr_accessor :total_pivot_groups_count
|
|
38
155
|
|
|
156
|
+
# A single pivot section header.
|
|
157
|
+
# Corresponds to the JSON property `pivotHeaderEntries`
|
|
158
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::PivotHeaderEntry>]
|
|
159
|
+
attr_accessor :pivot_header_entries
|
|
160
|
+
|
|
39
161
|
def initialize(**args)
|
|
40
162
|
update!(**args)
|
|
41
163
|
end
|
|
42
164
|
|
|
43
165
|
# Update properties of this object
|
|
44
166
|
def update!(**args)
|
|
45
|
-
@pivot_header_entries = args[:pivot_header_entries] if args.key?(:pivot_header_entries)
|
|
46
167
|
@total_pivot_groups_count = args[:total_pivot_groups_count] if args.key?(:total_pivot_groups_count)
|
|
168
|
+
@pivot_header_entries = args[:pivot_header_entries] if args.key?(:pivot_header_entries)
|
|
47
169
|
end
|
|
48
170
|
end
|
|
49
171
|
|
|
@@ -74,53 +196,62 @@ module Google
|
|
|
74
196
|
end
|
|
75
197
|
end
|
|
76
198
|
|
|
77
|
-
#
|
|
78
|
-
class
|
|
199
|
+
# The main request class which specifies the Reporting API request.
|
|
200
|
+
class ReportRequest
|
|
79
201
|
include Google::Apis::Core::Hashable
|
|
80
202
|
|
|
81
|
-
# The
|
|
82
|
-
#
|
|
83
|
-
#
|
|
84
|
-
#
|
|
203
|
+
# The desired report
|
|
204
|
+
# [sample](https://support.google.com/analytics/answer/2637192) size.
|
|
205
|
+
# If the the `samplingLevel` field is unspecified the `DEFAULT` sampling
|
|
206
|
+
# level is used. Every [ReportRequest](#ReportRequest) within a
|
|
207
|
+
# `batchGet` method must contain the same `samplingLevel` definition. See
|
|
208
|
+
# [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
|
|
209
|
+
# for details.
|
|
210
|
+
# Corresponds to the JSON property `samplingLevel`
|
|
85
211
|
# @return [String]
|
|
86
|
-
attr_accessor :
|
|
212
|
+
attr_accessor :sampling_level
|
|
87
213
|
|
|
88
|
-
# The
|
|
89
|
-
#
|
|
90
|
-
#
|
|
91
|
-
|
|
214
|
+
# The dimensions requested.
|
|
215
|
+
# Requests can have a total of 7 dimensions.
|
|
216
|
+
# Corresponds to the JSON property `dimensions`
|
|
217
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::Dimension>]
|
|
218
|
+
attr_accessor :dimensions
|
|
92
219
|
|
|
93
|
-
#
|
|
94
|
-
#
|
|
95
|
-
#
|
|
96
|
-
#
|
|
97
|
-
# Corresponds to the JSON property `
|
|
220
|
+
# A continuation token to get the next page of the results. Adding this to
|
|
221
|
+
# the request will return the rows after the pageToken. The pageToken should
|
|
222
|
+
# be the value returned in the nextPageToken parameter in the response to
|
|
223
|
+
# the GetReports request.
|
|
224
|
+
# Corresponds to the JSON property `pageToken`
|
|
98
225
|
# @return [String]
|
|
99
|
-
attr_accessor :
|
|
100
|
-
|
|
101
|
-
# Logical `NOT` operator. If this boolean is set to true, then the matching
|
|
102
|
-
# metric values will be excluded in the report. The default is false.
|
|
103
|
-
# Corresponds to the JSON property `not`
|
|
104
|
-
# @return [Boolean]
|
|
105
|
-
attr_accessor :not
|
|
106
|
-
alias_method :not?, :not
|
|
226
|
+
attr_accessor :page_token
|
|
107
227
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
228
|
+
# Date ranges in the request. The request can have a maximum of 2 date
|
|
229
|
+
# ranges. The response will contain a set of metric values for each
|
|
230
|
+
# combination of the dimensions for each date range in the request. So, if
|
|
231
|
+
# there are two date ranges, there will be two set of metric values, one for
|
|
232
|
+
# the original date range and one for the second date range.
|
|
233
|
+
# The `reportRequest.dateRanges` field should not be specified for cohorts
|
|
234
|
+
# or Lifetime value requests.
|
|
235
|
+
# If a date range is not provided, the default date range is (startDate:
|
|
236
|
+
# current date - 7 days, endDate: current date - 1 day). Every
|
|
237
|
+
# [ReportRequest](#ReportRequest) within a `batchGet` method must
|
|
238
|
+
# contain the same `dateRanges` definition.
|
|
239
|
+
# Corresponds to the JSON property `dateRanges`
|
|
240
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRange>]
|
|
241
|
+
attr_accessor :date_ranges
|
|
111
242
|
|
|
112
|
-
#
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
@operator = args[:operator] if args.key?(:operator)
|
|
117
|
-
@not = args[:not] if args.key?(:not)
|
|
118
|
-
end
|
|
119
|
-
end
|
|
243
|
+
# The pivot definitions. Requests can have a maximum of 2 pivots.
|
|
244
|
+
# Corresponds to the JSON property `pivots`
|
|
245
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::Pivot>]
|
|
246
|
+
attr_accessor :pivots
|
|
120
247
|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
248
|
+
# If set to false, the response does not include rows if all the retrieved
|
|
249
|
+
# metrics are equal to zero. The default is false which will exclude these
|
|
250
|
+
# rows.
|
|
251
|
+
# Corresponds to the JSON property `includeEmptyRows`
|
|
252
|
+
# @return [Boolean]
|
|
253
|
+
attr_accessor :include_empty_rows
|
|
254
|
+
alias_method :include_empty_rows?, :include_empty_rows
|
|
124
255
|
|
|
125
256
|
# The metric filter clauses. They are logically combined with the `AND`
|
|
126
257
|
# operator. Metric filters look at only the first date range and not the
|
|
@@ -209,73 +340,20 @@ module Google
|
|
|
209
340
|
attr_accessor :dimension_filter_clauses
|
|
210
341
|
|
|
211
342
|
# Sort order on output rows. To compare two rows, the elements of the
|
|
212
|
-
# following are applied in order until a difference is found. All date
|
|
213
|
-
# ranges in the output get the same row order.
|
|
214
|
-
# Corresponds to the JSON property `orderBys`
|
|
215
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::OrderBy>]
|
|
216
|
-
attr_accessor :order_bys
|
|
217
|
-
|
|
218
|
-
# Segment the data returned for the request. A segment definition helps look
|
|
219
|
-
# at a subset of the segment request. A request can contain up to four
|
|
220
|
-
# segments. Every [ReportRequest](#ReportRequest) within a
|
|
221
|
-
# `batchGet` method must contain the same `segments` definition. Requests
|
|
222
|
-
# with segments must have the `ga:segment` dimension.
|
|
223
|
-
# Corresponds to the JSON property `segments`
|
|
224
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::Segment>]
|
|
225
|
-
attr_accessor :segments
|
|
226
|
-
|
|
227
|
-
# The desired report
|
|
228
|
-
# [sample](https://support.google.com/analytics/answer/2637192) size.
|
|
229
|
-
# If the the `samplingLevel` field is unspecified the `DEFAULT` sampling
|
|
230
|
-
# level is used. Every [ReportRequest](#ReportRequest) within a
|
|
231
|
-
# `batchGet` method must contain the same `samplingLevel` definition. See
|
|
232
|
-
# [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
|
|
233
|
-
# for details.
|
|
234
|
-
# Corresponds to the JSON property `samplingLevel`
|
|
235
|
-
# @return [String]
|
|
236
|
-
attr_accessor :sampling_level
|
|
237
|
-
|
|
238
|
-
# The dimensions requested.
|
|
239
|
-
# Requests can have a total of 7 dimensions.
|
|
240
|
-
# Corresponds to the JSON property `dimensions`
|
|
241
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::Dimension>]
|
|
242
|
-
attr_accessor :dimensions
|
|
243
|
-
|
|
244
|
-
# Date ranges in the request. The request can have a maximum of 2 date
|
|
245
|
-
# ranges. The response will contain a set of metric values for each
|
|
246
|
-
# combination of the dimensions for each date range in the request. So, if
|
|
247
|
-
# there are two date ranges, there will be two set of metric values, one for
|
|
248
|
-
# the original date range and one for the second date range.
|
|
249
|
-
# The `reportRequest.dateRanges` field should not be specified for cohorts
|
|
250
|
-
# or Lifetime value requests.
|
|
251
|
-
# If a date range is not provided, the default date range is (startDate:
|
|
252
|
-
# current date - 7 days, endDate: current date - 1 day). Every
|
|
253
|
-
# [ReportRequest](#ReportRequest) within a `batchGet` method must
|
|
254
|
-
# contain the same `dateRanges` definition.
|
|
255
|
-
# Corresponds to the JSON property `dateRanges`
|
|
256
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRange>]
|
|
257
|
-
attr_accessor :date_ranges
|
|
258
|
-
|
|
259
|
-
# A continuation token to get the next page of the results. Adding this to
|
|
260
|
-
# the request will return the rows after the pageToken. The pageToken should
|
|
261
|
-
# be the value returned in the nextPageToken parameter in the response to
|
|
262
|
-
# the GetReports request.
|
|
263
|
-
# Corresponds to the JSON property `pageToken`
|
|
264
|
-
# @return [String]
|
|
265
|
-
attr_accessor :page_token
|
|
266
|
-
|
|
267
|
-
# The pivot definitions. Requests can have a maximum of 2 pivots.
|
|
268
|
-
# Corresponds to the JSON property `pivots`
|
|
269
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::Pivot>]
|
|
270
|
-
attr_accessor :pivots
|
|
271
|
-
|
|
272
|
-
# If set to false, the response does not include rows if all the retrieved
|
|
273
|
-
# metrics are equal to zero. The default is false which will exclude these
|
|
274
|
-
# rows.
|
|
275
|
-
# Corresponds to the JSON property `includeEmptyRows`
|
|
276
|
-
# @return [Boolean]
|
|
277
|
-
attr_accessor :include_empty_rows
|
|
278
|
-
alias_method :include_empty_rows?, :include_empty_rows
|
|
343
|
+
# following are applied in order until a difference is found. All date
|
|
344
|
+
# ranges in the output get the same row order.
|
|
345
|
+
# Corresponds to the JSON property `orderBys`
|
|
346
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::OrderBy>]
|
|
347
|
+
attr_accessor :order_bys
|
|
348
|
+
|
|
349
|
+
# Segment the data returned for the request. A segment definition helps look
|
|
350
|
+
# at a subset of the segment request. A request can contain up to four
|
|
351
|
+
# segments. Every [ReportRequest](#ReportRequest) within a
|
|
352
|
+
# `batchGet` method must contain the same `segments` definition. Requests
|
|
353
|
+
# with segments must have the `ga:segment` dimension.
|
|
354
|
+
# Corresponds to the JSON property `segments`
|
|
355
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::Segment>]
|
|
356
|
+
attr_accessor :segments
|
|
279
357
|
|
|
280
358
|
def initialize(**args)
|
|
281
359
|
update!(**args)
|
|
@@ -283,6 +361,12 @@ module Google
|
|
|
283
361
|
|
|
284
362
|
# Update properties of this object
|
|
285
363
|
def update!(**args)
|
|
364
|
+
@sampling_level = args[:sampling_level] if args.key?(:sampling_level)
|
|
365
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
|
366
|
+
@page_token = args[:page_token] if args.key?(:page_token)
|
|
367
|
+
@date_ranges = args[:date_ranges] if args.key?(:date_ranges)
|
|
368
|
+
@pivots = args[:pivots] if args.key?(:pivots)
|
|
369
|
+
@include_empty_rows = args[:include_empty_rows] if args.key?(:include_empty_rows)
|
|
286
370
|
@metric_filter_clauses = args[:metric_filter_clauses] if args.key?(:metric_filter_clauses)
|
|
287
371
|
@page_size = args[:page_size] if args.key?(:page_size)
|
|
288
372
|
@hide_totals = args[:hide_totals] if args.key?(:hide_totals)
|
|
@@ -294,12 +378,50 @@ module Google
|
|
|
294
378
|
@dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses)
|
|
295
379
|
@order_bys = args[:order_bys] if args.key?(:order_bys)
|
|
296
380
|
@segments = args[:segments] if args.key?(:segments)
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
381
|
+
end
|
|
382
|
+
end
|
|
383
|
+
|
|
384
|
+
# MetricFilter specifies the filter on a metric.
|
|
385
|
+
class MetricFilter
|
|
386
|
+
include Google::Apis::Core::Hashable
|
|
387
|
+
|
|
388
|
+
# The metric that will be filtered on. A metricFilter must contain a metric
|
|
389
|
+
# name. A metric name can be an alias earlier defined as a metric or it can
|
|
390
|
+
# also be a metric expression.
|
|
391
|
+
# Corresponds to the JSON property `metricName`
|
|
392
|
+
# @return [String]
|
|
393
|
+
attr_accessor :metric_name
|
|
394
|
+
|
|
395
|
+
# The value to compare against.
|
|
396
|
+
# Corresponds to the JSON property `comparisonValue`
|
|
397
|
+
# @return [String]
|
|
398
|
+
attr_accessor :comparison_value
|
|
399
|
+
|
|
400
|
+
# Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the
|
|
401
|
+
# comparisonValue, the default is `EQUAL`. If the operator is
|
|
402
|
+
# `IS_MISSING`, checks if the metric is missing and would ignore the
|
|
403
|
+
# comparisonValue.
|
|
404
|
+
# Corresponds to the JSON property `operator`
|
|
405
|
+
# @return [String]
|
|
406
|
+
attr_accessor :operator
|
|
407
|
+
|
|
408
|
+
# Logical `NOT` operator. If this boolean is set to true, then the matching
|
|
409
|
+
# metric values will be excluded in the report. The default is false.
|
|
410
|
+
# Corresponds to the JSON property `not`
|
|
411
|
+
# @return [Boolean]
|
|
412
|
+
attr_accessor :not
|
|
413
|
+
alias_method :not?, :not
|
|
414
|
+
|
|
415
|
+
def initialize(**args)
|
|
416
|
+
update!(**args)
|
|
417
|
+
end
|
|
418
|
+
|
|
419
|
+
# Update properties of this object
|
|
420
|
+
def update!(**args)
|
|
421
|
+
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
|
422
|
+
@comparison_value = args[:comparison_value] if args.key?(:comparison_value)
|
|
423
|
+
@operator = args[:operator] if args.key?(:operator)
|
|
424
|
+
@not = args[:not] if args.key?(:not)
|
|
303
425
|
end
|
|
304
426
|
end
|
|
305
427
|
|
|
@@ -381,6 +503,12 @@ module Google
|
|
|
381
503
|
class DynamicSegment
|
|
382
504
|
include Google::Apis::Core::Hashable
|
|
383
505
|
|
|
506
|
+
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
|
507
|
+
# are combined together with a logical `AND` operation.
|
|
508
|
+
# Corresponds to the JSON property `userSegment`
|
|
509
|
+
# @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
|
|
510
|
+
attr_accessor :user_segment
|
|
511
|
+
|
|
384
512
|
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
|
385
513
|
# are combined together with a logical `AND` operation.
|
|
386
514
|
# Corresponds to the JSON property `sessionSegment`
|
|
@@ -392,21 +520,15 @@ module Google
|
|
|
392
520
|
# @return [String]
|
|
393
521
|
attr_accessor :name
|
|
394
522
|
|
|
395
|
-
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
|
396
|
-
# are combined together with a logical `AND` operation.
|
|
397
|
-
# Corresponds to the JSON property `userSegment`
|
|
398
|
-
# @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
|
|
399
|
-
attr_accessor :user_segment
|
|
400
|
-
|
|
401
523
|
def initialize(**args)
|
|
402
524
|
update!(**args)
|
|
403
525
|
end
|
|
404
526
|
|
|
405
527
|
# Update properties of this object
|
|
406
528
|
def update!(**args)
|
|
529
|
+
@user_segment = args[:user_segment] if args.key?(:user_segment)
|
|
407
530
|
@session_segment = args[:session_segment] if args.key?(:session_segment)
|
|
408
531
|
@name = args[:name] if args.key?(:name)
|
|
409
|
-
@user_segment = args[:user_segment] if args.key?(:user_segment)
|
|
410
532
|
end
|
|
411
533
|
end
|
|
412
534
|
|
|
@@ -414,24 +536,24 @@ module Google
|
|
|
414
536
|
class ColumnHeader
|
|
415
537
|
include Google::Apis::Core::Hashable
|
|
416
538
|
|
|
417
|
-
# The dimension names in the response.
|
|
418
|
-
# Corresponds to the JSON property `dimensions`
|
|
419
|
-
# @return [Array<String>]
|
|
420
|
-
attr_accessor :dimensions
|
|
421
|
-
|
|
422
539
|
# The headers for the metrics.
|
|
423
540
|
# Corresponds to the JSON property `metricHeader`
|
|
424
541
|
# @return [Google::Apis::AnalyticsreportingV4::MetricHeader]
|
|
425
542
|
attr_accessor :metric_header
|
|
426
543
|
|
|
544
|
+
# The dimension names in the response.
|
|
545
|
+
# Corresponds to the JSON property `dimensions`
|
|
546
|
+
# @return [Array<String>]
|
|
547
|
+
attr_accessor :dimensions
|
|
548
|
+
|
|
427
549
|
def initialize(**args)
|
|
428
550
|
update!(**args)
|
|
429
551
|
end
|
|
430
552
|
|
|
431
553
|
# Update properties of this object
|
|
432
554
|
def update!(**args)
|
|
433
|
-
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
|
434
555
|
@metric_header = args[:metric_header] if args.key?(:metric_header)
|
|
556
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
|
435
557
|
end
|
|
436
558
|
end
|
|
437
559
|
|
|
@@ -468,44 +590,6 @@ module Google
|
|
|
468
590
|
end
|
|
469
591
|
end
|
|
470
592
|
|
|
471
|
-
# Defines a cohort. A cohort is a group of users who share a common
|
|
472
|
-
# characteristic. For example, all users with the same acquisition date
|
|
473
|
-
# belong to the same cohort.
|
|
474
|
-
class Cohort
|
|
475
|
-
include Google::Apis::Core::Hashable
|
|
476
|
-
|
|
477
|
-
# A unique name for the cohort. If not defined name will be auto-generated
|
|
478
|
-
# with values cohort_[1234...].
|
|
479
|
-
# Corresponds to the JSON property `name`
|
|
480
|
-
# @return [String]
|
|
481
|
-
attr_accessor :name
|
|
482
|
-
|
|
483
|
-
# A contiguous set of days: startDate, startDate + 1 day, ..., endDate.
|
|
484
|
-
# The start and end dates are specified in
|
|
485
|
-
# [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.
|
|
486
|
-
# Corresponds to the JSON property `dateRange`
|
|
487
|
-
# @return [Google::Apis::AnalyticsreportingV4::DateRange]
|
|
488
|
-
attr_accessor :date_range
|
|
489
|
-
|
|
490
|
-
# Type of the cohort. The only supported type as of now is
|
|
491
|
-
# `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated
|
|
492
|
-
# as `FIRST_VISIT_DATE` type cohort.
|
|
493
|
-
# Corresponds to the JSON property `type`
|
|
494
|
-
# @return [String]
|
|
495
|
-
attr_accessor :type
|
|
496
|
-
|
|
497
|
-
def initialize(**args)
|
|
498
|
-
update!(**args)
|
|
499
|
-
end
|
|
500
|
-
|
|
501
|
-
# Update properties of this object
|
|
502
|
-
def update!(**args)
|
|
503
|
-
@name = args[:name] if args.key?(:name)
|
|
504
|
-
@date_range = args[:date_range] if args.key?(:date_range)
|
|
505
|
-
@type = args[:type] if args.key?(:type)
|
|
506
|
-
end
|
|
507
|
-
end
|
|
508
|
-
|
|
509
593
|
# A row in the report.
|
|
510
594
|
class ReportRow
|
|
511
595
|
include Google::Apis::Core::Hashable
|
|
@@ -536,26 +620,64 @@ module Google
|
|
|
536
620
|
class MetricFilterClause
|
|
537
621
|
include Google::Apis::Core::Hashable
|
|
538
622
|
|
|
539
|
-
# The operator for combining multiple metric filters. If unspecified, it is
|
|
540
|
-
# treated as an `OR`.
|
|
541
|
-
# Corresponds to the JSON property `operator`
|
|
542
|
-
# @return [String]
|
|
543
|
-
attr_accessor :operator
|
|
544
|
-
|
|
545
623
|
# The repeated set of filters. They are logically combined based on the
|
|
546
624
|
# operator specified.
|
|
547
625
|
# Corresponds to the JSON property `filters`
|
|
548
626
|
# @return [Array<Google::Apis::AnalyticsreportingV4::MetricFilter>]
|
|
549
627
|
attr_accessor :filters
|
|
550
628
|
|
|
629
|
+
# The operator for combining multiple metric filters. If unspecified, it is
|
|
630
|
+
# treated as an `OR`.
|
|
631
|
+
# Corresponds to the JSON property `operator`
|
|
632
|
+
# @return [String]
|
|
633
|
+
attr_accessor :operator
|
|
634
|
+
|
|
551
635
|
def initialize(**args)
|
|
552
636
|
update!(**args)
|
|
553
637
|
end
|
|
554
638
|
|
|
555
639
|
# Update properties of this object
|
|
556
640
|
def update!(**args)
|
|
557
|
-
@operator = args[:operator] if args.key?(:operator)
|
|
558
641
|
@filters = args[:filters] if args.key?(:filters)
|
|
642
|
+
@operator = args[:operator] if args.key?(:operator)
|
|
643
|
+
end
|
|
644
|
+
end
|
|
645
|
+
|
|
646
|
+
# Defines a cohort. A cohort is a group of users who share a common
|
|
647
|
+
# characteristic. For example, all users with the same acquisition date
|
|
648
|
+
# belong to the same cohort.
|
|
649
|
+
class Cohort
|
|
650
|
+
include Google::Apis::Core::Hashable
|
|
651
|
+
|
|
652
|
+
# A contiguous set of days: startDate, startDate + 1 day, ..., endDate.
|
|
653
|
+
# The start and end dates are specified in
|
|
654
|
+
# [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.
|
|
655
|
+
# Corresponds to the JSON property `dateRange`
|
|
656
|
+
# @return [Google::Apis::AnalyticsreportingV4::DateRange]
|
|
657
|
+
attr_accessor :date_range
|
|
658
|
+
|
|
659
|
+
# A unique name for the cohort. If not defined name will be auto-generated
|
|
660
|
+
# with values cohort_[1234...].
|
|
661
|
+
# Corresponds to the JSON property `name`
|
|
662
|
+
# @return [String]
|
|
663
|
+
attr_accessor :name
|
|
664
|
+
|
|
665
|
+
# Type of the cohort. The only supported type as of now is
|
|
666
|
+
# `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated
|
|
667
|
+
# as `FIRST_VISIT_DATE` type cohort.
|
|
668
|
+
# Corresponds to the JSON property `type`
|
|
669
|
+
# @return [String]
|
|
670
|
+
attr_accessor :type
|
|
671
|
+
|
|
672
|
+
def initialize(**args)
|
|
673
|
+
update!(**args)
|
|
674
|
+
end
|
|
675
|
+
|
|
676
|
+
# Update properties of this object
|
|
677
|
+
def update!(**args)
|
|
678
|
+
@date_range = args[:date_range] if args.key?(:date_range)
|
|
679
|
+
@name = args[:name] if args.key?(:name)
|
|
680
|
+
@type = args[:type] if args.key?(:type)
|
|
559
681
|
end
|
|
560
682
|
end
|
|
561
683
|
|
|
@@ -609,26 +731,26 @@ module Google
|
|
|
609
731
|
class DimensionFilterClause
|
|
610
732
|
include Google::Apis::Core::Hashable
|
|
611
733
|
|
|
612
|
-
# The operator for combining multiple dimension filters. If unspecified, it
|
|
613
|
-
# is treated as an `OR`.
|
|
614
|
-
# Corresponds to the JSON property `operator`
|
|
615
|
-
# @return [String]
|
|
616
|
-
attr_accessor :operator
|
|
617
|
-
|
|
618
734
|
# The repeated set of filters. They are logically combined based on the
|
|
619
735
|
# operator specified.
|
|
620
736
|
# Corresponds to the JSON property `filters`
|
|
621
737
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DimensionFilter>]
|
|
622
738
|
attr_accessor :filters
|
|
623
739
|
|
|
740
|
+
# The operator for combining multiple dimension filters. If unspecified, it
|
|
741
|
+
# is treated as an `OR`.
|
|
742
|
+
# Corresponds to the JSON property `operator`
|
|
743
|
+
# @return [String]
|
|
744
|
+
attr_accessor :operator
|
|
745
|
+
|
|
624
746
|
def initialize(**args)
|
|
625
747
|
update!(**args)
|
|
626
748
|
end
|
|
627
749
|
|
|
628
750
|
# Update properties of this object
|
|
629
751
|
def update!(**args)
|
|
630
|
-
@operator = args[:operator] if args.key?(:operator)
|
|
631
752
|
@filters = args[:filters] if args.key?(:filters)
|
|
753
|
+
@operator = args[:operator] if args.key?(:operator)
|
|
632
754
|
end
|
|
633
755
|
end
|
|
634
756
|
|
|
@@ -658,11 +780,6 @@ module Google
|
|
|
658
780
|
class SequenceSegment
|
|
659
781
|
include Google::Apis::Core::Hashable
|
|
660
782
|
|
|
661
|
-
# The list of steps in the sequence.
|
|
662
|
-
# Corresponds to the JSON property `segmentSequenceSteps`
|
|
663
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::SegmentSequenceStep>]
|
|
664
|
-
attr_accessor :segment_sequence_steps
|
|
665
|
-
|
|
666
783
|
# If set, first step condition must match the first hit of the visitor (in
|
|
667
784
|
# the date range).
|
|
668
785
|
# Corresponds to the JSON property `firstStepShouldMatchFirstHit`
|
|
@@ -670,14 +787,19 @@ module Google
|
|
|
670
787
|
attr_accessor :first_step_should_match_first_hit
|
|
671
788
|
alias_method :first_step_should_match_first_hit?, :first_step_should_match_first_hit
|
|
672
789
|
|
|
790
|
+
# The list of steps in the sequence.
|
|
791
|
+
# Corresponds to the JSON property `segmentSequenceSteps`
|
|
792
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::SegmentSequenceStep>]
|
|
793
|
+
attr_accessor :segment_sequence_steps
|
|
794
|
+
|
|
673
795
|
def initialize(**args)
|
|
674
796
|
update!(**args)
|
|
675
797
|
end
|
|
676
798
|
|
|
677
799
|
# Update properties of this object
|
|
678
800
|
def update!(**args)
|
|
679
|
-
@segment_sequence_steps = args[:segment_sequence_steps] if args.key?(:segment_sequence_steps)
|
|
680
801
|
@first_step_should_match_first_hit = args[:first_step_should_match_first_hit] if args.key?(:first_step_should_match_first_hit)
|
|
802
|
+
@segment_sequence_steps = args[:segment_sequence_steps] if args.key?(:segment_sequence_steps)
|
|
681
803
|
end
|
|
682
804
|
end
|
|
683
805
|
|
|
@@ -685,6 +807,12 @@ module Google
|
|
|
685
807
|
class SegmentMetricFilter
|
|
686
808
|
include Google::Apis::Core::Hashable
|
|
687
809
|
|
|
810
|
+
# Specifies is the operation to perform to compare the metric. The default
|
|
811
|
+
# is `EQUAL`.
|
|
812
|
+
# Corresponds to the JSON property `operator`
|
|
813
|
+
# @return [String]
|
|
814
|
+
attr_accessor :operator
|
|
815
|
+
|
|
688
816
|
# The metric that will be filtered on. A `metricFilter` must contain a
|
|
689
817
|
# metric name.
|
|
690
818
|
# Corresponds to the JSON property `metricName`
|
|
@@ -710,23 +838,17 @@ module Google
|
|
|
710
838
|
# @return [String]
|
|
711
839
|
attr_accessor :comparison_value
|
|
712
840
|
|
|
713
|
-
# Specifies is the operation to perform to compare the metric. The default
|
|
714
|
-
# is `EQUAL`.
|
|
715
|
-
# Corresponds to the JSON property `operator`
|
|
716
|
-
# @return [String]
|
|
717
|
-
attr_accessor :operator
|
|
718
|
-
|
|
719
841
|
def initialize(**args)
|
|
720
842
|
update!(**args)
|
|
721
843
|
end
|
|
722
844
|
|
|
723
845
|
# Update properties of this object
|
|
724
846
|
def update!(**args)
|
|
847
|
+
@operator = args[:operator] if args.key?(:operator)
|
|
725
848
|
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
|
726
849
|
@scope = args[:scope] if args.key?(:scope)
|
|
727
850
|
@max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value)
|
|
728
851
|
@comparison_value = args[:comparison_value] if args.key?(:comparison_value)
|
|
729
|
-
@operator = args[:operator] if args.key?(:operator)
|
|
730
852
|
end
|
|
731
853
|
end
|
|
732
854
|
|
|
@@ -772,6 +894,11 @@ module Google
|
|
|
772
894
|
class CohortGroup
|
|
773
895
|
include Google::Apis::Core::Hashable
|
|
774
896
|
|
|
897
|
+
# The definition for the cohort.
|
|
898
|
+
# Corresponds to the JSON property `cohorts`
|
|
899
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::Cohort>]
|
|
900
|
+
attr_accessor :cohorts
|
|
901
|
+
|
|
775
902
|
# Enable Life Time Value (LTV). LTV measures lifetime value for users
|
|
776
903
|
# acquired through different channels.
|
|
777
904
|
# Please see:
|
|
@@ -804,19 +931,14 @@ module Google
|
|
|
804
931
|
attr_accessor :lifetime_value
|
|
805
932
|
alias_method :lifetime_value?, :lifetime_value
|
|
806
933
|
|
|
807
|
-
# The definition for the cohort.
|
|
808
|
-
# Corresponds to the JSON property `cohorts`
|
|
809
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::Cohort>]
|
|
810
|
-
attr_accessor :cohorts
|
|
811
|
-
|
|
812
934
|
def initialize(**args)
|
|
813
935
|
update!(**args)
|
|
814
936
|
end
|
|
815
937
|
|
|
816
938
|
# Update properties of this object
|
|
817
939
|
def update!(**args)
|
|
818
|
-
@lifetime_value = args[:lifetime_value] if args.key?(:lifetime_value)
|
|
819
940
|
@cohorts = args[:cohorts] if args.key?(:cohorts)
|
|
941
|
+
@lifetime_value = args[:lifetime_value] if args.key?(:lifetime_value)
|
|
820
942
|
end
|
|
821
943
|
end
|
|
822
944
|
|
|
@@ -847,6 +969,12 @@ module Google
|
|
|
847
969
|
class Pivot
|
|
848
970
|
include Google::Apis::Core::Hashable
|
|
849
971
|
|
|
972
|
+
# Specifies the maximum number of groups to return.
|
|
973
|
+
# The default value is 10, also the maximum value is 1,000.
|
|
974
|
+
# Corresponds to the JSON property `maxGroupCount`
|
|
975
|
+
# @return [Fixnum]
|
|
976
|
+
attr_accessor :max_group_count
|
|
977
|
+
|
|
850
978
|
# If k metrics were requested, then the response will contain some
|
|
851
979
|
# data-dependent multiple of k columns in the report. E.g., if you pivoted
|
|
852
980
|
# on the dimension `ga:browser` then you'd get k columns for "Firefox", k
|
|
@@ -863,18 +991,11 @@ module Google
|
|
|
863
991
|
# @return [Fixnum]
|
|
864
992
|
attr_accessor :start_group
|
|
865
993
|
|
|
866
|
-
# The pivot metrics. Pivot metrics are part of the
|
|
867
|
-
# restriction on total number of metrics allowed in the request.
|
|
868
|
-
# Corresponds to the JSON property `metrics`
|
|
869
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::Metric>]
|
|
870
|
-
attr_accessor :metrics
|
|
871
|
-
|
|
872
|
-
# A list of dimensions to show as pivot columns. A Pivot can have a maximum
|
|
873
|
-
# of 4 dimensions. Pivot dimensions are part of the restriction on the
|
|
874
|
-
# total number of dimensions allowed in the request.
|
|
875
|
-
# Corresponds to the JSON property `dimensions`
|
|
876
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::Dimension>]
|
|
877
|
-
attr_accessor :dimensions
|
|
994
|
+
# The pivot metrics. Pivot metrics are part of the
|
|
995
|
+
# restriction on total number of metrics allowed in the request.
|
|
996
|
+
# Corresponds to the JSON property `metrics`
|
|
997
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::Metric>]
|
|
998
|
+
attr_accessor :metrics
|
|
878
999
|
|
|
879
1000
|
# DimensionFilterClauses are logically combined with an `AND` operator: only
|
|
880
1001
|
# data that is included by all these DimensionFilterClauses contributes to
|
|
@@ -887,11 +1008,12 @@ module Google
|
|
|
887
1008
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DimensionFilterClause>]
|
|
888
1009
|
attr_accessor :dimension_filter_clauses
|
|
889
1010
|
|
|
890
|
-
#
|
|
891
|
-
#
|
|
892
|
-
#
|
|
893
|
-
#
|
|
894
|
-
|
|
1011
|
+
# A list of dimensions to show as pivot columns. A Pivot can have a maximum
|
|
1012
|
+
# of 4 dimensions. Pivot dimensions are part of the restriction on the
|
|
1013
|
+
# total number of dimensions allowed in the request.
|
|
1014
|
+
# Corresponds to the JSON property `dimensions`
|
|
1015
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::Dimension>]
|
|
1016
|
+
attr_accessor :dimensions
|
|
895
1017
|
|
|
896
1018
|
def initialize(**args)
|
|
897
1019
|
update!(**args)
|
|
@@ -899,11 +1021,11 @@ module Google
|
|
|
899
1021
|
|
|
900
1022
|
# Update properties of this object
|
|
901
1023
|
def update!(**args)
|
|
1024
|
+
@max_group_count = args[:max_group_count] if args.key?(:max_group_count)
|
|
902
1025
|
@start_group = args[:start_group] if args.key?(:start_group)
|
|
903
1026
|
@metrics = args[:metrics] if args.key?(:metrics)
|
|
904
|
-
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
|
905
1027
|
@dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses)
|
|
906
|
-
@
|
|
1028
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
|
907
1029
|
end
|
|
908
1030
|
end
|
|
909
1031
|
|
|
@@ -912,16 +1034,16 @@ module Google
|
|
|
912
1034
|
class PivotHeaderEntry
|
|
913
1035
|
include Google::Apis::Core::Hashable
|
|
914
1036
|
|
|
915
|
-
# The name of the dimensions in the pivot response.
|
|
916
|
-
# Corresponds to the JSON property `dimensionNames`
|
|
917
|
-
# @return [Array<String>]
|
|
918
|
-
attr_accessor :dimension_names
|
|
919
|
-
|
|
920
1037
|
# Header for the metrics.
|
|
921
1038
|
# Corresponds to the JSON property `metric`
|
|
922
1039
|
# @return [Google::Apis::AnalyticsreportingV4::MetricHeaderEntry]
|
|
923
1040
|
attr_accessor :metric
|
|
924
1041
|
|
|
1042
|
+
# The name of the dimensions in the pivot response.
|
|
1043
|
+
# Corresponds to the JSON property `dimensionNames`
|
|
1044
|
+
# @return [Array<String>]
|
|
1045
|
+
attr_accessor :dimension_names
|
|
1046
|
+
|
|
925
1047
|
# The values for the dimensions in the pivot.
|
|
926
1048
|
# Corresponds to the JSON property `dimensionValues`
|
|
927
1049
|
# @return [Array<String>]
|
|
@@ -933,8 +1055,8 @@ module Google
|
|
|
933
1055
|
|
|
934
1056
|
# Update properties of this object
|
|
935
1057
|
def update!(**args)
|
|
936
|
-
@dimension_names = args[:dimension_names] if args.key?(:dimension_names)
|
|
937
1058
|
@metric = args[:metric] if args.key?(:metric)
|
|
1059
|
+
@dimension_names = args[:dimension_names] if args.key?(:dimension_names)
|
|
938
1060
|
@dimension_values = args[:dimension_values] if args.key?(:dimension_values)
|
|
939
1061
|
end
|
|
940
1062
|
end
|
|
@@ -946,6 +1068,13 @@ module Google
|
|
|
946
1068
|
class SegmentFilter
|
|
947
1069
|
include Google::Apis::Core::Hashable
|
|
948
1070
|
|
|
1071
|
+
# Sequence conditions consist of one or more steps, where each step is defined
|
|
1072
|
+
# by one or more dimension/metric conditions. Multiple steps can be combined
|
|
1073
|
+
# with special sequence operators.
|
|
1074
|
+
# Corresponds to the JSON property `sequenceSegment`
|
|
1075
|
+
# @return [Google::Apis::AnalyticsreportingV4::SequenceSegment]
|
|
1076
|
+
attr_accessor :sequence_segment
|
|
1077
|
+
|
|
949
1078
|
# If true, match the complement of simple or sequence segment.
|
|
950
1079
|
# For example, to match all visits not from "New York", we can define the
|
|
951
1080
|
# segment as follows:
|
|
@@ -975,22 +1104,15 @@ module Google
|
|
|
975
1104
|
# @return [Google::Apis::AnalyticsreportingV4::SimpleSegment]
|
|
976
1105
|
attr_accessor :simple_segment
|
|
977
1106
|
|
|
978
|
-
# Sequence conditions consist of one or more steps, where each step is defined
|
|
979
|
-
# by one or more dimension/metric conditions. Multiple steps can be combined
|
|
980
|
-
# with special sequence operators.
|
|
981
|
-
# Corresponds to the JSON property `sequenceSegment`
|
|
982
|
-
# @return [Google::Apis::AnalyticsreportingV4::SequenceSegment]
|
|
983
|
-
attr_accessor :sequence_segment
|
|
984
|
-
|
|
985
1107
|
def initialize(**args)
|
|
986
1108
|
update!(**args)
|
|
987
1109
|
end
|
|
988
1110
|
|
|
989
1111
|
# Update properties of this object
|
|
990
1112
|
def update!(**args)
|
|
1113
|
+
@sequence_segment = args[:sequence_segment] if args.key?(:sequence_segment)
|
|
991
1114
|
@not = args[:not] if args.key?(:not)
|
|
992
1115
|
@simple_segment = args[:simple_segment] if args.key?(:simple_segment)
|
|
993
|
-
@sequence_segment = args[:sequence_segment] if args.key?(:sequence_segment)
|
|
994
1116
|
end
|
|
995
1117
|
end
|
|
996
1118
|
|
|
@@ -1084,16 +1206,6 @@ module Google
|
|
|
1084
1206
|
# @return [Array<Fixnum>]
|
|
1085
1207
|
attr_accessor :samples_read_counts
|
|
1086
1208
|
|
|
1087
|
-
# Total number of matching rows for this query.
|
|
1088
|
-
# Corresponds to the JSON property `rowCount`
|
|
1089
|
-
# @return [Fixnum]
|
|
1090
|
-
attr_accessor :row_count
|
|
1091
|
-
|
|
1092
|
-
# There's one ReportRow for every unique combination of dimensions.
|
|
1093
|
-
# Corresponds to the JSON property `rows`
|
|
1094
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::ReportRow>]
|
|
1095
|
-
attr_accessor :rows
|
|
1096
|
-
|
|
1097
1209
|
# Indicates if response to this request is golden or not. Data is
|
|
1098
1210
|
# golden when the exact same request will not produce any new results if
|
|
1099
1211
|
# asked at a later point in time.
|
|
@@ -1102,6 +1214,16 @@ module Google
|
|
|
1102
1214
|
attr_accessor :is_data_golden
|
|
1103
1215
|
alias_method :is_data_golden?, :is_data_golden
|
|
1104
1216
|
|
|
1217
|
+
# There's one ReportRow for every unique combination of dimensions.
|
|
1218
|
+
# Corresponds to the JSON property `rows`
|
|
1219
|
+
# @return [Array<Google::Apis::AnalyticsreportingV4::ReportRow>]
|
|
1220
|
+
attr_accessor :rows
|
|
1221
|
+
|
|
1222
|
+
# Total number of matching rows for this query.
|
|
1223
|
+
# Corresponds to the JSON property `rowCount`
|
|
1224
|
+
# @return [Fixnum]
|
|
1225
|
+
attr_accessor :row_count
|
|
1226
|
+
|
|
1105
1227
|
# The last time the data in the report was refreshed. All the hits received
|
|
1106
1228
|
# before this timestamp are included in the calculation of the report.
|
|
1107
1229
|
# Corresponds to the JSON property `dataLastRefreshed`
|
|
@@ -1125,9 +1247,9 @@ module Google
|
|
|
1125
1247
|
@minimums = args[:minimums] if args.key?(:minimums)
|
|
1126
1248
|
@totals = args[:totals] if args.key?(:totals)
|
|
1127
1249
|
@samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts)
|
|
1128
|
-
@row_count = args[:row_count] if args.key?(:row_count)
|
|
1129
|
-
@rows = args[:rows] if args.key?(:rows)
|
|
1130
1250
|
@is_data_golden = args[:is_data_golden] if args.key?(:is_data_golden)
|
|
1251
|
+
@rows = args[:rows] if args.key?(:rows)
|
|
1252
|
+
@row_count = args[:row_count] if args.key?(:row_count)
|
|
1131
1253
|
@data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed)
|
|
1132
1254
|
@maximums = args[:maximums] if args.key?(:maximums)
|
|
1133
1255
|
end
|
|
@@ -1137,22 +1259,21 @@ module Google
|
|
|
1137
1259
|
class DimensionFilter
|
|
1138
1260
|
include Google::Apis::Core::Hashable
|
|
1139
1261
|
|
|
1140
|
-
#
|
|
1141
|
-
# Corresponds to the JSON property `
|
|
1142
|
-
# @return [
|
|
1143
|
-
attr_accessor :
|
|
1262
|
+
# Should the match be case sensitive? Default is false.
|
|
1263
|
+
# Corresponds to the JSON property `caseSensitive`
|
|
1264
|
+
# @return [Boolean]
|
|
1265
|
+
attr_accessor :case_sensitive
|
|
1266
|
+
alias_method :case_sensitive?, :case_sensitive
|
|
1144
1267
|
|
|
1145
1268
|
# How to match the dimension to the expression. The default is REGEXP.
|
|
1146
1269
|
# Corresponds to the JSON property `operator`
|
|
1147
1270
|
# @return [String]
|
|
1148
1271
|
attr_accessor :operator
|
|
1149
1272
|
|
|
1150
|
-
#
|
|
1151
|
-
#
|
|
1152
|
-
#
|
|
1153
|
-
|
|
1154
|
-
attr_accessor :not
|
|
1155
|
-
alias_method :not?, :not
|
|
1273
|
+
# The dimension to filter on. A DimensionFilter must contain a dimension.
|
|
1274
|
+
# Corresponds to the JSON property `dimensionName`
|
|
1275
|
+
# @return [String]
|
|
1276
|
+
attr_accessor :dimension_name
|
|
1156
1277
|
|
|
1157
1278
|
# Strings or regular expression to match against. Only the first value of
|
|
1158
1279
|
# the list is used for comparison unless the operator is `IN_LIST`.
|
|
@@ -1162,11 +1283,12 @@ module Google
|
|
|
1162
1283
|
# @return [Array<String>]
|
|
1163
1284
|
attr_accessor :expressions
|
|
1164
1285
|
|
|
1165
|
-
#
|
|
1166
|
-
#
|
|
1286
|
+
# Logical `NOT` operator. If this boolean is set to true, then the matching
|
|
1287
|
+
# dimension values will be excluded in the report. The default is false.
|
|
1288
|
+
# Corresponds to the JSON property `not`
|
|
1167
1289
|
# @return [Boolean]
|
|
1168
|
-
attr_accessor :
|
|
1169
|
-
alias_method :
|
|
1290
|
+
attr_accessor :not
|
|
1291
|
+
alias_method :not?, :not
|
|
1170
1292
|
|
|
1171
1293
|
def initialize(**args)
|
|
1172
1294
|
update!(**args)
|
|
@@ -1174,11 +1296,11 @@ module Google
|
|
|
1174
1296
|
|
|
1175
1297
|
# Update properties of this object
|
|
1176
1298
|
def update!(**args)
|
|
1177
|
-
@
|
|
1299
|
+
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
|
1178
1300
|
@operator = args[:operator] if args.key?(:operator)
|
|
1179
|
-
@
|
|
1301
|
+
@dimension_name = args[:dimension_name] if args.key?(:dimension_name)
|
|
1180
1302
|
@expressions = args[:expressions] if args.key?(:expressions)
|
|
1181
|
-
@
|
|
1303
|
+
@not = args[:not] if args.key?(:not)
|
|
1182
1304
|
end
|
|
1183
1305
|
end
|
|
1184
1306
|
|
|
@@ -1186,6 +1308,11 @@ module Google
|
|
|
1186
1308
|
class SegmentDimensionFilter
|
|
1187
1309
|
include Google::Apis::Core::Hashable
|
|
1188
1310
|
|
|
1311
|
+
# Maximum comparison values for `BETWEEN` match type.
|
|
1312
|
+
# Corresponds to the JSON property `maxComparisonValue`
|
|
1313
|
+
# @return [String]
|
|
1314
|
+
attr_accessor :max_comparison_value
|
|
1315
|
+
|
|
1189
1316
|
# Name of the dimension for which the filter is being applied.
|
|
1190
1317
|
# Corresponds to the JSON property `dimensionName`
|
|
1191
1318
|
# @return [String]
|
|
@@ -1212,23 +1339,18 @@ module Google
|
|
|
1212
1339
|
# @return [String]
|
|
1213
1340
|
attr_accessor :min_comparison_value
|
|
1214
1341
|
|
|
1215
|
-
# Maximum comparison values for `BETWEEN` match type.
|
|
1216
|
-
# Corresponds to the JSON property `maxComparisonValue`
|
|
1217
|
-
# @return [String]
|
|
1218
|
-
attr_accessor :max_comparison_value
|
|
1219
|
-
|
|
1220
1342
|
def initialize(**args)
|
|
1221
1343
|
update!(**args)
|
|
1222
1344
|
end
|
|
1223
1345
|
|
|
1224
1346
|
# Update properties of this object
|
|
1225
1347
|
def update!(**args)
|
|
1348
|
+
@max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value)
|
|
1226
1349
|
@dimension_name = args[:dimension_name] if args.key?(:dimension_name)
|
|
1227
1350
|
@operator = args[:operator] if args.key?(:operator)
|
|
1228
1351
|
@expressions = args[:expressions] if args.key?(:expressions)
|
|
1229
1352
|
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
|
1230
1353
|
@min_comparison_value = args[:min_comparison_value] if args.key?(:min_comparison_value)
|
|
1231
|
-
@max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value)
|
|
1232
1354
|
end
|
|
1233
1355
|
end
|
|
1234
1356
|
|
|
@@ -1236,10 +1358,10 @@ module Google
|
|
|
1236
1358
|
class OrderBy
|
|
1237
1359
|
include Google::Apis::Core::Hashable
|
|
1238
1360
|
|
|
1239
|
-
# The
|
|
1240
|
-
# Corresponds to the JSON property `
|
|
1361
|
+
# The order type. The default orderType is `VALUE`.
|
|
1362
|
+
# Corresponds to the JSON property `orderType`
|
|
1241
1363
|
# @return [String]
|
|
1242
|
-
attr_accessor :
|
|
1364
|
+
attr_accessor :order_type
|
|
1243
1365
|
|
|
1244
1366
|
# The field which to sort by. The default sort order is ascending. Example:
|
|
1245
1367
|
# `ga:browser`.
|
|
@@ -1249,10 +1371,10 @@ module Google
|
|
|
1249
1371
|
# @return [String]
|
|
1250
1372
|
attr_accessor :field_name
|
|
1251
1373
|
|
|
1252
|
-
# The order
|
|
1253
|
-
# Corresponds to the JSON property `
|
|
1374
|
+
# The sorting order for the field.
|
|
1375
|
+
# Corresponds to the JSON property `sortOrder`
|
|
1254
1376
|
# @return [String]
|
|
1255
|
-
attr_accessor :
|
|
1377
|
+
attr_accessor :sort_order
|
|
1256
1378
|
|
|
1257
1379
|
def initialize(**args)
|
|
1258
1380
|
update!(**args)
|
|
@@ -1260,9 +1382,9 @@ module Google
|
|
|
1260
1382
|
|
|
1261
1383
|
# Update properties of this object
|
|
1262
1384
|
def update!(**args)
|
|
1263
|
-
@sort_order = args[:sort_order] if args.key?(:sort_order)
|
|
1264
|
-
@field_name = args[:field_name] if args.key?(:field_name)
|
|
1265
1385
|
@order_type = args[:order_type] if args.key?(:order_type)
|
|
1386
|
+
@field_name = args[:field_name] if args.key?(:field_name)
|
|
1387
|
+
@sort_order = args[:sort_order] if args.key?(:sort_order)
|
|
1266
1388
|
end
|
|
1267
1389
|
end
|
|
1268
1390
|
|
|
@@ -1293,128 +1415,6 @@ module Google
|
|
|
1293
1415
|
@segment_id = args[:segment_id] if args.key?(:segment_id)
|
|
1294
1416
|
end
|
|
1295
1417
|
end
|
|
1296
|
-
|
|
1297
|
-
# A segment sequence definition.
|
|
1298
|
-
class SegmentSequenceStep
|
|
1299
|
-
include Google::Apis::Core::Hashable
|
|
1300
|
-
|
|
1301
|
-
# A sequence is specified with a list of Or grouped filters which are
|
|
1302
|
-
# combined with `AND` operator.
|
|
1303
|
-
# Corresponds to the JSON property `orFiltersForSegment`
|
|
1304
|
-
# @return [Array<Google::Apis::AnalyticsreportingV4::OrFiltersForSegment>]
|
|
1305
|
-
attr_accessor :or_filters_for_segment
|
|
1306
|
-
|
|
1307
|
-
# Specifies if the step immediately precedes or can be any time before the
|
|
1308
|
-
# next step.
|
|
1309
|
-
# Corresponds to the JSON property `matchType`
|
|
1310
|
-
# @return [String]
|
|
1311
|
-
attr_accessor :match_type
|
|
1312
|
-
|
|
1313
|
-
def initialize(**args)
|
|
1314
|
-
update!(**args)
|
|
1315
|
-
end
|
|
1316
|
-
|
|
1317
|
-
# Update properties of this object
|
|
1318
|
-
def update!(**args)
|
|
1319
|
-
@or_filters_for_segment = args[:or_filters_for_segment] if args.key?(:or_filters_for_segment)
|
|
1320
|
-
@match_type = args[:match_type] if args.key?(:match_type)
|
|
1321
|
-
end
|
|
1322
|
-
end
|
|
1323
|
-
|
|
1324
|
-
# [Metrics](https://support.google.com/analytics/answer/1033861)
|
|
1325
|
-
# are the quantitative measurements. For example, the metric `ga:users`
|
|
1326
|
-
# indicates the total number of users for the requested time period.
|
|
1327
|
-
class Metric
|
|
1328
|
-
include Google::Apis::Core::Hashable
|
|
1329
|
-
|
|
1330
|
-
# An alias for the metric expression is an alternate name for the
|
|
1331
|
-
# expression. The alias can be used for filtering and sorting. This field
|
|
1332
|
-
# is optional and is useful if the expression is not a single metric but
|
|
1333
|
-
# a complex expression which cannot be used in filtering and sorting.
|
|
1334
|
-
# The alias is also used in the response column header.
|
|
1335
|
-
# Corresponds to the JSON property `alias`
|
|
1336
|
-
# @return [String]
|
|
1337
|
-
attr_accessor :alias
|
|
1338
|
-
|
|
1339
|
-
# A metric expression in the request. An expression is constructed from one
|
|
1340
|
-
# or more metrics and numbers. Accepted operators include: Plus (+), Minus
|
|
1341
|
-
# (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
|
|
1342
|
-
# Positive cardinal numbers (0-9), can include decimals and is limited to
|
|
1343
|
-
# 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
|
|
1344
|
-
# metric expression is just a single metric name like `ga:users`.
|
|
1345
|
-
# Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
|
|
1346
|
-
# will result in unexpected results.
|
|
1347
|
-
# Corresponds to the JSON property `expression`
|
|
1348
|
-
# @return [String]
|
|
1349
|
-
attr_accessor :expression
|
|
1350
|
-
|
|
1351
|
-
# Specifies how the metric expression should be formatted, for example
|
|
1352
|
-
# `INTEGER`.
|
|
1353
|
-
# Corresponds to the JSON property `formattingType`
|
|
1354
|
-
# @return [String]
|
|
1355
|
-
attr_accessor :formatting_type
|
|
1356
|
-
|
|
1357
|
-
def initialize(**args)
|
|
1358
|
-
update!(**args)
|
|
1359
|
-
end
|
|
1360
|
-
|
|
1361
|
-
# Update properties of this object
|
|
1362
|
-
def update!(**args)
|
|
1363
|
-
@alias = args[:alias] if args.key?(:alias)
|
|
1364
|
-
@expression = args[:expression] if args.key?(:expression)
|
|
1365
|
-
@formatting_type = args[:formatting_type] if args.key?(:formatting_type)
|
|
1366
|
-
end
|
|
1367
|
-
end
|
|
1368
|
-
|
|
1369
|
-
# The metric values in the pivot region.
|
|
1370
|
-
class PivotValueRegion
|
|
1371
|
-
include Google::Apis::Core::Hashable
|
|
1372
|
-
|
|
1373
|
-
# The values of the metrics in each of the pivot regions.
|
|
1374
|
-
# Corresponds to the JSON property `values`
|
|
1375
|
-
# @return [Array<String>]
|
|
1376
|
-
attr_accessor :values
|
|
1377
|
-
|
|
1378
|
-
def initialize(**args)
|
|
1379
|
-
update!(**args)
|
|
1380
|
-
end
|
|
1381
|
-
|
|
1382
|
-
# Update properties of this object
|
|
1383
|
-
def update!(**args)
|
|
1384
|
-
@values = args[:values] if args.key?(:values)
|
|
1385
|
-
end
|
|
1386
|
-
end
|
|
1387
|
-
|
|
1388
|
-
# The data response corresponding to the request.
|
|
1389
|
-
class Report
|
|
1390
|
-
include Google::Apis::Core::Hashable
|
|
1391
|
-
|
|
1392
|
-
# Column headers.
|
|
1393
|
-
# Corresponds to the JSON property `columnHeader`
|
|
1394
|
-
# @return [Google::Apis::AnalyticsreportingV4::ColumnHeader]
|
|
1395
|
-
attr_accessor :column_header
|
|
1396
|
-
|
|
1397
|
-
# The data part of the report.
|
|
1398
|
-
# Corresponds to the JSON property `data`
|
|
1399
|
-
# @return [Google::Apis::AnalyticsreportingV4::ReportData]
|
|
1400
|
-
attr_accessor :data
|
|
1401
|
-
|
|
1402
|
-
# Page token to retrieve the next page of results in the list.
|
|
1403
|
-
# Corresponds to the JSON property `nextPageToken`
|
|
1404
|
-
# @return [String]
|
|
1405
|
-
attr_accessor :next_page_token
|
|
1406
|
-
|
|
1407
|
-
def initialize(**args)
|
|
1408
|
-
update!(**args)
|
|
1409
|
-
end
|
|
1410
|
-
|
|
1411
|
-
# Update properties of this object
|
|
1412
|
-
def update!(**args)
|
|
1413
|
-
@column_header = args[:column_header] if args.key?(:column_header)
|
|
1414
|
-
@data = args[:data] if args.key?(:data)
|
|
1415
|
-
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
1416
|
-
end
|
|
1417
|
-
end
|
|
1418
1418
|
end
|
|
1419
1419
|
end
|
|
1420
1420
|
end
|