google-api-client 0.11.1 → 0.11.2

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.
Files changed (252) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/api_names.yaml +42335 -1
  4. data/generated/google/apis/acceleratedmobilepageurl_v1.rb +3 -3
  5. data/generated/google/apis/acceleratedmobilepageurl_v1/classes.rb +28 -28
  6. data/generated/google/apis/acceleratedmobilepageurl_v1/representations.rb +12 -12
  7. data/generated/google/apis/acceleratedmobilepageurl_v1/service.rb +2 -2
  8. data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
  9. data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +757 -757
  10. data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +162 -162
  11. data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +48 -48
  12. data/generated/google/apis/admin_directory_v1.rb +1 -1
  13. data/generated/google/apis/admin_directory_v1/classes.rb +75 -7
  14. data/generated/google/apis/admin_directory_v1/representations.rb +20 -0
  15. data/generated/google/apis/admin_directory_v1/service.rb +61 -61
  16. data/generated/google/apis/adsense_v1_4.rb +1 -1
  17. data/generated/google/apis/adsensehost_v4_1.rb +1 -1
  18. data/generated/google/apis/analyticsreporting_v4.rb +1 -1
  19. data/generated/google/apis/analyticsreporting_v4/classes.rb +403 -403
  20. data/generated/google/apis/analyticsreporting_v4/representations.rb +108 -108
  21. data/generated/google/apis/androidenterprise_v1.rb +1 -1
  22. data/generated/google/apis/androidenterprise_v1/classes.rb +36 -11
  23. data/generated/google/apis/androidenterprise_v1/representations.rb +2 -0
  24. data/generated/google/apis/androidpublisher_v2.rb +1 -1
  25. data/generated/google/apis/appengine_v1.rb +6 -5
  26. data/generated/google/apis/appengine_v1/classes.rb +1429 -1421
  27. data/generated/google/apis/appengine_v1/representations.rb +331 -331
  28. data/generated/google/apis/appengine_v1/service.rb +173 -168
  29. data/generated/google/apis/appstate_v1.rb +1 -1
  30. data/generated/google/apis/bigquery_v2.rb +1 -1
  31. data/generated/google/apis/calendar_v3.rb +1 -1
  32. data/generated/google/apis/classroom_v1.rb +1 -1
  33. data/generated/google/apis/cloudbilling_v1.rb +1 -1
  34. data/generated/google/apis/cloudbuild_v1.rb +1 -1
  35. data/generated/google/apis/cloudbuild_v1/classes.rb +624 -618
  36. data/generated/google/apis/cloudbuild_v1/representations.rb +126 -125
  37. data/generated/google/apis/cloudbuild_v1/service.rb +87 -87
  38. data/generated/google/apis/clouddebugger_v2.rb +4 -4
  39. data/generated/google/apis/clouddebugger_v2/classes.rb +267 -267
  40. data/generated/google/apis/clouddebugger_v2/representations.rb +83 -83
  41. data/generated/google/apis/clouddebugger_v2/service.rb +137 -137
  42. data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
  43. data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +131 -131
  44. data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +28 -28
  45. data/generated/google/apis/clouderrorreporting_v1beta1/service.rb +17 -17
  46. data/generated/google/apis/cloudfunctions_v1.rb +1 -4
  47. data/generated/google/apis/cloudfunctions_v1/classes.rb +7 -47
  48. data/generated/google/apis/cloudfunctions_v1/representations.rb +1 -17
  49. data/generated/google/apis/cloudfunctions_v1/service.rb +0 -30
  50. data/generated/google/apis/cloudkms_v1.rb +1 -1
  51. data/generated/google/apis/cloudkms_v1/classes.rb +625 -625
  52. data/generated/google/apis/cloudkms_v1/representations.rb +132 -132
  53. data/generated/google/apis/cloudkms_v1/service.rb +272 -272
  54. data/generated/google/apis/cloudmonitoring_v2beta2.rb +1 -1
  55. data/generated/google/apis/cloudresourcemanager_v1.rb +4 -4
  56. data/generated/google/apis/cloudresourcemanager_v1/classes.rb +242 -242
  57. data/generated/google/apis/cloudresourcemanager_v1/representations.rb +43 -43
  58. data/generated/google/apis/cloudresourcemanager_v1/service.rb +505 -505
  59. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +4 -4
  60. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +172 -172
  61. data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +39 -39
  62. data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +310 -310
  63. data/generated/google/apis/cloudtrace_v1.rb +1 -1
  64. data/generated/google/apis/cloudtrace_v1/classes.rb +96 -69
  65. data/generated/google/apis/cloudtrace_v1/representations.rb +16 -16
  66. data/generated/google/apis/cloudtrace_v1/service.rb +42 -15
  67. data/generated/google/apis/compute_beta.rb +1 -1
  68. data/generated/google/apis/compute_beta/classes.rb +194 -25
  69. data/generated/google/apis/compute_beta/representations.rb +42 -0
  70. data/generated/google/apis/compute_beta/service.rb +196 -100
  71. data/generated/google/apis/compute_v1.rb +1 -1
  72. data/generated/google/apis/compute_v1/classes.rb +69 -18
  73. data/generated/google/apis/compute_v1/representations.rb +16 -0
  74. data/generated/google/apis/compute_v1/service.rb +84 -26
  75. data/generated/google/apis/container_v1.rb +3 -3
  76. data/generated/google/apis/container_v1/classes.rb +794 -586
  77. data/generated/google/apis/container_v1/representations.rb +202 -118
  78. data/generated/google/apis/container_v1/service.rb +396 -167
  79. data/generated/google/apis/content_v2.rb +1 -1
  80. data/generated/google/apis/content_v2/service.rb +4 -4
  81. data/generated/google/apis/dataproc_v1.rb +1 -1
  82. data/generated/google/apis/dataproc_v1/classes.rb +487 -484
  83. data/generated/google/apis/dataproc_v1/representations.rb +83 -83
  84. data/generated/google/apis/dataproc_v1/service.rb +299 -297
  85. data/generated/google/apis/datastore_v1.rb +1 -1
  86. data/generated/google/apis/datastore_v1/classes.rb +703 -703
  87. data/generated/google/apis/datastore_v1/representations.rb +148 -148
  88. data/generated/google/apis/datastore_v1/service.rb +62 -62
  89. data/generated/google/apis/deploymentmanager_v2.rb +1 -1
  90. data/generated/google/apis/deploymentmanager_v2/classes.rb +7 -5
  91. data/generated/google/apis/dfareporting_v2_6.rb +1 -1
  92. data/generated/google/apis/dfareporting_v2_6/classes.rb +66 -53
  93. data/generated/google/apis/dfareporting_v2_6/service.rb +30 -30
  94. data/generated/google/apis/dfareporting_v2_7.rb +1 -1
  95. data/generated/google/apis/dfareporting_v2_7/classes.rb +69 -55
  96. data/generated/google/apis/dfareporting_v2_7/service.rb +38 -37
  97. data/generated/google/apis/dfareporting_v2_8.rb +40 -0
  98. data/generated/google/apis/dfareporting_v2_8/classes.rb +12046 -0
  99. data/generated/google/apis/dfareporting_v2_8/representations.rb +4310 -0
  100. data/generated/google/apis/dfareporting_v2_8/service.rb +9135 -0
  101. data/generated/google/apis/dns_v1.rb +1 -1
  102. data/generated/google/apis/dns_v2beta1.rb +1 -1
  103. data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
  104. data/generated/google/apis/drive_v2.rb +1 -1
  105. data/generated/google/apis/drive_v2/classes.rb +15 -0
  106. data/generated/google/apis/drive_v2/representations.rb +2 -0
  107. data/generated/google/apis/drive_v2/service.rb +2 -1
  108. data/generated/google/apis/drive_v3.rb +1 -1
  109. data/generated/google/apis/drive_v3/classes.rb +16 -0
  110. data/generated/google/apis/drive_v3/representations.rb +2 -0
  111. data/generated/google/apis/drive_v3/service.rb +2 -1
  112. data/generated/google/apis/firebasedynamiclinks_v1.rb +2 -3
  113. data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +159 -159
  114. data/generated/google/apis/firebasedynamiclinks_v1/representations.rb +55 -55
  115. data/generated/google/apis/firebasedynamiclinks_v1/service.rb +5 -6
  116. data/generated/google/apis/firebaserules_v1.rb +1 -1
  117. data/generated/google/apis/firebaserules_v1/classes.rb +73 -73
  118. data/generated/google/apis/firebaserules_v1/representations.rb +25 -25
  119. data/generated/google/apis/firebaserules_v1/service.rb +118 -118
  120. data/generated/google/apis/fusiontables_v2.rb +1 -1
  121. data/generated/google/apis/games_configuration_v1configuration.rb +1 -1
  122. data/generated/google/apis/games_management_v1management.rb +1 -1
  123. data/generated/google/apis/games_v1.rb +1 -1
  124. data/generated/google/apis/genomics_v1.rb +1 -1
  125. data/generated/google/apis/genomics_v1/classes.rb +920 -920
  126. data/generated/google/apis/genomics_v1/representations.rb +202 -202
  127. data/generated/google/apis/genomics_v1/service.rb +1092 -1092
  128. data/generated/google/apis/gmail_v1.rb +1 -1
  129. data/generated/google/apis/iam_v1.rb +1 -1
  130. data/generated/google/apis/iam_v1/classes.rb +455 -435
  131. data/generated/google/apis/iam_v1/representations.rb +96 -93
  132. data/generated/google/apis/iam_v1/service.rb +157 -157
  133. data/generated/google/apis/identitytoolkit_v3.rb +1 -1
  134. data/generated/google/apis/identitytoolkit_v3/classes.rb +12 -0
  135. data/generated/google/apis/identitytoolkit_v3/representations.rb +2 -0
  136. data/generated/google/apis/kgsearch_v1/classes.rb +6 -6
  137. data/generated/google/apis/kgsearch_v1/representations.rb +1 -1
  138. data/generated/google/apis/kgsearch_v1/service.rb +9 -9
  139. data/generated/google/apis/language_v1.rb +1 -1
  140. data/generated/google/apis/language_v1/classes.rb +455 -455
  141. data/generated/google/apis/language_v1/representations.rb +102 -102
  142. data/generated/google/apis/language_v1/service.rb +42 -42
  143. data/generated/google/apis/language_v1beta1.rb +1 -1
  144. data/generated/google/apis/language_v1beta1/classes.rb +216 -215
  145. data/generated/google/apis/language_v1beta1/representations.rb +75 -75
  146. data/generated/google/apis/language_v1beta1/service.rb +45 -45
  147. data/generated/google/apis/logging_v2.rb +1 -1
  148. data/generated/google/apis/logging_v2/classes.rb +908 -895
  149. data/generated/google/apis/logging_v2/representations.rb +121 -120
  150. data/generated/google/apis/logging_v2/service.rb +489 -489
  151. data/generated/google/apis/logging_v2beta1.rb +4 -4
  152. data/generated/google/apis/logging_v2beta1/classes.rb +928 -915
  153. data/generated/google/apis/logging_v2beta1/representations.rb +121 -120
  154. data/generated/google/apis/logging_v2beta1/service.rb +249 -249
  155. data/generated/google/apis/manufacturers_v1.rb +1 -1
  156. data/generated/google/apis/manufacturers_v1/classes.rb +294 -294
  157. data/generated/google/apis/manufacturers_v1/representations.rb +84 -84
  158. data/generated/google/apis/manufacturers_v1/service.rb +8 -8
  159. data/generated/google/apis/mirror_v1.rb +1 -1
  160. data/generated/google/apis/ml_v1.rb +1 -1
  161. data/generated/google/apis/ml_v1/classes.rb +1186 -1183
  162. data/generated/google/apis/ml_v1/representations.rb +177 -177
  163. data/generated/google/apis/ml_v1/service.rb +244 -244
  164. data/generated/google/apis/monitoring_v3.rb +1 -1
  165. data/generated/google/apis/monitoring_v3/classes.rb +866 -866
  166. data/generated/google/apis/monitoring_v3/representations.rb +163 -163
  167. data/generated/google/apis/monitoring_v3/service.rb +355 -316
  168. data/generated/google/apis/oauth2_v2.rb +1 -1
  169. data/generated/google/apis/partners_v2.rb +1 -1
  170. data/generated/google/apis/partners_v2/classes.rb +1499 -1499
  171. data/generated/google/apis/partners_v2/representations.rb +368 -368
  172. data/generated/google/apis/partners_v2/service.rb +512 -512
  173. data/generated/google/apis/people_v1.rb +10 -10
  174. data/generated/google/apis/people_v1/classes.rb +544 -423
  175. data/generated/google/apis/people_v1/representations.rb +127 -109
  176. data/generated/google/apis/people_v1/service.rb +8 -8
  177. data/generated/google/apis/plus_domains_v1.rb +1 -1
  178. data/generated/google/apis/plus_v1.rb +1 -1
  179. data/generated/google/apis/proximitybeacon_v1beta1.rb +1 -1
  180. data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +200 -200
  181. data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +41 -41
  182. data/generated/google/apis/proximitybeacon_v1beta1/service.rb +80 -80
  183. data/generated/google/apis/pubsub_v1.rb +1 -1
  184. data/generated/google/apis/pubsub_v1/classes.rb +377 -377
  185. data/generated/google/apis/pubsub_v1/representations.rb +82 -82
  186. data/generated/google/apis/pubsub_v1/service.rb +93 -93
  187. data/generated/google/apis/runtimeconfig_v1.rb +6 -4
  188. data/generated/google/apis/runtimeconfig_v1/classes.rb +22 -22
  189. data/generated/google/apis/runtimeconfig_v1/representations.rb +2 -2
  190. data/generated/google/apis/runtimeconfig_v1/service.rb +57 -55
  191. data/generated/google/apis/script_v1.rb +14 -14
  192. data/generated/google/apis/script_v1/classes.rb +113 -58
  193. data/generated/google/apis/script_v1/representations.rb +43 -14
  194. data/generated/google/apis/script_v1/service.rb +6 -6
  195. data/generated/google/apis/searchconsole_v1.rb +1 -1
  196. data/generated/google/apis/searchconsole_v1/classes.rb +67 -67
  197. data/generated/google/apis/searchconsole_v1/representations.rb +29 -29
  198. data/generated/google/apis/searchconsole_v1/service.rb +6 -6
  199. data/generated/google/apis/servicecontrol_v1.rb +4 -4
  200. data/generated/google/apis/servicecontrol_v1/classes.rb +1125 -1125
  201. data/generated/google/apis/servicecontrol_v1/representations.rb +213 -213
  202. data/generated/google/apis/servicecontrol_v1/service.rb +92 -92
  203. data/generated/google/apis/servicemanagement_v1.rb +1 -1
  204. data/generated/google/apis/servicemanagement_v1/classes.rb +3364 -3622
  205. data/generated/google/apis/servicemanagement_v1/representations.rb +546 -530
  206. data/generated/google/apis/servicemanagement_v1/service.rb +262 -152
  207. data/generated/google/apis/serviceuser_v1.rb +4 -4
  208. data/generated/google/apis/serviceuser_v1/classes.rb +2616 -2874
  209. data/generated/google/apis/serviceuser_v1/representations.rb +294 -278
  210. data/generated/google/apis/serviceuser_v1/service.rb +19 -19
  211. data/generated/google/apis/sheets_v4.rb +4 -1
  212. data/generated/google/apis/sheets_v4/classes.rb +4315 -4313
  213. data/generated/google/apis/sheets_v4/representations.rb +858 -858
  214. data/generated/google/apis/sheets_v4/service.rb +115 -115
  215. data/generated/google/apis/slides_v1.rb +1 -1
  216. data/generated/google/apis/slides_v1/classes.rb +2890 -2890
  217. data/generated/google/apis/slides_v1/representations.rb +638 -638
  218. data/generated/google/apis/slides_v1/service.rb +36 -36
  219. data/generated/google/apis/sourcerepo_v1.rb +1 -1
  220. data/generated/google/apis/sourcerepo_v1/classes.rb +283 -283
  221. data/generated/google/apis/sourcerepo_v1/representations.rb +67 -67
  222. data/generated/google/apis/sourcerepo_v1/service.rb +88 -88
  223. data/generated/google/apis/spanner_v1.rb +1 -1
  224. data/generated/google/apis/spanner_v1/classes.rb +2258 -2233
  225. data/generated/google/apis/spanner_v1/representations.rb +325 -325
  226. data/generated/google/apis/spanner_v1/service.rb +466 -466
  227. data/generated/google/apis/speech_v1beta1.rb +2 -2
  228. data/generated/google/apis/speech_v1beta1/classes.rb +97 -97
  229. data/generated/google/apis/speech_v1beta1/representations.rb +29 -29
  230. data/generated/google/apis/speech_v1beta1/service.rb +49 -49
  231. data/generated/google/apis/storage_v1.rb +1 -1
  232. data/generated/google/apis/storagetransfer_v1.rb +1 -1
  233. data/generated/google/apis/storagetransfer_v1/classes.rb +786 -786
  234. data/generated/google/apis/storagetransfer_v1/representations.rb +133 -133
  235. data/generated/google/apis/storagetransfer_v1/service.rb +30 -30
  236. data/generated/google/apis/surveys_v2.rb +1 -1
  237. data/generated/google/apis/surveys_v2/classes.rb +0 -12
  238. data/generated/google/apis/surveys_v2/representations.rb +0 -4
  239. data/generated/google/apis/toolresults_v1beta3.rb +1 -1
  240. data/generated/google/apis/vision_v1.rb +1 -1
  241. data/generated/google/apis/vision_v1/classes.rb +1301 -1302
  242. data/generated/google/apis/vision_v1/representations.rb +183 -183
  243. data/generated/google/apis/youtube_analytics_v1.rb +1 -1
  244. data/generated/google/apis/youtube_partner_v1.rb +1 -1
  245. data/generated/google/apis/youtube_partner_v1/classes.rb +10 -0
  246. data/generated/google/apis/youtube_partner_v1/representations.rb +1 -0
  247. data/generated/google/apis/youtubereporting_v1.rb +1 -1
  248. data/generated/google/apis/youtubereporting_v1/classes.rb +64 -64
  249. data/generated/google/apis/youtubereporting_v1/representations.rb +12 -12
  250. data/generated/google/apis/youtubereporting_v1/service.rb +94 -94
  251. data/lib/google/apis/version.rb +1 -1
  252. metadata +7 -3
@@ -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 = '20170401'
28
+ REVISION = '20170503'
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 = '20170401'
29
+ REVISION = '20170502'
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 = '20170309'
28
+ REVISION = '20170427'
29
29
 
30
30
  # View your Google Analytics data
31
31
  AUTH_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/analytics.readonly'
@@ -22,22 +22,95 @@ module Google
22
22
  module Apis
23
23
  module AnalyticsreportingV4
24
24
 
25
- # The segment definition, if the report needs to be segmented.
26
- # A Segment is a subset of the Analytics data. For example, of the entire
27
- # set of users, one Segment might be users from a particular country or city.
28
- class Segment
25
+ # SegmentFilter defines the segment to be either a simple or a sequence
26
+ # segment. A simple segment condition contains dimension and metric conditions
27
+ # to select the sessions or users. A sequence segment condition can be used to
28
+ # select users or sessions based on sequential conditions.
29
+ class SegmentFilter
29
30
  include Google::Apis::Core::Hashable
30
31
 
31
- # Dynamic segment definition for defining the segment within the request.
32
- # A segment can select users, sessions or both.
33
- # Corresponds to the JSON property `dynamicSegment`
34
- # @return [Google::Apis::AnalyticsreportingV4::DynamicSegment]
35
- attr_accessor :dynamic_segment
32
+ # If true, match the complement of simple or sequence segment.
33
+ # For example, to match all visits not from "New York", we can define the
34
+ # segment as follows:
35
+ # "sessionSegment": `
36
+ # "segmentFilters": [`
37
+ # "simpleSegment" :`
38
+ # "orFiltersForSegment": [`
39
+ # "segmentFilterClauses":[`
40
+ # "dimensionFilter": `
41
+ # "dimensionName": "ga:city",
42
+ # "expressions": ["New York"]
43
+ # `
44
+ # `]
45
+ # `]
46
+ # `,
47
+ # "not": "True"
48
+ # `]
49
+ # `,
50
+ # Corresponds to the JSON property `not`
51
+ # @return [Boolean]
52
+ attr_accessor :not
53
+ alias_method :not?, :not
36
54
 
37
- # The segment ID of a built-in or custom segment, for example `gaid::-3`.
38
- # Corresponds to the JSON property `segmentId`
55
+ # A Simple segment conditions consist of one or more dimension/metric
56
+ # conditions that can be combined.
57
+ # Corresponds to the JSON property `simpleSegment`
58
+ # @return [Google::Apis::AnalyticsreportingV4::SimpleSegment]
59
+ attr_accessor :simple_segment
60
+
61
+ # Sequence conditions consist of one or more steps, where each step is defined
62
+ # by one or more dimension/metric conditions. Multiple steps can be combined
63
+ # with special sequence operators.
64
+ # Corresponds to the JSON property `sequenceSegment`
65
+ # @return [Google::Apis::AnalyticsreportingV4::SequenceSegment]
66
+ attr_accessor :sequence_segment
67
+
68
+ def initialize(**args)
69
+ update!(**args)
70
+ end
71
+
72
+ # Update properties of this object
73
+ def update!(**args)
74
+ @not = args[:not] if args.key?(:not)
75
+ @simple_segment = args[:simple_segment] if args.key?(:simple_segment)
76
+ @sequence_segment = args[:sequence_segment] if args.key?(:sequence_segment)
77
+ end
78
+ end
79
+
80
+ # SegmentDefinition defines the segment to be a set of SegmentFilters which
81
+ # are combined together with a logical `AND` operation.
82
+ class SegmentDefinition
83
+ include Google::Apis::Core::Hashable
84
+
85
+ # A segment is defined by a set of segment filters which are combined
86
+ # together with a logical `AND` operation.
87
+ # Corresponds to the JSON property `segmentFilters`
88
+ # @return [Array<Google::Apis::AnalyticsreportingV4::SegmentFilter>]
89
+ attr_accessor :segment_filters
90
+
91
+ def initialize(**args)
92
+ update!(**args)
93
+ end
94
+
95
+ # Update properties of this object
96
+ def update!(**args)
97
+ @segment_filters = args[:segment_filters] if args.key?(:segment_filters)
98
+ end
99
+ end
100
+
101
+ # Header for the metrics.
102
+ class MetricHeaderEntry
103
+ include Google::Apis::Core::Hashable
104
+
105
+ # The name of the header.
106
+ # Corresponds to the JSON property `name`
39
107
  # @return [String]
40
- attr_accessor :segment_id
108
+ attr_accessor :name
109
+
110
+ # The type of the metric, for example `INTEGER`.
111
+ # Corresponds to the JSON property `type`
112
+ # @return [String]
113
+ attr_accessor :type
41
114
 
42
115
  def initialize(**args)
43
116
  update!(**args)
@@ -45,32 +118,138 @@ module Google
45
118
 
46
119
  # Update properties of this object
47
120
  def update!(**args)
48
- @dynamic_segment = args[:dynamic_segment] if args.key?(:dynamic_segment)
49
- @segment_id = args[:segment_id] if args.key?(:segment_id)
121
+ @name = args[:name] if args.key?(:name)
122
+ @type = args[:type] if args.key?(:type)
50
123
  end
51
124
  end
52
125
 
53
- # Specifies the sorting options.
54
- class OrderBy
126
+ # The data part of the report.
127
+ class ReportData
55
128
  include Google::Apis::Core::Hashable
56
129
 
57
- # The sorting order for the field.
58
- # Corresponds to the JSON property `sortOrder`
130
+ # The last time the data in the report was refreshed. All the hits received
131
+ # before this timestamp are included in the calculation of the report.
132
+ # Corresponds to the JSON property `dataLastRefreshed`
59
133
  # @return [String]
60
- attr_accessor :sort_order
134
+ attr_accessor :data_last_refreshed
61
135
 
62
- # The field which to sort by. The default sort order is ascending. Example:
63
- # `ga:browser`.
64
- # Note, that you can only specify one field for sort here. For example,
65
- # `ga:browser, ga:city` is not valid.
66
- # Corresponds to the JSON property `fieldName`
136
+ # Minimum and maximum values seen over all matching rows. These are both
137
+ # empty when `hideValueRanges` in the request is false, or when
138
+ # rowCount is zero.
139
+ # Corresponds to the JSON property `maximums`
140
+ # @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
141
+ attr_accessor :maximums
142
+
143
+ # If the results are
144
+ # [sampled](https://support.google.com/analytics/answer/2637192),
145
+ # this returns the total number of
146
+ # samples present, one entry per date range. If the results are not sampled
147
+ # this field will not be defined. See
148
+ # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
149
+ # for details.
150
+ # Corresponds to the JSON property `samplingSpaceSizes`
151
+ # @return [Array<Fixnum>]
152
+ attr_accessor :sampling_space_sizes
153
+
154
+ # Minimum and maximum values seen over all matching rows. These are both
155
+ # empty when `hideValueRanges` in the request is false, or when
156
+ # rowCount is zero.
157
+ # Corresponds to the JSON property `minimums`
158
+ # @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
159
+ attr_accessor :minimums
160
+
161
+ # For each requested date range, for the set of all rows that match
162
+ # the query, every requested value format gets a total. The total
163
+ # for a value format is computed by first totaling the metrics
164
+ # mentioned in the value format and then evaluating the value
165
+ # format as a scalar expression. E.g., The "totals" for
166
+ # `3 / (ga:sessions + 2)` we compute
167
+ # `3 / ((sum of all relevant ga:sessions) + 2)`.
168
+ # Totals are computed before pagination.
169
+ # Corresponds to the JSON property `totals`
170
+ # @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
171
+ attr_accessor :totals
172
+
173
+ # If the results are
174
+ # [sampled](https://support.google.com/analytics/answer/2637192),
175
+ # this returns the total number of samples read, one entry per date range.
176
+ # If the results are not sampled this field will not be defined. See
177
+ # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
178
+ # for details.
179
+ # Corresponds to the JSON property `samplesReadCounts`
180
+ # @return [Array<Fixnum>]
181
+ attr_accessor :samples_read_counts
182
+
183
+ # Total number of matching rows for this query.
184
+ # Corresponds to the JSON property `rowCount`
185
+ # @return [Fixnum]
186
+ attr_accessor :row_count
187
+
188
+ # There's one ReportRow for every unique combination of dimensions.
189
+ # Corresponds to the JSON property `rows`
190
+ # @return [Array<Google::Apis::AnalyticsreportingV4::ReportRow>]
191
+ attr_accessor :rows
192
+
193
+ # Indicates if response to this request is golden or not. Data is
194
+ # golden when the exact same request will not produce any new results if
195
+ # asked at a later point in time.
196
+ # Corresponds to the JSON property `isDataGolden`
197
+ # @return [Boolean]
198
+ attr_accessor :is_data_golden
199
+ alias_method :is_data_golden?, :is_data_golden
200
+
201
+ def initialize(**args)
202
+ update!(**args)
203
+ end
204
+
205
+ # Update properties of this object
206
+ def update!(**args)
207
+ @data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed)
208
+ @maximums = args[:maximums] if args.key?(:maximums)
209
+ @sampling_space_sizes = args[:sampling_space_sizes] if args.key?(:sampling_space_sizes)
210
+ @minimums = args[:minimums] if args.key?(:minimums)
211
+ @totals = args[:totals] if args.key?(:totals)
212
+ @samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts)
213
+ @row_count = args[:row_count] if args.key?(:row_count)
214
+ @rows = args[:rows] if args.key?(:rows)
215
+ @is_data_golden = args[:is_data_golden] if args.key?(:is_data_golden)
216
+ end
217
+ end
218
+
219
+ # Dimension filter specifies the filtering options on a dimension.
220
+ class DimensionFilter
221
+ include Google::Apis::Core::Hashable
222
+
223
+ # Logical `NOT` operator. If this boolean is set to true, then the matching
224
+ # dimension values will be excluded in the report. The default is false.
225
+ # Corresponds to the JSON property `not`
226
+ # @return [Boolean]
227
+ attr_accessor :not
228
+ alias_method :not?, :not
229
+
230
+ # Strings or regular expression to match against. Only the first value of
231
+ # the list is used for comparison unless the operator is `IN_LIST`.
232
+ # If `IN_LIST` operator, then the entire list is used to filter the
233
+ # dimensions as explained in the description of the `IN_LIST` operator.
234
+ # Corresponds to the JSON property `expressions`
235
+ # @return [Array<String>]
236
+ attr_accessor :expressions
237
+
238
+ # Should the match be case sensitive? Default is false.
239
+ # Corresponds to the JSON property `caseSensitive`
240
+ # @return [Boolean]
241
+ attr_accessor :case_sensitive
242
+ alias_method :case_sensitive?, :case_sensitive
243
+
244
+ # The dimension to filter on. A DimensionFilter must contain a dimension.
245
+ # Corresponds to the JSON property `dimensionName`
67
246
  # @return [String]
68
- attr_accessor :field_name
247
+ attr_accessor :dimension_name
69
248
 
70
- # The order type. The default orderType is `VALUE`.
71
- # Corresponds to the JSON property `orderType`
249
+ # How to match the dimension to the expression. The default is REGEXP.
250
+ # Corresponds to the JSON property `operator`
72
251
  # @return [String]
73
- attr_accessor :order_type
252
+ attr_accessor :operator
74
253
 
75
254
  def initialize(**args)
76
255
  update!(**args)
@@ -78,9 +257,11 @@ module Google
78
257
 
79
258
  # Update properties of this object
80
259
  def update!(**args)
81
- @sort_order = args[:sort_order] if args.key?(:sort_order)
82
- @field_name = args[:field_name] if args.key?(:field_name)
83
- @order_type = args[:order_type] if args.key?(:order_type)
260
+ @not = args[:not] if args.key?(:not)
261
+ @expressions = args[:expressions] if args.key?(:expressions)
262
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
263
+ @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
264
+ @operator = args[:operator] if args.key?(:operator)
84
265
  end
85
266
  end
86
267
 
@@ -88,6 +269,22 @@ module Google
88
269
  class SegmentDimensionFilter
89
270
  include Google::Apis::Core::Hashable
90
271
 
272
+ # The list of expressions, only the first element is used for all operators
273
+ # Corresponds to the JSON property `expressions`
274
+ # @return [Array<String>]
275
+ attr_accessor :expressions
276
+
277
+ # Should the match be case sensitive, ignored for `IN_LIST` operator.
278
+ # Corresponds to the JSON property `caseSensitive`
279
+ # @return [Boolean]
280
+ attr_accessor :case_sensitive
281
+ alias_method :case_sensitive?, :case_sensitive
282
+
283
+ # Minimum comparison values for `BETWEEN` match type.
284
+ # Corresponds to the JSON property `minComparisonValue`
285
+ # @return [String]
286
+ attr_accessor :min_comparison_value
287
+
91
288
  # Maximum comparison values for `BETWEEN` match type.
92
289
  # Corresponds to the JSON property `maxComparisonValue`
93
290
  # @return [String]
@@ -101,23 +298,73 @@ module Google
101
298
  # The operator to use to match the dimension with the expressions.
102
299
  # Corresponds to the JSON property `operator`
103
300
  # @return [String]
104
- attr_accessor :operator
301
+ attr_accessor :operator
302
+
303
+ def initialize(**args)
304
+ update!(**args)
305
+ end
306
+
307
+ # Update properties of this object
308
+ def update!(**args)
309
+ @expressions = args[:expressions] if args.key?(:expressions)
310
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
311
+ @min_comparison_value = args[:min_comparison_value] if args.key?(:min_comparison_value)
312
+ @max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value)
313
+ @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
314
+ @operator = args[:operator] if args.key?(:operator)
315
+ end
316
+ end
317
+
318
+ # Specifies the sorting options.
319
+ class OrderBy
320
+ include Google::Apis::Core::Hashable
321
+
322
+ # The field which to sort by. The default sort order is ascending. Example:
323
+ # `ga:browser`.
324
+ # Note, that you can only specify one field for sort here. For example,
325
+ # `ga:browser, ga:city` is not valid.
326
+ # Corresponds to the JSON property `fieldName`
327
+ # @return [String]
328
+ attr_accessor :field_name
329
+
330
+ # The order type. The default orderType is `VALUE`.
331
+ # Corresponds to the JSON property `orderType`
332
+ # @return [String]
333
+ attr_accessor :order_type
334
+
335
+ # The sorting order for the field.
336
+ # Corresponds to the JSON property `sortOrder`
337
+ # @return [String]
338
+ attr_accessor :sort_order
105
339
 
106
- # The list of expressions, only the first element is used for all operators
107
- # Corresponds to the JSON property `expressions`
108
- # @return [Array<String>]
109
- attr_accessor :expressions
340
+ def initialize(**args)
341
+ update!(**args)
342
+ end
110
343
 
111
- # Should the match be case sensitive, ignored for `IN_LIST` operator.
112
- # Corresponds to the JSON property `caseSensitive`
113
- # @return [Boolean]
114
- attr_accessor :case_sensitive
115
- alias_method :case_sensitive?, :case_sensitive
344
+ # Update properties of this object
345
+ def update!(**args)
346
+ @field_name = args[:field_name] if args.key?(:field_name)
347
+ @order_type = args[:order_type] if args.key?(:order_type)
348
+ @sort_order = args[:sort_order] if args.key?(:sort_order)
349
+ end
350
+ end
116
351
 
117
- # Minimum comparison values for `BETWEEN` match type.
118
- # Corresponds to the JSON property `minComparisonValue`
352
+ # The segment definition, if the report needs to be segmented.
353
+ # A Segment is a subset of the Analytics data. For example, of the entire
354
+ # set of users, one Segment might be users from a particular country or city.
355
+ class Segment
356
+ include Google::Apis::Core::Hashable
357
+
358
+ # Dynamic segment definition for defining the segment within the request.
359
+ # A segment can select users, sessions or both.
360
+ # Corresponds to the JSON property `dynamicSegment`
361
+ # @return [Google::Apis::AnalyticsreportingV4::DynamicSegment]
362
+ attr_accessor :dynamic_segment
363
+
364
+ # The segment ID of a built-in or custom segment, for example `gaid::-3`.
365
+ # Corresponds to the JSON property `segmentId`
119
366
  # @return [String]
120
- attr_accessor :min_comparison_value
367
+ attr_accessor :segment_id
121
368
 
122
369
  def initialize(**args)
123
370
  update!(**args)
@@ -125,12 +372,8 @@ module Google
125
372
 
126
373
  # Update properties of this object
127
374
  def update!(**args)
128
- @max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value)
129
- @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
130
- @operator = args[:operator] if args.key?(:operator)
131
- @expressions = args[:expressions] if args.key?(:expressions)
132
- @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
133
- @min_comparison_value = args[:min_comparison_value] if args.key?(:min_comparison_value)
375
+ @dynamic_segment = args[:dynamic_segment] if args.key?(:dynamic_segment)
376
+ @segment_id = args[:segment_id] if args.key?(:segment_id)
134
377
  end
135
378
  end
136
379
 
@@ -167,6 +410,15 @@ module Google
167
410
  class Metric
168
411
  include Google::Apis::Core::Hashable
169
412
 
413
+ # An alias for the metric expression is an alternate name for the
414
+ # expression. The alias can be used for filtering and sorting. This field
415
+ # is optional and is useful if the expression is not a single metric but
416
+ # a complex expression which cannot be used in filtering and sorting.
417
+ # The alias is also used in the response column header.
418
+ # Corresponds to the JSON property `alias`
419
+ # @return [String]
420
+ attr_accessor :alias
421
+
170
422
  # A metric expression in the request. An expression is constructed from one
171
423
  # or more metrics and numbers. Accepted operators include: Plus (+), Minus
172
424
  # (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
@@ -185,24 +437,15 @@ module Google
185
437
  # @return [String]
186
438
  attr_accessor :formatting_type
187
439
 
188
- # An alias for the metric expression is an alternate name for the
189
- # expression. The alias can be used for filtering and sorting. This field
190
- # is optional and is useful if the expression is not a single metric but
191
- # a complex expression which cannot be used in filtering and sorting.
192
- # The alias is also used in the response column header.
193
- # Corresponds to the JSON property `alias`
194
- # @return [String]
195
- attr_accessor :alias
196
-
197
440
  def initialize(**args)
198
441
  update!(**args)
199
442
  end
200
443
 
201
444
  # Update properties of this object
202
445
  def update!(**args)
446
+ @alias = args[:alias] if args.key?(:alias)
203
447
  @expression = args[:expression] if args.key?(:expression)
204
448
  @formatting_type = args[:formatting_type] if args.key?(:formatting_type)
205
- @alias = args[:alias] if args.key?(:alias)
206
449
  end
207
450
  end
208
451
 
@@ -229,11 +472,6 @@ module Google
229
472
  class Report
230
473
  include Google::Apis::Core::Hashable
231
474
 
232
- # Column headers.
233
- # Corresponds to the JSON property `columnHeader`
234
- # @return [Google::Apis::AnalyticsreportingV4::ColumnHeader]
235
- attr_accessor :column_header
236
-
237
475
  # The data part of the report.
238
476
  # Corresponds to the JSON property `data`
239
477
  # @return [Google::Apis::AnalyticsreportingV4::ReportData]
@@ -244,15 +482,20 @@ module Google
244
482
  # @return [String]
245
483
  attr_accessor :next_page_token
246
484
 
485
+ # Column headers.
486
+ # Corresponds to the JSON property `columnHeader`
487
+ # @return [Google::Apis::AnalyticsreportingV4::ColumnHeader]
488
+ attr_accessor :column_header
489
+
247
490
  def initialize(**args)
248
491
  update!(**args)
249
492
  end
250
493
 
251
494
  # Update properties of this object
252
495
  def update!(**args)
253
- @column_header = args[:column_header] if args.key?(:column_header)
254
496
  @data = args[:data] if args.key?(:data)
255
497
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
498
+ @column_header = args[:column_header] if args.key?(:column_header)
256
499
  end
257
500
  end
258
501
 
@@ -312,19 +555,6 @@ module Google
312
555
  class MetricFilter
313
556
  include Google::Apis::Core::Hashable
314
557
 
315
- # The value to compare against.
316
- # Corresponds to the JSON property `comparisonValue`
317
- # @return [String]
318
- attr_accessor :comparison_value
319
-
320
- # Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the
321
- # comparisonValue, the default is `EQUAL`. If the operator is
322
- # `IS_MISSING`, checks if the metric is missing and would ignore the
323
- # comparisonValue.
324
- # Corresponds to the JSON property `operator`
325
- # @return [String]
326
- attr_accessor :operator
327
-
328
558
  # Logical `NOT` operator. If this boolean is set to true, then the matching
329
559
  # metric values will be excluded in the report. The default is false.
330
560
  # Corresponds to the JSON property `not`
@@ -339,16 +569,29 @@ module Google
339
569
  # @return [String]
340
570
  attr_accessor :metric_name
341
571
 
572
+ # The value to compare against.
573
+ # Corresponds to the JSON property `comparisonValue`
574
+ # @return [String]
575
+ attr_accessor :comparison_value
576
+
577
+ # Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the
578
+ # comparisonValue, the default is `EQUAL`. If the operator is
579
+ # `IS_MISSING`, checks if the metric is missing and would ignore the
580
+ # comparisonValue.
581
+ # Corresponds to the JSON property `operator`
582
+ # @return [String]
583
+ attr_accessor :operator
584
+
342
585
  def initialize(**args)
343
586
  update!(**args)
344
587
  end
345
588
 
346
589
  # Update properties of this object
347
590
  def update!(**args)
348
- @comparison_value = args[:comparison_value] if args.key?(:comparison_value)
349
- @operator = args[:operator] if args.key?(:operator)
350
591
  @not = args[:not] if args.key?(:not)
351
592
  @metric_name = args[:metric_name] if args.key?(:metric_name)
593
+ @comparison_value = args[:comparison_value] if args.key?(:comparison_value)
594
+ @operator = args[:operator] if args.key?(:operator)
352
595
  end
353
596
  end
354
597
 
@@ -390,6 +633,18 @@ module Google
390
633
  attr_accessor :hide_value_ranges
391
634
  alias_method :hide_value_ranges?, :hide_value_ranges
392
635
 
636
+ # Dimension or metric filters that restrict the data returned for your
637
+ # request. To use the `filtersExpression`, supply a dimension or metric on
638
+ # which to filter, followed by the filter expression. For example, the
639
+ # following expression selects `ga:browser` dimension which starts with
640
+ # Firefox; `ga:browser=~^Firefox`. For more information on dimensions
641
+ # and metric filters, see
642
+ # [Filters reference](https://developers.google.com/analytics/devguides/
643
+ # reporting/core/v3/reference#filters).
644
+ # Corresponds to the JSON property `filtersExpression`
645
+ # @return [String]
646
+ attr_accessor :filters_expression
647
+
393
648
  # Defines a cohort group.
394
649
  # For example:
395
650
  # "cohortGroup": `
@@ -407,18 +662,6 @@ module Google
407
662
  # @return [Google::Apis::AnalyticsreportingV4::CohortGroup]
408
663
  attr_accessor :cohort_group
409
664
 
410
- # Dimension or metric filters that restrict the data returned for your
411
- # request. To use the `filtersExpression`, supply a dimension or metric on
412
- # which to filter, followed by the filter expression. For example, the
413
- # following expression selects `ga:browser` dimension which starts with
414
- # Firefox; `ga:browser=~^Firefox`. For more information on dimensions
415
- # and metric filters, see
416
- # [Filters reference](https://developers.google.com/analytics/devguides/
417
- # reporting/core/v3/reference#filters).
418
- # Corresponds to the JSON property `filtersExpression`
419
- # @return [String]
420
- attr_accessor :filters_expression
421
-
422
665
  # The Analytics
423
666
  # [view ID](https://support.google.com/analytics/answer/1009618)
424
667
  # from which to retrieve data. Every [ReportRequest](#ReportRequest)
@@ -521,8 +764,8 @@ module Google
521
764
  @page_size = args[:page_size] if args.key?(:page_size)
522
765
  @hide_totals = args[:hide_totals] if args.key?(:hide_totals)
523
766
  @hide_value_ranges = args[:hide_value_ranges] if args.key?(:hide_value_ranges)
524
- @cohort_group = args[:cohort_group] if args.key?(:cohort_group)
525
767
  @filters_expression = args[:filters_expression] if args.key?(:filters_expression)
768
+ @cohort_group = args[:cohort_group] if args.key?(:cohort_group)
526
769
  @view_id = args[:view_id] if args.key?(:view_id)
527
770
  @metrics = args[:metrics] if args.key?(:metrics)
528
771
  @dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses)
@@ -594,12 +837,6 @@ module Google
594
837
  class DynamicSegment
595
838
  include Google::Apis::Core::Hashable
596
839
 
597
- # SegmentDefinition defines the segment to be a set of SegmentFilters which
598
- # are combined together with a logical `AND` operation.
599
- # Corresponds to the JSON property `sessionSegment`
600
- # @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
601
- attr_accessor :session_segment
602
-
603
840
  # The name of the dynamic segment.
604
841
  # Corresponds to the JSON property `name`
605
842
  # @return [String]
@@ -611,15 +848,21 @@ module Google
611
848
  # @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
612
849
  attr_accessor :user_segment
613
850
 
851
+ # SegmentDefinition defines the segment to be a set of SegmentFilters which
852
+ # are combined together with a logical `AND` operation.
853
+ # Corresponds to the JSON property `sessionSegment`
854
+ # @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition]
855
+ attr_accessor :session_segment
856
+
614
857
  def initialize(**args)
615
858
  update!(**args)
616
859
  end
617
860
 
618
861
  # Update properties of this object
619
862
  def update!(**args)
620
- @session_segment = args[:session_segment] if args.key?(:session_segment)
621
863
  @name = args[:name] if args.key?(:name)
622
864
  @user_segment = args[:user_segment] if args.key?(:user_segment)
865
+ @session_segment = args[:session_segment] if args.key?(:session_segment)
623
866
  end
624
867
  end
625
868
 
@@ -648,24 +891,24 @@ module Google
648
891
  class ColumnHeader
649
892
  include Google::Apis::Core::Hashable
650
893
 
651
- # The dimension names in the response.
652
- # Corresponds to the JSON property `dimensions`
653
- # @return [Array<String>]
654
- attr_accessor :dimensions
655
-
656
894
  # The headers for the metrics.
657
895
  # Corresponds to the JSON property `metricHeader`
658
896
  # @return [Google::Apis::AnalyticsreportingV4::MetricHeader]
659
897
  attr_accessor :metric_header
660
898
 
899
+ # The dimension names in the response.
900
+ # Corresponds to the JSON property `dimensions`
901
+ # @return [Array<String>]
902
+ attr_accessor :dimensions
903
+
661
904
  def initialize(**args)
662
905
  update!(**args)
663
906
  end
664
907
 
665
908
  # Update properties of this object
666
909
  def update!(**args)
667
- @dimensions = args[:dimensions] if args.key?(:dimensions)
668
910
  @metric_header = args[:metric_header] if args.key?(:metric_header)
911
+ @dimensions = args[:dimensions] if args.key?(:dimensions)
669
912
  end
670
913
  end
671
914
 
@@ -674,11 +917,6 @@ module Google
674
917
  class SegmentFilterClause
675
918
  include Google::Apis::Core::Hashable
676
919
 
677
- # Metric filter to be used in a segment filter clause.
678
- # Corresponds to the JSON property `metricFilter`
679
- # @return [Google::Apis::AnalyticsreportingV4::SegmentMetricFilter]
680
- attr_accessor :metric_filter
681
-
682
920
  # Matches the complement (`!`) of the filter.
683
921
  # Corresponds to the JSON property `not`
684
922
  # @return [Boolean]
@@ -690,40 +928,20 @@ module Google
690
928
  # @return [Google::Apis::AnalyticsreportingV4::SegmentDimensionFilter]
691
929
  attr_accessor :dimension_filter
692
930
 
931
+ # Metric filter to be used in a segment filter clause.
932
+ # Corresponds to the JSON property `metricFilter`
933
+ # @return [Google::Apis::AnalyticsreportingV4::SegmentMetricFilter]
934
+ attr_accessor :metric_filter
935
+
693
936
  def initialize(**args)
694
937
  update!(**args)
695
938
  end
696
939
 
697
940
  # Update properties of this object
698
941
  def update!(**args)
699
- @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
700
942
  @not = args[:not] if args.key?(:not)
701
943
  @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
702
- end
703
- end
704
-
705
- # A row in the report.
706
- class ReportRow
707
- include Google::Apis::Core::Hashable
708
-
709
- # List of metrics for each requested DateRange.
710
- # Corresponds to the JSON property `metrics`
711
- # @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
712
- attr_accessor :metrics
713
-
714
- # List of requested dimensions.
715
- # Corresponds to the JSON property `dimensions`
716
- # @return [Array<String>]
717
- attr_accessor :dimensions
718
-
719
- def initialize(**args)
720
- update!(**args)
721
- end
722
-
723
- # Update properties of this object
724
- def update!(**args)
725
- @metrics = args[:metrics] if args.key?(:metrics)
726
- @dimensions = args[:dimensions] if args.key?(:dimensions)
944
+ @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
727
945
  end
728
946
  end
729
947
 
@@ -793,6 +1011,31 @@ module Google
793
1011
  end
794
1012
  end
795
1013
 
1014
+ # A row in the report.
1015
+ class ReportRow
1016
+ include Google::Apis::Core::Hashable
1017
+
1018
+ # List of metrics for each requested DateRange.
1019
+ # Corresponds to the JSON property `metrics`
1020
+ # @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
1021
+ attr_accessor :metrics
1022
+
1023
+ # List of requested dimensions.
1024
+ # Corresponds to the JSON property `dimensions`
1025
+ # @return [Array<String>]
1026
+ attr_accessor :dimensions
1027
+
1028
+ def initialize(**args)
1029
+ update!(**args)
1030
+ end
1031
+
1032
+ # Update properties of this object
1033
+ def update!(**args)
1034
+ @metrics = args[:metrics] if args.key?(:metrics)
1035
+ @dimensions = args[:dimensions] if args.key?(:dimensions)
1036
+ end
1037
+ end
1038
+
796
1039
  # A list of segment filters in the `OR` group are combined with the logical OR
797
1040
  # operator.
798
1041
  class OrFiltersForSegment
@@ -919,6 +1162,19 @@ module Google
919
1162
  class SegmentMetricFilter
920
1163
  include Google::Apis::Core::Hashable
921
1164
 
1165
+ # Scope for a metric defines the level at which that metric is defined. The
1166
+ # specified metric scope must be equal to or greater than its primary scope
1167
+ # as defined in the data model. The primary scope is defined by if the
1168
+ # segment is selecting users or sessions.
1169
+ # Corresponds to the JSON property `scope`
1170
+ # @return [String]
1171
+ attr_accessor :scope
1172
+
1173
+ # Max comparison value is only used for `BETWEEN` operator.
1174
+ # Corresponds to the JSON property `maxComparisonValue`
1175
+ # @return [String]
1176
+ attr_accessor :max_comparison_value
1177
+
922
1178
  # The value to compare against. If the operator is `BETWEEN`, this value is
923
1179
  # treated as minimum comparison value.
924
1180
  # Corresponds to the JSON property `comparisonValue`
@@ -937,30 +1193,17 @@ module Google
937
1193
  # @return [String]
938
1194
  attr_accessor :metric_name
939
1195
 
940
- # Scope for a metric defines the level at which that metric is defined. The
941
- # specified metric scope must be equal to or greater than its primary scope
942
- # as defined in the data model. The primary scope is defined by if the
943
- # segment is selecting users or sessions.
944
- # Corresponds to the JSON property `scope`
945
- # @return [String]
946
- attr_accessor :scope
947
-
948
- # Max comparison value is only used for `BETWEEN` operator.
949
- # Corresponds to the JSON property `maxComparisonValue`
950
- # @return [String]
951
- attr_accessor :max_comparison_value
952
-
953
1196
  def initialize(**args)
954
1197
  update!(**args)
955
1198
  end
956
1199
 
957
1200
  # Update properties of this object
958
1201
  def update!(**args)
959
- @comparison_value = args[:comparison_value] if args.key?(:comparison_value)
960
- @operator = args[:operator] if args.key?(:operator)
961
- @metric_name = args[:metric_name] if args.key?(:metric_name)
962
1202
  @scope = args[:scope] if args.key?(:scope)
963
1203
  @max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value)
1204
+ @comparison_value = args[:comparison_value] if args.key?(:comparison_value)
1205
+ @operator = args[:operator] if args.key?(:operator)
1206
+ @metric_name = args[:metric_name] if args.key?(:metric_name)
964
1207
  end
965
1208
  end
966
1209
 
@@ -969,24 +1212,24 @@ module Google
969
1212
  class DateRangeValues
970
1213
  include Google::Apis::Core::Hashable
971
1214
 
972
- # Each value corresponds to each Metric in the request.
973
- # Corresponds to the JSON property `values`
974
- # @return [Array<String>]
975
- attr_accessor :values
976
-
977
1215
  # The values of each pivot region.
978
1216
  # Corresponds to the JSON property `pivotValueRegions`
979
1217
  # @return [Array<Google::Apis::AnalyticsreportingV4::PivotValueRegion>]
980
1218
  attr_accessor :pivot_value_regions
981
1219
 
1220
+ # Each value corresponds to each Metric in the request.
1221
+ # Corresponds to the JSON property `values`
1222
+ # @return [Array<String>]
1223
+ attr_accessor :values
1224
+
982
1225
  def initialize(**args)
983
1226
  update!(**args)
984
1227
  end
985
1228
 
986
1229
  # Update properties of this object
987
1230
  def update!(**args)
988
- @values = args[:values] if args.key?(:values)
989
1231
  @pivot_value_regions = args[:pivot_value_regions] if args.key?(:pivot_value_regions)
1232
+ @values = args[:values] if args.key?(:values)
990
1233
  end
991
1234
  end
992
1235
 
@@ -1172,249 +1415,6 @@ module Google
1172
1415
  @dimension_values = args[:dimension_values] if args.key?(:dimension_values)
1173
1416
  end
1174
1417
  end
1175
-
1176
- # SegmentFilter defines the segment to be either a simple or a sequence
1177
- # segment. A simple segment condition contains dimension and metric conditions
1178
- # to select the sessions or users. A sequence segment condition can be used to
1179
- # select users or sessions based on sequential conditions.
1180
- class SegmentFilter
1181
- include Google::Apis::Core::Hashable
1182
-
1183
- # Sequence conditions consist of one or more steps, where each step is defined
1184
- # by one or more dimension/metric conditions. Multiple steps can be combined
1185
- # with special sequence operators.
1186
- # Corresponds to the JSON property `sequenceSegment`
1187
- # @return [Google::Apis::AnalyticsreportingV4::SequenceSegment]
1188
- attr_accessor :sequence_segment
1189
-
1190
- # If true, match the complement of simple or sequence segment.
1191
- # For example, to match all visits not from "New York", we can define the
1192
- # segment as follows:
1193
- # "sessionSegment": `
1194
- # "segmentFilters": [`
1195
- # "simpleSegment" :`
1196
- # "orFiltersForSegment": [`
1197
- # "segmentFilterClauses":[`
1198
- # "dimensionFilter": `
1199
- # "dimensionName": "ga:city",
1200
- # "expressions": ["New York"]
1201
- # `
1202
- # `]
1203
- # `]
1204
- # `,
1205
- # "not": "True"
1206
- # `]
1207
- # `,
1208
- # Corresponds to the JSON property `not`
1209
- # @return [Boolean]
1210
- attr_accessor :not
1211
- alias_method :not?, :not
1212
-
1213
- # A Simple segment conditions consist of one or more dimension/metric
1214
- # conditions that can be combined.
1215
- # Corresponds to the JSON property `simpleSegment`
1216
- # @return [Google::Apis::AnalyticsreportingV4::SimpleSegment]
1217
- attr_accessor :simple_segment
1218
-
1219
- def initialize(**args)
1220
- update!(**args)
1221
- end
1222
-
1223
- # Update properties of this object
1224
- def update!(**args)
1225
- @sequence_segment = args[:sequence_segment] if args.key?(:sequence_segment)
1226
- @not = args[:not] if args.key?(:not)
1227
- @simple_segment = args[:simple_segment] if args.key?(:simple_segment)
1228
- end
1229
- end
1230
-
1231
- # SegmentDefinition defines the segment to be a set of SegmentFilters which
1232
- # are combined together with a logical `AND` operation.
1233
- class SegmentDefinition
1234
- include Google::Apis::Core::Hashable
1235
-
1236
- # A segment is defined by a set of segment filters which are combined
1237
- # together with a logical `AND` operation.
1238
- # Corresponds to the JSON property `segmentFilters`
1239
- # @return [Array<Google::Apis::AnalyticsreportingV4::SegmentFilter>]
1240
- attr_accessor :segment_filters
1241
-
1242
- def initialize(**args)
1243
- update!(**args)
1244
- end
1245
-
1246
- # Update properties of this object
1247
- def update!(**args)
1248
- @segment_filters = args[:segment_filters] if args.key?(:segment_filters)
1249
- end
1250
- end
1251
-
1252
- # Header for the metrics.
1253
- class MetricHeaderEntry
1254
- include Google::Apis::Core::Hashable
1255
-
1256
- # The name of the header.
1257
- # Corresponds to the JSON property `name`
1258
- # @return [String]
1259
- attr_accessor :name
1260
-
1261
- # The type of the metric, for example `INTEGER`.
1262
- # Corresponds to the JSON property `type`
1263
- # @return [String]
1264
- attr_accessor :type
1265
-
1266
- def initialize(**args)
1267
- update!(**args)
1268
- end
1269
-
1270
- # Update properties of this object
1271
- def update!(**args)
1272
- @name = args[:name] if args.key?(:name)
1273
- @type = args[:type] if args.key?(:type)
1274
- end
1275
- end
1276
-
1277
- # The data part of the report.
1278
- class ReportData
1279
- include Google::Apis::Core::Hashable
1280
-
1281
- # Minimum and maximum values seen over all matching rows. These are both
1282
- # empty when `hideValueRanges` in the request is false, or when
1283
- # rowCount is zero.
1284
- # Corresponds to the JSON property `minimums`
1285
- # @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
1286
- attr_accessor :minimums
1287
-
1288
- # If the results are
1289
- # [sampled](https://support.google.com/analytics/answer/2637192),
1290
- # this returns the total number of
1291
- # samples present, one entry per date range. If the results are not sampled
1292
- # this field will not be defined. See
1293
- # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
1294
- # for details.
1295
- # Corresponds to the JSON property `samplingSpaceSizes`
1296
- # @return [Array<Fixnum>]
1297
- attr_accessor :sampling_space_sizes
1298
-
1299
- # For each requested date range, for the set of all rows that match
1300
- # the query, every requested value format gets a total. The total
1301
- # for a value format is computed by first totaling the metrics
1302
- # mentioned in the value format and then evaluating the value
1303
- # format as a scalar expression. E.g., The "totals" for
1304
- # `3 / (ga:sessions + 2)` we compute
1305
- # `3 / ((sum of all relevant ga:sessions) + 2)`.
1306
- # Totals are computed before pagination.
1307
- # Corresponds to the JSON property `totals`
1308
- # @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
1309
- attr_accessor :totals
1310
-
1311
- # If the results are
1312
- # [sampled](https://support.google.com/analytics/answer/2637192),
1313
- # this returns the total number of samples read, one entry per date range.
1314
- # If the results are not sampled this field will not be defined. See
1315
- # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
1316
- # for details.
1317
- # Corresponds to the JSON property `samplesReadCounts`
1318
- # @return [Array<Fixnum>]
1319
- attr_accessor :samples_read_counts
1320
-
1321
- # Indicates if response to this request is golden or not. Data is
1322
- # golden when the exact same request will not produce any new results if
1323
- # asked at a later point in time.
1324
- # Corresponds to the JSON property `isDataGolden`
1325
- # @return [Boolean]
1326
- attr_accessor :is_data_golden
1327
- alias_method :is_data_golden?, :is_data_golden
1328
-
1329
- # There's one ReportRow for every unique combination of dimensions.
1330
- # Corresponds to the JSON property `rows`
1331
- # @return [Array<Google::Apis::AnalyticsreportingV4::ReportRow>]
1332
- attr_accessor :rows
1333
-
1334
- # Total number of matching rows for this query.
1335
- # Corresponds to the JSON property `rowCount`
1336
- # @return [Fixnum]
1337
- attr_accessor :row_count
1338
-
1339
- # The last time the data in the report was refreshed. All the hits received
1340
- # before this timestamp are included in the calculation of the report.
1341
- # Corresponds to the JSON property `dataLastRefreshed`
1342
- # @return [String]
1343
- attr_accessor :data_last_refreshed
1344
-
1345
- # Minimum and maximum values seen over all matching rows. These are both
1346
- # empty when `hideValueRanges` in the request is false, or when
1347
- # rowCount is zero.
1348
- # Corresponds to the JSON property `maximums`
1349
- # @return [Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>]
1350
- attr_accessor :maximums
1351
-
1352
- def initialize(**args)
1353
- update!(**args)
1354
- end
1355
-
1356
- # Update properties of this object
1357
- def update!(**args)
1358
- @minimums = args[:minimums] if args.key?(:minimums)
1359
- @sampling_space_sizes = args[:sampling_space_sizes] if args.key?(:sampling_space_sizes)
1360
- @totals = args[:totals] if args.key?(:totals)
1361
- @samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts)
1362
- @is_data_golden = args[:is_data_golden] if args.key?(:is_data_golden)
1363
- @rows = args[:rows] if args.key?(:rows)
1364
- @row_count = args[:row_count] if args.key?(:row_count)
1365
- @data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed)
1366
- @maximums = args[:maximums] if args.key?(:maximums)
1367
- end
1368
- end
1369
-
1370
- # Dimension filter specifies the filtering options on a dimension.
1371
- class DimensionFilter
1372
- include Google::Apis::Core::Hashable
1373
-
1374
- # The dimension to filter on. A DimensionFilter must contain a dimension.
1375
- # Corresponds to the JSON property `dimensionName`
1376
- # @return [String]
1377
- attr_accessor :dimension_name
1378
-
1379
- # How to match the dimension to the expression. The default is REGEXP.
1380
- # Corresponds to the JSON property `operator`
1381
- # @return [String]
1382
- attr_accessor :operator
1383
-
1384
- # Logical `NOT` operator. If this boolean is set to true, then the matching
1385
- # dimension values will be excluded in the report. The default is false.
1386
- # Corresponds to the JSON property `not`
1387
- # @return [Boolean]
1388
- attr_accessor :not
1389
- alias_method :not?, :not
1390
-
1391
- # Strings or regular expression to match against. Only the first value of
1392
- # the list is used for comparison unless the operator is `IN_LIST`.
1393
- # If `IN_LIST` operator, then the entire list is used to filter the
1394
- # dimensions as explained in the description of the `IN_LIST` operator.
1395
- # Corresponds to the JSON property `expressions`
1396
- # @return [Array<String>]
1397
- attr_accessor :expressions
1398
-
1399
- # Should the match be case sensitive? Default is false.
1400
- # Corresponds to the JSON property `caseSensitive`
1401
- # @return [Boolean]
1402
- attr_accessor :case_sensitive
1403
- alias_method :case_sensitive?, :case_sensitive
1404
-
1405
- def initialize(**args)
1406
- update!(**args)
1407
- end
1408
-
1409
- # Update properties of this object
1410
- def update!(**args)
1411
- @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
1412
- @operator = args[:operator] if args.key?(:operator)
1413
- @not = args[:not] if args.key?(:not)
1414
- @expressions = args[:expressions] if args.key?(:expressions)
1415
- @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
1416
- end
1417
- end
1418
1418
  end
1419
1419
  end
1420
1420
  end