google-api-client 0.44.1 → 0.44.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (291) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +119 -0
  3. data/api_names.yaml +1 -0
  4. data/generated/google/apis/accessapproval_v1.rb +1 -1
  5. data/generated/google/apis/accessapproval_v1/classes.rb +6 -4
  6. data/generated/google/apis/accesscontextmanager_v1.rb +1 -1
  7. data/generated/google/apis/accesscontextmanager_v1beta.rb +1 -1
  8. data/generated/google/apis/admin_directory_v1.rb +1 -1
  9. data/generated/google/apis/admin_directory_v1/classes.rb +1 -15
  10. data/generated/google/apis/admin_directory_v1/representations.rb +1 -14
  11. data/generated/google/apis/admin_directory_v1/service.rb +89 -1
  12. data/generated/google/apis/admob_v1.rb +1 -1
  13. data/generated/google/apis/analyticsdata_v1alpha.rb +37 -0
  14. data/generated/google/apis/analyticsdata_v1alpha/classes.rb +1610 -0
  15. data/generated/google/apis/analyticsdata_v1alpha/representations.rb +789 -0
  16. data/generated/google/apis/analyticsdata_v1alpha/service.rb +220 -0
  17. data/generated/google/apis/analyticsreporting_v4.rb +1 -1
  18. data/generated/google/apis/androidpublisher_v3.rb +1 -1
  19. data/generated/google/apis/apigateway_v1alpha1.rb +34 -0
  20. data/generated/google/apis/apigateway_v1alpha1/classes.rb +633 -0
  21. data/generated/google/apis/apigateway_v1alpha1/representations.rb +250 -0
  22. data/generated/google/apis/apigateway_v1alpha1/service.rb +623 -0
  23. data/generated/google/apis/apigateway_v1beta.rb +34 -0
  24. data/generated/google/apis/apigateway_v1beta/classes.rb +1162 -0
  25. data/generated/google/apis/apigateway_v1beta/representations.rb +470 -0
  26. data/generated/google/apis/apigateway_v1beta/service.rb +1172 -0
  27. data/generated/google/apis/appengine_v1.rb +1 -1
  28. data/generated/google/apis/appengine_v1/classes.rb +51 -24
  29. data/generated/google/apis/appengine_v1/representations.rb +15 -0
  30. data/generated/google/apis/appengine_v1beta.rb +1 -1
  31. data/generated/google/apis/appengine_v1beta/classes.rb +58 -24
  32. data/generated/google/apis/appengine_v1beta/representations.rb +16 -0
  33. data/generated/google/apis/bigquery_v2.rb +1 -1
  34. data/generated/google/apis/bigquery_v2/classes.rb +26 -0
  35. data/generated/google/apis/bigquery_v2/representations.rb +15 -0
  36. data/generated/google/apis/bigtableadmin_v1.rb +1 -1
  37. data/generated/google/apis/bigtableadmin_v1/classes.rb +87 -119
  38. data/generated/google/apis/bigtableadmin_v2.rb +1 -1
  39. data/generated/google/apis/bigtableadmin_v2/classes.rb +405 -607
  40. data/generated/google/apis/bigtableadmin_v2/service.rb +194 -247
  41. data/generated/google/apis/binaryauthorization_v1.rb +1 -1
  42. data/generated/google/apis/binaryauthorization_v1/classes.rb +7 -0
  43. data/generated/google/apis/binaryauthorization_v1/representations.rb +1 -0
  44. data/generated/google/apis/binaryauthorization_v1beta1.rb +1 -1
  45. data/generated/google/apis/binaryauthorization_v1beta1/classes.rb +7 -0
  46. data/generated/google/apis/binaryauthorization_v1beta1/representations.rb +1 -0
  47. data/generated/google/apis/calendar_v3.rb +1 -1
  48. data/generated/google/apis/calendar_v3/classes.rb +11 -9
  49. data/generated/google/apis/civicinfo_v2.rb +1 -1
  50. data/generated/google/apis/civicinfo_v2/classes.rb +18 -8
  51. data/generated/google/apis/civicinfo_v2/representations.rb +2 -0
  52. data/generated/google/apis/cloudasset_v1.rb +1 -1
  53. data/generated/google/apis/cloudasset_v1beta1.rb +1 -1
  54. data/generated/google/apis/cloudasset_v1p5beta1.rb +1 -1
  55. data/generated/google/apis/cloudbuild_v1.rb +1 -1
  56. data/generated/google/apis/cloudbuild_v1/classes.rb +81 -1
  57. data/generated/google/apis/cloudbuild_v1/representations.rb +22 -0
  58. data/generated/google/apis/cloudbuild_v1/service.rb +217 -3
  59. data/generated/google/apis/cloudbuild_v1alpha1.rb +1 -1
  60. data/generated/google/apis/cloudbuild_v1alpha1/classes.rb +8 -0
  61. data/generated/google/apis/cloudbuild_v1alpha1/representations.rb +1 -0
  62. data/generated/google/apis/cloudbuild_v1alpha2.rb +1 -1
  63. data/generated/google/apis/cloudbuild_v1alpha2/classes.rb +8 -0
  64. data/generated/google/apis/cloudbuild_v1alpha2/representations.rb +1 -0
  65. data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
  66. data/generated/google/apis/cloudidentity_v1.rb +4 -1
  67. data/generated/google/apis/cloudidentity_v1/classes.rb +270 -2
  68. data/generated/google/apis/cloudidentity_v1/representations.rb +139 -0
  69. data/generated/google/apis/cloudidentity_v1/service.rb +759 -0
  70. data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
  71. data/generated/google/apis/cloudidentity_v1beta1/classes.rb +20 -7
  72. data/generated/google/apis/cloudiot_v1.rb +1 -1
  73. data/generated/google/apis/cloudiot_v1/classes.rb +7 -0
  74. data/generated/google/apis/cloudiot_v1/representations.rb +1 -0
  75. data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
  76. data/generated/google/apis/cloudresourcemanager_v1/classes.rb +14 -7
  77. data/generated/google/apis/cloudresourcemanager_v1/representations.rb +1 -0
  78. data/generated/google/apis/cloudresourcemanager_v1/service.rb +59 -57
  79. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
  80. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +11 -4
  81. data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +1 -0
  82. data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +23 -22
  83. data/generated/google/apis/cloudresourcemanager_v2.rb +1 -1
  84. data/generated/google/apis/cloudresourcemanager_v2/classes.rb +7 -0
  85. data/generated/google/apis/cloudresourcemanager_v2/representations.rb +1 -0
  86. data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
  87. data/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +7 -0
  88. data/generated/google/apis/cloudresourcemanager_v2beta1/representations.rb +1 -0
  89. data/generated/google/apis/cloudsearch_v1.rb +1 -1
  90. data/generated/google/apis/cloudtasks_v2beta3.rb +1 -1
  91. data/generated/google/apis/cloudtasks_v2beta3/classes.rb +18 -18
  92. data/generated/google/apis/container_v1.rb +1 -1
  93. data/generated/google/apis/container_v1/classes.rb +57 -2
  94. data/generated/google/apis/container_v1/representations.rb +7 -0
  95. data/generated/google/apis/container_v1beta1.rb +1 -1
  96. data/generated/google/apis/container_v1beta1/classes.rb +52 -8
  97. data/generated/google/apis/container_v1beta1/representations.rb +6 -0
  98. data/generated/google/apis/containeranalysis_v1alpha1.rb +1 -1
  99. data/generated/google/apis/containeranalysis_v1alpha1/classes.rb +7 -0
  100. data/generated/google/apis/containeranalysis_v1alpha1/representations.rb +1 -0
  101. data/generated/google/apis/containeranalysis_v1beta1.rb +1 -1
  102. data/generated/google/apis/containeranalysis_v1beta1/classes.rb +7 -0
  103. data/generated/google/apis/containeranalysis_v1beta1/representations.rb +1 -0
  104. data/generated/google/apis/content_v2.rb +1 -1
  105. data/generated/google/apis/content_v2/classes.rb +2 -1
  106. data/generated/google/apis/content_v2_1.rb +1 -1
  107. data/generated/google/apis/content_v2_1/classes.rb +14 -3
  108. data/generated/google/apis/content_v2_1/representations.rb +1 -0
  109. data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
  110. data/generated/google/apis/datacatalog_v1beta1/classes.rb +7 -0
  111. data/generated/google/apis/datacatalog_v1beta1/representations.rb +1 -0
  112. data/generated/google/apis/datafusion_v1.rb +1 -1
  113. data/generated/google/apis/datafusion_v1/classes.rb +15 -0
  114. data/generated/google/apis/datafusion_v1/representations.rb +2 -0
  115. data/generated/google/apis/datafusion_v1beta1.rb +1 -1
  116. data/generated/google/apis/datafusion_v1beta1/classes.rb +15 -0
  117. data/generated/google/apis/datafusion_v1beta1/representations.rb +2 -0
  118. data/generated/google/apis/dataproc_v1.rb +1 -1
  119. data/generated/google/apis/dataproc_v1/classes.rb +22 -9
  120. data/generated/google/apis/dataproc_v1/representations.rb +2 -0
  121. data/generated/google/apis/dataproc_v1beta2.rb +1 -1
  122. data/generated/google/apis/dataproc_v1beta2/classes.rb +22 -9
  123. data/generated/google/apis/dataproc_v1beta2/representations.rb +2 -0
  124. data/generated/google/apis/dialogflow_v2.rb +1 -1
  125. data/generated/google/apis/dialogflow_v2/classes.rb +42 -26
  126. data/generated/google/apis/dialogflow_v2/representations.rb +1 -0
  127. data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
  128. data/generated/google/apis/dialogflow_v2beta1/classes.rb +53 -34
  129. data/generated/google/apis/dialogflow_v2beta1/representations.rb +1 -0
  130. data/generated/google/apis/dialogflow_v2beta1/service.rb +458 -320
  131. data/generated/google/apis/dialogflow_v3beta1.rb +1 -1
  132. data/generated/google/apis/dialogflow_v3beta1/classes.rb +42 -33
  133. data/generated/google/apis/dialogflow_v3beta1/representations.rb +1 -1
  134. data/generated/google/apis/digitalassetlinks_v1.rb +1 -1
  135. data/generated/google/apis/digitalassetlinks_v1/classes.rb +66 -92
  136. data/generated/google/apis/digitalassetlinks_v1/service.rb +131 -188
  137. data/generated/google/apis/displayvideo_v1.rb +1 -1
  138. data/generated/google/apis/displayvideo_v1/service.rb +2 -2
  139. data/generated/google/apis/displayvideo_v1beta.rb +38 -0
  140. data/generated/google/apis/displayvideo_v1beta/classes.rb +146 -0
  141. data/generated/google/apis/displayvideo_v1beta/representations.rb +72 -0
  142. data/generated/google/apis/displayvideo_v1beta/service.rb +161 -0
  143. data/generated/google/apis/displayvideo_v1beta2.rb +38 -0
  144. data/generated/google/apis/displayvideo_v1beta2/classes.rb +146 -0
  145. data/generated/google/apis/displayvideo_v1beta2/representations.rb +72 -0
  146. data/generated/google/apis/displayvideo_v1beta2/service.rb +130 -0
  147. data/generated/google/apis/displayvideo_v1dev.rb +38 -0
  148. data/generated/google/apis/displayvideo_v1dev/classes.rb +146 -0
  149. data/generated/google/apis/displayvideo_v1dev/representations.rb +72 -0
  150. data/generated/google/apis/displayvideo_v1dev/service.rb +130 -0
  151. data/generated/google/apis/dlp_v2.rb +1 -1
  152. data/generated/google/apis/dlp_v2/classes.rb +5 -5
  153. data/generated/google/apis/documentai_v1beta2.rb +1 -1
  154. data/generated/google/apis/documentai_v1beta2/classes.rb +1059 -6
  155. data/generated/google/apis/documentai_v1beta2/representations.rb +398 -0
  156. data/generated/google/apis/doubleclickbidmanager_v1.rb +1 -1
  157. data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +1 -2
  158. data/generated/google/apis/doubleclickbidmanager_v1_1.rb +1 -1
  159. data/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb +1 -2
  160. data/generated/google/apis/firebase_v1beta1.rb +1 -1
  161. data/generated/google/apis/firebase_v1beta1/classes.rb +8 -4
  162. data/generated/google/apis/firebasedynamiclinks_v1.rb +1 -1
  163. data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
  164. data/generated/google/apis/firebasehosting_v1beta1/classes.rb +160 -0
  165. data/generated/google/apis/firebasehosting_v1beta1/representations.rb +68 -0
  166. data/generated/google/apis/firebasehosting_v1beta1/service.rb +414 -0
  167. data/generated/google/apis/firebaseml_v1beta2.rb +1 -1
  168. data/generated/google/apis/firebaseml_v1beta2/classes.rb +8 -0
  169. data/generated/google/apis/firebaseml_v1beta2/representations.rb +1 -0
  170. data/generated/google/apis/firestore_v1.rb +1 -1
  171. data/generated/google/apis/firestore_v1beta1.rb +1 -1
  172. data/generated/google/apis/fitness_v1.rb +3 -3
  173. data/generated/google/apis/fitness_v1/classes.rb +5 -5
  174. data/generated/google/apis/games_v1.rb +1 -1
  175. data/generated/google/apis/gameservices_v1.rb +1 -1
  176. data/generated/google/apis/gameservices_v1/classes.rb +7 -0
  177. data/generated/google/apis/gameservices_v1/representations.rb +1 -0
  178. data/generated/google/apis/gameservices_v1beta.rb +1 -1
  179. data/generated/google/apis/gameservices_v1beta/classes.rb +7 -0
  180. data/generated/google/apis/gameservices_v1beta/representations.rb +1 -0
  181. data/generated/google/apis/healthcare_v1.rb +1 -1
  182. data/generated/google/apis/healthcare_v1/classes.rb +72 -0
  183. data/generated/google/apis/healthcare_v1/representations.rb +32 -0
  184. data/generated/google/apis/healthcare_v1/service.rb +182 -16
  185. data/generated/google/apis/healthcare_v1beta1.rb +1 -1
  186. data/generated/google/apis/healthcare_v1beta1/service.rb +231 -16
  187. data/generated/google/apis/homegraph_v1.rb +4 -1
  188. data/generated/google/apis/iam_v1.rb +1 -1
  189. data/generated/google/apis/iam_v1/classes.rb +7 -0
  190. data/generated/google/apis/iam_v1/representations.rb +1 -0
  191. data/generated/google/apis/iap_v1.rb +1 -1
  192. data/generated/google/apis/iap_v1/classes.rb +7 -0
  193. data/generated/google/apis/iap_v1/representations.rb +1 -0
  194. data/generated/google/apis/iap_v1beta1.rb +1 -1
  195. data/generated/google/apis/iap_v1beta1/classes.rb +7 -0
  196. data/generated/google/apis/iap_v1beta1/representations.rb +1 -0
  197. data/generated/google/apis/jobs_v2.rb +1 -1
  198. data/generated/google/apis/jobs_v2/classes.rb +786 -1086
  199. data/generated/google/apis/jobs_v2/service.rb +85 -126
  200. data/generated/google/apis/jobs_v3.rb +1 -1
  201. data/generated/google/apis/jobs_v3/classes.rb +637 -856
  202. data/generated/google/apis/jobs_v3/service.rb +101 -139
  203. data/generated/google/apis/jobs_v3p1beta1.rb +1 -1
  204. data/generated/google/apis/jobs_v3p1beta1/classes.rb +762 -1023
  205. data/generated/google/apis/jobs_v3p1beta1/service.rb +103 -142
  206. data/generated/google/apis/managedidentities_v1alpha1.rb +1 -1
  207. data/generated/google/apis/managedidentities_v1alpha1/classes.rb +8 -0
  208. data/generated/google/apis/managedidentities_v1alpha1/representations.rb +1 -0
  209. data/generated/google/apis/managedidentities_v1beta1.rb +1 -1
  210. data/generated/google/apis/managedidentities_v1beta1/classes.rb +8 -0
  211. data/generated/google/apis/managedidentities_v1beta1/representations.rb +1 -0
  212. data/generated/google/apis/ml_v1.rb +1 -1
  213. data/generated/google/apis/ml_v1/classes.rb +7 -0
  214. data/generated/google/apis/ml_v1/representations.rb +1 -0
  215. data/generated/google/apis/ml_v1/service.rb +1 -1
  216. data/generated/google/apis/monitoring_v1.rb +1 -1
  217. data/generated/google/apis/monitoring_v1/classes.rb +9 -5
  218. data/generated/google/apis/osconfig_v1.rb +1 -1
  219. data/generated/google/apis/osconfig_v1/classes.rb +0 -704
  220. data/generated/google/apis/osconfig_v1/representations.rb +0 -337
  221. data/generated/google/apis/osconfig_v1beta.rb +1 -1
  222. data/generated/google/apis/osconfig_v1beta/classes.rb +0 -704
  223. data/generated/google/apis/osconfig_v1beta/representations.rb +0 -337
  224. data/generated/google/apis/playcustomapp_v1.rb +1 -1
  225. data/generated/google/apis/playcustomapp_v1/service.rb +2 -2
  226. data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
  227. data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +20 -0
  228. data/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +13 -0
  229. data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +479 -0
  230. data/generated/google/apis/remotebuildexecution_v1.rb +1 -1
  231. data/generated/google/apis/remotebuildexecution_v1alpha.rb +1 -1
  232. data/generated/google/apis/remotebuildexecution_v2.rb +1 -1
  233. data/generated/google/apis/runtimeconfig_v1beta1.rb +1 -1
  234. data/generated/google/apis/runtimeconfig_v1beta1/classes.rb +7 -0
  235. data/generated/google/apis/runtimeconfig_v1beta1/representations.rb +1 -0
  236. data/generated/google/apis/safebrowsing_v4.rb +1 -1
  237. data/generated/google/apis/secretmanager_v1.rb +1 -1
  238. data/generated/google/apis/secretmanager_v1/classes.rb +168 -2
  239. data/generated/google/apis/secretmanager_v1/representations.rb +92 -0
  240. data/generated/google/apis/secretmanager_v1beta1.rb +1 -1
  241. data/generated/google/apis/secretmanager_v1beta1/classes.rb +7 -0
  242. data/generated/google/apis/secretmanager_v1beta1/representations.rb +1 -0
  243. data/generated/google/apis/servicedirectory_v1beta1.rb +1 -1
  244. data/generated/google/apis/servicedirectory_v1beta1/classes.rb +7 -0
  245. data/generated/google/apis/servicedirectory_v1beta1/representations.rb +1 -0
  246. data/generated/google/apis/servicenetworking_v1.rb +1 -1
  247. data/generated/google/apis/servicenetworking_v1/classes.rb +0 -9
  248. data/generated/google/apis/servicenetworking_v1/representations.rb +0 -1
  249. data/generated/google/apis/speech_v1p1beta1.rb +1 -1
  250. data/generated/google/apis/sql_v1beta4.rb +1 -1
  251. data/generated/google/apis/storage_v1.rb +1 -1
  252. data/generated/google/apis/storagetransfer_v1.rb +1 -1
  253. data/generated/google/apis/sts_v1.rb +32 -0
  254. data/generated/google/apis/sts_v1/classes.rb +120 -0
  255. data/generated/google/apis/sts_v1/representations.rb +59 -0
  256. data/generated/google/apis/sts_v1/service.rb +90 -0
  257. data/generated/google/apis/sts_v1beta.rb +32 -0
  258. data/generated/google/apis/sts_v1beta/classes.rb +191 -0
  259. data/generated/google/apis/sts_v1beta/representations.rb +61 -0
  260. data/generated/google/apis/sts_v1beta/service.rb +92 -0
  261. data/generated/google/apis/texttospeech_v1beta1.rb +1 -1
  262. data/generated/google/apis/tpu_v1.rb +1 -1
  263. data/generated/google/apis/tpu_v1/classes.rb +43 -0
  264. data/generated/google/apis/tpu_v1/representations.rb +18 -0
  265. data/generated/google/apis/tpu_v1alpha1.rb +1 -1
  266. data/generated/google/apis/tpu_v1alpha1/classes.rb +43 -0
  267. data/generated/google/apis/tpu_v1alpha1/representations.rb +18 -0
  268. data/generated/google/apis/vault_v1.rb +1 -1
  269. data/generated/google/apis/vault_v1/classes.rb +80 -103
  270. data/generated/google/apis/vault_v1/service.rb +31 -37
  271. data/generated/google/apis/verifiedaccess_v1.rb +1 -1
  272. data/generated/google/apis/verifiedaccess_v1/classes.rb +20 -27
  273. data/generated/google/apis/videointelligence_v1.rb +1 -1
  274. data/generated/google/apis/videointelligence_v1/service.rb +31 -0
  275. data/generated/google/apis/videointelligence_v1beta2.rb +1 -1
  276. data/generated/google/apis/videointelligence_v1p1beta1.rb +1 -1
  277. data/generated/google/apis/videointelligence_v1p2beta1.rb +1 -1
  278. data/generated/google/apis/videointelligence_v1p3beta1.rb +1 -1
  279. data/generated/google/apis/vision_v1.rb +1 -1
  280. data/generated/google/apis/vision_v1p1beta1.rb +1 -1
  281. data/generated/google/apis/vision_v1p2beta1.rb +1 -1
  282. data/generated/google/apis/workflowexecutions_v1beta.rb +34 -0
  283. data/generated/google/apis/workflowexecutions_v1beta/classes.rb +155 -0
  284. data/generated/google/apis/workflowexecutions_v1beta/representations.rb +88 -0
  285. data/generated/google/apis/workflowexecutions_v1beta/service.rb +211 -0
  286. data/generated/google/apis/youtube_partner_v1.rb +1 -1
  287. data/generated/google/apis/youtube_v3.rb +1 -1
  288. data/generated/google/apis/youtube_v3/service.rb +78 -78
  289. data/google-api-client.gemspec +2 -1
  290. data/lib/google/apis/version.rb +1 -1
  291. metadata +54 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f4f7c808bc2dad27ef3556c87746aefecbcde173211986f93852c9dbf2445805
4
- data.tar.gz: 6dc1511f2f9306caf94526edee2c9fac9224e9d553d9a2e475c02a2a4d684a7f
3
+ metadata.gz: 80acae5af7ef07fa795b0ca86787f9c5914d8d03d0359c9fc437fbd4195ae52b
4
+ data.tar.gz: e9942ce2bc06e2380462a188731eb8df3a58624feed04ce6c190e7edd842e798
5
5
  SHA512:
6
- metadata.gz: 4dbb661ceb76f948b964de21ec80024c2869130e527c0725698635c7c2011e32b651ff917dee9b3ce2911b21fd6603f2a9a84bf100db56a45f990a49125f838e
7
- data.tar.gz: 5e3fa7f938baf3faf759686c880259cfca434b6eb271eda6491018d2caf1f34c04893d6ef7a52355e5902da58aed2c5733f017a2580d871cf198482e051849b3
6
+ metadata.gz: 052b11eb7e0f4759ed984a5a7d9bad009074792aea2b90ff8899bbccf3513fe93b9f000cf619cdd23cba5c2687ed38b6c40507e13454cb712c827f2fc7e3ab20
7
+ data.tar.gz: 9e1ad94e0595ce0a60160b24288afea9b4c121395eac5653ae6fe8accda3a0151bd6684c4a4ef93ff58e344d3e246f46ad85a555aada481e8cd684b4bcdb8b9e
@@ -1,3 +1,122 @@
1
+ # 0.44.2
2
+ * Backwards compatible changes:
3
+ * Added `analyticsdata_v1alpha`
4
+ * Added `apigateway_v1alpha1`
5
+ * Added `apigateway_v1beta`
6
+ * Added `displayvideo_v1beta`
7
+ * Added `displayvideo_v1beta2`
8
+ * Added `displayvideo_v1dev`
9
+ * Added `sts_v1`
10
+ * Added `sts_v1beta`
11
+ * Added `workflowexecutions_v1beta`
12
+ * Updated `accessapproval_v1`
13
+ * Updated `accesscontextmanager_v1`
14
+ * Updated `accesscontextmanager_v1beta`
15
+ * Updated `admin_directory_v1`
16
+ * Updated `admob_v1`
17
+ * Updated `analyticsreporting_v4`
18
+ * Updated `androidpublisher_v3`
19
+ * Updated `appengine_v1`
20
+ * Updated `appengine_v1beta`
21
+ * Updated `bigquery_v2`
22
+ * Updated `bigtableadmin_v1`
23
+ * Updated `bigtableadmin_v2`
24
+ * Updated `binaryauthorization_v1`
25
+ * Updated `binaryauthorization_v1beta1`
26
+ * Updated `calendar_v3`
27
+ * Updated `civicinfo_v2`
28
+ * Updated `cloudasset_v1`
29
+ * Updated `cloudasset_v1beta1`
30
+ * Updated `cloudasset_v1p5beta1`
31
+ * Updated `cloudbuild_v1`
32
+ * Updated `cloudbuild_v1alpha1`
33
+ * Updated `cloudbuild_v1alpha2`
34
+ * Updated `clouderrorreporting_v1beta1`
35
+ * Updated `cloudidentity_v1`
36
+ * Updated `cloudidentity_v1beta1`
37
+ * Updated `cloudiot_v1`
38
+ * Updated `cloudresourcemanager_v1`
39
+ * Updated `cloudresourcemanager_v1beta1`
40
+ * Updated `cloudresourcemanager_v2`
41
+ * Updated `cloudresourcemanager_v2beta1`
42
+ * Updated `cloudsearch_v1`
43
+ * Updated `cloudtasks_v2beta3`
44
+ * Updated `container_v1`
45
+ * Updated `container_v1beta1`
46
+ * Updated `containeranalysis_v1alpha1`
47
+ * Updated `containeranalysis_v1beta1`
48
+ * Updated `content_v2`
49
+ * Updated `content_v2_1`
50
+ * Updated `datacatalog_v1beta1`
51
+ * Updated `datafusion_v1`
52
+ * Updated `datafusion_v1beta1`
53
+ * Updated `dataproc_v1`
54
+ * Updated `dataproc_v1beta2`
55
+ * Updated `dialogflow_v2`
56
+ * Updated `dialogflow_v2beta1`
57
+ * Updated `dialogflow_v3beta1`
58
+ * Updated `digitalassetlinks_v1`
59
+ * Updated `displayvideo_v1`
60
+ * Updated `dlp_v2`
61
+ * Updated `documentai_v1beta2`
62
+ * Updated `doubleclickbidmanager_v1`
63
+ * Updated `doubleclickbidmanager_v1_1`
64
+ * Updated `firebase_v1beta1`
65
+ * Updated `firebasedynamiclinks_v1`
66
+ * Updated `firebasehosting_v1beta1`
67
+ * Updated `firebaseml_v1beta2`
68
+ * Updated `firestore_v1`
69
+ * Updated `firestore_v1beta1`
70
+ * Updated `fitness_v1`
71
+ * Updated `games_v1`
72
+ * Updated `gameservices_v1`
73
+ * Updated `gameservices_v1beta`
74
+ * Updated `healthcare_v1`
75
+ * Updated `healthcare_v1beta1`
76
+ * Updated `homegraph_v1`
77
+ * Updated `iam_v1`
78
+ * Updated `iap_v1`
79
+ * Updated `iap_v1beta1`
80
+ * Updated `jobs_v2`
81
+ * Updated `jobs_v3`
82
+ * Updated `jobs_v3p1beta1`
83
+ * Updated `managedidentities_v1alpha1`
84
+ * Updated `managedidentities_v1beta1`
85
+ * Updated `ml_v1`
86
+ * Updated `monitoring_v1`
87
+ * Updated `osconfig_v1`
88
+ * Updated `osconfig_v1beta`
89
+ * Updated `playcustomapp_v1`
90
+ * Updated `prod_tt_sasportal_v1alpha1`
91
+ * Updated `remotebuildexecution_v1`
92
+ * Updated `remotebuildexecution_v1alpha`
93
+ * Updated `remotebuildexecution_v2`
94
+ * Updated `runtimeconfig_v1beta1`
95
+ * Updated `safebrowsing_v4`
96
+ * Updated `secretmanager_v1`
97
+ * Updated `secretmanager_v1beta1`
98
+ * Updated `servicedirectory_v1beta1`
99
+ * Updated `servicenetworking_v1`
100
+ * Updated `speech_v1p1beta1`
101
+ * Updated `sql_v1beta4`
102
+ * Updated `storage_v1`
103
+ * Updated `storagetransfer_v1`
104
+ * Updated `texttospeech_v1beta1`
105
+ * Updated `tpu_v1`
106
+ * Updated `tpu_v1alpha1`
107
+ * Updated `vault_v1`
108
+ * Updated `verifiedaccess_v1`
109
+ * Updated `videointelligence_v1`
110
+ * Updated `videointelligence_v1beta2`
111
+ * Updated `videointelligence_v1p1beta1`
112
+ * Updated `videointelligence_v1p2beta1`
113
+ * Updated `videointelligence_v1p3beta1`
114
+ * Updated `vision_v1`
115
+ * Updated `vision_v1p1beta1`
116
+ * Updated `vision_v1p2beta1`
117
+ * Updated `youtube_partner_v1`
118
+ * Updated `youtube_v3`
119
+
1
120
  # 0.44.1
2
121
  * Backwards compatible changes:
3
122
  * Added `workflows_v1beta`
@@ -705,6 +705,7 @@
705
705
  "/dfareporting:v2.6/UserRolesListResponse": list_user_roles_response
706
706
  "/dfareporting:v2.6/dfareporting.floodlightActivities.generatetag": generate_floodlight_activity_tag
707
707
  "/dfareporting:v2.6/dfareporting.placements.generatetags": generate_placement_tags
708
+ "/displayvideo:v1beta/displayvideo.sdfdownloadtasks.operations.get": get_sdfdownloadtasks_operation
708
709
  "/discovery:v1/RestDescription/methods": api_methods
709
710
  "/discovery:v1/RestResource/methods": api_methods
710
711
  "/discovery:v1/discovery.apis.getRest": get_rest_api
@@ -25,7 +25,7 @@ module Google
25
25
  # @see https://cloud.google.com/access-approval/docs
26
26
  module AccessapprovalV1
27
27
  VERSION = 'V1'
28
- REVISION = '20200807'
28
+ REVISION = '20200903'
29
29
 
30
30
  # View and manage your data across Google Cloud Platform services
31
31
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -317,10 +317,12 @@ module Google
317
317
  include Google::Apis::Core::Hashable
318
318
 
319
319
  # The product for which Access Approval will be enrolled. Allowed values are
320
- # listed below (case-sensitive): 1. all 2. appengine.googleapis.com 3. bigquery.
321
- # googleapis.com 4. bigtable.googleapis.com 5. cloudkms.googleapis.com 6.
322
- # compute.googleapis.com 7. dataflow.googleapis.com 8. iam.googleapis.com 9.
323
- # pubsub.googleapis.com 10. storage.googleapis.com
320
+ # listed below (case-sensitive): 1. all 2. ga-only 3. appengine.googleapis.com 4.
321
+ # bigquery.googleapis.com 5. bigtable.googleapis.com 6. cloudkms.googleapis.com
322
+ # 7. compute.googleapis.com 8. dataflow.googleapis.com 9. iam.googleapis.com 10.
323
+ # pubsub.googleapis.com 11. storage.googleapis.com Note: 'all' will enroll the
324
+ # resource in all products supported at both 'GA' and 'Preview' levels. 'ga-only'
325
+ # will only enroll the resource in products supported at 'GA' level.
324
326
  # Corresponds to the JSON property `cloudProduct`
325
327
  # @return [String]
326
328
  attr_accessor :cloud_product
@@ -25,7 +25,7 @@ module Google
25
25
  # @see https://cloud.google.com/access-context-manager/docs/reference/rest/
26
26
  module AccesscontextmanagerV1
27
27
  VERSION = 'V1'
28
- REVISION = '20200801'
28
+ REVISION = '20200825'
29
29
 
30
30
  # View and manage your data across Google Cloud Platform services
31
31
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -25,7 +25,7 @@ module Google
25
25
  # @see https://cloud.google.com/access-context-manager/docs/reference/rest/
26
26
  module AccesscontextmanagerV1beta
27
27
  VERSION = 'V1beta'
28
- REVISION = '20200801'
28
+ REVISION = '20200825'
29
29
 
30
30
  # View and manage your data across Google Cloud Platform services
31
31
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -27,7 +27,7 @@ module Google
27
27
  # @see http://developers.google.com/admin-sdk/
28
28
  module AdminDirectoryV1
29
29
  VERSION = 'DirectoryV1'
30
- REVISION = '20200819'
30
+ REVISION = '20200909'
31
31
 
32
32
  # View and manage customer related information
33
33
  AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer'
@@ -3021,7 +3021,7 @@ module Google
3021
3021
 
3022
3022
  # Custom fields of the user.
3023
3023
  # Corresponds to the JSON property `customSchemas`
3024
- # @return [Hash<String,Google::Apis::AdminDirectoryV1::UserCustomProperties>]
3024
+ # @return [Hash<String,Hash<String,Object>>]
3025
3025
  attr_accessor :custom_schemas
3026
3026
 
3027
3027
  # Output only. CustomerId of User (Read-only)
@@ -3407,20 +3407,6 @@ module Google
3407
3407
  end
3408
3408
  end
3409
3409
 
3410
- # JSON template for a set of custom properties (i.e. all fields in a particular
3411
- # schema)
3412
- class UserCustomProperties
3413
- include Google::Apis::Core::Hashable
3414
-
3415
- def initialize(**args)
3416
- update!(**args)
3417
- end
3418
-
3419
- # Update properties of this object
3420
- def update!(**args)
3421
- end
3422
- end
3423
-
3424
3410
  # JSON template for an email.
3425
3411
  class UserEmail
3426
3412
  include Google::Apis::Core::Hashable
@@ -394,12 +394,6 @@ module Google
394
394
  include Google::Apis::Core::JsonObjectSupport
395
395
  end
396
396
 
397
- class UserCustomProperties
398
- class Representation < Google::Apis::Core::JsonRepresentation; end
399
-
400
- include Google::Apis::Core::JsonObjectSupport
401
- end
402
-
403
397
  class UserEmail
404
398
  class Representation < Google::Apis::Core::JsonRepresentation; end
405
399
 
@@ -1270,8 +1264,7 @@ module Google
1270
1264
  property :change_password_at_next_login, as: 'changePasswordAtNextLogin'
1271
1265
  property :creation_time, as: 'creationTime', type: DateTime
1272
1266
 
1273
- hash :custom_schemas, as: 'customSchemas', class: Google::Apis::AdminDirectoryV1::UserCustomProperties, decorator: Google::Apis::AdminDirectoryV1::UserCustomProperties::Representation
1274
-
1267
+ hash :custom_schemas, as: 'customSchemas'
1275
1268
  property :customer_id, as: 'customerId'
1276
1269
  property :deletion_time, as: 'deletionTime', type: DateTime
1277
1270
 
@@ -1344,12 +1337,6 @@ module Google
1344
1337
  end
1345
1338
  end
1346
1339
 
1347
- class UserCustomProperties
1348
- # @private
1349
- class Representation < Google::Apis::Core::JsonRepresentation
1350
- end
1351
- end
1352
-
1353
1340
  class UserEmail
1354
1341
  # @private
1355
1342
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3046,6 +3046,35 @@ module Google
3046
3046
  execute_or_queue_command(command, &block)
3047
3047
  end
3048
3048
 
3049
+ # Turn off 2-Step Verification for user.
3050
+ # @param [String] user_key
3051
+ # Identifies the user in the API request. The value can be the user's primary
3052
+ # email address, alias email address, or unique user ID.
3053
+ # @param [String] fields
3054
+ # Selector specifying which fields to include in a partial response.
3055
+ # @param [String] quota_user
3056
+ # Available to use for quota purposes for server-side applications. Can be any
3057
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3058
+ # @param [Google::Apis::RequestOptions] options
3059
+ # Request-specific options
3060
+ #
3061
+ # @yield [result, err] Result & error if block supplied
3062
+ # @yieldparam result [NilClass] No result returned for this method
3063
+ # @yieldparam err [StandardError] error object if request failed
3064
+ #
3065
+ # @return [void]
3066
+ #
3067
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3068
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3069
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3070
+ def turn_two_step_verification_off(user_key, fields: nil, quota_user: nil, options: nil, &block)
3071
+ command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/twoStepVerification/turnOff', options)
3072
+ command.params['userKey'] = user_key unless user_key.nil?
3073
+ command.query['fields'] = fields unless fields.nil?
3074
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3075
+ execute_or_queue_command(command, &block)
3076
+ end
3077
+
3049
3078
  # Delete user
3050
3079
  # @param [String] user_key
3051
3080
  # Email or immutable ID of the user
@@ -3273,6 +3302,36 @@ module Google
3273
3302
  execute_or_queue_command(command, &block)
3274
3303
  end
3275
3304
 
3305
+ # Sign a user out of all web and device sessions and reset their sign-in cookies.
3306
+ # User will have to sign in by authenticating again.
3307
+ # @param [String] user_key
3308
+ # Identifies the target user in the API request. The value can be the user's
3309
+ # primary email address, alias email address, or unique user ID.
3310
+ # @param [String] fields
3311
+ # Selector specifying which fields to include in a partial response.
3312
+ # @param [String] quota_user
3313
+ # Available to use for quota purposes for server-side applications. Can be any
3314
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3315
+ # @param [Google::Apis::RequestOptions] options
3316
+ # Request-specific options
3317
+ #
3318
+ # @yield [result, err] Result & error if block supplied
3319
+ # @yieldparam result [NilClass] No result returned for this method
3320
+ # @yieldparam err [StandardError] error object if request failed
3321
+ #
3322
+ # @return [void]
3323
+ #
3324
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3325
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3326
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3327
+ def sign_user_out(user_key, fields: nil, quota_user: nil, options: nil, &block)
3328
+ command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/signOut', options)
3329
+ command.params['userKey'] = user_key unless user_key.nil?
3330
+ command.query['fields'] = fields unless fields.nil?
3331
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3332
+ execute_or_queue_command(command, &block)
3333
+ end
3334
+
3276
3335
  # Undelete a deleted user
3277
3336
  # @param [String] user_key
3278
3337
  # The immutable id of the user
@@ -3340,6 +3399,9 @@ module Google
3340
3399
 
3341
3400
  # Watch for changes in users list
3342
3401
  # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object
3402
+ # @param [String] custom_field_mask
3403
+ # Comma-separated list of schema names. All fields from these schemas are
3404
+ # fetched. This should only be set when projection=custom.
3343
3405
  # @param [String] customer
3344
3406
  # Immutable ID of the G Suite account. In case of multi-domain, to fetch all
3345
3407
  # users for a customer, fill this field instead of domain.
@@ -3348,6 +3410,23 @@ module Google
3348
3410
  # return all users in a multi-domain fill customer field instead."
3349
3411
  # @param [String] event
3350
3412
  # Event on which subscription is intended
3413
+ # @param [Fixnum] max_results
3414
+ # Maximum number of results to return.
3415
+ # @param [String] order_by
3416
+ # Column to use for sorting results
3417
+ # @param [String] page_token
3418
+ # Token to specify next page in the list
3419
+ # @param [String] projection
3420
+ # What subset of fields to fetch for this user.
3421
+ # @param [String] query
3422
+ # Query string search. Should be of the form "". Complete documentation is at
3423
+ # https: //developers.google.com/admin-sdk/directory/v1/guides/search-users
3424
+ # @param [String] show_deleted
3425
+ # If set to true, retrieves the list of deleted users. (Default: false)
3426
+ # @param [String] sort_order
3427
+ # Whether to return results in ascending or descending order.
3428
+ # @param [String] view_type
3429
+ # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
3351
3430
  # @param [String] fields
3352
3431
  # Selector specifying which fields to include in a partial response.
3353
3432
  # @param [String] quota_user
@@ -3365,15 +3444,24 @@ module Google
3365
3444
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3366
3445
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3367
3446
  # @raise [Google::Apis::AuthorizationError] Authorization is required
3368
- def watch_user(channel_object = nil, customer: nil, domain: nil, event: nil, fields: nil, quota_user: nil, options: nil, &block)
3447
+ def watch_user(channel_object = nil, custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block)
3369
3448
  command = make_simple_command(:post, 'admin/directory/v1/users/watch', options)
3370
3449
  command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
3371
3450
  command.request_object = channel_object
3372
3451
  command.response_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
3373
3452
  command.response_class = Google::Apis::AdminDirectoryV1::Channel
3453
+ command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil?
3374
3454
  command.query['customer'] = customer unless customer.nil?
3375
3455
  command.query['domain'] = domain unless domain.nil?
3376
3456
  command.query['event'] = event unless event.nil?
3457
+ command.query['maxResults'] = max_results unless max_results.nil?
3458
+ command.query['orderBy'] = order_by unless order_by.nil?
3459
+ command.query['pageToken'] = page_token unless page_token.nil?
3460
+ command.query['projection'] = projection unless projection.nil?
3461
+ command.query['query'] = query unless query.nil?
3462
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
3463
+ command.query['sortOrder'] = sort_order unless sort_order.nil?
3464
+ command.query['viewType'] = view_type unless view_type.nil?
3377
3465
  command.query['fields'] = fields unless fields.nil?
3378
3466
  command.query['quotaUser'] = quota_user unless quota_user.nil?
3379
3467
  execute_or_queue_command(command, &block)
@@ -25,7 +25,7 @@ module Google
25
25
  # @see https://developers.google.com/admob/api/
26
26
  module AdmobV1
27
27
  VERSION = 'V1'
28
- REVISION = '20200822'
28
+ REVISION = '20200905'
29
29
  end
30
30
  end
31
31
  end
@@ -0,0 +1,37 @@
1
+ # Copyright 2015 Google Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/analyticsdata_v1alpha/service.rb'
16
+ require 'google/apis/analyticsdata_v1alpha/classes.rb'
17
+ require 'google/apis/analyticsdata_v1alpha/representations.rb'
18
+
19
+ module Google
20
+ module Apis
21
+ # Google Analytics Data API
22
+ #
23
+ # Accesses report data in Google Analytics.
24
+ #
25
+ # @see https://developers.google.com/analytics/trusted-testing/analytics-data/
26
+ module AnalyticsdataV1alpha
27
+ VERSION = 'V1alpha'
28
+ REVISION = '20200907'
29
+
30
+ # View and manage your Google Analytics data
31
+ AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics'
32
+
33
+ # View your Google Analytics data
34
+ AUTH_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/analytics.readonly'
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,1610 @@
1
+ # Copyright 2015 Google Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module AnalyticsdataV1alpha
24
+
25
+ # The batch request containing multiple pivot report requests.
26
+ class BatchRunPivotReportsRequest
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # The unique identifier of the property whose events are tracked.
30
+ # Corresponds to the JSON property `entity`
31
+ # @return [Google::Apis::AnalyticsdataV1alpha::Entity]
32
+ attr_accessor :entity
33
+
34
+ # Individual requests. Each request has a separate pivot report response. Each
35
+ # batch request is allowed up to 5 requests.
36
+ # Corresponds to the JSON property `requests`
37
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::RunPivotReportRequest>]
38
+ attr_accessor :requests
39
+
40
+ def initialize(**args)
41
+ update!(**args)
42
+ end
43
+
44
+ # Update properties of this object
45
+ def update!(**args)
46
+ @entity = args[:entity] if args.key?(:entity)
47
+ @requests = args[:requests] if args.key?(:requests)
48
+ end
49
+ end
50
+
51
+ # The batch response containing multiple pivot reports.
52
+ class BatchRunPivotReportsResponse
53
+ include Google::Apis::Core::Hashable
54
+
55
+ # Individual responses. Each response has a separate pivot report request.
56
+ # Corresponds to the JSON property `pivotReports`
57
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::RunPivotReportResponse>]
58
+ attr_accessor :pivot_reports
59
+
60
+ def initialize(**args)
61
+ update!(**args)
62
+ end
63
+
64
+ # Update properties of this object
65
+ def update!(**args)
66
+ @pivot_reports = args[:pivot_reports] if args.key?(:pivot_reports)
67
+ end
68
+ end
69
+
70
+ # The batch request containing multiple report requests.
71
+ class BatchRunReportsRequest
72
+ include Google::Apis::Core::Hashable
73
+
74
+ # The unique identifier of the property whose events are tracked.
75
+ # Corresponds to the JSON property `entity`
76
+ # @return [Google::Apis::AnalyticsdataV1alpha::Entity]
77
+ attr_accessor :entity
78
+
79
+ # Individual requests. Each request has a separate report response. Each batch
80
+ # request is allowed up to 5 requests.
81
+ # Corresponds to the JSON property `requests`
82
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::RunReportRequest>]
83
+ attr_accessor :requests
84
+
85
+ def initialize(**args)
86
+ update!(**args)
87
+ end
88
+
89
+ # Update properties of this object
90
+ def update!(**args)
91
+ @entity = args[:entity] if args.key?(:entity)
92
+ @requests = args[:requests] if args.key?(:requests)
93
+ end
94
+ end
95
+
96
+ # The batch response containing multiple reports.
97
+ class BatchRunReportsResponse
98
+ include Google::Apis::Core::Hashable
99
+
100
+ # Individual responses. Each response has a separate report request.
101
+ # Corresponds to the JSON property `reports`
102
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::RunReportResponse>]
103
+ attr_accessor :reports
104
+
105
+ def initialize(**args)
106
+ update!(**args)
107
+ end
108
+
109
+ # Update properties of this object
110
+ def update!(**args)
111
+ @reports = args[:reports] if args.key?(:reports)
112
+ end
113
+ end
114
+
115
+ # To express that the result needs to be between two numbers (inclusive).
116
+ class BetweenFilter
117
+ include Google::Apis::Core::Hashable
118
+
119
+ # To represent a number.
120
+ # Corresponds to the JSON property `fromValue`
121
+ # @return [Google::Apis::AnalyticsdataV1alpha::NumericValue]
122
+ attr_accessor :from_value
123
+
124
+ # To represent a number.
125
+ # Corresponds to the JSON property `toValue`
126
+ # @return [Google::Apis::AnalyticsdataV1alpha::NumericValue]
127
+ attr_accessor :to_value
128
+
129
+ def initialize(**args)
130
+ update!(**args)
131
+ end
132
+
133
+ # Update properties of this object
134
+ def update!(**args)
135
+ @from_value = args[:from_value] if args.key?(:from_value)
136
+ @to_value = args[:to_value] if args.key?(:to_value)
137
+ end
138
+ end
139
+
140
+ # Used to convert a dimension value to a single case.
141
+ class CaseExpression
142
+ include Google::Apis::Core::Hashable
143
+
144
+ # Name of a dimension. The name must refer back to a name in dimensions field of
145
+ # the request.
146
+ # Corresponds to the JSON property `dimensionName`
147
+ # @return [String]
148
+ attr_accessor :dimension_name
149
+
150
+ def initialize(**args)
151
+ update!(**args)
152
+ end
153
+
154
+ # Update properties of this object
155
+ def update!(**args)
156
+ @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
157
+ end
158
+ end
159
+
160
+ # Defines a cohort. A cohort is a group of users who share a common
161
+ # characteristic. For example, all users with the same acquisition date belong
162
+ # to the same cohort.
163
+ class Cohort
164
+ include Google::Apis::Core::Hashable
165
+
166
+ # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are
167
+ # allowed up to 4 date ranges, and the union of the ranges can cover up to 1
168
+ # year.
169
+ # Corresponds to the JSON property `dateRange`
170
+ # @return [Google::Apis::AnalyticsdataV1alpha::DateRange]
171
+ attr_accessor :date_range
172
+
173
+ # The dimension used by cohort. Only supports `firstTouchDate` for retention
174
+ # report.
175
+ # Corresponds to the JSON property `dimension`
176
+ # @return [String]
177
+ attr_accessor :dimension
178
+
179
+ # Assigns a name to this cohort. The dimension `cohort` is valued to this name
180
+ # in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If
181
+ # not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`,
182
+ # etc.
183
+ # Corresponds to the JSON property `name`
184
+ # @return [String]
185
+ attr_accessor :name
186
+
187
+ def initialize(**args)
188
+ update!(**args)
189
+ end
190
+
191
+ # Update properties of this object
192
+ def update!(**args)
193
+ @date_range = args[:date_range] if args.key?(:date_range)
194
+ @dimension = args[:dimension] if args.key?(:dimension)
195
+ @name = args[:name] if args.key?(:name)
196
+ end
197
+ end
198
+
199
+ # Settings of a cohort report.
200
+ class CohortReportSettings
201
+ include Google::Apis::Core::Hashable
202
+
203
+ # If true, accumulates the result from first visit day to the end day. Not
204
+ # supported in `RunReportRequest`.
205
+ # Corresponds to the JSON property `accumulate`
206
+ # @return [Boolean]
207
+ attr_accessor :accumulate
208
+ alias_method :accumulate?, :accumulate
209
+
210
+ def initialize(**args)
211
+ update!(**args)
212
+ end
213
+
214
+ # Update properties of this object
215
+ def update!(**args)
216
+ @accumulate = args[:accumulate] if args.key?(:accumulate)
217
+ end
218
+ end
219
+
220
+ # Specification for a cohort report.
221
+ class CohortSpec
222
+ include Google::Apis::Core::Hashable
223
+
224
+ # Settings of a cohort report.
225
+ # Corresponds to the JSON property `cohortReportSettings`
226
+ # @return [Google::Apis::AnalyticsdataV1alpha::CohortReportSettings]
227
+ attr_accessor :cohort_report_settings
228
+
229
+ # The definition for the cohorts.
230
+ # Corresponds to the JSON property `cohorts`
231
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Cohort>]
232
+ attr_accessor :cohorts
233
+
234
+ # Describes date range for a cohort report.
235
+ # Corresponds to the JSON property `cohortsRange`
236
+ # @return [Google::Apis::AnalyticsdataV1alpha::CohortsRange]
237
+ attr_accessor :cohorts_range
238
+
239
+ def initialize(**args)
240
+ update!(**args)
241
+ end
242
+
243
+ # Update properties of this object
244
+ def update!(**args)
245
+ @cohort_report_settings = args[:cohort_report_settings] if args.key?(:cohort_report_settings)
246
+ @cohorts = args[:cohorts] if args.key?(:cohorts)
247
+ @cohorts_range = args[:cohorts_range] if args.key?(:cohorts_range)
248
+ end
249
+ end
250
+
251
+ # Describes date range for a cohort report.
252
+ class CohortsRange
253
+ include Google::Apis::Core::Hashable
254
+
255
+ # For daily cohorts, this will be the end day offset. For weekly cohorts, this
256
+ # will be the week offset.
257
+ # Corresponds to the JSON property `endOffset`
258
+ # @return [Fixnum]
259
+ attr_accessor :end_offset
260
+
261
+ # Reporting date range for each cohort is calculated based on these three fields.
262
+ # Corresponds to the JSON property `granularity`
263
+ # @return [String]
264
+ attr_accessor :granularity
265
+
266
+ # For daily cohorts, this will be the start day offset. For weekly cohorts, this
267
+ # will be the week offset.
268
+ # Corresponds to the JSON property `startOffset`
269
+ # @return [Fixnum]
270
+ attr_accessor :start_offset
271
+
272
+ def initialize(**args)
273
+ update!(**args)
274
+ end
275
+
276
+ # Update properties of this object
277
+ def update!(**args)
278
+ @end_offset = args[:end_offset] if args.key?(:end_offset)
279
+ @granularity = args[:granularity] if args.key?(:granularity)
280
+ @start_offset = args[:start_offset] if args.key?(:start_offset)
281
+ end
282
+ end
283
+
284
+ # Used to combine dimension values to a single dimension.
285
+ class ConcatenateExpression
286
+ include Google::Apis::Core::Hashable
287
+
288
+ # The delimiter placed between dimension names. Delimiters are often single
289
+ # characters such as "|" or "," but can be longer strings. If a dimension value
290
+ # contains the delimiter, both will be present in response with no distinction.
291
+ # For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and
292
+ # delimiter = ",", then the response will contain "US,FR,JP".
293
+ # Corresponds to the JSON property `delimiter`
294
+ # @return [String]
295
+ attr_accessor :delimiter
296
+
297
+ # Names of dimensions. The names must refer back to names in the dimensions
298
+ # field of the request.
299
+ # Corresponds to the JSON property `dimensionNames`
300
+ # @return [Array<String>]
301
+ attr_accessor :dimension_names
302
+
303
+ def initialize(**args)
304
+ update!(**args)
305
+ end
306
+
307
+ # Update properties of this object
308
+ def update!(**args)
309
+ @delimiter = args[:delimiter] if args.key?(:delimiter)
310
+ @dimension_names = args[:dimension_names] if args.key?(:dimension_names)
311
+ end
312
+ end
313
+
314
+ # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are
315
+ # allowed up to 4 date ranges, and the union of the ranges can cover up to 1
316
+ # year.
317
+ class DateRange
318
+ include Google::Apis::Core::Hashable
319
+
320
+ # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be
321
+ # before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
322
+ # accepted, and in that case, the date is inferred based on the property's
323
+ # reporting time zone.
324
+ # Corresponds to the JSON property `endDate`
325
+ # @return [String]
326
+ attr_accessor :end_date
327
+
328
+ # Assigns a name to this date range. The dimension `dateRange` is valued to this
329
+ # name in a report response. If set, cannot begin with `date_range_` or `
330
+ # RESERVED_`. If not set, date ranges are named by their zero based index in the
331
+ # request: `date_range_0`, `date_range_1`, etc.
332
+ # Corresponds to the JSON property `name`
333
+ # @return [String]
334
+ attr_accessor :name
335
+
336
+ # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be
337
+ # after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
338
+ # accepted, and in that case, the date is inferred based on the property's
339
+ # reporting time zone.
340
+ # Corresponds to the JSON property `startDate`
341
+ # @return [String]
342
+ attr_accessor :start_date
343
+
344
+ def initialize(**args)
345
+ update!(**args)
346
+ end
347
+
348
+ # Update properties of this object
349
+ def update!(**args)
350
+ @end_date = args[:end_date] if args.key?(:end_date)
351
+ @name = args[:name] if args.key?(:name)
352
+ @start_date = args[:start_date] if args.key?(:start_date)
353
+ end
354
+ end
355
+
356
+ # Dimensions are attributes of your data. For example, the dimension City
357
+ # indicates the city, for example, "Paris" or "New York", from which an event
358
+ # originates. Requests are allowed up to 8 dimensions.
359
+ class Dimension
360
+ include Google::Apis::Core::Hashable
361
+
362
+ # Used to express a dimension which is the result of a formula of multiple
363
+ # dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1,
364
+ # symbol, dimension2).
365
+ # Corresponds to the JSON property `dimensionExpression`
366
+ # @return [Google::Apis::AnalyticsdataV1alpha::DimensionExpression]
367
+ attr_accessor :dimension_expression
368
+
369
+ # The name of the dimension.
370
+ # Corresponds to the JSON property `name`
371
+ # @return [String]
372
+ attr_accessor :name
373
+
374
+ def initialize(**args)
375
+ update!(**args)
376
+ end
377
+
378
+ # Update properties of this object
379
+ def update!(**args)
380
+ @dimension_expression = args[:dimension_expression] if args.key?(:dimension_expression)
381
+ @name = args[:name] if args.key?(:name)
382
+ end
383
+ end
384
+
385
+ # Used to express a dimension which is the result of a formula of multiple
386
+ # dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1,
387
+ # symbol, dimension2).
388
+ class DimensionExpression
389
+ include Google::Apis::Core::Hashable
390
+
391
+ # Used to combine dimension values to a single dimension.
392
+ # Corresponds to the JSON property `concatenate`
393
+ # @return [Google::Apis::AnalyticsdataV1alpha::ConcatenateExpression]
394
+ attr_accessor :concatenate
395
+
396
+ # Used to convert a dimension value to a single case.
397
+ # Corresponds to the JSON property `lowerCase`
398
+ # @return [Google::Apis::AnalyticsdataV1alpha::CaseExpression]
399
+ attr_accessor :lower_case
400
+
401
+ # Used to convert a dimension value to a single case.
402
+ # Corresponds to the JSON property `upperCase`
403
+ # @return [Google::Apis::AnalyticsdataV1alpha::CaseExpression]
404
+ attr_accessor :upper_case
405
+
406
+ def initialize(**args)
407
+ update!(**args)
408
+ end
409
+
410
+ # Update properties of this object
411
+ def update!(**args)
412
+ @concatenate = args[:concatenate] if args.key?(:concatenate)
413
+ @lower_case = args[:lower_case] if args.key?(:lower_case)
414
+ @upper_case = args[:upper_case] if args.key?(:upper_case)
415
+ end
416
+ end
417
+
418
+ # Describes a dimension column in the report. Dimensions requested in a report
419
+ # produce column entries within rows and DimensionHeaders. However, dimensions
420
+ # used exclusively within filters or expressions do not produce columns in a
421
+ # report; correspondingly, those dimensions do not produce headers.
422
+ class DimensionHeader
423
+ include Google::Apis::Core::Hashable
424
+
425
+ # The dimension's name.
426
+ # Corresponds to the JSON property `name`
427
+ # @return [String]
428
+ attr_accessor :name
429
+
430
+ def initialize(**args)
431
+ update!(**args)
432
+ end
433
+
434
+ # Update properties of this object
435
+ def update!(**args)
436
+ @name = args[:name] if args.key?(:name)
437
+ end
438
+ end
439
+
440
+ # Explains a dimension.
441
+ class DimensionMetadata
442
+ include Google::Apis::Core::Hashable
443
+
444
+ # This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
445
+ # example, `eventName`.
446
+ # Corresponds to the JSON property `apiName`
447
+ # @return [String]
448
+ attr_accessor :api_name
449
+
450
+ # Still usable but deprecated names for this dimension. If populated, this
451
+ # dimension is available by either `apiName` or one of `deprecatedApiNames` for
452
+ # a period of time. After the deprecation period, the dimension will be
453
+ # available only by `apiName`.
454
+ # Corresponds to the JSON property `deprecatedApiNames`
455
+ # @return [Array<String>]
456
+ attr_accessor :deprecated_api_names
457
+
458
+ # Description of how this dimension is used and calculated.
459
+ # Corresponds to the JSON property `description`
460
+ # @return [String]
461
+ attr_accessor :description
462
+
463
+ # This dimension's name within the Google Analytics user interface. For example,
464
+ # `Event name`.
465
+ # Corresponds to the JSON property `uiName`
466
+ # @return [String]
467
+ attr_accessor :ui_name
468
+
469
+ def initialize(**args)
470
+ update!(**args)
471
+ end
472
+
473
+ # Update properties of this object
474
+ def update!(**args)
475
+ @api_name = args[:api_name] if args.key?(:api_name)
476
+ @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
477
+ @description = args[:description] if args.key?(:description)
478
+ @ui_name = args[:ui_name] if args.key?(:ui_name)
479
+ end
480
+ end
481
+
482
+ # Sorts by dimension values.
483
+ class DimensionOrderBy
484
+ include Google::Apis::Core::Hashable
485
+
486
+ # A dimension name in the request to order by.
487
+ # Corresponds to the JSON property `dimensionName`
488
+ # @return [String]
489
+ attr_accessor :dimension_name
490
+
491
+ # Controls the rule for dimension value ordering.
492
+ # Corresponds to the JSON property `orderType`
493
+ # @return [String]
494
+ attr_accessor :order_type
495
+
496
+ def initialize(**args)
497
+ update!(**args)
498
+ end
499
+
500
+ # Update properties of this object
501
+ def update!(**args)
502
+ @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
503
+ @order_type = args[:order_type] if args.key?(:order_type)
504
+ end
505
+ end
506
+
507
+ # The value of a dimension.
508
+ class DimensionValue
509
+ include Google::Apis::Core::Hashable
510
+
511
+ # Value as a string if the dimension type is a string.
512
+ # Corresponds to the JSON property `value`
513
+ # @return [String]
514
+ attr_accessor :value
515
+
516
+ def initialize(**args)
517
+ update!(**args)
518
+ end
519
+
520
+ # Update properties of this object
521
+ def update!(**args)
522
+ @value = args[:value] if args.key?(:value)
523
+ end
524
+ end
525
+
526
+ # The unique identifier of the property whose events are tracked.
527
+ class Entity
528
+ include Google::Apis::Core::Hashable
529
+
530
+ # A Google Analytics App + Web property id.
531
+ # Corresponds to the JSON property `propertyId`
532
+ # @return [String]
533
+ attr_accessor :property_id
534
+
535
+ def initialize(**args)
536
+ update!(**args)
537
+ end
538
+
539
+ # Update properties of this object
540
+ def update!(**args)
541
+ @property_id = args[:property_id] if args.key?(:property_id)
542
+ end
543
+ end
544
+
545
+ # An expression to filter dimension or metric values.
546
+ class Filter
547
+ include Google::Apis::Core::Hashable
548
+
549
+ # To express that the result needs to be between two numbers (inclusive).
550
+ # Corresponds to the JSON property `betweenFilter`
551
+ # @return [Google::Apis::AnalyticsdataV1alpha::BetweenFilter]
552
+ attr_accessor :between_filter
553
+
554
+ # The dimension name or metric name. Must be a name defined in dimensions or
555
+ # metrics.
556
+ # Corresponds to the JSON property `fieldName`
557
+ # @return [String]
558
+ attr_accessor :field_name
559
+
560
+ # The result needs to be in a list of string values.
561
+ # Corresponds to the JSON property `inListFilter`
562
+ # @return [Google::Apis::AnalyticsdataV1alpha::InListFilter]
563
+ attr_accessor :in_list_filter
564
+
565
+ # A filter for null values.
566
+ # Corresponds to the JSON property `nullFilter`
567
+ # @return [Boolean]
568
+ attr_accessor :null_filter
569
+ alias_method :null_filter?, :null_filter
570
+
571
+ # Filters for numeric or date values.
572
+ # Corresponds to the JSON property `numericFilter`
573
+ # @return [Google::Apis::AnalyticsdataV1alpha::NumericFilter]
574
+ attr_accessor :numeric_filter
575
+
576
+ # The filter for string
577
+ # Corresponds to the JSON property `stringFilter`
578
+ # @return [Google::Apis::AnalyticsdataV1alpha::StringFilter]
579
+ attr_accessor :string_filter
580
+
581
+ def initialize(**args)
582
+ update!(**args)
583
+ end
584
+
585
+ # Update properties of this object
586
+ def update!(**args)
587
+ @between_filter = args[:between_filter] if args.key?(:between_filter)
588
+ @field_name = args[:field_name] if args.key?(:field_name)
589
+ @in_list_filter = args[:in_list_filter] if args.key?(:in_list_filter)
590
+ @null_filter = args[:null_filter] if args.key?(:null_filter)
591
+ @numeric_filter = args[:numeric_filter] if args.key?(:numeric_filter)
592
+ @string_filter = args[:string_filter] if args.key?(:string_filter)
593
+ end
594
+ end
595
+
596
+ # To express dimension or metric filters. The fields in the same
597
+ # FilterExpression need to be either all dimensions or all metrics.
598
+ class FilterExpression
599
+ include Google::Apis::Core::Hashable
600
+
601
+ # A list of filter expressions.
602
+ # Corresponds to the JSON property `andGroup`
603
+ # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpressionList]
604
+ attr_accessor :and_group
605
+
606
+ # An expression to filter dimension or metric values.
607
+ # Corresponds to the JSON property `filter`
608
+ # @return [Google::Apis::AnalyticsdataV1alpha::Filter]
609
+ attr_accessor :filter
610
+
611
+ # To express dimension or metric filters. The fields in the same
612
+ # FilterExpression need to be either all dimensions or all metrics.
613
+ # Corresponds to the JSON property `notExpression`
614
+ # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression]
615
+ attr_accessor :not_expression
616
+
617
+ # A list of filter expressions.
618
+ # Corresponds to the JSON property `orGroup`
619
+ # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpressionList]
620
+ attr_accessor :or_group
621
+
622
+ def initialize(**args)
623
+ update!(**args)
624
+ end
625
+
626
+ # Update properties of this object
627
+ def update!(**args)
628
+ @and_group = args[:and_group] if args.key?(:and_group)
629
+ @filter = args[:filter] if args.key?(:filter)
630
+ @not_expression = args[:not_expression] if args.key?(:not_expression)
631
+ @or_group = args[:or_group] if args.key?(:or_group)
632
+ end
633
+ end
634
+
635
+ # A list of filter expressions.
636
+ class FilterExpressionList
637
+ include Google::Apis::Core::Hashable
638
+
639
+ # A list of filter expressions.
640
+ # Corresponds to the JSON property `expressions`
641
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::FilterExpression>]
642
+ attr_accessor :expressions
643
+
644
+ def initialize(**args)
645
+ update!(**args)
646
+ end
647
+
648
+ # Update properties of this object
649
+ def update!(**args)
650
+ @expressions = args[:expressions] if args.key?(:expressions)
651
+ end
652
+ end
653
+
654
+ # The result needs to be in a list of string values.
655
+ class InListFilter
656
+ include Google::Apis::Core::Hashable
657
+
658
+ # If true, the string value is case sensitive.
659
+ # Corresponds to the JSON property `caseSensitive`
660
+ # @return [Boolean]
661
+ attr_accessor :case_sensitive
662
+ alias_method :case_sensitive?, :case_sensitive
663
+
664
+ # The list of string values. Must be non-empty.
665
+ # Corresponds to the JSON property `values`
666
+ # @return [Array<String>]
667
+ attr_accessor :values
668
+
669
+ def initialize(**args)
670
+ update!(**args)
671
+ end
672
+
673
+ # Update properties of this object
674
+ def update!(**args)
675
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
676
+ @values = args[:values] if args.key?(:values)
677
+ end
678
+ end
679
+
680
+ # The quantitative measurements of a report. For example, the metric eventCount
681
+ # is the total number of events. Requests are allowed up to 10 metrics.
682
+ class Metric
683
+ include Google::Apis::Core::Hashable
684
+
685
+ # A mathematical expression for derived metrics. For example, the metric Event
686
+ # count per user is eventCount/totalUsers.
687
+ # Corresponds to the JSON property `expression`
688
+ # @return [String]
689
+ attr_accessor :expression
690
+
691
+ # Indicates if a metric is invisible. If a metric is invisible, the metric is
692
+ # not in the response, but can be used in filters, order_bys or being referred
693
+ # to in a metric expression.
694
+ # Corresponds to the JSON property `invisible`
695
+ # @return [Boolean]
696
+ attr_accessor :invisible
697
+ alias_method :invisible?, :invisible
698
+
699
+ # The name of the metric.
700
+ # Corresponds to the JSON property `name`
701
+ # @return [String]
702
+ attr_accessor :name
703
+
704
+ def initialize(**args)
705
+ update!(**args)
706
+ end
707
+
708
+ # Update properties of this object
709
+ def update!(**args)
710
+ @expression = args[:expression] if args.key?(:expression)
711
+ @invisible = args[:invisible] if args.key?(:invisible)
712
+ @name = args[:name] if args.key?(:name)
713
+ end
714
+ end
715
+
716
+ # Describes a metric column in the report. Visible metrics requested in a report
717
+ # produce column entries within rows and MetricHeaders. However, metrics used
718
+ # exclusively within filters or expressions do not produce columns in a report;
719
+ # correspondingly, those metrics do not produce headers.
720
+ class MetricHeader
721
+ include Google::Apis::Core::Hashable
722
+
723
+ # The metric's name.
724
+ # Corresponds to the JSON property `name`
725
+ # @return [String]
726
+ attr_accessor :name
727
+
728
+ # The metric's data type.
729
+ # Corresponds to the JSON property `type`
730
+ # @return [String]
731
+ attr_accessor :type
732
+
733
+ def initialize(**args)
734
+ update!(**args)
735
+ end
736
+
737
+ # Update properties of this object
738
+ def update!(**args)
739
+ @name = args[:name] if args.key?(:name)
740
+ @type = args[:type] if args.key?(:type)
741
+ end
742
+ end
743
+
744
+ # Explains a metric.
745
+ class MetricMetadata
746
+ include Google::Apis::Core::Hashable
747
+
748
+ # A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`
749
+ # .
750
+ # Corresponds to the JSON property `apiName`
751
+ # @return [String]
752
+ attr_accessor :api_name
753
+
754
+ # Still usable but deprecated names for this metric. If populated, this metric
755
+ # is available by either `apiName` or one of `deprecatedApiNames` for a period
756
+ # of time. After the deprecation period, the metric will be available only by `
757
+ # apiName`.
758
+ # Corresponds to the JSON property `deprecatedApiNames`
759
+ # @return [Array<String>]
760
+ attr_accessor :deprecated_api_names
761
+
762
+ # Description of how this metric is used and calculated.
763
+ # Corresponds to the JSON property `description`
764
+ # @return [String]
765
+ attr_accessor :description
766
+
767
+ # The mathematical expression for this derived metric. Can be used in [Metric](#
768
+ # Metric)'s `expression` field for equivalent reports. Most metrics are not
769
+ # expressions, and for non-expressions, this field is empty.
770
+ # Corresponds to the JSON property `expression`
771
+ # @return [String]
772
+ attr_accessor :expression
773
+
774
+ # The type of this metric.
775
+ # Corresponds to the JSON property `type`
776
+ # @return [String]
777
+ attr_accessor :type
778
+
779
+ # This metric's name within the Google Analytics user interface. For example, `
780
+ # Event count`.
781
+ # Corresponds to the JSON property `uiName`
782
+ # @return [String]
783
+ attr_accessor :ui_name
784
+
785
+ def initialize(**args)
786
+ update!(**args)
787
+ end
788
+
789
+ # Update properties of this object
790
+ def update!(**args)
791
+ @api_name = args[:api_name] if args.key?(:api_name)
792
+ @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
793
+ @description = args[:description] if args.key?(:description)
794
+ @expression = args[:expression] if args.key?(:expression)
795
+ @type = args[:type] if args.key?(:type)
796
+ @ui_name = args[:ui_name] if args.key?(:ui_name)
797
+ end
798
+ end
799
+
800
+ # Sorts by metric values.
801
+ class MetricOrderBy
802
+ include Google::Apis::Core::Hashable
803
+
804
+ # A metric name in the request to order by.
805
+ # Corresponds to the JSON property `metricName`
806
+ # @return [String]
807
+ attr_accessor :metric_name
808
+
809
+ def initialize(**args)
810
+ update!(**args)
811
+ end
812
+
813
+ # Update properties of this object
814
+ def update!(**args)
815
+ @metric_name = args[:metric_name] if args.key?(:metric_name)
816
+ end
817
+ end
818
+
819
+ # The value of a metric.
820
+ class MetricValue
821
+ include Google::Apis::Core::Hashable
822
+
823
+ # Measurement value. See MetricHeader for type.
824
+ # Corresponds to the JSON property `value`
825
+ # @return [String]
826
+ attr_accessor :value
827
+
828
+ def initialize(**args)
829
+ update!(**args)
830
+ end
831
+
832
+ # Update properties of this object
833
+ def update!(**args)
834
+ @value = args[:value] if args.key?(:value)
835
+ end
836
+ end
837
+
838
+ # Filters for numeric or date values.
839
+ class NumericFilter
840
+ include Google::Apis::Core::Hashable
841
+
842
+ # The operation type for this filter.
843
+ # Corresponds to the JSON property `operation`
844
+ # @return [String]
845
+ attr_accessor :operation
846
+
847
+ # To represent a number.
848
+ # Corresponds to the JSON property `value`
849
+ # @return [Google::Apis::AnalyticsdataV1alpha::NumericValue]
850
+ attr_accessor :value
851
+
852
+ def initialize(**args)
853
+ update!(**args)
854
+ end
855
+
856
+ # Update properties of this object
857
+ def update!(**args)
858
+ @operation = args[:operation] if args.key?(:operation)
859
+ @value = args[:value] if args.key?(:value)
860
+ end
861
+ end
862
+
863
+ # To represent a number.
864
+ class NumericValue
865
+ include Google::Apis::Core::Hashable
866
+
867
+ # Double value
868
+ # Corresponds to the JSON property `doubleValue`
869
+ # @return [Float]
870
+ attr_accessor :double_value
871
+
872
+ # Integer value
873
+ # Corresponds to the JSON property `int64Value`
874
+ # @return [Fixnum]
875
+ attr_accessor :int64_value
876
+
877
+ def initialize(**args)
878
+ update!(**args)
879
+ end
880
+
881
+ # Update properties of this object
882
+ def update!(**args)
883
+ @double_value = args[:double_value] if args.key?(:double_value)
884
+ @int64_value = args[:int64_value] if args.key?(:int64_value)
885
+ end
886
+ end
887
+
888
+ # The sort options.
889
+ class OrderBy
890
+ include Google::Apis::Core::Hashable
891
+
892
+ # If true, sorts by descending order.
893
+ # Corresponds to the JSON property `desc`
894
+ # @return [Boolean]
895
+ attr_accessor :desc
896
+ alias_method :desc?, :desc
897
+
898
+ # Sorts by dimension values.
899
+ # Corresponds to the JSON property `dimension`
900
+ # @return [Google::Apis::AnalyticsdataV1alpha::DimensionOrderBy]
901
+ attr_accessor :dimension
902
+
903
+ # Sorts by metric values.
904
+ # Corresponds to the JSON property `metric`
905
+ # @return [Google::Apis::AnalyticsdataV1alpha::MetricOrderBy]
906
+ attr_accessor :metric
907
+
908
+ # Sorts by a pivot column group.
909
+ # Corresponds to the JSON property `pivot`
910
+ # @return [Google::Apis::AnalyticsdataV1alpha::PivotOrderBy]
911
+ attr_accessor :pivot
912
+
913
+ def initialize(**args)
914
+ update!(**args)
915
+ end
916
+
917
+ # Update properties of this object
918
+ def update!(**args)
919
+ @desc = args[:desc] if args.key?(:desc)
920
+ @dimension = args[:dimension] if args.key?(:dimension)
921
+ @metric = args[:metric] if args.key?(:metric)
922
+ @pivot = args[:pivot] if args.key?(:pivot)
923
+ end
924
+ end
925
+
926
+ # Describes the visible dimension columns and rows in the report response.
927
+ class Pivot
928
+ include Google::Apis::Core::Hashable
929
+
930
+ # Dimension names for visible columns in the report response. Including "
931
+ # dateRange" produces a date range column; for each row in the response,
932
+ # dimension values in the date range column will indicate the corresponding date
933
+ # range from the request.
934
+ # Corresponds to the JSON property `fieldNames`
935
+ # @return [Array<String>]
936
+ attr_accessor :field_names
937
+
938
+ # The number of rows to return in this pivot. If unspecified, 10 rows are
939
+ # returned. If -1, all rows are returned.
940
+ # Corresponds to the JSON property `limit`
941
+ # @return [Fixnum]
942
+ attr_accessor :limit
943
+
944
+ # Aggregate the metrics by dimensions in this pivot using the specified
945
+ # metric_aggregations.
946
+ # Corresponds to the JSON property `metricAggregations`
947
+ # @return [Array<String>]
948
+ attr_accessor :metric_aggregations
949
+
950
+ # The row count of the start row. The first row is counted as row 0.
951
+ # Corresponds to the JSON property `offset`
952
+ # @return [Fixnum]
953
+ attr_accessor :offset
954
+
955
+ # Specifies how dimensions are ordered in the pivot. In the first Pivot, the
956
+ # OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots,
957
+ # the OrderBys determine only PivotDimensionHeader ordering. Dimensions
958
+ # specified in these OrderBys must be a subset of Pivot.field_names.
959
+ # Corresponds to the JSON property `orderBys`
960
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::OrderBy>]
961
+ attr_accessor :order_bys
962
+
963
+ def initialize(**args)
964
+ update!(**args)
965
+ end
966
+
967
+ # Update properties of this object
968
+ def update!(**args)
969
+ @field_names = args[:field_names] if args.key?(:field_names)
970
+ @limit = args[:limit] if args.key?(:limit)
971
+ @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations)
972
+ @offset = args[:offset] if args.key?(:offset)
973
+ @order_bys = args[:order_bys] if args.key?(:order_bys)
974
+ end
975
+ end
976
+
977
+ # Summarizes dimension values from a row for this pivot.
978
+ class PivotDimensionHeader
979
+ include Google::Apis::Core::Hashable
980
+
981
+ # Values of multiple dimensions in a pivot.
982
+ # Corresponds to the JSON property `dimensionValues`
983
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::DimensionValue>]
984
+ attr_accessor :dimension_values
985
+
986
+ def initialize(**args)
987
+ update!(**args)
988
+ end
989
+
990
+ # Update properties of this object
991
+ def update!(**args)
992
+ @dimension_values = args[:dimension_values] if args.key?(:dimension_values)
993
+ end
994
+ end
995
+
996
+ # Dimensions' values in a single pivot.
997
+ class PivotHeader
998
+ include Google::Apis::Core::Hashable
999
+
1000
+ # The size is the same as the cardinality of the corresponding dimension
1001
+ # combinations.
1002
+ # Corresponds to the JSON property `pivotDimensionHeaders`
1003
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::PivotDimensionHeader>]
1004
+ attr_accessor :pivot_dimension_headers
1005
+
1006
+ # The cardinality of the pivot as if offset = 0 and limit = -1. The total number
1007
+ # of rows for this pivot's fields regardless of how the parameters offset and
1008
+ # limit are specified in the request.
1009
+ # Corresponds to the JSON property `rowCount`
1010
+ # @return [Fixnum]
1011
+ attr_accessor :row_count
1012
+
1013
+ def initialize(**args)
1014
+ update!(**args)
1015
+ end
1016
+
1017
+ # Update properties of this object
1018
+ def update!(**args)
1019
+ @pivot_dimension_headers = args[:pivot_dimension_headers] if args.key?(:pivot_dimension_headers)
1020
+ @row_count = args[:row_count] if args.key?(:row_count)
1021
+ end
1022
+ end
1023
+
1024
+ # Sorts by a pivot column group.
1025
+ class PivotOrderBy
1026
+ include Google::Apis::Core::Hashable
1027
+
1028
+ # In the response to order by, order rows by this column. Must be a metric name
1029
+ # from the request.
1030
+ # Corresponds to the JSON property `metricName`
1031
+ # @return [String]
1032
+ attr_accessor :metric_name
1033
+
1034
+ # Used to select a dimension name and value pivot. If multiple pivot selections
1035
+ # are given, the sort occurs on rows where all pivot selection dimension name
1036
+ # and value pairs match the row's dimension name and value pair.
1037
+ # Corresponds to the JSON property `pivotSelections`
1038
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::PivotSelection>]
1039
+ attr_accessor :pivot_selections
1040
+
1041
+ def initialize(**args)
1042
+ update!(**args)
1043
+ end
1044
+
1045
+ # Update properties of this object
1046
+ def update!(**args)
1047
+ @metric_name = args[:metric_name] if args.key?(:metric_name)
1048
+ @pivot_selections = args[:pivot_selections] if args.key?(:pivot_selections)
1049
+ end
1050
+ end
1051
+
1052
+ # A pair of dimension names and values. Rows with this dimension pivot pair are
1053
+ # ordered by the metric's value. For example if pivots = ``"browser", "Chrome"``
1054
+ # and metric_name = "Sessions", then the rows will be sorted based on Sessions
1055
+ # in Chrome. ---------|----------|----------------|----------|---------------- |
1056
+ # Chrome | Chrome | Safari | Safari ---------|----------|----------------|-------
1057
+ # ---|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/
1058
+ # Sessions ---------|----------|----------------|----------|---------------- US |
1059
+ # 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------
1060
+ # - Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|-----
1061
+ # -----------
1062
+ class PivotSelection
1063
+ include Google::Apis::Core::Hashable
1064
+
1065
+ # Must be a dimension name from the request.
1066
+ # Corresponds to the JSON property `dimensionName`
1067
+ # @return [String]
1068
+ attr_accessor :dimension_name
1069
+
1070
+ # Order by only when the named dimension is this value.
1071
+ # Corresponds to the JSON property `dimensionValue`
1072
+ # @return [String]
1073
+ attr_accessor :dimension_value
1074
+
1075
+ def initialize(**args)
1076
+ update!(**args)
1077
+ end
1078
+
1079
+ # Update properties of this object
1080
+ def update!(**args)
1081
+ @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
1082
+ @dimension_value = args[:dimension_value] if args.key?(:dimension_value)
1083
+ end
1084
+ end
1085
+
1086
+ # Current state of all quotas for this Analytics Property. If any quota for a
1087
+ # property is exhausted, all requests to that property will return Resource
1088
+ # Exhausted errors.
1089
+ class PropertyQuota
1090
+ include Google::Apis::Core::Hashable
1091
+
1092
+ # Current state for a particular quota group.
1093
+ # Corresponds to the JSON property `concurrentRequests`
1094
+ # @return [Google::Apis::AnalyticsdataV1alpha::QuotaStatus]
1095
+ attr_accessor :concurrent_requests
1096
+
1097
+ # Current state for a particular quota group.
1098
+ # Corresponds to the JSON property `serverErrorsPerProjectPerHour`
1099
+ # @return [Google::Apis::AnalyticsdataV1alpha::QuotaStatus]
1100
+ attr_accessor :server_errors_per_project_per_hour
1101
+
1102
+ # Current state for a particular quota group.
1103
+ # Corresponds to the JSON property `tokensPerDay`
1104
+ # @return [Google::Apis::AnalyticsdataV1alpha::QuotaStatus]
1105
+ attr_accessor :tokens_per_day
1106
+
1107
+ # Current state for a particular quota group.
1108
+ # Corresponds to the JSON property `tokensPerHour`
1109
+ # @return [Google::Apis::AnalyticsdataV1alpha::QuotaStatus]
1110
+ attr_accessor :tokens_per_hour
1111
+
1112
+ def initialize(**args)
1113
+ update!(**args)
1114
+ end
1115
+
1116
+ # Update properties of this object
1117
+ def update!(**args)
1118
+ @concurrent_requests = args[:concurrent_requests] if args.key?(:concurrent_requests)
1119
+ @server_errors_per_project_per_hour = args[:server_errors_per_project_per_hour] if args.key?(:server_errors_per_project_per_hour)
1120
+ @tokens_per_day = args[:tokens_per_day] if args.key?(:tokens_per_day)
1121
+ @tokens_per_hour = args[:tokens_per_hour] if args.key?(:tokens_per_hour)
1122
+ end
1123
+ end
1124
+
1125
+ # Current state for a particular quota group.
1126
+ class QuotaStatus
1127
+ include Google::Apis::Core::Hashable
1128
+
1129
+ # Quota consumed by this request.
1130
+ # Corresponds to the JSON property `consumed`
1131
+ # @return [Fixnum]
1132
+ attr_accessor :consumed
1133
+
1134
+ # Quota remaining after this request.
1135
+ # Corresponds to the JSON property `remaining`
1136
+ # @return [Fixnum]
1137
+ attr_accessor :remaining
1138
+
1139
+ def initialize(**args)
1140
+ update!(**args)
1141
+ end
1142
+
1143
+ # Update properties of this object
1144
+ def update!(**args)
1145
+ @consumed = args[:consumed] if args.key?(:consumed)
1146
+ @remaining = args[:remaining] if args.key?(:remaining)
1147
+ end
1148
+ end
1149
+
1150
+ # Response's metadata carrying additional information about the report content.
1151
+ class ResponseMetaData
1152
+ include Google::Apis::Core::Hashable
1153
+
1154
+ # If true, indicates some buckets of dimension combinations are rolled into "(
1155
+ # other)" row. This can happen for high cardinality reports.
1156
+ # Corresponds to the JSON property `dataLossFromOtherRow`
1157
+ # @return [Boolean]
1158
+ attr_accessor :data_loss_from_other_row
1159
+ alias_method :data_loss_from_other_row?, :data_loss_from_other_row
1160
+
1161
+ def initialize(**args)
1162
+ update!(**args)
1163
+ end
1164
+
1165
+ # Update properties of this object
1166
+ def update!(**args)
1167
+ @data_loss_from_other_row = args[:data_loss_from_other_row] if args.key?(:data_loss_from_other_row)
1168
+ end
1169
+ end
1170
+
1171
+ # Report data for each row. For example if RunReportRequest contains: ```none
1172
+ # dimensions ` name: "eventName" ` dimensions ` name: "countryId" ` metrics `
1173
+ # name: "eventCount" ` ``` One row with 'in_app_purchase' as the eventName, 'us'
1174
+ # as the countryId, and 15 as the eventCount, would be: ```none dimension_values
1175
+ # ` name: 'in_app_purchase' name: 'us' ` metric_values ` int64_value: 15 ` ```
1176
+ class Row
1177
+ include Google::Apis::Core::Hashable
1178
+
1179
+ # List of requested dimension values. In a PivotReport, dimension_values are
1180
+ # only listed for dimensions included in a pivot.
1181
+ # Corresponds to the JSON property `dimensionValues`
1182
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::DimensionValue>]
1183
+ attr_accessor :dimension_values
1184
+
1185
+ # List of requested visible metric values.
1186
+ # Corresponds to the JSON property `metricValues`
1187
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::MetricValue>]
1188
+ attr_accessor :metric_values
1189
+
1190
+ def initialize(**args)
1191
+ update!(**args)
1192
+ end
1193
+
1194
+ # Update properties of this object
1195
+ def update!(**args)
1196
+ @dimension_values = args[:dimension_values] if args.key?(:dimension_values)
1197
+ @metric_values = args[:metric_values] if args.key?(:metric_values)
1198
+ end
1199
+ end
1200
+
1201
+ # The request to generate a pivot report.
1202
+ class RunPivotReportRequest
1203
+ include Google::Apis::Core::Hashable
1204
+
1205
+ # Specification for a cohort report.
1206
+ # Corresponds to the JSON property `cohortSpec`
1207
+ # @return [Google::Apis::AnalyticsdataV1alpha::CohortSpec]
1208
+ attr_accessor :cohort_spec
1209
+
1210
+ # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field
1211
+ # is empty, the report uses the entity's default currency.
1212
+ # Corresponds to the JSON property `currencyCode`
1213
+ # @return [String]
1214
+ attr_accessor :currency_code
1215
+
1216
+ # The date range to retrieve event data for the report. If multiple date ranges
1217
+ # are specified, event data from each date range is used in the report. A
1218
+ # special dimension with field name "dateRange" can be included in a Pivot's
1219
+ # field names; if included, the report compares between date ranges. In a cohort
1220
+ # request, this `dateRanges` must be unspecified.
1221
+ # Corresponds to the JSON property `dateRanges`
1222
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::DateRange>]
1223
+ attr_accessor :date_ranges
1224
+
1225
+ # To express dimension or metric filters. The fields in the same
1226
+ # FilterExpression need to be either all dimensions or all metrics.
1227
+ # Corresponds to the JSON property `dimensionFilter`
1228
+ # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression]
1229
+ attr_accessor :dimension_filter
1230
+
1231
+ # The dimensions requested. All defined dimensions must be used by one of the
1232
+ # following: dimension_expression, dimension_filter, pivots, order_bys.
1233
+ # Corresponds to the JSON property `dimensions`
1234
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Dimension>]
1235
+ attr_accessor :dimensions
1236
+
1237
+ # The unique identifier of the property whose events are tracked.
1238
+ # Corresponds to the JSON property `entity`
1239
+ # @return [Google::Apis::AnalyticsdataV1alpha::Entity]
1240
+ attr_accessor :entity
1241
+
1242
+ # If false or unspecified, each row with all metrics equal to 0 will not be
1243
+ # returned. If true, these rows will be returned if they are not separately
1244
+ # removed by a filter.
1245
+ # Corresponds to the JSON property `keepEmptyRows`
1246
+ # @return [Boolean]
1247
+ attr_accessor :keep_empty_rows
1248
+ alias_method :keep_empty_rows?, :keep_empty_rows
1249
+
1250
+ # To express dimension or metric filters. The fields in the same
1251
+ # FilterExpression need to be either all dimensions or all metrics.
1252
+ # Corresponds to the JSON property `metricFilter`
1253
+ # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression]
1254
+ attr_accessor :metric_filter
1255
+
1256
+ # The metrics requested, at least one metric needs to be specified. All defined
1257
+ # metrics must be used by one of the following: metric_expression, metric_filter,
1258
+ # order_bys.
1259
+ # Corresponds to the JSON property `metrics`
1260
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Metric>]
1261
+ attr_accessor :metrics
1262
+
1263
+ # Describes the visual format of the report's dimensions in columns or rows. The
1264
+ # union of the fieldNames (dimension names) in all pivots must be a subset of
1265
+ # dimension names defined in Dimensions. No two pivots can share a dimension. A
1266
+ # dimension is only visible if it appears in a pivot.
1267
+ # Corresponds to the JSON property `pivots`
1268
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Pivot>]
1269
+ attr_accessor :pivots
1270
+
1271
+ # Toggles whether to return the current state of this Analytics Property's quota.
1272
+ # Quota is returned in [PropertyQuota](#PropertyQuota).
1273
+ # Corresponds to the JSON property `returnPropertyQuota`
1274
+ # @return [Boolean]
1275
+ attr_accessor :return_property_quota
1276
+ alias_method :return_property_quota?, :return_property_quota
1277
+
1278
+ def initialize(**args)
1279
+ update!(**args)
1280
+ end
1281
+
1282
+ # Update properties of this object
1283
+ def update!(**args)
1284
+ @cohort_spec = args[:cohort_spec] if args.key?(:cohort_spec)
1285
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
1286
+ @date_ranges = args[:date_ranges] if args.key?(:date_ranges)
1287
+ @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
1288
+ @dimensions = args[:dimensions] if args.key?(:dimensions)
1289
+ @entity = args[:entity] if args.key?(:entity)
1290
+ @keep_empty_rows = args[:keep_empty_rows] if args.key?(:keep_empty_rows)
1291
+ @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
1292
+ @metrics = args[:metrics] if args.key?(:metrics)
1293
+ @pivots = args[:pivots] if args.key?(:pivots)
1294
+ @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
1295
+ end
1296
+ end
1297
+
1298
+ # The response pivot report table corresponding to a pivot request.
1299
+ class RunPivotReportResponse
1300
+ include Google::Apis::Core::Hashable
1301
+
1302
+ # Aggregation of metric values. Can be totals, minimums, or maximums. The
1303
+ # returned aggregations are controlled by the metric_aggregations in the pivot.
1304
+ # The type of aggregation returned in each row is shown by the dimension_values
1305
+ # which are set to "RESERVED_".
1306
+ # Corresponds to the JSON property `aggregates`
1307
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
1308
+ attr_accessor :aggregates
1309
+
1310
+ # Describes dimension columns. The number of DimensionHeaders and ordering of
1311
+ # DimensionHeaders matches the dimensions present in rows.
1312
+ # Corresponds to the JSON property `dimensionHeaders`
1313
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::DimensionHeader>]
1314
+ attr_accessor :dimension_headers
1315
+
1316
+ # Response's metadata carrying additional information about the report content.
1317
+ # Corresponds to the JSON property `metadata`
1318
+ # @return [Google::Apis::AnalyticsdataV1alpha::ResponseMetaData]
1319
+ attr_accessor :metadata
1320
+
1321
+ # Describes metric columns. The number of MetricHeaders and ordering of
1322
+ # MetricHeaders matches the metrics present in rows.
1323
+ # Corresponds to the JSON property `metricHeaders`
1324
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::MetricHeader>]
1325
+ attr_accessor :metric_headers
1326
+
1327
+ # Summarizes the columns and rows created by a pivot. Each pivot in the request
1328
+ # produces one header in the response. If we have a request like this: "pivots":
1329
+ # [` "fieldNames": ["country", "city"] `, ` "fieldNames": "eventName" `] We will
1330
+ # have the following `pivotHeaders` in the response: "pivotHeaders" : [` "
1331
+ # dimensionHeaders": [` "dimensionValues": [ ` "value": "United Kingdom" `, ` "
1332
+ # value": "London" ` ] `, ` "dimensionValues": [ ` "value": "Japan" `, ` "value":
1333
+ # "Osaka" ` ] `] `, ` "dimensionHeaders": [` "dimensionValues": [` "value": "
1334
+ # session_start" `] `, ` "dimensionValues": [` "value": "scroll" `] `] `]
1335
+ # Corresponds to the JSON property `pivotHeaders`
1336
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::PivotHeader>]
1337
+ attr_accessor :pivot_headers
1338
+
1339
+ # Current state of all quotas for this Analytics Property. If any quota for a
1340
+ # property is exhausted, all requests to that property will return Resource
1341
+ # Exhausted errors.
1342
+ # Corresponds to the JSON property `propertyQuota`
1343
+ # @return [Google::Apis::AnalyticsdataV1alpha::PropertyQuota]
1344
+ attr_accessor :property_quota
1345
+
1346
+ # Rows of dimension value combinations and metric values in the report.
1347
+ # Corresponds to the JSON property `rows`
1348
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
1349
+ attr_accessor :rows
1350
+
1351
+ def initialize(**args)
1352
+ update!(**args)
1353
+ end
1354
+
1355
+ # Update properties of this object
1356
+ def update!(**args)
1357
+ @aggregates = args[:aggregates] if args.key?(:aggregates)
1358
+ @dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers)
1359
+ @metadata = args[:metadata] if args.key?(:metadata)
1360
+ @metric_headers = args[:metric_headers] if args.key?(:metric_headers)
1361
+ @pivot_headers = args[:pivot_headers] if args.key?(:pivot_headers)
1362
+ @property_quota = args[:property_quota] if args.key?(:property_quota)
1363
+ @rows = args[:rows] if args.key?(:rows)
1364
+ end
1365
+ end
1366
+
1367
+ # The request to generate a report.
1368
+ class RunReportRequest
1369
+ include Google::Apis::Core::Hashable
1370
+
1371
+ # Specification for a cohort report.
1372
+ # Corresponds to the JSON property `cohortSpec`
1373
+ # @return [Google::Apis::AnalyticsdataV1alpha::CohortSpec]
1374
+ attr_accessor :cohort_spec
1375
+
1376
+ # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field
1377
+ # is empty, the report uses the entity's default currency.
1378
+ # Corresponds to the JSON property `currencyCode`
1379
+ # @return [String]
1380
+ attr_accessor :currency_code
1381
+
1382
+ # Date ranges of data to read. If multiple date ranges are requested, each
1383
+ # response row will contain a zero based date range index. If two date ranges
1384
+ # overlap, the event data for the overlapping days is included in the response
1385
+ # rows for both date ranges. In a cohort request, this `dateRanges` must be
1386
+ # unspecified.
1387
+ # Corresponds to the JSON property `dateRanges`
1388
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::DateRange>]
1389
+ attr_accessor :date_ranges
1390
+
1391
+ # To express dimension or metric filters. The fields in the same
1392
+ # FilterExpression need to be either all dimensions or all metrics.
1393
+ # Corresponds to the JSON property `dimensionFilter`
1394
+ # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression]
1395
+ attr_accessor :dimension_filter
1396
+
1397
+ # The dimensions requested and displayed.
1398
+ # Corresponds to the JSON property `dimensions`
1399
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Dimension>]
1400
+ attr_accessor :dimensions
1401
+
1402
+ # The unique identifier of the property whose events are tracked.
1403
+ # Corresponds to the JSON property `entity`
1404
+ # @return [Google::Apis::AnalyticsdataV1alpha::Entity]
1405
+ attr_accessor :entity
1406
+
1407
+ # If false or unspecified, each row with all metrics equal to 0 will not be
1408
+ # returned. If true, these rows will be returned if they are not separately
1409
+ # removed by a filter.
1410
+ # Corresponds to the JSON property `keepEmptyRows`
1411
+ # @return [Boolean]
1412
+ attr_accessor :keep_empty_rows
1413
+ alias_method :keep_empty_rows?, :keep_empty_rows
1414
+
1415
+ # The number of rows to return. If unspecified, 10 rows are returned. If -1, all
1416
+ # rows are returned.
1417
+ # Corresponds to the JSON property `limit`
1418
+ # @return [Fixnum]
1419
+ attr_accessor :limit
1420
+
1421
+ # Aggregation of metrics. Aggregated metric values will be shown in rows where
1422
+ # the dimension_values are set to "RESERVED_(MetricAggregation)".
1423
+ # Corresponds to the JSON property `metricAggregations`
1424
+ # @return [Array<String>]
1425
+ attr_accessor :metric_aggregations
1426
+
1427
+ # To express dimension or metric filters. The fields in the same
1428
+ # FilterExpression need to be either all dimensions or all metrics.
1429
+ # Corresponds to the JSON property `metricFilter`
1430
+ # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression]
1431
+ attr_accessor :metric_filter
1432
+
1433
+ # The metrics requested and displayed.
1434
+ # Corresponds to the JSON property `metrics`
1435
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Metric>]
1436
+ attr_accessor :metrics
1437
+
1438
+ # The row count of the start row. The first row is counted as row 0.
1439
+ # Corresponds to the JSON property `offset`
1440
+ # @return [Fixnum]
1441
+ attr_accessor :offset
1442
+
1443
+ # Specifies how rows are ordered in the response.
1444
+ # Corresponds to the JSON property `orderBys`
1445
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::OrderBy>]
1446
+ attr_accessor :order_bys
1447
+
1448
+ # Toggles whether to return the current state of this Analytics Property's quota.
1449
+ # Quota is returned in [PropertyQuota](#PropertyQuota).
1450
+ # Corresponds to the JSON property `returnPropertyQuota`
1451
+ # @return [Boolean]
1452
+ attr_accessor :return_property_quota
1453
+ alias_method :return_property_quota?, :return_property_quota
1454
+
1455
+ def initialize(**args)
1456
+ update!(**args)
1457
+ end
1458
+
1459
+ # Update properties of this object
1460
+ def update!(**args)
1461
+ @cohort_spec = args[:cohort_spec] if args.key?(:cohort_spec)
1462
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
1463
+ @date_ranges = args[:date_ranges] if args.key?(:date_ranges)
1464
+ @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
1465
+ @dimensions = args[:dimensions] if args.key?(:dimensions)
1466
+ @entity = args[:entity] if args.key?(:entity)
1467
+ @keep_empty_rows = args[:keep_empty_rows] if args.key?(:keep_empty_rows)
1468
+ @limit = args[:limit] if args.key?(:limit)
1469
+ @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations)
1470
+ @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
1471
+ @metrics = args[:metrics] if args.key?(:metrics)
1472
+ @offset = args[:offset] if args.key?(:offset)
1473
+ @order_bys = args[:order_bys] if args.key?(:order_bys)
1474
+ @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
1475
+ end
1476
+ end
1477
+
1478
+ # The response report table corresponding to a request.
1479
+ class RunReportResponse
1480
+ include Google::Apis::Core::Hashable
1481
+
1482
+ # Describes dimension columns. The number of DimensionHeaders and ordering of
1483
+ # DimensionHeaders matches the dimensions present in rows.
1484
+ # Corresponds to the JSON property `dimensionHeaders`
1485
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::DimensionHeader>]
1486
+ attr_accessor :dimension_headers
1487
+
1488
+ # If requested, the maximum values of metrics.
1489
+ # Corresponds to the JSON property `maximums`
1490
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
1491
+ attr_accessor :maximums
1492
+
1493
+ # Response's metadata carrying additional information about the report content.
1494
+ # Corresponds to the JSON property `metadata`
1495
+ # @return [Google::Apis::AnalyticsdataV1alpha::ResponseMetaData]
1496
+ attr_accessor :metadata
1497
+
1498
+ # Describes metric columns. The number of MetricHeaders and ordering of
1499
+ # MetricHeaders matches the metrics present in rows.
1500
+ # Corresponds to the JSON property `metricHeaders`
1501
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::MetricHeader>]
1502
+ attr_accessor :metric_headers
1503
+
1504
+ # If requested, the minimum values of metrics.
1505
+ # Corresponds to the JSON property `minimums`
1506
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
1507
+ attr_accessor :minimums
1508
+
1509
+ # Current state of all quotas for this Analytics Property. If any quota for a
1510
+ # property is exhausted, all requests to that property will return Resource
1511
+ # Exhausted errors.
1512
+ # Corresponds to the JSON property `propertyQuota`
1513
+ # @return [Google::Apis::AnalyticsdataV1alpha::PropertyQuota]
1514
+ attr_accessor :property_quota
1515
+
1516
+ # The total number of rows in the query result, regardless of the number of rows
1517
+ # returned in the response. For example if a query returns 175 rows and includes
1518
+ # limit = 50 in the API request, the response will contain row_count = 175 but
1519
+ # only 50 rows.
1520
+ # Corresponds to the JSON property `rowCount`
1521
+ # @return [Fixnum]
1522
+ attr_accessor :row_count
1523
+
1524
+ # Rows of dimension value combinations and metric values in the report.
1525
+ # Corresponds to the JSON property `rows`
1526
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
1527
+ attr_accessor :rows
1528
+
1529
+ # If requested, the totaled values of metrics.
1530
+ # Corresponds to the JSON property `totals`
1531
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
1532
+ attr_accessor :totals
1533
+
1534
+ def initialize(**args)
1535
+ update!(**args)
1536
+ end
1537
+
1538
+ # Update properties of this object
1539
+ def update!(**args)
1540
+ @dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers)
1541
+ @maximums = args[:maximums] if args.key?(:maximums)
1542
+ @metadata = args[:metadata] if args.key?(:metadata)
1543
+ @metric_headers = args[:metric_headers] if args.key?(:metric_headers)
1544
+ @minimums = args[:minimums] if args.key?(:minimums)
1545
+ @property_quota = args[:property_quota] if args.key?(:property_quota)
1546
+ @row_count = args[:row_count] if args.key?(:row_count)
1547
+ @rows = args[:rows] if args.key?(:rows)
1548
+ @totals = args[:totals] if args.key?(:totals)
1549
+ end
1550
+ end
1551
+
1552
+ # The filter for string
1553
+ class StringFilter
1554
+ include Google::Apis::Core::Hashable
1555
+
1556
+ # If true, the string value is case sensitive.
1557
+ # Corresponds to the JSON property `caseSensitive`
1558
+ # @return [Boolean]
1559
+ attr_accessor :case_sensitive
1560
+ alias_method :case_sensitive?, :case_sensitive
1561
+
1562
+ # The match type for this filter.
1563
+ # Corresponds to the JSON property `matchType`
1564
+ # @return [String]
1565
+ attr_accessor :match_type
1566
+
1567
+ # The string value used for the matching.
1568
+ # Corresponds to the JSON property `value`
1569
+ # @return [String]
1570
+ attr_accessor :value
1571
+
1572
+ def initialize(**args)
1573
+ update!(**args)
1574
+ end
1575
+
1576
+ # Update properties of this object
1577
+ def update!(**args)
1578
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
1579
+ @match_type = args[:match_type] if args.key?(:match_type)
1580
+ @value = args[:value] if args.key?(:value)
1581
+ end
1582
+ end
1583
+
1584
+ # The dimensions and metrics currently accepted in reporting methods.
1585
+ class UniversalMetadata
1586
+ include Google::Apis::Core::Hashable
1587
+
1588
+ # The dimensions descriptions.
1589
+ # Corresponds to the JSON property `dimensions`
1590
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::DimensionMetadata>]
1591
+ attr_accessor :dimensions
1592
+
1593
+ # The metric descriptions.
1594
+ # Corresponds to the JSON property `metrics`
1595
+ # @return [Array<Google::Apis::AnalyticsdataV1alpha::MetricMetadata>]
1596
+ attr_accessor :metrics
1597
+
1598
+ def initialize(**args)
1599
+ update!(**args)
1600
+ end
1601
+
1602
+ # Update properties of this object
1603
+ def update!(**args)
1604
+ @dimensions = args[:dimensions] if args.key?(:dimensions)
1605
+ @metrics = args[:metrics] if args.key?(:metrics)
1606
+ end
1607
+ end
1608
+ end
1609
+ end
1610
+ end