google-api-client 0.42.2 → 0.43.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +129 -0
- data/generated/google/apis/abusiveexperiencereport_v1.rb +1 -1
- data/generated/google/apis/abusiveexperiencereport_v1/classes.rb +8 -13
- data/generated/google/apis/abusiveexperiencereport_v1/service.rb +2 -3
- data/generated/google/apis/accessapproval_v1.rb +1 -1
- data/generated/google/apis/accessapproval_v1/classes.rb +9 -0
- data/generated/google/apis/accessapproval_v1/representations.rb +1 -0
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +523 -653
- data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +467 -631
- data/generated/google/apis/adexperiencereport_v1.rb +1 -1
- data/generated/google/apis/adexperiencereport_v1/classes.rb +11 -18
- data/generated/google/apis/adexperiencereport_v1/service.rb +2 -3
- data/generated/google/apis/admob_v1.rb +1 -1
- data/generated/google/apis/admob_v1/classes.rb +139 -270
- data/generated/google/apis/admob_v1/service.rb +11 -13
- data/generated/google/apis/alertcenter_v1beta1.rb +1 -1
- data/generated/google/apis/alertcenter_v1beta1/classes.rb +107 -138
- data/generated/google/apis/alertcenter_v1beta1/service.rb +50 -55
- data/generated/google/apis/analyticsreporting_v4.rb +1 -1
- data/generated/google/apis/analyticsreporting_v4/classes.rb +315 -399
- data/generated/google/apis/androiddeviceprovisioning_v1.rb +1 -1
- data/generated/google/apis/androiddeviceprovisioning_v1/classes.rb +193 -220
- data/generated/google/apis/androiddeviceprovisioning_v1/service.rb +55 -61
- data/generated/google/apis/androidenterprise_v1.rb +1 -1
- data/generated/google/apis/androidenterprise_v1/classes.rb +452 -557
- data/generated/google/apis/androidenterprise_v1/service.rb +181 -240
- data/generated/google/apis/androidmanagement_v1.rb +1 -1
- data/generated/google/apis/androidpublisher_v3.rb +1 -1
- data/generated/google/apis/androidpublisher_v3/classes.rb +281 -342
- data/generated/google/apis/androidpublisher_v3/service.rb +125 -153
- data/generated/google/apis/apigee_v1.rb +6 -7
- data/generated/google/apis/apigee_v1/classes.rb +733 -1180
- data/generated/google/apis/apigee_v1/service.rb +879 -1133
- data/generated/google/apis/appsmarket_v2.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2/service.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1/classes.rb +97 -118
- data/generated/google/apis/billingbudgets_v1beta1/service.rb +30 -33
- data/generated/google/apis/blogger_v2.rb +2 -3
- data/generated/google/apis/blogger_v2/classes.rb +1 -2
- data/generated/google/apis/blogger_v2/service.rb +1 -2
- data/generated/google/apis/blogger_v3.rb +2 -3
- data/generated/google/apis/blogger_v3/classes.rb +1 -2
- data/generated/google/apis/blogger_v3/service.rb +1 -2
- data/generated/google/apis/chromeuxreport_v1.rb +1 -1
- data/generated/google/apis/chromeuxreport_v1/classes.rb +55 -66
- data/generated/google/apis/classroom_v1.rb +1 -1
- data/generated/google/apis/classroom_v1/classes.rb +250 -365
- data/generated/google/apis/classroom_v1/service.rb +643 -902
- data/generated/google/apis/cloudasset_v1.rb +1 -1
- data/generated/google/apis/cloudasset_v1/classes.rb +15 -11
- data/generated/google/apis/cloudasset_v1/service.rb +62 -45
- data/generated/google/apis/cloudasset_v1beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1beta1/classes.rb +3 -1
- data/generated/google/apis/cloudasset_v1p4beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p5beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p5beta1/classes.rb +3 -1
- data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +7 -0
- data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +1 -0
- data/generated/google/apis/cloudsearch_v1.rb +1 -1
- data/generated/google/apis/cloudsearch_v1/classes.rb +1 -2
- data/generated/google/apis/compute_alpha.rb +1 -1
- data/generated/google/apis/compute_alpha/classes.rb +350 -20
- data/generated/google/apis/compute_alpha/representations.rb +100 -0
- data/generated/google/apis/compute_alpha/service.rb +15 -7
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +39 -14
- data/generated/google/apis/compute_beta/representations.rb +2 -0
- data/generated/google/apis/compute_beta/service.rb +15 -7
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +65 -42
- data/generated/google/apis/compute_v1/representations.rb +18 -15
- data/generated/google/apis/compute_v1/service.rb +63 -19
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +26 -0
- data/generated/google/apis/container_v1/representations.rb +15 -0
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +9 -0
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +9 -0
- data/generated/google/apis/customsearch_v1.rb +1 -1
- data/generated/google/apis/customsearch_v1/classes.rb +303 -492
- data/generated/google/apis/customsearch_v1/service.rb +184 -341
- data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
- data/generated/google/apis/datacatalog_v1beta1/classes.rb +572 -380
- data/generated/google/apis/datacatalog_v1beta1/service.rb +440 -319
- data/generated/google/apis/datafusion_v1.rb +43 -0
- data/generated/google/apis/datafusion_v1/classes.rb +1154 -0
- data/generated/google/apis/datafusion_v1/representations.rb +390 -0
- data/generated/google/apis/datafusion_v1/service.rb +680 -0
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +192 -316
- data/generated/google/apis/dataproc_v1/service.rb +134 -168
- data/generated/google/apis/dataproc_v1beta2.rb +1 -1
- data/generated/google/apis/dataproc_v1beta2/classes.rb +198 -317
- data/generated/google/apis/dataproc_v1beta2/service.rb +137 -192
- data/generated/google/apis/deploymentmanager_alpha.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2beta.rb +1 -1
- data/generated/google/apis/dialogflow_v2.rb +1 -1
- data/generated/google/apis/dialogflow_v2/classes.rb +1238 -1589
- data/generated/google/apis/dialogflow_v2/service.rb +324 -448
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/classes.rb +1313 -1681
- data/generated/google/apis/dialogflow_v2beta1/service.rb +742 -998
- data/generated/google/apis/displayvideo_v1.rb +1 -1
- data/generated/google/apis/displayvideo_v1/classes.rb +104 -0
- data/generated/google/apis/displayvideo_v1/representations.rb +36 -0
- data/generated/google/apis/displayvideo_v1/service.rb +104 -0
- data/generated/google/apis/dlp_v2.rb +1 -1
- data/generated/google/apis/dlp_v2/classes.rb +5 -4
- data/generated/google/apis/dns_v1.rb +1 -1
- data/generated/google/apis/dns_v1/classes.rb +7 -7
- data/generated/google/apis/dns_v1beta2.rb +1 -1
- data/generated/google/apis/dns_v1beta2/classes.rb +7 -7
- data/generated/google/apis/dns_v2beta1.rb +1 -1
- data/generated/google/apis/dns_v2beta1/classes.rb +7 -7
- data/generated/google/apis/domainsrdap_v1.rb +1 -1
- data/generated/google/apis/domainsrdap_v1/classes.rb +42 -69
- data/generated/google/apis/domainsrdap_v1/service.rb +16 -16
- data/generated/google/apis/doubleclickbidmanager_v1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1/service.rb +4 -2
- data/generated/google/apis/doubleclickbidmanager_v1_1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb +196 -1
- data/generated/google/apis/doubleclickbidmanager_v1_1/representations.rb +107 -0
- data/generated/google/apis/doubleclickbidmanager_v1_1/service.rb +4 -2
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v2/classes.rb +3 -1
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/classes.rb +9 -1
- data/generated/google/apis/drive_v3/representations.rb +1 -0
- data/generated/google/apis/driveactivity_v2.rb +1 -1
- data/generated/google/apis/driveactivity_v2/classes.rb +55 -68
- data/generated/google/apis/factchecktools_v1alpha1.rb +1 -1
- data/generated/google/apis/factchecktools_v1alpha1/classes.rb +46 -56
- data/generated/google/apis/factchecktools_v1alpha1/service.rb +30 -33
- data/generated/google/apis/firebase_v1beta1.rb +1 -1
- data/generated/google/apis/firebase_v1beta1/classes.rb +313 -345
- data/generated/google/apis/firebase_v1beta1/representations.rb +1 -0
- data/generated/google/apis/firebase_v1beta1/service.rb +356 -420
- data/generated/google/apis/firebasedynamiclinks_v1.rb +1 -1
- data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +89 -112
- data/generated/google/apis/firebasedynamiclinks_v1/service.rb +18 -21
- data/generated/google/apis/firebasehosting_v1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1/classes.rb +36 -40
- data/generated/google/apis/firebasehosting_v1/service.rb +19 -22
- data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1beta1/classes.rb +148 -177
- data/generated/google/apis/firebasehosting_v1beta1/service.rb +112 -145
- data/generated/google/apis/firebaseml_v1.rb +1 -1
- data/generated/google/apis/firebaseml_v1/classes.rb +39 -44
- data/generated/google/apis/firebaseml_v1/service.rb +19 -22
- data/generated/google/apis/firebaseml_v1beta2.rb +1 -1
- data/generated/google/apis/firebaseml_v1beta2/classes.rb +60 -70
- data/generated/google/apis/firebaseml_v1beta2/service.rb +16 -18
- data/generated/google/apis/gameservices_v1.rb +1 -1
- data/generated/google/apis/gameservices_v1/classes.rb +344 -523
- data/generated/google/apis/gameservices_v1/service.rb +167 -207
- data/generated/google/apis/gameservices_v1beta.rb +1 -1
- data/generated/google/apis/gameservices_v1beta/classes.rb +344 -523
- data/generated/google/apis/gameservices_v1beta/service.rb +167 -207
- data/generated/google/apis/genomics_v1.rb +1 -1
- data/generated/google/apis/genomics_v1alpha2.rb +1 -1
- data/generated/google/apis/genomics_v2alpha1.rb +1 -1
- data/generated/google/apis/genomics_v2alpha1/classes.rb +3 -75
- data/generated/google/apis/genomics_v2alpha1/representations.rb +0 -27
- data/generated/google/apis/genomics_v2alpha1/service.rb +0 -34
- data/generated/google/apis/gmail_v1.rb +3 -3
- data/generated/google/apis/gmail_v1/classes.rb +216 -269
- data/generated/google/apis/gmail_v1/service.rb +257 -286
- data/generated/google/apis/gmailpostmastertools_v1beta1.rb +1 -1
- data/generated/google/apis/gmailpostmastertools_v1beta1/classes.rb +37 -42
- data/generated/google/apis/gmailpostmastertools_v1beta1/service.rb +34 -40
- data/generated/google/apis/healthcare_v1.rb +1 -1
- data/generated/google/apis/healthcare_v1/service.rb +26 -14
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/healthcare_v1beta1/classes.rb +85 -17
- data/generated/google/apis/healthcare_v1beta1/representations.rb +39 -0
- data/generated/google/apis/healthcare_v1beta1/service.rb +87 -16
- data/generated/google/apis/language_v1.rb +1 -1
- data/generated/google/apis/language_v1/classes.rb +93 -111
- data/generated/google/apis/language_v1/service.rb +4 -4
- data/generated/google/apis/language_v1beta1.rb +1 -1
- data/generated/google/apis/language_v1beta1/classes.rb +78 -90
- data/generated/google/apis/language_v1beta1/service.rb +2 -2
- data/generated/google/apis/language_v1beta2.rb +1 -1
- data/generated/google/apis/language_v1beta2/classes.rb +95 -112
- data/generated/google/apis/language_v1beta2/service.rb +4 -4
- data/generated/google/apis/libraryagent_v1.rb +1 -1
- data/generated/google/apis/libraryagent_v1/classes.rb +10 -16
- data/generated/google/apis/libraryagent_v1/service.rb +13 -16
- data/generated/google/apis/logging_v2.rb +1 -1
- data/generated/google/apis/logging_v2/classes.rb +6 -6
- data/generated/google/apis/managedidentities_v1.rb +1 -1
- data/generated/google/apis/managedidentities_v1/classes.rb +326 -452
- data/generated/google/apis/managedidentities_v1/service.rb +78 -99
- data/generated/google/apis/managedidentities_v1alpha1.rb +1 -1
- data/generated/google/apis/managedidentities_v1alpha1/classes.rb +336 -457
- data/generated/google/apis/managedidentities_v1alpha1/service.rb +88 -112
- data/generated/google/apis/managedidentities_v1beta1.rb +1 -1
- data/generated/google/apis/managedidentities_v1beta1/classes.rb +332 -456
- data/generated/google/apis/managedidentities_v1beta1/service.rb +76 -96
- data/generated/google/apis/memcache_v1.rb +35 -0
- data/generated/google/apis/memcache_v1/classes.rb +1157 -0
- data/generated/google/apis/memcache_v1/representations.rb +471 -0
- data/generated/google/apis/memcache_v1/service.rb +558 -0
- data/generated/google/apis/memcache_v1beta2.rb +1 -1
- data/generated/google/apis/memcache_v1beta2/classes.rb +41 -502
- data/generated/google/apis/memcache_v1beta2/representations.rb +9 -110
- data/generated/google/apis/memcache_v1beta2/service.rb +0 -119
- data/generated/google/apis/monitoring_v1.rb +1 -1
- data/generated/google/apis/monitoring_v1/classes.rb +12 -11
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +31 -14
- data/generated/google/apis/monitoring_v3/representations.rb +2 -0
- data/generated/google/apis/osconfig_v1.rb +1 -1
- data/generated/google/apis/osconfig_v1/classes.rb +721 -0
- data/generated/google/apis/osconfig_v1/representations.rb +337 -0
- data/generated/google/apis/people_v1.rb +1 -1
- data/generated/google/apis/people_v1/classes.rb +148 -13
- data/generated/google/apis/people_v1/representations.rb +57 -0
- data/generated/google/apis/people_v1/service.rb +60 -48
- data/generated/google/apis/playcustomapp_v1.rb +1 -1
- data/generated/google/apis/playcustomapp_v1/classes.rb +2 -2
- data/generated/google/apis/policytroubleshooter_v1.rb +1 -1
- data/generated/google/apis/policytroubleshooter_v1/classes.rb +232 -394
- data/generated/google/apis/policytroubleshooter_v1/service.rb +2 -2
- data/generated/google/apis/policytroubleshooter_v1beta.rb +1 -1
- data/generated/google/apis/policytroubleshooter_v1beta/classes.rb +232 -393
- data/generated/google/apis/policytroubleshooter_v1beta/service.rb +2 -2
- data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +122 -146
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +38 -49
- data/generated/google/apis/realtimebidding_v1.rb +1 -4
- data/generated/google/apis/realtimebidding_v1/classes.rb +198 -291
- data/generated/google/apis/realtimebidding_v1/service.rb +98 -135
- data/generated/google/apis/recommendationengine_v1beta1.rb +2 -2
- data/generated/google/apis/recommendationengine_v1beta1/classes.rb +10 -8
- data/generated/google/apis/recommendationengine_v1beta1/service.rb +1 -1
- data/generated/google/apis/recommender_v1.rb +1 -1
- data/generated/google/apis/recommender_v1/classes.rb +76 -100
- data/generated/google/apis/recommender_v1/service.rb +43 -58
- data/generated/google/apis/recommender_v1beta1.rb +1 -1
- data/generated/google/apis/recommender_v1beta1/classes.rb +75 -99
- data/generated/google/apis/recommender_v1beta1/service.rb +43 -58
- data/generated/google/apis/run_v1.rb +1 -1
- data/generated/google/apis/run_v1/classes.rb +2 -2
- data/generated/google/apis/run_v1/service.rb +38 -2
- data/generated/google/apis/runtimeconfig_v1.rb +1 -1
- data/generated/google/apis/runtimeconfig_v1/classes.rb +36 -40
- data/generated/google/apis/runtimeconfig_v1/service.rb +19 -22
- data/generated/google/apis/sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/sasportal_v1alpha1/classes.rb +122 -146
- data/generated/google/apis/sasportal_v1alpha1/service.rb +38 -49
- data/generated/google/apis/searchconsole_v1.rb +1 -1
- data/generated/google/apis/searchconsole_v1/classes.rb +2 -2
- data/generated/google/apis/securitycenter_v1.rb +1 -1
- data/generated/google/apis/securitycenter_v1/classes.rb +574 -826
- data/generated/google/apis/securitycenter_v1/service.rb +250 -332
- data/generated/google/apis/securitycenter_v1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1beta1/classes.rb +521 -746
- data/generated/google/apis/securitycenter_v1beta1/service.rb +160 -202
- data/generated/google/apis/securitycenter_v1p1alpha1.rb +1 -1
- data/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +176 -208
- data/generated/google/apis/securitycenter_v1p1alpha1/service.rb +21 -25
- data/generated/google/apis/securitycenter_v1p1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1p1beta1/classes.rb +545 -791
- data/generated/google/apis/securitycenter_v1p1beta1/service.rb +247 -330
- data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +1149 -1783
- data/generated/google/apis/serviceconsumermanagement_v1/service.rb +111 -138
- data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +1137 -1774
- data/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb +52 -66
- data/generated/google/apis/servicecontrol_v2.rb +38 -0
- data/generated/google/apis/servicecontrol_v2/classes.rb +1121 -0
- data/generated/google/apis/servicecontrol_v2/representations.rb +405 -0
- data/generated/google/apis/servicecontrol_v2/service.rb +165 -0
- data/generated/google/apis/servicemanagement_v1.rb +1 -1
- data/generated/google/apis/servicemanagement_v1/classes.rb +49 -1
- data/generated/google/apis/servicemanagement_v1/representations.rb +14 -0
- data/generated/google/apis/servicenetworking_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1/classes.rb +1119 -1758
- data/generated/google/apis/servicenetworking_v1/service.rb +94 -114
- data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta/classes.rb +1065 -1684
- data/generated/google/apis/servicenetworking_v1beta/service.rb +52 -63
- data/generated/google/apis/serviceusage_v1.rb +1 -1
- data/generated/google/apis/serviceusage_v1/classes.rb +1140 -1823
- data/generated/google/apis/serviceusage_v1/service.rb +63 -80
- data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1/classes.rb +1235 -1986
- data/generated/google/apis/serviceusage_v1beta1/service.rb +130 -162
- data/generated/google/apis/spanner_v1.rb +1 -1
- data/generated/google/apis/spanner_v1/classes.rb +3 -2
- data/generated/google/apis/storagetransfer_v1.rb +1 -1
- data/generated/google/apis/storagetransfer_v1/classes.rb +8 -10
- data/generated/google/apis/storagetransfer_v1/service.rb +26 -2
- data/generated/google/apis/tagmanager_v1.rb +2 -3
- data/generated/google/apis/tagmanager_v1/classes.rb +225 -288
- data/generated/google/apis/tagmanager_v1/service.rb +20 -21
- data/generated/google/apis/tagmanager_v2.rb +2 -3
- data/generated/google/apis/tagmanager_v2/classes.rb +240 -280
- data/generated/google/apis/tagmanager_v2/representations.rb +1 -0
- data/generated/google/apis/tagmanager_v2/service.rb +187 -283
- data/generated/google/apis/toolresults_v1beta3.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +665 -931
- data/generated/google/apis/toolresults_v1beta3/service.rb +231 -349
- data/generated/google/apis/tpu_v1.rb +1 -1
- data/generated/google/apis/tpu_v1/classes.rb +68 -78
- data/generated/google/apis/tpu_v1/service.rb +21 -25
- data/generated/google/apis/tpu_v1alpha1.rb +1 -1
- data/generated/google/apis/tpu_v1alpha1/classes.rb +68 -78
- data/generated/google/apis/tpu_v1alpha1/service.rb +21 -25
- data/generated/google/apis/translate_v3.rb +1 -1
- data/generated/google/apis/translate_v3/service.rb +14 -1
- data/generated/google/apis/translate_v3beta1.rb +1 -1
- data/generated/google/apis/translate_v3beta1/service.rb +14 -1
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +1304 -1870
- data/generated/google/apis/vision_v1/service.rb +254 -340
- data/generated/google/apis/vision_v1p1beta1.rb +1 -1
- data/generated/google/apis/vision_v1p1beta1/classes.rb +1246 -1790
- data/generated/google/apis/vision_v1p1beta1/service.rb +91 -121
- data/generated/google/apis/vision_v1p2beta1.rb +1 -1
- data/generated/google/apis/vision_v1p2beta1/classes.rb +1246 -1790
- data/generated/google/apis/vision_v1p2beta1/service.rb +91 -121
- data/generated/google/apis/websecurityscanner_v1.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1/classes.rb +71 -95
- data/generated/google/apis/websecurityscanner_v1/service.rb +46 -65
- data/generated/google/apis/websecurityscanner_v1alpha.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1alpha/classes.rb +55 -63
- data/generated/google/apis/websecurityscanner_v1alpha/service.rb +46 -65
- data/generated/google/apis/websecurityscanner_v1beta.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1beta/classes.rb +77 -92
- data/generated/google/apis/websecurityscanner_v1beta/service.rb +46 -65
- data/generated/google/apis/youtube_analytics_v2.rb +1 -1
- data/generated/google/apis/youtube_analytics_v2/classes.rb +77 -104
- data/generated/google/apis/youtube_analytics_v2/service.rb +106 -126
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtube_partner_v1/service.rb +19 -19
- data/generated/google/apis/youtube_v3.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +937 -1175
- data/generated/google/apis/youtube_v3/service.rb +975 -1284
- data/generated/google/apis/youtubereporting_v1.rb +1 -1
- data/generated/google/apis/youtubereporting_v1/classes.rb +20 -29
- data/generated/google/apis/youtubereporting_v1/service.rb +40 -43
- data/lib/google/apis/core/base_service.rb +7 -1
- data/lib/google/apis/version.rb +1 -1
- metadata +15 -7
- data/generated/google/apis/fitness_v1.rb +0 -85
- data/generated/google/apis/fitness_v1/classes.rb +0 -1020
- data/generated/google/apis/fitness_v1/representations.rb +0 -398
- data/generated/google/apis/fitness_v1/service.rb +0 -647
@@ -108,16 +108,16 @@ module Google
|
|
108
108
|
end
|
109
109
|
|
110
110
|
# Marks the specified alert for deletion. An alert that has been marked for
|
111
|
-
# deletion is removed from Alert Center after 30 days.
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
111
|
+
# deletion is removed from Alert Center after 30 days. Marking an alert for
|
112
|
+
# deletion has no effect on an alert which has already been marked for deletion.
|
113
|
+
# Attempting to mark a nonexistent alert for deletion results in a `NOT_FOUND`
|
114
|
+
# error.
|
115
115
|
# @param [String] alert_id
|
116
116
|
# Required. The identifier of the alert to delete.
|
117
117
|
# @param [String] customer_id
|
118
118
|
# Optional. The unique identifier of the G Suite organization account of the
|
119
|
-
# customer the alert is associated with.
|
120
|
-
#
|
119
|
+
# customer the alert is associated with. Inferred from the caller identity if
|
120
|
+
# not provided.
|
121
121
|
# @param [String] fields
|
122
122
|
# Selector specifying which fields to include in a partial response.
|
123
123
|
# @param [String] quota_user
|
@@ -146,14 +146,14 @@ module Google
|
|
146
146
|
execute_or_queue_command(command, &block)
|
147
147
|
end
|
148
148
|
|
149
|
-
# Gets the specified alert. Attempting to get a nonexistent alert returns
|
150
|
-
#
|
149
|
+
# Gets the specified alert. Attempting to get a nonexistent alert returns `
|
150
|
+
# NOT_FOUND` error.
|
151
151
|
# @param [String] alert_id
|
152
152
|
# Required. The identifier of the alert to retrieve.
|
153
153
|
# @param [String] customer_id
|
154
154
|
# Optional. The unique identifier of the G Suite organization account of the
|
155
|
-
# customer the alert is associated with.
|
156
|
-
#
|
155
|
+
# customer the alert is associated with. Inferred from the caller identity if
|
156
|
+
# not provided.
|
157
157
|
# @param [String] fields
|
158
158
|
# Selector specifying which fields to include in a partial response.
|
159
159
|
# @param [String] quota_user
|
@@ -182,14 +182,14 @@ module Google
|
|
182
182
|
execute_or_queue_command(command, &block)
|
183
183
|
end
|
184
184
|
|
185
|
-
# Returns the metadata of an alert. Attempting to get metadata for
|
186
|
-
#
|
185
|
+
# Returns the metadata of an alert. Attempting to get metadata for a non-
|
186
|
+
# existent alert returns `NOT_FOUND` error.
|
187
187
|
# @param [String] alert_id
|
188
188
|
# Required. The identifier of the alert this metadata belongs to.
|
189
189
|
# @param [String] customer_id
|
190
190
|
# Optional. The unique identifier of the G Suite organization account of the
|
191
|
-
# customer the alert metadata is associated with.
|
192
|
-
#
|
191
|
+
# customer the alert metadata is associated with. Inferred from the caller
|
192
|
+
# identity if not provided.
|
193
193
|
# @param [String] fields
|
194
194
|
# Selector specifying which fields to include in a partial response.
|
195
195
|
# @param [String] quota_user
|
@@ -221,29 +221,26 @@ module Google
|
|
221
221
|
# Lists the alerts.
|
222
222
|
# @param [String] customer_id
|
223
223
|
# Optional. The unique identifier of the G Suite organization account of the
|
224
|
-
# customer the alerts are associated with.
|
225
|
-
#
|
224
|
+
# customer the alerts are associated with. Inferred from the caller identity if
|
225
|
+
# not provided.
|
226
226
|
# @param [String] filter
|
227
|
-
# Optional. A query string for filtering alert results.
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
# fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).
|
227
|
+
# Optional. A query string for filtering alert results. For more details, see [
|
228
|
+
# Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported
|
229
|
+
# query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.
|
230
|
+
# list).
|
232
231
|
# @param [String] order_by
|
233
|
-
# Optional. The sort order of the list results.
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
# `update_time desc`
|
232
|
+
# Optional. The sort order of the list results. If not specified results may be
|
233
|
+
# returned in arbitrary order. You can sort the results in descending order
|
234
|
+
# based on the creation timestamp using `order_by="create_time desc"`. Currently,
|
235
|
+
# supported sorting are `create_time asc`, `create_time desc`, `update_time
|
236
|
+
# desc`
|
239
237
|
# @param [Fixnum] page_size
|
240
238
|
# Optional. The requested page size. Server may return fewer items than
|
241
239
|
# requested. If unspecified, server picks an appropriate default.
|
242
240
|
# @param [String] page_token
|
243
|
-
# Optional. A token identifying a page of results the server should return.
|
244
|
-
#
|
245
|
-
#
|
246
|
-
# next_page_token field.
|
241
|
+
# Optional. A token identifying a page of results the server should return. If
|
242
|
+
# empty, a new iteration is started. To continue an iteration, pass in the value
|
243
|
+
# from the previous ListAlertsResponse's next_page_token field.
|
247
244
|
# @param [String] fields
|
248
245
|
# Selector specifying which fields to include in a partial response.
|
249
246
|
# @param [String] quota_user
|
@@ -277,9 +274,9 @@ module Google
|
|
277
274
|
|
278
275
|
# Restores, or "undeletes", an alert that was marked for deletion within the
|
279
276
|
# past 30 days. Attempting to undelete an alert which was marked for deletion
|
280
|
-
# over 30 days ago (which has been removed from the Alert Center database) or
|
281
|
-
#
|
282
|
-
#
|
277
|
+
# over 30 days ago (which has been removed from the Alert Center database) or a
|
278
|
+
# nonexistent alert returns a `NOT_FOUND` error. Attempting to undelete an alert
|
279
|
+
# which has not been marked for deletion has no effect.
|
283
280
|
# @param [String] alert_id
|
284
281
|
# Required. The identifier of the alert to undelete.
|
285
282
|
# @param [Google::Apis::AlertcenterV1beta1::UndeleteAlertRequest] undelete_alert_request_object
|
@@ -312,17 +309,16 @@ module Google
|
|
312
309
|
execute_or_queue_command(command, &block)
|
313
310
|
end
|
314
311
|
|
315
|
-
# Creates new feedback for an alert. Attempting to create a feedback for
|
316
|
-
#
|
317
|
-
#
|
318
|
-
# `FAILED_PRECONDITION' error.
|
312
|
+
# Creates new feedback for an alert. Attempting to create a feedback for a non-
|
313
|
+
# existent alert returns `NOT_FOUND` error. Attempting to create a feedback for
|
314
|
+
# an alert that is marked for deletion returns `FAILED_PRECONDITION' error.
|
319
315
|
# @param [String] alert_id
|
320
316
|
# Required. The identifier of the alert this feedback belongs to.
|
321
317
|
# @param [Google::Apis::AlertcenterV1beta1::AlertFeedback] alert_feedback_object
|
322
318
|
# @param [String] customer_id
|
323
319
|
# Optional. The unique identifier of the G Suite organization account of the
|
324
|
-
# customer the alert is associated with.
|
325
|
-
#
|
320
|
+
# customer the alert is associated with. Inferred from the caller identity if
|
321
|
+
# not provided.
|
326
322
|
# @param [String] fields
|
327
323
|
# Selector specifying which fields to include in a partial response.
|
328
324
|
# @param [String] quota_user
|
@@ -353,21 +349,20 @@ module Google
|
|
353
349
|
execute_or_queue_command(command, &block)
|
354
350
|
end
|
355
351
|
|
356
|
-
# Lists all the feedback for an alert. Attempting to list feedbacks for
|
357
|
-
#
|
352
|
+
# Lists all the feedback for an alert. Attempting to list feedbacks for a non-
|
353
|
+
# existent alert returns `NOT_FOUND` error.
|
358
354
|
# @param [String] alert_id
|
359
|
-
# Required. The alert identifier.
|
360
|
-
#
|
355
|
+
# Required. The alert identifier. The "-" wildcard could be used to represent
|
356
|
+
# all alerts.
|
361
357
|
# @param [String] customer_id
|
362
358
|
# Optional. The unique identifier of the G Suite organization account of the
|
363
|
-
# customer the alert feedback are associated with.
|
364
|
-
#
|
359
|
+
# customer the alert feedback are associated with. Inferred from the caller
|
360
|
+
# identity if not provided.
|
365
361
|
# @param [String] filter
|
366
|
-
# Optional. A query string for filtering alert feedback results.
|
367
|
-
#
|
368
|
-
#
|
369
|
-
#
|
370
|
-
# fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).
|
362
|
+
# Optional. A query string for filtering alert feedback results. For more
|
363
|
+
# details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [
|
364
|
+
# Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#
|
365
|
+
# alerts.feedback.list).
|
371
366
|
# @param [String] fields
|
372
367
|
# Selector specifying which fields to include in a partial response.
|
373
368
|
# @param [String] quota_user
|
@@ -400,8 +395,8 @@ module Google
|
|
400
395
|
# Returns customer-level settings.
|
401
396
|
# @param [String] customer_id
|
402
397
|
# Optional. The unique identifier of the G Suite organization account of the
|
403
|
-
# customer the alert settings are associated with.
|
404
|
-
#
|
398
|
+
# customer the alert settings are associated with. Inferred from the caller
|
399
|
+
# identity if not provided.
|
405
400
|
# @param [String] fields
|
406
401
|
# Selector specifying which fields to include in a partial response.
|
407
402
|
# @param [String] quota_user
|
@@ -433,8 +428,8 @@ module Google
|
|
433
428
|
# @param [Google::Apis::AlertcenterV1beta1::Settings] settings_object
|
434
429
|
# @param [String] customer_id
|
435
430
|
# Optional. The unique identifier of the G Suite organization account of the
|
436
|
-
# customer the alert settings are associated with.
|
437
|
-
#
|
431
|
+
# customer the alert settings are associated with. Inferred from the caller
|
432
|
+
# identity if not provided.
|
438
433
|
# @param [String] fields
|
439
434
|
# Selector specifying which fields to include in a partial response.
|
440
435
|
# @param [String] quota_user
|
@@ -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 = '20200803'
|
29
29
|
|
30
30
|
# View and manage your Google Analytics data
|
31
31
|
AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics'
|
@@ -22,23 +22,21 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module AnalyticsreportingV4
|
24
24
|
|
25
|
-
# An Activity represents data for an activity of a user. Note that an
|
26
|
-
#
|
27
|
-
#
|
28
|
-
#
|
29
|
-
#
|
30
|
-
#
|
31
|
-
#
|
32
|
-
# These hits will be merged into one ECOMMERCE Activity.
|
25
|
+
# An Activity represents data for an activity of a user. Note that an Activity
|
26
|
+
# is different from a hit. A hit might result in multiple Activity's. For
|
27
|
+
# example, if a hit includes a transaction and a goal completion, there will be
|
28
|
+
# two Activity protos for this hit, one for ECOMMERCE and one for GOAL.
|
29
|
+
# Conversely, multiple hits can also construct one Activity. In classic e-
|
30
|
+
# commerce, data for one transaction might be sent through multiple hits. These
|
31
|
+
# hits will be merged into one ECOMMERCE Activity.
|
33
32
|
class Activity
|
34
33
|
include Google::Apis::Core::Hashable
|
35
34
|
|
36
|
-
# Timestamp of the activity. If activities for a visit cross midnight and
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
# 113472 is one session, and session ID 243742 is two sessions.
|
35
|
+
# Timestamp of the activity. If activities for a visit cross midnight and occur
|
36
|
+
# in two separate dates, then two sessions (one per date) share the session
|
37
|
+
# identifier. For example, say session ID 113472 has activity within 2019-08-20,
|
38
|
+
# and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session
|
39
|
+
# ID 113472 is one session, and session ID 243742 is two sessions.
|
42
40
|
# Corresponds to the JSON property `activityTime`
|
43
41
|
# @return [String]
|
44
42
|
attr_accessor :activity_time
|
@@ -54,15 +52,15 @@ module Google
|
|
54
52
|
attr_accessor :appview
|
55
53
|
|
56
54
|
# For manual campaign tracking, it is the value of the utm_campaign campaign
|
57
|
-
# tracking parameter. For AdWords autotagging, it is the name(s) of the
|
58
|
-
#
|
59
|
-
#
|
55
|
+
# tracking parameter. For AdWords autotagging, it is the name(s) of the online
|
56
|
+
# ad campaign(s) you use for the property. If you use neither, its value is (not
|
57
|
+
# set).
|
60
58
|
# Corresponds to the JSON property `campaign`
|
61
59
|
# @return [String]
|
62
60
|
attr_accessor :campaign
|
63
61
|
|
64
|
-
# The Channel Group associated with an end user's session for this View
|
65
|
-
#
|
62
|
+
# The Channel Group associated with an end user's session for this View (defined
|
63
|
+
# by the View's Channel Groupings).
|
66
64
|
# Corresponds to the JSON property `channelGrouping`
|
67
65
|
# @return [String]
|
68
66
|
attr_accessor :channel_grouping
|
@@ -94,11 +92,10 @@ module Google
|
|
94
92
|
|
95
93
|
# For manual campaign tracking, it is the value of the utm_term campaign
|
96
94
|
# tracking parameter. For AdWords traffic, it contains the best matching
|
97
|
-
# targeting criteria. For the display network, where multiple targeting
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
# is (not set).
|
95
|
+
# targeting criteria. For the display network, where multiple targeting criteria
|
96
|
+
# could have caused the ad to show up, it returns the best matching targeting
|
97
|
+
# criteria as selected by Ads. This could be display_keyword, site placement,
|
98
|
+
# boomuserlist, user_interest, age, or gender. Otherwise its value is (not set).
|
102
99
|
# Corresponds to the JSON property `keyword`
|
103
100
|
# @return [String]
|
104
101
|
attr_accessor :keyword
|
@@ -109,11 +106,10 @@ module Google
|
|
109
106
|
attr_accessor :landing_page_path
|
110
107
|
|
111
108
|
# The type of referrals. For manual campaign tracking, it is the value of the
|
112
|
-
# utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc.
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
# (none).
|
109
|
+
# utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If
|
110
|
+
# users came from a search engine detected by Google Analytics, it is organic.
|
111
|
+
# If the referrer is not a search engine, it is referral. If users came directly
|
112
|
+
# to the property and document.referrer is empty, its value is (none).
|
117
113
|
# Corresponds to the JSON property `medium`
|
118
114
|
# @return [String]
|
119
115
|
attr_accessor :medium
|
@@ -123,11 +119,11 @@ module Google
|
|
123
119
|
# @return [Google::Apis::AnalyticsreportingV4::PageviewData]
|
124
120
|
attr_accessor :pageview
|
125
121
|
|
126
|
-
# The source of referrals. For manual campaign tracking, it is the value of
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
122
|
+
# The source of referrals. For manual campaign tracking, it is the value of the
|
123
|
+
# utm_source campaign tracking parameter. For AdWords autotagging, it is google.
|
124
|
+
# If you use neither, it is the domain of the source (e.g., document.referrer)
|
125
|
+
# referring the users. It may also contain a port address. If users arrived
|
126
|
+
# without a referrer, its value is (direct).
|
131
127
|
# Corresponds to the JSON property `source`
|
132
128
|
# @return [String]
|
133
129
|
attr_accessor :source
|
@@ -157,27 +153,27 @@ module Google
|
|
157
153
|
end
|
158
154
|
|
159
155
|
# Defines a cohort. A cohort is a group of users who share a common
|
160
|
-
# characteristic. For example, all users with the same acquisition date
|
161
|
-
#
|
156
|
+
# characteristic. For example, all users with the same acquisition date belong
|
157
|
+
# to the same cohort.
|
162
158
|
class Cohort
|
163
159
|
include Google::Apis::Core::Hashable
|
164
160
|
|
165
|
-
# A contiguous set of days: startDate, startDate + 1 day, ..., endDate.
|
166
|
-
#
|
167
|
-
#
|
161
|
+
# A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The
|
162
|
+
# start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/
|
163
|
+
# ISO_8601) date format `YYYY-MM-DD`.
|
168
164
|
# Corresponds to the JSON property `dateRange`
|
169
165
|
# @return [Google::Apis::AnalyticsreportingV4::DateRange]
|
170
166
|
attr_accessor :date_range
|
171
167
|
|
172
|
-
# A unique name for the cohort. If not defined name will be auto-generated
|
173
|
-
#
|
168
|
+
# A unique name for the cohort. If not defined name will be auto-generated with
|
169
|
+
# values cohort_[1234...].
|
174
170
|
# Corresponds to the JSON property `name`
|
175
171
|
# @return [String]
|
176
172
|
attr_accessor :name
|
177
173
|
|
178
|
-
# Type of the cohort. The only supported type as of now is
|
179
|
-
#
|
180
|
-
#
|
174
|
+
# Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`.
|
175
|
+
# If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type
|
176
|
+
# cohort.
|
181
177
|
# Corresponds to the JSON property `type`
|
182
178
|
# @return [String]
|
183
179
|
attr_accessor :type
|
@@ -194,19 +190,10 @@ module Google
|
|
194
190
|
end
|
195
191
|
end
|
196
192
|
|
197
|
-
# Defines a cohort group.
|
198
|
-
#
|
199
|
-
# "
|
200
|
-
# "
|
201
|
-
# "name": "cohort 1",
|
202
|
-
# "type": "FIRST_VISIT_DATE",
|
203
|
-
# "dateRange": ` "startDate": "2015-08-01", "endDate": "2015-08-01" `
|
204
|
-
# `,`
|
205
|
-
# "name": "cohort 2"
|
206
|
-
# "type": "FIRST_VISIT_DATE"
|
207
|
-
# "dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" `
|
208
|
-
# `]
|
209
|
-
# `
|
193
|
+
# Defines a cohort group. For example: "cohortGroup": ` "cohorts": [` "name": "
|
194
|
+
# cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": ` "startDate": "2015-08-01"
|
195
|
+
# , "endDate": "2015-08-01" ` `,` "name": "cohort 2" "type": "FIRST_VISIT_DATE" "
|
196
|
+
# dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" ` `] `
|
210
197
|
class CohortGroup
|
211
198
|
include Google::Apis::Core::Hashable
|
212
199
|
|
@@ -215,33 +202,24 @@ module Google
|
|
215
202
|
# @return [Array<Google::Apis::AnalyticsreportingV4::Cohort>]
|
216
203
|
attr_accessor :cohorts
|
217
204
|
|
218
|
-
# Enable Life Time Value (LTV).
|
219
|
-
#
|
220
|
-
#
|
221
|
-
#
|
222
|
-
#
|
223
|
-
#
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
227
|
-
#
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
233
|
-
# - The
|
234
|
-
#
|
235
|
-
#
|
236
|
-
# engagement (Appviews, Goal Completions, Sessions, and Session Duration)
|
237
|
-
# grow during the 90 days after a user is acquired.
|
238
|
-
# - The metrics are calculated as a cumulative average per user per the time
|
239
|
-
# increment.
|
240
|
-
# - The cohort definition date ranges need not be aligned to the calendar
|
241
|
-
# week and month boundaries.
|
242
|
-
# - The `viewId` must be an
|
243
|
-
# [app view
|
244
|
-
# ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)
|
205
|
+
# Enable Life Time Value (LTV). LTV measures lifetime value for users acquired
|
206
|
+
# through different channels. Please see: [Cohort Analysis](https://support.
|
207
|
+
# google.com/analytics/answer/6074676) and [Lifetime Value](https://support.
|
208
|
+
# google.com/analytics/answer/6182550) If the value of lifetimeValue is false: -
|
209
|
+
# The metric values are similar to the values in the web interface cohort report.
|
210
|
+
# - The cohort definition date ranges must be aligned to the calendar week and
|
211
|
+
# month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort
|
212
|
+
# definition should be a Sunday and the `endDate` should be the following
|
213
|
+
# Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of
|
214
|
+
# the month and `endDate` should be the last day of the month. When the
|
215
|
+
# lifetimeValue is true: - The metric values will correspond to the values in
|
216
|
+
# the web interface LifeTime value report. - The Lifetime Value report shows you
|
217
|
+
# how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions,
|
218
|
+
# and Session Duration) grow during the 90 days after a user is acquired. - The
|
219
|
+
# metrics are calculated as a cumulative average per user per the time increment.
|
220
|
+
# - The cohort definition date ranges need not be aligned to the calendar week
|
221
|
+
# and month boundaries. - The `viewId` must be an [app view ID](https://support.
|
222
|
+
# google.com/analytics/answer/2649553#WebVersusAppViews)
|
245
223
|
# Corresponds to the JSON property `lifetimeValue`
|
246
224
|
# @return [Boolean]
|
247
225
|
attr_accessor :lifetime_value
|
@@ -309,9 +287,9 @@ module Google
|
|
309
287
|
end
|
310
288
|
end
|
311
289
|
|
312
|
-
# A contiguous set of days: startDate, startDate + 1 day, ..., endDate.
|
313
|
-
#
|
314
|
-
#
|
290
|
+
# A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The
|
291
|
+
# start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/
|
292
|
+
# ISO_8601) date format `YYYY-MM-DD`.
|
315
293
|
class DateRange
|
316
294
|
include Google::Apis::Core::Hashable
|
317
295
|
|
@@ -362,38 +340,31 @@ module Google
|
|
362
340
|
end
|
363
341
|
end
|
364
342
|
|
365
|
-
# [Dimensions](https://support.google.com/analytics/answer/1033861)
|
366
|
-
#
|
367
|
-
#
|
368
|
-
# a session originates.
|
343
|
+
# [Dimensions](https://support.google.com/analytics/answer/1033861) are
|
344
|
+
# attributes of your data. For example, the dimension `ga:city` indicates the
|
345
|
+
# city, for example, "Paris" or "New York", from which a session originates.
|
369
346
|
class Dimension
|
370
347
|
include Google::Apis::Core::Hashable
|
371
348
|
|
372
|
-
# If non-empty, we place dimension values into buckets after string to
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
# - bucket #
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
# (lexicographic) order. For example the ascending dictionary order is:
|
392
|
-
# "<50", "1001+", "121-1000", "50-120"
|
393
|
-
# And the ascending `HISTOGRAM_BUCKET` order is:
|
394
|
-
# "<50", "50-120", "121-1000", "1001+"
|
395
|
-
# The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"`
|
396
|
-
# for a histogram-mutated dimension.
|
349
|
+
# If non-empty, we place dimension values into buckets after string to int64.
|
350
|
+
# Dimension values that are not the string representation of an integral value
|
351
|
+
# will be converted to zero. The bucket values have to be in increasing order.
|
352
|
+
# Each bucket is closed on the lower end, and open on the upper end. The "first"
|
353
|
+
# bucket includes all values less than the first boundary, the "last" bucket
|
354
|
+
# includes all values up to infinity. Dimension values that fall in a bucket get
|
355
|
+
# transformed to a new dimension value. For example, if one gives a list of "0,
|
356
|
+
# 1, 3, 4, 7", then we return the following buckets: - bucket #1: values < 0,
|
357
|
+
# dimension value "<0" - bucket #2: values in [0,1), dimension value "0" -
|
358
|
+
# bucket #3: values in [1,3), dimension value "1-2" - bucket #4: values in [3,4),
|
359
|
+
# dimension value "3" - bucket #5: values in [4,7), dimension value "4-6" -
|
360
|
+
# bucket #6: values >= 7, dimension value "7+" NOTE: If you are applying
|
361
|
+
# histogram mutation on any dimension, and using that dimension in sort, you
|
362
|
+
# will want to use the sort type `HISTOGRAM_BUCKET` for that purpose. Without
|
363
|
+
# that the dimension values will be sorted according to dictionary (
|
364
|
+
# lexicographic) order. For example the ascending dictionary order is: "<50", "
|
365
|
+
# 1001+", "121-1000", "50-120" And the ascending `HISTOGRAM_BUCKET` order is: "<
|
366
|
+
# 50", "50-120", "121-1000", "1001+" The client has to explicitly request `"
|
367
|
+
# orderType": "HISTOGRAM_BUCKET"` for a histogram-mutated dimension.
|
397
368
|
# Corresponds to the JSON property `histogramBuckets`
|
398
369
|
# @return [Array<Fixnum>]
|
399
370
|
attr_accessor :histogram_buckets
|
@@ -429,10 +400,10 @@ module Google
|
|
429
400
|
# @return [String]
|
430
401
|
attr_accessor :dimension_name
|
431
402
|
|
432
|
-
# Strings or regular expression to match against. Only the first value of
|
433
|
-
#
|
434
|
-
#
|
435
|
-
#
|
403
|
+
# Strings or regular expression to match against. Only the first value of the
|
404
|
+
# list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST`
|
405
|
+
# operator, then the entire list is used to filter the dimensions as explained
|
406
|
+
# in the description of the `IN_LIST` operator.
|
436
407
|
# Corresponds to the JSON property `expressions`
|
437
408
|
# @return [Array<String>]
|
438
409
|
attr_accessor :expressions
|
@@ -463,19 +434,19 @@ module Google
|
|
463
434
|
end
|
464
435
|
end
|
465
436
|
|
466
|
-
# A group of dimension filters. Set the operator value to specify how
|
467
|
-
#
|
437
|
+
# A group of dimension filters. Set the operator value to specify how the
|
438
|
+
# filters are logically combined.
|
468
439
|
class DimensionFilterClause
|
469
440
|
include Google::Apis::Core::Hashable
|
470
441
|
|
471
|
-
# The repeated set of filters. They are logically combined based on the
|
472
|
-
#
|
442
|
+
# The repeated set of filters. They are logically combined based on the operator
|
443
|
+
# specified.
|
473
444
|
# Corresponds to the JSON property `filters`
|
474
445
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DimensionFilter>]
|
475
446
|
attr_accessor :filters
|
476
447
|
|
477
|
-
# The operator for combining multiple dimension filters. If unspecified, it
|
478
|
-
#
|
448
|
+
# The operator for combining multiple dimension filters. If unspecified, it is
|
449
|
+
# treated as an `OR`.
|
479
450
|
# Corresponds to the JSON property `operator`
|
480
451
|
# @return [String]
|
481
452
|
attr_accessor :operator
|
@@ -491,8 +462,8 @@ module Google
|
|
491
462
|
end
|
492
463
|
end
|
493
464
|
|
494
|
-
# Dynamic segment definition for defining the segment within the request.
|
495
|
-
#
|
465
|
+
# Dynamic segment definition for defining the segment within the request. A
|
466
|
+
# segment can select users, sessions or both.
|
496
467
|
class DynamicSegment
|
497
468
|
include Google::Apis::Core::Hashable
|
498
469
|
|
@@ -501,14 +472,14 @@ module Google
|
|
501
472
|
# @return [String]
|
502
473
|
attr_accessor :name
|
503
474
|
|
504
|
-
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
505
|
-
#
|
475
|
+
# SegmentDefinition defines the segment to be a set of SegmentFilters which are
|
476
|
+
# combined together with a logical `AND` operation.
|
506
477
|
# Corresponds to the JSON property `sessionSegment`
|
507
478
|
# @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
|
508
479
|
attr_accessor :session_segment
|
509
480
|
|
510
|
-
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
511
|
-
#
|
481
|
+
# SegmentDefinition defines the segment to be a set of SegmentFilters which are
|
482
|
+
# combined together with a logical `AND` operation.
|
512
483
|
# Corresponds to the JSON property `userSegment`
|
513
484
|
# @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
|
514
485
|
attr_accessor :user_segment
|
@@ -610,26 +581,20 @@ module Google
|
|
610
581
|
class GetReportsRequest
|
611
582
|
include Google::Apis::Core::Hashable
|
612
583
|
|
613
|
-
# Requests, each request will have a separate response.
|
614
|
-
#
|
615
|
-
#
|
584
|
+
# Requests, each request will have a separate response. There can be a maximum
|
585
|
+
# of 5 requests. All requests should have the same `dateRanges`, `viewId`, `
|
586
|
+
# segments`, `samplingLevel`, and `cohortGroup`.
|
616
587
|
# Corresponds to the JSON property `reportRequests`
|
617
588
|
# @return [Array<Google::Apis::AnalyticsreportingV4::ReportRequest>]
|
618
589
|
attr_accessor :report_requests
|
619
590
|
|
620
|
-
# Enables
|
621
|
-
#
|
622
|
-
#
|
623
|
-
#
|
624
|
-
#
|
625
|
-
#
|
626
|
-
#
|
627
|
-
# higher enable sampling rates. (10 Million for `SMALL`,
|
628
|
-
# 100M for `LARGE`. See the
|
629
|
-
# [limits and quotas
|
630
|
-
# documentation](/analytics/devguides/reporting/core/v4/limits-quotas#
|
631
|
-
# analytics_reporting_api_v4)
|
632
|
-
# for details.
|
591
|
+
# Enables [resource based quotas](/analytics/devguides/reporting/core/v4/limits-
|
592
|
+
# quotas#analytics_reporting_api_v4), (defaults to `False`). If this field is
|
593
|
+
# set to `True` the per view (profile) quotas are governed by the computational
|
594
|
+
# cost of the request. Note that using cost based quotas will higher enable
|
595
|
+
# sampling rates. (10 Million for `SMALL`, 100M for `LARGE`. See the [limits and
|
596
|
+
# quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#
|
597
|
+
# analytics_reporting_api_v4) for details.
|
633
598
|
# Corresponds to the JSON property `useResourceQuotas`
|
634
599
|
# @return [Boolean]
|
635
600
|
attr_accessor :use_resource_quotas
|
@@ -646,8 +611,8 @@ module Google
|
|
646
611
|
end
|
647
612
|
end
|
648
613
|
|
649
|
-
# The main response class which holds the reports from the Reporting API
|
650
|
-
#
|
614
|
+
# The main response class which holds the reports from the Reporting API `
|
615
|
+
# batchGet` call.
|
651
616
|
class GetReportsResponse
|
652
617
|
include Google::Apis::Core::Hashable
|
653
618
|
|
@@ -760,35 +725,33 @@ module Google
|
|
760
725
|
end
|
761
726
|
end
|
762
727
|
|
763
|
-
# [Metrics](https://support.google.com/analytics/answer/1033861)
|
764
|
-
#
|
765
|
-
#
|
728
|
+
# [Metrics](https://support.google.com/analytics/answer/1033861) are the
|
729
|
+
# quantitative measurements. For example, the metric `ga:users` indicates the
|
730
|
+
# total number of users for the requested time period.
|
766
731
|
class Metric
|
767
732
|
include Google::Apis::Core::Hashable
|
768
733
|
|
769
|
-
# An alias for the metric expression is an alternate name for the
|
770
|
-
#
|
771
|
-
#
|
772
|
-
#
|
773
|
-
#
|
734
|
+
# An alias for the metric expression is an alternate name for the expression.
|
735
|
+
# The alias can be used for filtering and sorting. This field is optional and is
|
736
|
+
# useful if the expression is not a single metric but a complex expression which
|
737
|
+
# cannot be used in filtering and sorting. The alias is also used in the
|
738
|
+
# response column header.
|
774
739
|
# Corresponds to the JSON property `alias`
|
775
740
|
# @return [String]
|
776
741
|
attr_accessor :alias
|
777
742
|
|
778
|
-
# A metric expression in the request. An expression is constructed from one
|
779
|
-
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
785
|
-
# will result in unexpected results.
|
743
|
+
# A metric expression in the request. An expression is constructed from one or
|
744
|
+
# more metrics and numbers. Accepted operators include: Plus (+), Minus (-),
|
745
|
+
# Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive
|
746
|
+
# cardinal numbers (0-9), can include decimals and is limited to 1024 characters.
|
747
|
+
# Example `ga:totalRefunds/ga:users`, in most cases the metric expression is
|
748
|
+
# just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., `
|
749
|
+
# CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results.
|
786
750
|
# Corresponds to the JSON property `expression`
|
787
751
|
# @return [String]
|
788
752
|
attr_accessor :expression
|
789
753
|
|
790
|
-
# Specifies how the metric expression should be formatted, for example
|
791
|
-
# `INTEGER`.
|
754
|
+
# Specifies how the metric expression should be formatted, for example `INTEGER`.
|
792
755
|
# Corresponds to the JSON property `formattingType`
|
793
756
|
# @return [String]
|
794
757
|
attr_accessor :formatting_type
|
@@ -814,9 +777,9 @@ module Google
|
|
814
777
|
# @return [String]
|
815
778
|
attr_accessor :comparison_value
|
816
779
|
|
817
|
-
# The metric that will be filtered on. A metricFilter must contain a metric
|
818
|
-
#
|
819
|
-
#
|
780
|
+
# The metric that will be filtered on. A metricFilter must contain a metric name.
|
781
|
+
# A metric name can be an alias earlier defined as a metric or it can also be a
|
782
|
+
# metric expression.
|
820
783
|
# Corresponds to the JSON property `metricName`
|
821
784
|
# @return [String]
|
822
785
|
attr_accessor :metric_name
|
@@ -828,10 +791,9 @@ module Google
|
|
828
791
|
attr_accessor :not
|
829
792
|
alias_method :not?, :not
|
830
793
|
|
831
|
-
# Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the
|
832
|
-
#
|
833
|
-
#
|
834
|
-
# comparisonValue.
|
794
|
+
# Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the
|
795
|
+
# default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is
|
796
|
+
# missing and would ignore the comparisonValue.
|
835
797
|
# Corresponds to the JSON property `operator`
|
836
798
|
# @return [String]
|
837
799
|
attr_accessor :operator
|
@@ -849,13 +811,13 @@ module Google
|
|
849
811
|
end
|
850
812
|
end
|
851
813
|
|
852
|
-
# Represents a group of metric filters.
|
853
|
-
#
|
814
|
+
# Represents a group of metric filters. Set the operator value to specify how
|
815
|
+
# the filters are logically combined.
|
854
816
|
class MetricFilterClause
|
855
817
|
include Google::Apis::Core::Hashable
|
856
818
|
|
857
|
-
# The repeated set of filters. They are logically combined based on the
|
858
|
-
#
|
819
|
+
# The repeated set of filters. They are logically combined based on the operator
|
820
|
+
# specified.
|
859
821
|
# Corresponds to the JSON property `filters`
|
860
822
|
# @return [Array<Google::Apis::AnalyticsreportingV4::MetricFilter>]
|
861
823
|
attr_accessor :filters
|
@@ -951,9 +913,8 @@ module Google
|
|
951
913
|
class OrderBy
|
952
914
|
include Google::Apis::Core::Hashable
|
953
915
|
|
954
|
-
# The field which to sort by. The default sort order is ascending. Example:
|
955
|
-
#
|
956
|
-
# Note, that you can only specify one field for sort here. For example,
|
916
|
+
# The field which to sort by. The default sort order is ascending. Example: `ga:
|
917
|
+
# browser`. Note, that you can only specify one field for sort here. For example,
|
957
918
|
# `ga:browser, ga:city` is not valid.
|
958
919
|
# Corresponds to the JSON property `fieldName`
|
959
920
|
# @return [String]
|
@@ -1006,54 +967,52 @@ module Google
|
|
1006
967
|
end
|
1007
968
|
end
|
1008
969
|
|
1009
|
-
# The Pivot describes the pivot section in the request.
|
1010
|
-
#
|
1011
|
-
#
|
970
|
+
# The Pivot describes the pivot section in the request. The Pivot helps
|
971
|
+
# rearrange the information in the table for certain reports by pivoting your
|
972
|
+
# data on a second dimension.
|
1012
973
|
class Pivot
|
1013
974
|
include Google::Apis::Core::Hashable
|
1014
975
|
|
1015
976
|
# DimensionFilterClauses are logically combined with an `AND` operator: only
|
1016
|
-
# data that is included by all these DimensionFilterClauses contributes to
|
1017
|
-
#
|
1018
|
-
#
|
1019
|
-
#
|
1020
|
-
#
|
1021
|
-
#
|
977
|
+
# data that is included by all these DimensionFilterClauses contributes to the
|
978
|
+
# values in this pivot region. Dimension filters can be used to restrict the
|
979
|
+
# columns shown in the pivot region. For example if you have `ga:browser` as the
|
980
|
+
# requested dimension in the pivot region, and you specify key filters to
|
981
|
+
# restrict `ga:browser` to only "IE" or "Firefox", then only those two browsers
|
982
|
+
# would show up as columns.
|
1022
983
|
# Corresponds to the JSON property `dimensionFilterClauses`
|
1023
984
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DimensionFilterClause>]
|
1024
985
|
attr_accessor :dimension_filter_clauses
|
1025
986
|
|
1026
|
-
# A list of dimensions to show as pivot columns. A Pivot can have a maximum
|
1027
|
-
#
|
1028
|
-
#
|
987
|
+
# A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4
|
988
|
+
# dimensions. Pivot dimensions are part of the restriction on the total number
|
989
|
+
# of dimensions allowed in the request.
|
1029
990
|
# Corresponds to the JSON property `dimensions`
|
1030
991
|
# @return [Array<Google::Apis::AnalyticsreportingV4::Dimension>]
|
1031
992
|
attr_accessor :dimensions
|
1032
993
|
|
1033
|
-
# Specifies the maximum number of groups to return.
|
1034
|
-
#
|
994
|
+
# Specifies the maximum number of groups to return. The default value is 10,
|
995
|
+
# also the maximum value is 1,000.
|
1035
996
|
# Corresponds to the JSON property `maxGroupCount`
|
1036
997
|
# @return [Fixnum]
|
1037
998
|
attr_accessor :max_group_count
|
1038
999
|
|
1039
|
-
# The pivot metrics. Pivot metrics are part of the
|
1040
|
-
#
|
1000
|
+
# The pivot metrics. Pivot metrics are part of the restriction on total number
|
1001
|
+
# of metrics allowed in the request.
|
1041
1002
|
# Corresponds to the JSON property `metrics`
|
1042
1003
|
# @return [Array<Google::Apis::AnalyticsreportingV4::Metric>]
|
1043
1004
|
attr_accessor :metrics
|
1044
1005
|
|
1045
|
-
# If k metrics were requested, then the response will contain some
|
1046
|
-
#
|
1047
|
-
#
|
1048
|
-
#
|
1049
|
-
#
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1053
|
-
#
|
1054
|
-
#
|
1055
|
-
# The following let you choose which of the groups of k columns are
|
1056
|
-
# included in the response.
|
1006
|
+
# If k metrics were requested, then the response will contain some data-
|
1007
|
+
# dependent multiple of k columns in the report. E.g., if you pivoted on the
|
1008
|
+
# dimension `ga:browser` then you'd get k columns for "Firefox", k columns for "
|
1009
|
+
# IE", k columns for "Chrome", etc. The ordering of the groups of columns is
|
1010
|
+
# determined by descending order of "total" for the first of the k values. Ties
|
1011
|
+
# are broken by lexicographic ordering of the first pivot dimension, then
|
1012
|
+
# lexicographic ordering of the second pivot dimension, and so on. E.g., if the
|
1013
|
+
# totals for the first value for Firefox, IE, and Chrome were 8, 2, 8,
|
1014
|
+
# respectively, the order of columns would be Chrome, Firefox, IE. The following
|
1015
|
+
# let you choose which of the groups of k columns are included in the response.
|
1057
1016
|
# Corresponds to the JSON property `startGroup`
|
1058
1017
|
# @return [Fixnum]
|
1059
1018
|
attr_accessor :start_group
|
@@ -1157,8 +1116,8 @@ module Google
|
|
1157
1116
|
# @return [Float]
|
1158
1117
|
attr_accessor :item_revenue
|
1159
1118
|
|
1160
|
-
# The product name, supplied by the e-commerce tracking application, for
|
1161
|
-
#
|
1119
|
+
# The product name, supplied by the e-commerce tracking application, for the
|
1120
|
+
# purchased items.
|
1162
1121
|
# Corresponds to the JSON property `productName`
|
1163
1122
|
# @return [String]
|
1164
1123
|
attr_accessor :product_name
|
@@ -1227,24 +1186,22 @@ module Google
|
|
1227
1186
|
# @return [String]
|
1228
1187
|
attr_accessor :data_last_refreshed
|
1229
1188
|
|
1230
|
-
# Indicates if response to this request is golden or not. Data is
|
1231
|
-
#
|
1232
|
-
#
|
1189
|
+
# Indicates if response to this request is golden or not. Data is golden when
|
1190
|
+
# the exact same request will not produce any new results if asked at a later
|
1191
|
+
# point in time.
|
1233
1192
|
# Corresponds to the JSON property `isDataGolden`
|
1234
1193
|
# @return [Boolean]
|
1235
1194
|
attr_accessor :is_data_golden
|
1236
1195
|
alias_method :is_data_golden?, :is_data_golden
|
1237
1196
|
|
1238
|
-
# Minimum and maximum values seen over all matching rows. These are both
|
1239
|
-
#
|
1240
|
-
# rowCount is zero.
|
1197
|
+
# Minimum and maximum values seen over all matching rows. These are both empty
|
1198
|
+
# when `hideValueRanges` in the request is false, or when rowCount is zero.
|
1241
1199
|
# Corresponds to the JSON property `maximums`
|
1242
1200
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
1243
1201
|
attr_accessor :maximums
|
1244
1202
|
|
1245
|
-
# Minimum and maximum values seen over all matching rows. These are both
|
1246
|
-
#
|
1247
|
-
# rowCount is zero.
|
1203
|
+
# Minimum and maximum values seen over all matching rows. These are both empty
|
1204
|
+
# when `hideValueRanges` in the request is false, or when rowCount is zero.
|
1248
1205
|
# Corresponds to the JSON property `minimums`
|
1249
1206
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
1250
1207
|
attr_accessor :minimums
|
@@ -1259,34 +1216,29 @@ module Google
|
|
1259
1216
|
# @return [Array<Google::Apis::AnalyticsreportingV4::ReportRow>]
|
1260
1217
|
attr_accessor :rows
|
1261
1218
|
|
1262
|
-
# If the results are
|
1263
|
-
#
|
1264
|
-
#
|
1265
|
-
#
|
1266
|
-
#
|
1267
|
-
# for details.
|
1219
|
+
# If the results are [sampled](https://support.google.com/analytics/answer/
|
1220
|
+
# 2637192), this returns the total number of samples read, one entry per date
|
1221
|
+
# range. If the results are not sampled this field will not be defined. See [
|
1222
|
+
# developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for
|
1223
|
+
# details.
|
1268
1224
|
# Corresponds to the JSON property `samplesReadCounts`
|
1269
1225
|
# @return [Array<Fixnum>]
|
1270
1226
|
attr_accessor :samples_read_counts
|
1271
1227
|
|
1272
|
-
# If the results are
|
1273
|
-
#
|
1274
|
-
#
|
1275
|
-
#
|
1276
|
-
#
|
1277
|
-
# [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
|
1278
|
-
# for details.
|
1228
|
+
# If the results are [sampled](https://support.google.com/analytics/answer/
|
1229
|
+
# 2637192), this returns the total number of samples present, one entry per date
|
1230
|
+
# range. If the results are not sampled this field will not be defined. See [
|
1231
|
+
# developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for
|
1232
|
+
# details.
|
1279
1233
|
# Corresponds to the JSON property `samplingSpaceSizes`
|
1280
1234
|
# @return [Array<Fixnum>]
|
1281
1235
|
attr_accessor :sampling_space_sizes
|
1282
1236
|
|
1283
|
-
# For each requested date range, for the set of all rows that match
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
#
|
1287
|
-
#
|
1288
|
-
# `3 / (ga:sessions + 2)` we compute
|
1289
|
-
# `3 / ((sum of all relevant ga:sessions) + 2)`.
|
1237
|
+
# For each requested date range, for the set of all rows that match the query,
|
1238
|
+
# every requested value format gets a total. The total for a value format is
|
1239
|
+
# computed by first totaling the metrics mentioned in the value format and then
|
1240
|
+
# evaluating the value format as a scalar expression. E.g., The "totals" for `3 /
|
1241
|
+
# (ga:sessions + 2)` we compute `3 / ((sum of all relevant ga:sessions) + 2)`.
|
1290
1242
|
# Totals are computed before pagination.
|
1291
1243
|
# Corresponds to the JSON property `totals`
|
1292
1244
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
|
@@ -1314,125 +1266,108 @@ module Google
|
|
1314
1266
|
class ReportRequest
|
1315
1267
|
include Google::Apis::Core::Hashable
|
1316
1268
|
|
1317
|
-
# Defines a cohort group.
|
1318
|
-
#
|
1319
|
-
# "
|
1320
|
-
# "
|
1321
|
-
# "name": "cohort 1",
|
1322
|
-
# "type": "FIRST_VISIT_DATE",
|
1323
|
-
# "dateRange": ` "startDate": "2015-08-01", "endDate": "2015-08-01" `
|
1324
|
-
# `,`
|
1325
|
-
# "name": "cohort 2"
|
1326
|
-
# "type": "FIRST_VISIT_DATE"
|
1327
|
-
# "dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" `
|
1328
|
-
# `]
|
1329
|
-
# `
|
1269
|
+
# Defines a cohort group. For example: "cohortGroup": ` "cohorts": [` "name": "
|
1270
|
+
# cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": ` "startDate": "2015-08-01"
|
1271
|
+
# , "endDate": "2015-08-01" ` `,` "name": "cohort 2" "type": "FIRST_VISIT_DATE" "
|
1272
|
+
# dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" ` `] `
|
1330
1273
|
# Corresponds to the JSON property `cohortGroup`
|
1331
1274
|
# @return [Google::Apis::AnalyticsreportingV4::CohortGroup]
|
1332
1275
|
attr_accessor :cohort_group
|
1333
1276
|
|
1334
|
-
# Date ranges in the request. The request can have a maximum of 2 date
|
1335
|
-
#
|
1336
|
-
#
|
1337
|
-
#
|
1338
|
-
#
|
1339
|
-
#
|
1340
|
-
#
|
1341
|
-
#
|
1342
|
-
#
|
1343
|
-
# [ReportRequest](#ReportRequest) within a `batchGet` method must
|
1344
|
-
# contain the same `dateRanges` definition.
|
1277
|
+
# Date ranges in the request. The request can have a maximum of 2 date ranges.
|
1278
|
+
# The response will contain a set of metric values for each combination of the
|
1279
|
+
# dimensions for each date range in the request. So, if there are two date
|
1280
|
+
# ranges, there will be two set of metric values, one for the original date
|
1281
|
+
# range and one for the second date range. The `reportRequest.dateRanges` field
|
1282
|
+
# should not be specified for cohorts or Lifetime value requests. If a date
|
1283
|
+
# range is not provided, the default date range is (startDate: current date - 7
|
1284
|
+
# days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest)
|
1285
|
+
# within a `batchGet` method must contain the same `dateRanges` definition.
|
1345
1286
|
# Corresponds to the JSON property `dateRanges`
|
1346
1287
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DateRange>]
|
1347
1288
|
attr_accessor :date_ranges
|
1348
1289
|
|
1349
1290
|
# The dimension filter clauses for filtering Dimension Values. They are
|
1350
|
-
# logically combined with the `AND` operator. Note that filtering occurs
|
1351
|
-
#
|
1352
|
-
#
|
1291
|
+
# logically combined with the `AND` operator. Note that filtering occurs before
|
1292
|
+
# any dimensions are aggregated, so that the returned metrics represent the
|
1293
|
+
# total for only the relevant dimensions.
|
1353
1294
|
# Corresponds to the JSON property `dimensionFilterClauses`
|
1354
1295
|
# @return [Array<Google::Apis::AnalyticsreportingV4::DimensionFilterClause>]
|
1355
1296
|
attr_accessor :dimension_filter_clauses
|
1356
1297
|
|
1357
|
-
# The dimensions requested.
|
1358
|
-
# Requests can have a total of 9 dimensions.
|
1298
|
+
# The dimensions requested. Requests can have a total of 9 dimensions.
|
1359
1299
|
# Corresponds to the JSON property `dimensions`
|
1360
1300
|
# @return [Array<Google::Apis::AnalyticsreportingV4::Dimension>]
|
1361
1301
|
attr_accessor :dimensions
|
1362
1302
|
|
1363
|
-
# Dimension or metric filters that restrict the data returned for your
|
1364
|
-
#
|
1365
|
-
#
|
1366
|
-
#
|
1367
|
-
#
|
1368
|
-
#
|
1369
|
-
#
|
1370
|
-
# reference](https://developers.google.com/analytics/devguides/reporting/core/v3/
|
1371
|
-
# reference#filters).
|
1303
|
+
# Dimension or metric filters that restrict the data returned for your request.
|
1304
|
+
# To use the `filtersExpression`, supply a dimension or metric on which to
|
1305
|
+
# filter, followed by the filter expression. For example, the following
|
1306
|
+
# expression selects `ga:browser` dimension which starts with Firefox; `ga:
|
1307
|
+
# browser=~^Firefox`. For more information on dimensions and metric filters, see
|
1308
|
+
# [Filters reference](https://developers.google.com/analytics/devguides/
|
1309
|
+
# reporting/core/v3/reference#filters).
|
1372
1310
|
# Corresponds to the JSON property `filtersExpression`
|
1373
1311
|
# @return [String]
|
1374
1312
|
attr_accessor :filters_expression
|
1375
1313
|
|
1376
|
-
# If set to true, hides the total of all metrics for all the matching rows,
|
1377
|
-
#
|
1314
|
+
# If set to true, hides the total of all metrics for all the matching rows, for
|
1315
|
+
# every date range. The default false and will return the totals.
|
1378
1316
|
# Corresponds to the JSON property `hideTotals`
|
1379
1317
|
# @return [Boolean]
|
1380
1318
|
attr_accessor :hide_totals
|
1381
1319
|
alias_method :hide_totals?, :hide_totals
|
1382
1320
|
|
1383
|
-
# If set to true, hides the minimum and maximum across all matching rows.
|
1384
|
-
#
|
1321
|
+
# If set to true, hides the minimum and maximum across all matching rows. The
|
1322
|
+
# default is false and the value ranges are returned.
|
1385
1323
|
# Corresponds to the JSON property `hideValueRanges`
|
1386
1324
|
# @return [Boolean]
|
1387
1325
|
attr_accessor :hide_value_ranges
|
1388
1326
|
alias_method :hide_value_ranges?, :hide_value_ranges
|
1389
1327
|
|
1390
1328
|
# If set to false, the response does not include rows if all the retrieved
|
1391
|
-
# metrics are equal to zero. The default is false which will exclude these
|
1392
|
-
# rows.
|
1329
|
+
# metrics are equal to zero. The default is false which will exclude these rows.
|
1393
1330
|
# Corresponds to the JSON property `includeEmptyRows`
|
1394
1331
|
# @return [Boolean]
|
1395
1332
|
attr_accessor :include_empty_rows
|
1396
1333
|
alias_method :include_empty_rows?, :include_empty_rows
|
1397
1334
|
|
1398
|
-
# The metric filter clauses. They are logically combined with the `AND`
|
1399
|
-
#
|
1400
|
-
#
|
1401
|
-
# metrics are aggregated.
|
1335
|
+
# The metric filter clauses. They are logically combined with the `AND` operator.
|
1336
|
+
# Metric filters look at only the first date range and not the comparing date
|
1337
|
+
# range. Note that filtering on metrics occurs after the metrics are aggregated.
|
1402
1338
|
# Corresponds to the JSON property `metricFilterClauses`
|
1403
1339
|
# @return [Array<Google::Apis::AnalyticsreportingV4::MetricFilterClause>]
|
1404
1340
|
attr_accessor :metric_filter_clauses
|
1405
1341
|
|
1406
|
-
# The metrics requested.
|
1407
|
-
#
|
1408
|
-
# total of 10 metrics.
|
1342
|
+
# The metrics requested. Requests must specify at least one metric. Requests can
|
1343
|
+
# have a total of 10 metrics.
|
1409
1344
|
# Corresponds to the JSON property `metrics`
|
1410
1345
|
# @return [Array<Google::Apis::AnalyticsreportingV4::Metric>]
|
1411
1346
|
attr_accessor :metrics
|
1412
1347
|
|
1413
|
-
# Sort order on output rows. To compare two rows, the elements of the
|
1414
|
-
#
|
1415
|
-
#
|
1348
|
+
# Sort order on output rows. To compare two rows, the elements of the following
|
1349
|
+
# are applied in order until a difference is found. All date ranges in the
|
1350
|
+
# output get the same row order.
|
1416
1351
|
# Corresponds to the JSON property `orderBys`
|
1417
1352
|
# @return [Array<Google::Apis::AnalyticsreportingV4::OrderBy>]
|
1418
1353
|
attr_accessor :order_bys
|
1419
1354
|
|
1420
1355
|
# Page size is for paging and specifies the maximum number of returned rows.
|
1421
|
-
# Page size should be >= 0. A query returns the default of 1,000 rows.
|
1422
|
-
#
|
1423
|
-
#
|
1424
|
-
#
|
1425
|
-
#
|
1426
|
-
#
|
1427
|
-
#
|
1356
|
+
# Page size should be >= 0. A query returns the default of 1,000 rows. The
|
1357
|
+
# Analytics Core Reporting API returns a maximum of 100,000 rows per request, no
|
1358
|
+
# matter how many you ask for. It can also return fewer rows than requested, if
|
1359
|
+
# there aren't as many dimension segments as you expect. For instance, there are
|
1360
|
+
# fewer than 300 possible values for `ga:country`, so when segmenting only by
|
1361
|
+
# country, you can't get more than 300 rows, even if you set `pageSize` to a
|
1362
|
+
# higher value.
|
1428
1363
|
# Corresponds to the JSON property `pageSize`
|
1429
1364
|
# @return [Fixnum]
|
1430
1365
|
attr_accessor :page_size
|
1431
1366
|
|
1432
|
-
# A continuation token to get the next page of the results. Adding this to
|
1433
|
-
#
|
1434
|
-
#
|
1435
|
-
#
|
1367
|
+
# A continuation token to get the next page of the results. Adding this to the
|
1368
|
+
# request will return the rows after the pageToken. The pageToken should be the
|
1369
|
+
# value returned in the nextPageToken parameter in the response to the
|
1370
|
+
# GetReports request.
|
1436
1371
|
# Corresponds to the JSON property `pageToken`
|
1437
1372
|
# @return [String]
|
1438
1373
|
attr_accessor :page_token
|
@@ -1442,30 +1377,28 @@ module Google
|
|
1442
1377
|
# @return [Array<Google::Apis::AnalyticsreportingV4::Pivot>]
|
1443
1378
|
attr_accessor :pivots
|
1444
1379
|
|
1445
|
-
# The desired report
|
1446
|
-
#
|
1447
|
-
#
|
1448
|
-
#
|
1449
|
-
#
|
1450
|
-
#
|
1451
|
-
# for details.
|
1380
|
+
# The desired report [sample](https://support.google.com/analytics/answer/
|
1381
|
+
# 2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT`
|
1382
|
+
# sampling level is used. Every [ReportRequest](#ReportRequest) within a `
|
1383
|
+
# batchGet` method must contain the same `samplingLevel` definition. See [
|
1384
|
+
# developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for
|
1385
|
+
# details.
|
1452
1386
|
# Corresponds to the JSON property `samplingLevel`
|
1453
1387
|
# @return [String]
|
1454
1388
|
attr_accessor :sampling_level
|
1455
1389
|
|
1456
|
-
# Segment the data returned for the request. A segment definition helps look
|
1457
|
-
#
|
1458
|
-
#
|
1459
|
-
#
|
1460
|
-
#
|
1390
|
+
# Segment the data returned for the request. A segment definition helps look at
|
1391
|
+
# a subset of the segment request. A request can contain up to four segments.
|
1392
|
+
# Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain
|
1393
|
+
# the same `segments` definition. Requests with segments must have the `ga:
|
1394
|
+
# segment` dimension.
|
1461
1395
|
# Corresponds to the JSON property `segments`
|
1462
1396
|
# @return [Array<Google::Apis::AnalyticsreportingV4::Segment>]
|
1463
1397
|
attr_accessor :segments
|
1464
1398
|
|
1465
|
-
# The Analytics
|
1466
|
-
# [
|
1467
|
-
#
|
1468
|
-
# within a `batchGet` method must contain the same `viewId`.
|
1399
|
+
# The Analytics [view ID](https://support.google.com/analytics/answer/1009618)
|
1400
|
+
# from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `
|
1401
|
+
# batchGet` method must contain the same `viewId`.
|
1469
1402
|
# Corresponds to the JSON property `viewId`
|
1470
1403
|
# @return [String]
|
1471
1404
|
attr_accessor :view_id
|
@@ -1588,16 +1521,15 @@ module Google
|
|
1588
1521
|
class SearchUserActivityRequest
|
1589
1522
|
include Google::Apis::Core::Hashable
|
1590
1523
|
|
1591
|
-
# Set of all activity types being requested. Only acvities matching these
|
1592
|
-
#
|
1593
|
-
# returned.
|
1524
|
+
# Set of all activity types being requested. Only acvities matching these types
|
1525
|
+
# will be returned in the response. If empty, all activies will be returned.
|
1594
1526
|
# Corresponds to the JSON property `activityTypes`
|
1595
1527
|
# @return [Array<String>]
|
1596
1528
|
attr_accessor :activity_types
|
1597
1529
|
|
1598
|
-
# A contiguous set of days: startDate, startDate + 1 day, ..., endDate.
|
1599
|
-
#
|
1600
|
-
#
|
1530
|
+
# A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The
|
1531
|
+
# start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/
|
1532
|
+
# ISO_8601) date format `YYYY-MM-DD`.
|
1601
1533
|
# Corresponds to the JSON property `dateRange`
|
1602
1534
|
# @return [Google::Apis::AnalyticsreportingV4::DateRange]
|
1603
1535
|
attr_accessor :date_range
|
@@ -1609,10 +1541,10 @@ module Google
|
|
1609
1541
|
# @return [Fixnum]
|
1610
1542
|
attr_accessor :page_size
|
1611
1543
|
|
1612
|
-
# A continuation token to get the next page of the results. Adding this to
|
1613
|
-
#
|
1614
|
-
#
|
1615
|
-
#
|
1544
|
+
# A continuation token to get the next page of the results. Adding this to the
|
1545
|
+
# request will return the rows after the pageToken. The pageToken should be the
|
1546
|
+
# value returned in the nextPageToken parameter in the response to the [
|
1547
|
+
# SearchUserActivityRequest](#SearchUserActivityRequest) request.
|
1616
1548
|
# Corresponds to the JSON property `pageToken`
|
1617
1549
|
# @return [String]
|
1618
1550
|
attr_accessor :page_token
|
@@ -1622,11 +1554,9 @@ module Google
|
|
1622
1554
|
# @return [Google::Apis::AnalyticsreportingV4::User]
|
1623
1555
|
attr_accessor :user
|
1624
1556
|
|
1625
|
-
# Required. The Analytics
|
1626
|
-
# [
|
1627
|
-
#
|
1628
|
-
# [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the
|
1629
|
-
# `viewId`.
|
1557
|
+
# Required. The Analytics [view ID](https://support.google.com/analytics/answer/
|
1558
|
+
# 1009618) from which to retrieve data. Every [SearchUserActivityRequest](#
|
1559
|
+
# SearchUserActivityRequest) must contain the `viewId`.
|
1630
1560
|
# Corresponds to the JSON property `viewId`
|
1631
1561
|
# @return [String]
|
1632
1562
|
attr_accessor :view_id
|
@@ -1650,18 +1580,16 @@ module Google
|
|
1650
1580
|
class SearchUserActivityResponse
|
1651
1581
|
include Google::Apis::Core::Hashable
|
1652
1582
|
|
1653
|
-
# This token should be passed to
|
1654
|
-
#
|
1655
|
-
# next page.
|
1583
|
+
# This token should be passed to [SearchUserActivityRequest](#
|
1584
|
+
# SearchUserActivityRequest) to retrieve the next page.
|
1656
1585
|
# Corresponds to the JSON property `nextPageToken`
|
1657
1586
|
# @return [String]
|
1658
1587
|
attr_accessor :next_page_token
|
1659
1588
|
|
1660
|
-
# This field represents the
|
1661
|
-
#
|
1662
|
-
#
|
1663
|
-
#
|
1664
|
-
# for details.
|
1589
|
+
# This field represents the [sampling rate](https://support.google.com/analytics/
|
1590
|
+
# answer/2637192) for the given request and is a number between 0.0 to 1.0. See [
|
1591
|
+
# developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for
|
1592
|
+
# details.
|
1665
1593
|
# Corresponds to the JSON property `sampleRate`
|
1666
1594
|
# @return [Float]
|
1667
1595
|
attr_accessor :sample_rate
|
@@ -1689,14 +1617,14 @@ module Google
|
|
1689
1617
|
end
|
1690
1618
|
end
|
1691
1619
|
|
1692
|
-
# The segment definition, if the report needs to be segmented.
|
1693
|
-
#
|
1694
|
-
#
|
1620
|
+
# The segment definition, if the report needs to be segmented. A Segment is a
|
1621
|
+
# subset of the Analytics data. For example, of the entire set of users, one
|
1622
|
+
# Segment might be users from a particular country or city.
|
1695
1623
|
class Segment
|
1696
1624
|
include Google::Apis::Core::Hashable
|
1697
1625
|
|
1698
|
-
# Dynamic segment definition for defining the segment within the request.
|
1699
|
-
#
|
1626
|
+
# Dynamic segment definition for defining the segment within the request. A
|
1627
|
+
# segment can select users, sessions or both.
|
1700
1628
|
# Corresponds to the JSON property `dynamicSegment`
|
1701
1629
|
# @return [Google::Apis::AnalyticsreportingV4::DynamicSegment]
|
1702
1630
|
attr_accessor :dynamic_segment
|
@@ -1717,13 +1645,13 @@ module Google
|
|
1717
1645
|
end
|
1718
1646
|
end
|
1719
1647
|
|
1720
|
-
# SegmentDefinition defines the segment to be a set of SegmentFilters which
|
1721
|
-
#
|
1648
|
+
# SegmentDefinition defines the segment to be a set of SegmentFilters which are
|
1649
|
+
# combined together with a logical `AND` operation.
|
1722
1650
|
class SegmentDefinition
|
1723
1651
|
include Google::Apis::Core::Hashable
|
1724
1652
|
|
1725
|
-
# A segment is defined by a set of segment filters which are combined
|
1726
|
-
#
|
1653
|
+
# A segment is defined by a set of segment filters which are combined together
|
1654
|
+
# with a logical `AND` operation.
|
1727
1655
|
# Corresponds to the JSON property `segmentFilters`
|
1728
1656
|
# @return [Array<Google::Apis::AnalyticsreportingV4::SegmentFilter>]
|
1729
1657
|
attr_accessor :segment_filters
|
@@ -1788,31 +1716,19 @@ module Google
|
|
1788
1716
|
end
|
1789
1717
|
end
|
1790
1718
|
|
1791
|
-
# SegmentFilter defines the segment to be either a simple or a sequence
|
1792
|
-
#
|
1793
|
-
#
|
1794
|
-
#
|
1719
|
+
# SegmentFilter defines the segment to be either a simple or a sequence segment.
|
1720
|
+
# A simple segment condition contains dimension and metric conditions to select
|
1721
|
+
# the sessions or users. A sequence segment condition can be used to select
|
1722
|
+
# users or sessions based on sequential conditions.
|
1795
1723
|
class SegmentFilter
|
1796
1724
|
include Google::Apis::Core::Hashable
|
1797
1725
|
|
1798
|
-
# If true, match the complement of simple or sequence segment.
|
1799
|
-
#
|
1800
|
-
#
|
1801
|
-
# "
|
1802
|
-
# "
|
1803
|
-
#
|
1804
|
-
# "orFiltersForSegment": [`
|
1805
|
-
# "segmentFilterClauses":[`
|
1806
|
-
# "dimensionFilter": `
|
1807
|
-
# "dimensionName": "ga:city",
|
1808
|
-
# "expressions": ["New York"]
|
1809
|
-
# `
|
1810
|
-
# `]
|
1811
|
-
# `]
|
1812
|
-
# `,
|
1813
|
-
# "not": "True"
|
1814
|
-
# `]
|
1815
|
-
# `,
|
1726
|
+
# If true, match the complement of simple or sequence segment. For example, to
|
1727
|
+
# match all visits not from "New York", we can define the segment as follows: "
|
1728
|
+
# sessionSegment": ` "segmentFilters": [` "simpleSegment" :` "
|
1729
|
+
# orFiltersForSegment": [` "segmentFilterClauses":[` "dimensionFilter": ` "
|
1730
|
+
# dimensionName": "ga:city", "expressions": ["New York"] ` `] `] `, "not": "True"
|
1731
|
+
# `] `,
|
1816
1732
|
# Corresponds to the JSON property `not`
|
1817
1733
|
# @return [Boolean]
|
1818
1734
|
attr_accessor :not
|
@@ -1825,8 +1741,8 @@ module Google
|
|
1825
1741
|
# @return [Google::Apis::AnalyticsreportingV4::SequenceSegment]
|
1826
1742
|
attr_accessor :sequence_segment
|
1827
1743
|
|
1828
|
-
# A Simple segment conditions consist of one or more dimension/metric
|
1829
|
-
#
|
1744
|
+
# A Simple segment conditions consist of one or more dimension/metric conditions
|
1745
|
+
# that can be combined.
|
1830
1746
|
# Corresponds to the JSON property `simpleSegment`
|
1831
1747
|
# @return [Google::Apis::AnalyticsreportingV4::SimpleSegment]
|
1832
1748
|
attr_accessor :simple_segment
|
@@ -1843,8 +1759,8 @@ module Google
|
|
1843
1759
|
end
|
1844
1760
|
end
|
1845
1761
|
|
1846
|
-
# Filter Clause to be used in a segment definition, can be wither a metric or
|
1847
|
-
#
|
1762
|
+
# Filter Clause to be used in a segment definition, can be wither a metric or a
|
1763
|
+
# dimension filter.
|
1848
1764
|
class SegmentFilterClause
|
1849
1765
|
include Google::Apis::Core::Hashable
|
1850
1766
|
|
@@ -1891,22 +1807,22 @@ module Google
|
|
1891
1807
|
# @return [String]
|
1892
1808
|
attr_accessor :max_comparison_value
|
1893
1809
|
|
1894
|
-
# The metric that will be filtered on. A `metricFilter` must contain a
|
1895
|
-
#
|
1810
|
+
# The metric that will be filtered on. A `metricFilter` must contain a metric
|
1811
|
+
# name.
|
1896
1812
|
# Corresponds to the JSON property `metricName`
|
1897
1813
|
# @return [String]
|
1898
1814
|
attr_accessor :metric_name
|
1899
1815
|
|
1900
|
-
# Specifies is the operation to perform to compare the metric. The default
|
1901
|
-
#
|
1816
|
+
# Specifies is the operation to perform to compare the metric. The default is `
|
1817
|
+
# EQUAL`.
|
1902
1818
|
# Corresponds to the JSON property `operator`
|
1903
1819
|
# @return [String]
|
1904
1820
|
attr_accessor :operator
|
1905
1821
|
|
1906
|
-
# Scope for a metric defines the level at which that metric is defined.
|
1907
|
-
# specified metric scope must be equal to or greater than its primary scope
|
1908
|
-
#
|
1909
|
-
#
|
1822
|
+
# Scope for a metric defines the level at which that metric is defined. The
|
1823
|
+
# specified metric scope must be equal to or greater than its primary scope as
|
1824
|
+
# defined in the data model. The primary scope is defined by if the segment is
|
1825
|
+
# selecting users or sessions.
|
1910
1826
|
# Corresponds to the JSON property `scope`
|
1911
1827
|
# @return [String]
|
1912
1828
|
attr_accessor :scope
|
@@ -1929,14 +1845,14 @@ module Google
|
|
1929
1845
|
class SegmentSequenceStep
|
1930
1846
|
include Google::Apis::Core::Hashable
|
1931
1847
|
|
1932
|
-
# Specifies if the step immediately precedes or can be any time before the
|
1933
|
-
#
|
1848
|
+
# Specifies if the step immediately precedes or can be any time before the next
|
1849
|
+
# step.
|
1934
1850
|
# Corresponds to the JSON property `matchType`
|
1935
1851
|
# @return [String]
|
1936
1852
|
attr_accessor :match_type
|
1937
1853
|
|
1938
|
-
# A sequence is specified with a list of Or grouped filters which are
|
1939
|
-
#
|
1854
|
+
# A sequence is specified with a list of Or grouped filters which are combined
|
1855
|
+
# with `AND` operator.
|
1940
1856
|
# Corresponds to the JSON property `orFiltersForSegment`
|
1941
1857
|
# @return [Array<Google::Apis::AnalyticsreportingV4::OrFiltersForSegment>]
|
1942
1858
|
attr_accessor :or_filters_for_segment
|
@@ -1958,8 +1874,8 @@ module Google
|
|
1958
1874
|
class SequenceSegment
|
1959
1875
|
include Google::Apis::Core::Hashable
|
1960
1876
|
|
1961
|
-
# If set, first step condition must match the first hit of the visitor (in
|
1962
|
-
#
|
1877
|
+
# If set, first step condition must match the first hit of the visitor (in the
|
1878
|
+
# date range).
|
1963
1879
|
# Corresponds to the JSON property `firstStepShouldMatchFirstHit`
|
1964
1880
|
# @return [Boolean]
|
1965
1881
|
attr_accessor :first_step_should_match_first_hit
|
@@ -1981,8 +1897,8 @@ module Google
|
|
1981
1897
|
end
|
1982
1898
|
end
|
1983
1899
|
|
1984
|
-
# A Simple segment conditions consist of one or more dimension/metric
|
1985
|
-
#
|
1900
|
+
# A Simple segment conditions consist of one or more dimension/metric conditions
|
1901
|
+
# that can be combined.
|
1986
1902
|
class SimpleSegment
|
1987
1903
|
include Google::Apis::Core::Hashable
|
1988
1904
|
|
@@ -2077,9 +1993,9 @@ module Google
|
|
2077
1993
|
# @return [Array<Google::Apis::AnalyticsreportingV4::Activity>]
|
2078
1994
|
attr_accessor :activities
|
2079
1995
|
|
2080
|
-
# The data source of a hit. By default, hits sent from analytics.js are
|
2081
|
-
#
|
2082
|
-
#
|
1996
|
+
# The data source of a hit. By default, hits sent from analytics.js are reported
|
1997
|
+
# as "web" and hits sent from the mobile SDKs are reported as "app". These
|
1998
|
+
# values can be overridden in the Measurement Protocol.
|
2083
1999
|
# Corresponds to the JSON property `dataSource`
|
2084
2000
|
# @return [String]
|
2085
2001
|
attr_accessor :data_source
|