google-api-client 0.8.6 → 0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (497) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +20 -0
  3. data/.rspec +2 -0
  4. data/.rubocop.yml +7 -0
  5. data/.rubocop_todo.yml +63 -0
  6. data/.travis.yml +22 -0
  7. data/.yardopts +12 -0
  8. data/CHANGELOG.md +41 -2
  9. data/CONTRIBUTING.md +31 -0
  10. data/Gemfile +32 -2
  11. data/MIGRATING.md +171 -0
  12. data/README.md +181 -148
  13. data/Rakefile +1 -40
  14. data/api_names.yaml +1036 -0
  15. data/api_names_out.yaml +26053 -0
  16. data/bin/generate-api +95 -0
  17. data/generated/google/apis/adexchangebuyer_v1_3.rb +35 -0
  18. data/generated/google/apis/adexchangebuyer_v1_3/classes.rb +1335 -0
  19. data/generated/google/apis/adexchangebuyer_v1_3/representations.rb +446 -0
  20. data/generated/google/apis/adexchangebuyer_v1_3/service.rb +872 -0
  21. data/generated/google/apis/adexchangeseller_v2_0.rb +38 -0
  22. data/generated/google/apis/adexchangeseller_v2_0/classes.rb +792 -0
  23. data/generated/google/apis/adexchangeseller_v2_0/representations.rb +309 -0
  24. data/generated/google/apis/adexchangeseller_v2_0/service.rb +668 -0
  25. data/generated/google/apis/admin_datatransfer_v1.rb +37 -0
  26. data/generated/google/apis/admin_datatransfer_v1/classes.rb +267 -0
  27. data/generated/google/apis/admin_datatransfer_v1/representations.rb +118 -0
  28. data/generated/google/apis/admin_datatransfer_v1/service.rb +262 -0
  29. data/generated/google/apis/admin_directory_v1.rb +113 -0
  30. data/generated/google/apis/admin_directory_v1/classes.rb +3141 -0
  31. data/generated/google/apis/admin_directory_v1/representations.rb +1029 -0
  32. data/generated/google/apis/admin_directory_v1/service.rb +3818 -0
  33. data/generated/google/apis/admin_reports_v1.rb +38 -0
  34. data/generated/google/apis/admin_reports_v1/classes.rb +582 -0
  35. data/generated/google/apis/admin_reports_v1/representations.rb +231 -0
  36. data/generated/google/apis/admin_reports_v1/service.rb +336 -0
  37. data/generated/google/apis/adsense_v1_4.rb +38 -0
  38. data/generated/google/apis/adsense_v1_4/classes.rb +1285 -0
  39. data/generated/google/apis/adsense_v1_4/representations.rb +494 -0
  40. data/generated/google/apis/adsense_v1_4/service.rb +1714 -0
  41. data/generated/google/apis/adsensehost_v4_1.rb +35 -0
  42. data/generated/google/apis/adsensehost_v4_1/classes.rb +834 -0
  43. data/generated/google/apis/adsensehost_v4_1/representations.rb +327 -0
  44. data/generated/google/apis/adsensehost_v4_1/service.rb +1164 -0
  45. data/generated/google/apis/analytics_v3.rb +49 -0
  46. data/generated/google/apis/analytics_v3/classes.rb +5118 -0
  47. data/generated/google/apis/analytics_v3/representations.rb +1662 -0
  48. data/generated/google/apis/analytics_v3/service.rb +3568 -0
  49. data/generated/google/apis/androidenterprise_v1.rb +35 -0
  50. data/generated/google/apis/androidenterprise_v1/classes.rb +1443 -0
  51. data/generated/google/apis/androidenterprise_v1/representations.rb +538 -0
  52. data/generated/google/apis/androidenterprise_v1/service.rb +2602 -0
  53. data/generated/google/apis/androidpublisher_v2.rb +34 -0
  54. data/generated/google/apis/androidpublisher_v2/classes.rb +1411 -0
  55. data/generated/google/apis/androidpublisher_v2/representations.rb +646 -0
  56. data/generated/google/apis/androidpublisher_v2/service.rb +2338 -0
  57. data/generated/google/apis/appengine_v1beta4.rb +35 -0
  58. data/generated/google/apis/appengine_v1beta4/classes.rb +1532 -0
  59. data/generated/google/apis/appengine_v1beta4/representations.rb +526 -0
  60. data/generated/google/apis/appengine_v1beta4/service.rb +476 -0
  61. data/generated/google/apis/appsactivity_v1.rb +46 -0
  62. data/generated/google/apis/appsactivity_v1/classes.rb +392 -0
  63. data/generated/google/apis/appsactivity_v1/representations.rb +184 -0
  64. data/generated/google/apis/appsactivity_v1/service.rb +128 -0
  65. data/generated/google/apis/appstate_v1.rb +34 -0
  66. data/generated/google/apis/appstate_v1/classes.rb +154 -0
  67. data/generated/google/apis/appstate_v1/representations.rb +79 -0
  68. data/generated/google/apis/appstate_v1/service.rb +260 -0
  69. data/generated/google/apis/autoscaler_v1beta2.rb +38 -0
  70. data/generated/google/apis/autoscaler_v1beta2/classes.rb +747 -0
  71. data/generated/google/apis/autoscaler_v1beta2/representations.rb +281 -0
  72. data/generated/google/apis/autoscaler_v1beta2/service.rb +478 -0
  73. data/generated/google/apis/bigquery_v2.rb +52 -0
  74. data/generated/google/apis/bigquery_v2/classes.rb +2471 -0
  75. data/generated/google/apis/bigquery_v2/representations.rb +816 -0
  76. data/generated/google/apis/bigquery_v2/service.rb +982 -0
  77. data/generated/google/apis/blogger_v3.rb +37 -0
  78. data/generated/google/apis/blogger_v3/classes.rb +1354 -0
  79. data/generated/google/apis/blogger_v3/representations.rb +562 -0
  80. data/generated/google/apis/blogger_v3/service.rb +1587 -0
  81. data/generated/google/apis/books_v1.rb +34 -0
  82. data/generated/google/apis/books_v1/classes.rb +3956 -0
  83. data/generated/google/apis/books_v1/representations.rb +1538 -0
  84. data/generated/google/apis/books_v1/service.rb +2290 -0
  85. data/generated/google/apis/calendar_v3.rb +37 -0
  86. data/generated/google/apis/calendar_v3/classes.rb +1742 -0
  87. data/generated/google/apis/calendar_v3/representations.rb +567 -0
  88. data/generated/google/apis/calendar_v3/service.rb +1968 -0
  89. data/{lib/google/api_client/service_account.rb → generated/google/apis/civicinfo_v2.rb} +18 -8
  90. data/generated/google/apis/civicinfo_v2/classes.rb +1127 -0
  91. data/generated/google/apis/civicinfo_v2/representations.rb +383 -0
  92. data/generated/google/apis/civicinfo_v2/service.rb +279 -0
  93. data/generated/google/apis/classroom_v1.rb +49 -0
  94. data/generated/google/apis/classroom_v1/classes.rb +512 -0
  95. data/generated/google/apis/classroom_v1/representations.rb +217 -0
  96. data/generated/google/apis/classroom_v1/service.rb +970 -0
  97. data/generated/google/apis/classroom_v1beta1.rb +49 -0
  98. data/generated/google/apis/classroom_v1beta1/classes.rb +447 -0
  99. data/generated/google/apis/classroom_v1beta1/representations.rb +190 -0
  100. data/generated/google/apis/classroom_v1beta1/service.rb +791 -0
  101. data/generated/google/apis/cloudbilling_v1.rb +35 -0
  102. data/generated/google/apis/cloudbilling_v1/classes.rb +169 -0
  103. data/generated/google/apis/cloudbilling_v1/representations.rb +79 -0
  104. data/generated/google/apis/cloudbilling_v1/service.rb +258 -0
  105. data/generated/google/apis/clouddebugger_v2.rb +41 -0
  106. data/generated/google/apis/clouddebugger_v2/classes.rb +1004 -0
  107. data/generated/google/apis/clouddebugger_v2/representations.rb +410 -0
  108. data/generated/google/apis/clouddebugger_v2/service.rb +370 -0
  109. data/generated/google/apis/cloudmonitoring_v2beta2.rb +37 -0
  110. data/generated/google/apis/cloudmonitoring_v2beta2/classes.rb +679 -0
  111. data/generated/google/apis/cloudmonitoring_v2beta2/representations.rb +311 -0
  112. data/generated/google/apis/cloudmonitoring_v2beta2/service.rb +452 -0
  113. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +38 -0
  114. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +437 -0
  115. data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +188 -0
  116. data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +623 -0
  117. data/generated/google/apis/cloudtrace_v1.rb +35 -0
  118. data/generated/google/apis/cloudtrace_v1/classes.rb +188 -0
  119. data/generated/google/apis/cloudtrace_v1/representations.rb +92 -0
  120. data/generated/google/apis/cloudtrace_v1/service.rb +190 -0
  121. data/generated/google/apis/clouduseraccounts_beta.rb +43 -0
  122. data/generated/google/apis/clouduseraccounts_beta/classes.rb +823 -0
  123. data/generated/google/apis/clouduseraccounts_beta/representations.rb +313 -0
  124. data/generated/google/apis/clouduseraccounts_beta/service.rb +854 -0
  125. data/generated/google/apis/compute_beta.rb +49 -0
  126. data/generated/google/apis/compute_beta/classes.rb +9128 -0
  127. data/generated/google/apis/compute_beta/representations.rb +3048 -0
  128. data/generated/google/apis/compute_beta/service.rb +10154 -0
  129. data/generated/google/apis/compute_v1.rb +49 -0
  130. data/generated/google/apis/compute_v1/classes.rb +8681 -0
  131. data/generated/google/apis/compute_v1/representations.rb +2895 -0
  132. data/generated/google/apis/compute_v1/service.rb +9252 -0
  133. data/generated/google/apis/container_v1.rb +35 -0
  134. data/generated/google/apis/container_v1/classes.rb +463 -0
  135. data/generated/google/apis/container_v1/representations.rb +175 -0
  136. data/generated/google/apis/container_v1/service.rb +367 -0
  137. data/generated/google/apis/container_v1beta1.rb +35 -0
  138. data/generated/google/apis/container_v1beta1/classes.rb +466 -0
  139. data/generated/google/apis/container_v1beta1/representations.rb +177 -0
  140. data/generated/google/apis/container_v1beta1/service.rb +394 -0
  141. data/generated/google/apis/content_v2.rb +35 -0
  142. data/generated/google/apis/content_v2/classes.rb +5986 -0
  143. data/generated/google/apis/content_v2/representations.rb +2288 -0
  144. data/generated/google/apis/content_v2/service.rb +2338 -0
  145. data/generated/google/apis/coordinate_v1.rb +37 -0
  146. data/generated/google/apis/coordinate_v1/classes.rb +669 -0
  147. data/generated/google/apis/coordinate_v1/representations.rb +285 -0
  148. data/generated/google/apis/coordinate_v1/service.rb +678 -0
  149. data/{lib/google/api_client/auth/compute_service_account.rb → generated/google/apis/customsearch_v1.rb} +13 -10
  150. data/generated/google/apis/customsearch_v1/classes.rb +771 -0
  151. data/generated/google/apis/customsearch_v1/representations.rb +276 -0
  152. data/generated/google/apis/customsearch_v1/service.rb +207 -0
  153. data/generated/google/apis/datastore_v1beta2.rb +40 -0
  154. data/generated/google/apis/datastore_v1beta2/classes.rb +1186 -0
  155. data/generated/google/apis/datastore_v1beta2/representations.rb +526 -0
  156. data/generated/google/apis/datastore_v1beta2/service.rb +294 -0
  157. data/generated/google/apis/deploymentmanager_v2.rb +44 -0
  158. data/generated/google/apis/deploymentmanager_v2/classes.rb +1091 -0
  159. data/generated/google/apis/deploymentmanager_v2/representations.rb +422 -0
  160. data/generated/google/apis/deploymentmanager_v2/service.rb +857 -0
  161. data/generated/google/apis/deploymentmanager_v2beta2.rb +44 -0
  162. data/generated/google/apis/deploymentmanager_v2beta2/classes.rb +843 -0
  163. data/generated/google/apis/deploymentmanager_v2beta2/representations.rb +306 -0
  164. data/generated/google/apis/deploymentmanager_v2beta2/service.rb +689 -0
  165. data/generated/google/apis/dfareporting_v2_1.rb +37 -0
  166. data/generated/google/apis/dfareporting_v2_1/classes.rb +10770 -0
  167. data/generated/google/apis/dfareporting_v2_1/representations.rb +3438 -0
  168. data/generated/google/apis/dfareporting_v2_1/service.rb +8585 -0
  169. data/generated/google/apis/discovery_v1.rb +32 -0
  170. data/generated/google/apis/discovery_v1/classes.rb +961 -0
  171. data/generated/google/apis/discovery_v1/representations.rb +357 -0
  172. data/generated/google/apis/discovery_v1/service.rb +142 -0
  173. data/generated/google/apis/dns_v1.rb +44 -0
  174. data/generated/google/apis/dns_v1/classes.rb +406 -0
  175. data/generated/google/apis/dns_v1/representations.rb +151 -0
  176. data/generated/google/apis/dns_v1/service.rb +454 -0
  177. data/generated/google/apis/doubleclickbidmanager_v1.rb +31 -0
  178. data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +716 -0
  179. data/generated/google/apis/doubleclickbidmanager_v1/representations.rb +298 -0
  180. data/generated/google/apis/doubleclickbidmanager_v1/service.rb +341 -0
  181. data/generated/google/apis/doubleclicksearch_v2.rb +35 -0
  182. data/generated/google/apis/doubleclicksearch_v2/classes.rb +956 -0
  183. data/generated/google/apis/doubleclicksearch_v2/representations.rb +316 -0
  184. data/generated/google/apis/doubleclicksearch_v2/service.rb +480 -0
  185. data/generated/google/apis/drive_v2.rb +58 -0
  186. data/generated/google/apis/drive_v2/classes.rb +2562 -0
  187. data/generated/google/apis/drive_v2/representations.rb +795 -0
  188. data/generated/google/apis/drive_v2/service.rb +2696 -0
  189. data/generated/google/apis/drive_v3.rb +55 -0
  190. data/generated/google/apis/drive_v3/classes.rb +1534 -0
  191. data/generated/google/apis/drive_v3/representations.rb +497 -0
  192. data/generated/google/apis/drive_v3/service.rb +1541 -0
  193. data/generated/google/apis/fitness_v1.rb +49 -0
  194. data/generated/google/apis/fitness_v1/classes.rb +885 -0
  195. data/generated/google/apis/fitness_v1/representations.rb +320 -0
  196. data/generated/google/apis/fitness_v1/service.rb +675 -0
  197. data/generated/google/apis/fusiontables_v2.rb +37 -0
  198. data/generated/google/apis/fusiontables_v2/classes.rb +1048 -0
  199. data/generated/google/apis/fusiontables_v2/representations.rb +409 -0
  200. data/generated/google/apis/fusiontables_v2/service.rb +1463 -0
  201. data/generated/google/apis/games_configuration_v1configuration.rb +34 -0
  202. data/generated/google/apis/games_configuration_v1configuration/classes.rb +506 -0
  203. data/generated/google/apis/games_configuration_v1configuration/representations.rb +206 -0
  204. data/generated/google/apis/games_configuration_v1configuration/service.rb +565 -0
  205. data/generated/google/apis/games_management_v1management.rb +37 -0
  206. data/generated/google/apis/games_management_v1management/classes.rb +524 -0
  207. data/generated/google/apis/games_management_v1management/representations.rb +231 -0
  208. data/generated/google/apis/games_management_v1management/service.rb +994 -0
  209. data/generated/google/apis/games_v1.rb +40 -0
  210. data/generated/google/apis/games_v1/classes.rb +4617 -0
  211. data/generated/google/apis/games_v1/representations.rb +1584 -0
  212. data/generated/google/apis/games_v1/service.rb +2290 -0
  213. data/generated/google/apis/gan_v1beta1.rb +31 -0
  214. data/generated/google/apis/gan_v1beta1/classes.rb +1428 -0
  215. data/generated/google/apis/gan_v1beta1/representations.rb +428 -0
  216. data/generated/google/apis/gan_v1beta1/service.rb +682 -0
  217. data/generated/google/apis/genomics_v1.rb +49 -0
  218. data/generated/google/apis/genomics_v1/classes.rb +2609 -0
  219. data/generated/google/apis/genomics_v1/representations.rb +909 -0
  220. data/generated/google/apis/genomics_v1/service.rb +1676 -0
  221. data/generated/google/apis/genomics_v1beta2.rb +46 -0
  222. data/generated/google/apis/genomics_v1beta2/classes.rb +3288 -0
  223. data/generated/google/apis/genomics_v1beta2/representations.rb +1194 -0
  224. data/generated/google/apis/genomics_v1beta2/service.rb +2392 -0
  225. data/generated/google/apis/gmail_v1.rb +52 -0
  226. data/generated/google/apis/gmail_v1/classes.rb +794 -0
  227. data/generated/google/apis/gmail_v1/representations.rb +339 -0
  228. data/generated/google/apis/gmail_v1/service.rb +1470 -0
  229. data/generated/google/apis/groupsmigration_v1.rb +34 -0
  230. data/generated/google/apis/groupsmigration_v1/classes.rb +51 -0
  231. data/generated/google/apis/groupsmigration_v1/representations.rb +38 -0
  232. data/generated/google/apis/groupsmigration_v1/service.rb +110 -0
  233. data/generated/google/apis/groupssettings_v1.rb +34 -0
  234. data/generated/google/apis/groupssettings_v1/classes.rb +221 -0
  235. data/generated/google/apis/groupssettings_v1/representations.rb +64 -0
  236. data/generated/google/apis/groupssettings_v1/service.rb +179 -0
  237. data/generated/google/apis/identitytoolkit_v3.rb +31 -0
  238. data/generated/google/apis/identitytoolkit_v3/classes.rb +1466 -0
  239. data/generated/google/apis/identitytoolkit_v3/representations.rb +509 -0
  240. data/generated/google/apis/identitytoolkit_v3/service.rb +581 -0
  241. data/{spec/google/api_client/request_spec.rb → generated/google/apis/kgsearch_v1.rb} +16 -13
  242. data/generated/google/apis/kgsearch_v1/classes.rb +59 -0
  243. data/generated/google/apis/kgsearch_v1/representations.rb +39 -0
  244. data/generated/google/apis/kgsearch_v1/service.rb +111 -0
  245. data/generated/google/apis/licensing_v1.rb +34 -0
  246. data/generated/google/apis/licensing_v1/classes.rb +132 -0
  247. data/generated/google/apis/licensing_v1/representations.rb +68 -0
  248. data/generated/google/apis/licensing_v1/service.rb +369 -0
  249. data/generated/google/apis/logging_v1beta3.rb +47 -0
  250. data/generated/google/apis/logging_v1beta3/classes.rb +1079 -0
  251. data/generated/google/apis/logging_v1beta3/representations.rb +366 -0
  252. data/generated/google/apis/logging_v1beta3/service.rb +1001 -0
  253. data/generated/google/apis/manager_v1beta2.rb +53 -0
  254. data/generated/google/apis/manager_v1beta2/classes.rb +1287 -0
  255. data/generated/google/apis/manager_v1beta2/representations.rb +536 -0
  256. data/generated/google/apis/manager_v1beta2/service.rb +372 -0
  257. data/generated/google/apis/mapsengine_v1.rb +38 -0
  258. data/generated/google/apis/mapsengine_v1/classes.rb +2873 -0
  259. data/generated/google/apis/mapsengine_v1/representations.rb +1235 -0
  260. data/generated/google/apis/mapsengine_v1/service.rb +3388 -0
  261. data/generated/google/apis/mirror_v1.rb +37 -0
  262. data/generated/google/apis/mirror_v1/classes.rb +1072 -0
  263. data/generated/google/apis/mirror_v1/representations.rb +350 -0
  264. data/generated/google/apis/mirror_v1/service.rb +977 -0
  265. data/generated/google/apis/oauth2_v2.rb +43 -0
  266. data/generated/google/apis/oauth2_v2/classes.rb +245 -0
  267. data/generated/google/apis/oauth2_v2/representations.rb +94 -0
  268. data/generated/google/apis/oauth2_v2/service.rb +199 -0
  269. data/generated/google/apis/pagespeedonline_v2.rb +32 -0
  270. data/generated/google/apis/pagespeedonline_v2/classes.rb +614 -0
  271. data/generated/google/apis/pagespeedonline_v2/representations.rb +244 -0
  272. data/generated/google/apis/pagespeedonline_v2/service.rb +119 -0
  273. data/generated/google/apis/partners_v2.rb +32 -0
  274. data/generated/google/apis/partners_v2/classes.rb +942 -0
  275. data/generated/google/apis/partners_v2/representations.rb +402 -0
  276. data/generated/google/apis/partners_v2/service.rb +400 -0
  277. data/generated/google/apis/plus_domains_v1.rb +61 -0
  278. data/generated/google/apis/plus_domains_v1/classes.rb +2609 -0
  279. data/generated/google/apis/plus_domains_v1/representations.rb +987 -0
  280. data/generated/google/apis/plus_domains_v1/service.rb +904 -0
  281. data/generated/google/apis/plus_v1.rb +43 -0
  282. data/generated/google/apis/plus_v1/classes.rb +2094 -0
  283. data/generated/google/apis/plus_v1/representations.rb +805 -0
  284. data/generated/google/apis/plus_v1/service.rb +470 -0
  285. data/generated/google/apis/prediction_v1_6.rb +44 -0
  286. data/generated/google/apis/prediction_v1_6/classes.rb +751 -0
  287. data/generated/google/apis/prediction_v1_6/representations.rb +327 -0
  288. data/generated/google/apis/prediction_v1_6/service.rb +380 -0
  289. data/generated/google/apis/proximitybeacon_v1beta1.rb +31 -0
  290. data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +639 -0
  291. data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +274 -0
  292. data/generated/google/apis/proximitybeacon_v1beta1/service.rb +591 -0
  293. data/generated/google/apis/pubsub_v1.rb +37 -0
  294. data/generated/google/apis/pubsub_v1/classes.rb +614 -0
  295. data/generated/google/apis/pubsub_v1/representations.rb +281 -0
  296. data/generated/google/apis/pubsub_v1/service.rb +774 -0
  297. data/generated/google/apis/pubsub_v1beta2.rb +37 -0
  298. data/generated/google/apis/pubsub_v1beta2/classes.rb +620 -0
  299. data/generated/google/apis/pubsub_v1beta2/representations.rb +282 -0
  300. data/generated/google/apis/pubsub_v1beta2/service.rb +774 -0
  301. data/generated/google/apis/qpx_express_v1.rb +31 -0
  302. data/generated/google/apis/qpx_express_v1/classes.rb +1268 -0
  303. data/generated/google/apis/qpx_express_v1/representations.rb +424 -0
  304. data/generated/google/apis/qpx_express_v1/service.rb +100 -0
  305. data/generated/google/apis/replicapool_v1beta2.rb +44 -0
  306. data/generated/google/apis/replicapool_v1beta2/classes.rb +631 -0
  307. data/generated/google/apis/replicapool_v1beta2/representations.rb +236 -0
  308. data/generated/google/apis/replicapool_v1beta2/service.rb +608 -0
  309. data/generated/google/apis/replicapoolupdater_v1beta1.rb +44 -0
  310. data/generated/google/apis/replicapoolupdater_v1beta1/classes.rb +733 -0
  311. data/generated/google/apis/replicapoolupdater_v1beta1/representations.rb +264 -0
  312. data/generated/google/apis/replicapoolupdater_v1beta1/service.rb +508 -0
  313. data/generated/google/apis/reseller_v1.rb +37 -0
  314. data/generated/google/apis/reseller_v1/classes.rb +520 -0
  315. data/generated/google/apis/reseller_v1/representations.rb +200 -0
  316. data/generated/google/apis/reseller_v1/service.rb +623 -0
  317. data/generated/google/apis/resourceviews_v1beta2.rb +50 -0
  318. data/generated/google/apis/resourceviews_v1beta2/classes.rb +660 -0
  319. data/generated/google/apis/resourceviews_v1beta2/representations.rb +269 -0
  320. data/generated/google/apis/resourceviews_v1beta2/service.rb +563 -0
  321. data/generated/google/apis/script_v1.rb +61 -0
  322. data/generated/google/apis/script_v1/classes.rb +259 -0
  323. data/generated/google/apis/script_v1/representations.rb +106 -0
  324. data/generated/google/apis/script_v1/service.rb +98 -0
  325. data/generated/google/apis/site_verification_v1.rb +37 -0
  326. data/generated/google/apis/site_verification_v1/classes.rb +185 -0
  327. data/generated/google/apis/site_verification_v1/representations.rb +101 -0
  328. data/generated/google/apis/site_verification_v1/service.rb +315 -0
  329. data/generated/google/apis/sqladmin_v1beta4.rb +37 -0
  330. data/generated/google/apis/sqladmin_v1beta4/classes.rb +2001 -0
  331. data/generated/google/apis/sqladmin_v1beta4/representations.rb +758 -0
  332. data/generated/google/apis/sqladmin_v1beta4/service.rb +1625 -0
  333. data/generated/google/apis/storage_v1.rb +46 -0
  334. data/generated/google/apis/storage_v1/classes.rb +1222 -0
  335. data/generated/google/apis/storage_v1/representations.rb +445 -0
  336. data/generated/google/apis/storage_v1/service.rb +1903 -0
  337. data/generated/google/apis/storagetransfer_v1.rb +35 -0
  338. data/generated/google/apis/storagetransfer_v1/classes.rb +1046 -0
  339. data/generated/google/apis/storagetransfer_v1/representations.rb +370 -0
  340. data/generated/google/apis/storagetransfer_v1/service.rb +473 -0
  341. data/generated/google/apis/tagmanager_v1.rb +52 -0
  342. data/generated/google/apis/tagmanager_v1/classes.rb +1384 -0
  343. data/generated/google/apis/tagmanager_v1/representations.rb +515 -0
  344. data/generated/google/apis/tagmanager_v1/service.rb +1817 -0
  345. data/generated/google/apis/taskqueue_v1beta2.rb +37 -0
  346. data/generated/google/apis/taskqueue_v1beta2/classes.rb +254 -0
  347. data/generated/google/apis/taskqueue_v1beta2/representations.rb +114 -0
  348. data/generated/google/apis/taskqueue_v1beta2/service.rb +408 -0
  349. data/generated/google/apis/tasks_v1.rb +37 -0
  350. data/generated/google/apis/tasks_v1/classes.rb +296 -0
  351. data/generated/google/apis/tasks_v1/representations.rb +115 -0
  352. data/generated/google/apis/tasks_v1/service.rb +643 -0
  353. data/generated/google/apis/translate_v2.rb +31 -0
  354. data/generated/google/apis/translate_v2/classes.rb +168 -0
  355. data/generated/google/apis/translate_v2/representations.rb +109 -0
  356. data/generated/google/apis/translate_v2/service.rb +182 -0
  357. data/generated/google/apis/urlshortener_v1.rb +34 -0
  358. data/generated/google/apis/urlshortener_v1/classes.rb +246 -0
  359. data/generated/google/apis/urlshortener_v1/representations.rb +111 -0
  360. data/generated/google/apis/urlshortener_v1/service.rb +176 -0
  361. data/generated/google/apis/webmasters_v3.rb +37 -0
  362. data/generated/google/apis/webmasters_v3/classes.rb +563 -0
  363. data/generated/google/apis/webmasters_v3/representations.rb +250 -0
  364. data/generated/google/apis/webmasters_v3/service.rb +573 -0
  365. data/generated/google/apis/youtube_analytics_v1.rb +46 -0
  366. data/generated/google/apis/youtube_analytics_v1/classes.rb +546 -0
  367. data/generated/google/apis/youtube_analytics_v1/representations.rb +243 -0
  368. data/generated/google/apis/youtube_analytics_v1/service.rb +562 -0
  369. data/generated/google/apis/youtube_v3.rb +49 -0
  370. data/generated/google/apis/youtube_v3/classes.rb +8136 -0
  371. data/generated/google/apis/youtube_v3/representations.rb +2838 -0
  372. data/generated/google/apis/youtube_v3/service.rb +4403 -0
  373. data/generated/google/apis/youtubereporting_v1.rb +38 -0
  374. data/generated/google/apis/youtubereporting_v1/classes.rb +258 -0
  375. data/generated/google/apis/youtubereporting_v1/representations.rb +128 -0
  376. data/generated/google/apis/youtubereporting_v1/service.rb +364 -0
  377. data/google-api-client.gemspec +27 -39
  378. data/lib/google/api_client/auth/installed_app.rb +7 -5
  379. data/lib/google/api_client/auth/key_utils.rb +1 -0
  380. data/lib/google/api_client/auth/storage.rb +4 -2
  381. data/lib/google/api_client/auth/storages/file_store.rb +2 -3
  382. data/lib/google/api_client/auth/storages/redis_store.rb +7 -2
  383. data/lib/google/api_client/client_secrets.rb +4 -5
  384. data/lib/google/apis.rb +48 -0
  385. data/lib/google/apis/core/api_command.rb +135 -0
  386. data/lib/google/apis/core/base_service.rb +317 -0
  387. data/lib/google/apis/core/batch.rb +239 -0
  388. data/lib/google/apis/core/download.rb +94 -0
  389. data/lib/google/apis/core/hashable.rb +44 -0
  390. data/lib/google/apis/core/http_client_adapter.rb +82 -0
  391. data/lib/google/apis/core/http_command.rb +312 -0
  392. data/lib/google/apis/core/json_representation.rb +127 -0
  393. data/lib/google/{api_client/version.rb → apis/core/logging.rb} +12 -8
  394. data/lib/google/apis/core/multipart.rb +187 -0
  395. data/lib/google/apis/core/upload.rb +288 -0
  396. data/lib/google/{api_client → apis}/errors.rb +39 -28
  397. data/lib/google/apis/generator.rb +70 -0
  398. data/lib/google/apis/generator/annotator.rb +295 -0
  399. data/lib/google/apis/generator/helpers.rb +74 -0
  400. data/lib/google/apis/generator/model.rb +143 -0
  401. data/lib/google/apis/generator/template.rb +124 -0
  402. data/lib/google/apis/generator/templates/_class.tmpl +40 -0
  403. data/lib/google/apis/generator/templates/_method.tmpl +92 -0
  404. data/lib/google/apis/generator/templates/_representation.tmpl +51 -0
  405. data/lib/google/apis/generator/templates/_representation_stub.tmpl +15 -0
  406. data/lib/google/apis/generator/templates/_representation_type.tmpl +10 -0
  407. data/lib/google/{api_client/reference.rb → apis/generator/templates/classes.rb.tmpl} +11 -9
  408. data/lib/google/apis/generator/templates/module.rb.tmpl +40 -0
  409. data/lib/google/apis/generator/templates/representations.rb.tmpl +32 -0
  410. data/lib/google/apis/generator/templates/service.rb.tmpl +60 -0
  411. data/lib/google/apis/options.rb +85 -0
  412. data/lib/google/apis/version.rb +39 -0
  413. data/rakelib/metrics.rake +22 -0
  414. data/rakelib/rubocop.rake +10 -0
  415. data/rakelib/spec.rake +11 -0
  416. data/rakelib/yard.rake +11 -0
  417. data/samples/Gemfile +7 -0
  418. data/samples/README.md +51 -0
  419. data/samples/google-api-samples +32 -0
  420. data/samples/lib/base_cli.rb +94 -0
  421. data/samples/lib/samples/analytics.rb +62 -0
  422. data/samples/lib/samples/calendar.rb +83 -0
  423. data/samples/lib/samples/drive.rb +82 -0
  424. data/samples/lib/samples/gmail.rb +50 -0
  425. data/samples/lib/samples/pubsub.rb +114 -0
  426. data/samples/lib/samples/translate.rb +44 -0
  427. data/samples/lib/samples/you_tube.rb +44 -0
  428. data/script/generate +95 -0
  429. data/script/package +8 -0
  430. data/script/release +15 -0
  431. data/spec/fixtures/files/api_names.yaml +3 -0
  432. data/spec/fixtures/files/auth_stored_credentials.json +8 -0
  433. data/spec/fixtures/files/child/.gitignore +0 -0
  434. data/spec/fixtures/files/client_secrets.json +1 -0
  435. data/spec/fixtures/files/invalid.json +1 -0
  436. data/spec/fixtures/files/test.blah +1 -0
  437. data/spec/fixtures/files/test.txt +1 -0
  438. data/spec/fixtures/files/test_api.json +440 -0
  439. data/spec/google/api_client/auth/storage_spec.rb +1 -3
  440. data/spec/google/api_client/auth/storages/file_store_spec.rb +1 -2
  441. data/spec/google/api_client/auth/storages/redis_store_spec.rb +1 -3
  442. data/spec/google/api_client/client_secrets_spec.rb +38 -1
  443. data/spec/google/apis/core/api_command_spec.rb +209 -0
  444. data/spec/google/apis/core/batch_spec.rb +142 -0
  445. data/spec/google/apis/core/download_spec.rb +103 -0
  446. data/spec/google/apis/core/hashable_spec.rb +60 -0
  447. data/spec/google/apis/core/http_command_spec.rb +284 -0
  448. data/spec/google/apis/core/json_representation_spec.rb +192 -0
  449. data/spec/google/apis/core/service_spec.rb +247 -0
  450. data/spec/google/apis/core/upload_spec.rb +300 -0
  451. data/{lib/google/api_client/discovery.rb → spec/google/apis/generated_spec.rb} +13 -5
  452. data/spec/google/apis/generator/generator_spec.rb +272 -0
  453. data/spec/google/apis/logging_spec.rb +45 -0
  454. data/spec/google/apis/options_spec.rb +40 -0
  455. data/spec/integration_tests/adsense_spec.rb +29 -0
  456. data/spec/integration_tests/drive_spec.rb +35 -0
  457. data/spec/integration_tests/pubsub_spec.rb +48 -0
  458. data/spec/integration_tests/url_shortener_spec.rb +45 -0
  459. data/spec/spec_helper.rb +131 -44
  460. data/spec/spec_helper/load_path_spec.rb +33 -0
  461. data/third_party/hurley_patches.rb +103 -0
  462. metadata +533 -170
  463. data/lib/compat/multi_json.rb +0 -19
  464. data/lib/google/api_client.rb +0 -750
  465. data/lib/google/api_client/auth/file_storage.rb +0 -59
  466. data/lib/google/api_client/auth/jwt_asserter.rb +0 -126
  467. data/lib/google/api_client/auth/pkcs12.rb +0 -41
  468. data/lib/google/api_client/batch.rb +0 -326
  469. data/lib/google/api_client/charset.rb +0 -33
  470. data/lib/google/api_client/discovery/api.rb +0 -310
  471. data/lib/google/api_client/discovery/media.rb +0 -77
  472. data/lib/google/api_client/discovery/method.rb +0 -363
  473. data/lib/google/api_client/discovery/resource.rb +0 -156
  474. data/lib/google/api_client/discovery/schema.rb +0 -117
  475. data/lib/google/api_client/environment.rb +0 -42
  476. data/lib/google/api_client/gzip.rb +0 -28
  477. data/lib/google/api_client/logging.rb +0 -32
  478. data/lib/google/api_client/media.rb +0 -259
  479. data/lib/google/api_client/railtie.rb +0 -18
  480. data/lib/google/api_client/request.rb +0 -350
  481. data/lib/google/api_client/result.rb +0 -255
  482. data/lib/google/api_client/service.rb +0 -233
  483. data/lib/google/api_client/service/batch.rb +0 -110
  484. data/lib/google/api_client/service/request.rb +0 -144
  485. data/lib/google/api_client/service/resource.rb +0 -40
  486. data/lib/google/api_client/service/result.rb +0 -162
  487. data/lib/google/api_client/service/simple_file_store.rb +0 -151
  488. data/lib/google/api_client/service/stub_generator.rb +0 -61
  489. data/spec/google/api_client/batch_spec.rb +0 -248
  490. data/spec/google/api_client/discovery_spec.rb +0 -708
  491. data/spec/google/api_client/gzip_spec.rb +0 -98
  492. data/spec/google/api_client/media_spec.rb +0 -178
  493. data/spec/google/api_client/result_spec.rb +0 -207
  494. data/spec/google/api_client/service_account_spec.rb +0 -169
  495. data/spec/google/api_client/service_spec.rb +0 -618
  496. data/spec/google/api_client/simple_file_store_spec.rb +0 -133
  497. data/spec/google/api_client_spec.rb +0 -352
@@ -0,0 +1,3568 @@
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/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module AnalyticsV3
23
+ # Google Analytics API
24
+ #
25
+ # View and manage your Google Analytics data
26
+ #
27
+ # @example
28
+ # require 'google/apis/analytics_v3'
29
+ #
30
+ # Analytics = Google::Apis::AnalyticsV3 # Alias the module
31
+ # service = Analytics::AnalyticsService.new
32
+ #
33
+ # @see https://developers.google.com/analytics/
34
+ class AnalyticsService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ # Overrides userIp if both are provided.
44
+ attr_accessor :quota_user
45
+
46
+ # @return [String]
47
+ # IP address of the site where the request originates. Use this if you want to
48
+ # enforce per-user limits.
49
+ attr_accessor :user_ip
50
+
51
+ def initialize
52
+ super('https://www.googleapis.com/', 'analytics/v3/')
53
+ end
54
+
55
+ # Returns Analytics data for a view (profile).
56
+ # @param [String] ids
57
+ # Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX,
58
+ # where XXXX is the Analytics view (profile) ID.
59
+ # @param [String] start_date
60
+ # Start date for fetching Analytics data. Requests can specify a start date
61
+ # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or
62
+ # 7daysAgo). The default value is 7daysAgo.
63
+ # @param [String] end_date
64
+ # End date for fetching Analytics data. Request can should specify an end date
65
+ # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or
66
+ # 7daysAgo). The default value is yesterday.
67
+ # @param [String] metrics
68
+ # A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'.
69
+ # At least one metric must be specified.
70
+ # @param [String] dimensions
71
+ # A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
72
+ # @param [String] filters
73
+ # A comma-separated list of dimension or metric filters to be applied to
74
+ # Analytics data.
75
+ # @param [Boolean] include_empty_rows
76
+ # The response will include empty rows if this parameter is set to true, the
77
+ # default is true
78
+ # @param [Fixnum] max_results
79
+ # The maximum number of entries to include in this feed.
80
+ # @param [String] output
81
+ # The selected format for the response. Default format is JSON.
82
+ # @param [String] sampling_level
83
+ # The desired sampling level.
84
+ # @param [String] segment
85
+ # An Analytics segment to be applied to data.
86
+ # @param [String] sort
87
+ # A comma-separated list of dimensions or metrics that determine the sort order
88
+ # for Analytics data.
89
+ # @param [Fixnum] start_index
90
+ # An index of the first entity to retrieve. Use this parameter as a pagination
91
+ # mechanism along with the max-results parameter.
92
+ # @param [String] fields
93
+ # Selector specifying which fields to include in a partial response.
94
+ # @param [String] quota_user
95
+ # Available to use for quota purposes for server-side applications. Can be any
96
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
97
+ # Overrides userIp if both are provided.
98
+ # @param [String] user_ip
99
+ # IP address of the site where the request originates. Use this if you want to
100
+ # enforce per-user limits.
101
+ # @param [Google::Apis::RequestOptions] options
102
+ # Request-specific options
103
+ #
104
+ # @yield [result, err] Result & error if block supplied
105
+ # @yieldparam result [Google::Apis::AnalyticsV3::GaData] parsed result object
106
+ # @yieldparam err [StandardError] error object if request failed
107
+ #
108
+ # @return [Google::Apis::AnalyticsV3::GaData]
109
+ #
110
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
111
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
112
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
113
+ def get_ga_data(ids, start_date, end_date, metrics, dimensions: nil, filters: nil, include_empty_rows: nil, max_results: nil, output: nil, sampling_level: nil, segment: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
114
+ command = make_simple_command(:get, 'data/ga', options)
115
+ command.response_representation = Google::Apis::AnalyticsV3::GaData::Representation
116
+ command.response_class = Google::Apis::AnalyticsV3::GaData
117
+ command.query['dimensions'] = dimensions unless dimensions.nil?
118
+ command.query['end-date'] = end_date unless end_date.nil?
119
+ command.query['filters'] = filters unless filters.nil?
120
+ command.query['ids'] = ids unless ids.nil?
121
+ command.query['include-empty-rows'] = include_empty_rows unless include_empty_rows.nil?
122
+ command.query['max-results'] = max_results unless max_results.nil?
123
+ command.query['metrics'] = metrics unless metrics.nil?
124
+ command.query['output'] = output unless output.nil?
125
+ command.query['samplingLevel'] = sampling_level unless sampling_level.nil?
126
+ command.query['segment'] = segment unless segment.nil?
127
+ command.query['sort'] = sort unless sort.nil?
128
+ command.query['start-date'] = start_date unless start_date.nil?
129
+ command.query['start-index'] = start_index unless start_index.nil?
130
+ command.query['fields'] = fields unless fields.nil?
131
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
132
+ command.query['userIp'] = user_ip unless user_ip.nil?
133
+ execute_or_queue_command(command, &block)
134
+ end
135
+
136
+ # Returns Analytics Multi-Channel Funnels data for a view (profile).
137
+ # @param [String] ids
138
+ # Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX,
139
+ # where XXXX is the Analytics view (profile) ID.
140
+ # @param [String] start_date
141
+ # Start date for fetching Analytics data. Requests can specify a start date
142
+ # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or
143
+ # 7daysAgo). The default value is 7daysAgo.
144
+ # @param [String] end_date
145
+ # End date for fetching Analytics data. Requests can specify a start date
146
+ # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or
147
+ # 7daysAgo). The default value is 7daysAgo.
148
+ # @param [String] metrics
149
+ # A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:
150
+ # totalConversions,mcf:totalConversionValue'. At least one metric must be
151
+ # specified.
152
+ # @param [String] dimensions
153
+ # A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,
154
+ # mcf:medium'.
155
+ # @param [String] filters
156
+ # A comma-separated list of dimension or metric filters to be applied to the
157
+ # Analytics data.
158
+ # @param [Fixnum] max_results
159
+ # The maximum number of entries to include in this feed.
160
+ # @param [String] sampling_level
161
+ # The desired sampling level.
162
+ # @param [String] sort
163
+ # A comma-separated list of dimensions or metrics that determine the sort order
164
+ # for the Analytics data.
165
+ # @param [Fixnum] start_index
166
+ # An index of the first entity to retrieve. Use this parameter as a pagination
167
+ # mechanism along with the max-results parameter.
168
+ # @param [String] fields
169
+ # Selector specifying which fields to include in a partial response.
170
+ # @param [String] quota_user
171
+ # Available to use for quota purposes for server-side applications. Can be any
172
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
173
+ # Overrides userIp if both are provided.
174
+ # @param [String] user_ip
175
+ # IP address of the site where the request originates. Use this if you want to
176
+ # enforce per-user limits.
177
+ # @param [Google::Apis::RequestOptions] options
178
+ # Request-specific options
179
+ #
180
+ # @yield [result, err] Result & error if block supplied
181
+ # @yieldparam result [Google::Apis::AnalyticsV3::McfData] parsed result object
182
+ # @yieldparam err [StandardError] error object if request failed
183
+ #
184
+ # @return [Google::Apis::AnalyticsV3::McfData]
185
+ #
186
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
187
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
188
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
189
+ def get_mcf_data(ids, start_date, end_date, metrics, dimensions: nil, filters: nil, max_results: nil, sampling_level: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
190
+ command = make_simple_command(:get, 'data/mcf', options)
191
+ command.response_representation = Google::Apis::AnalyticsV3::McfData::Representation
192
+ command.response_class = Google::Apis::AnalyticsV3::McfData
193
+ command.query['dimensions'] = dimensions unless dimensions.nil?
194
+ command.query['end-date'] = end_date unless end_date.nil?
195
+ command.query['filters'] = filters unless filters.nil?
196
+ command.query['ids'] = ids unless ids.nil?
197
+ command.query['max-results'] = max_results unless max_results.nil?
198
+ command.query['metrics'] = metrics unless metrics.nil?
199
+ command.query['samplingLevel'] = sampling_level unless sampling_level.nil?
200
+ command.query['sort'] = sort unless sort.nil?
201
+ command.query['start-date'] = start_date unless start_date.nil?
202
+ command.query['start-index'] = start_index unless start_index.nil?
203
+ command.query['fields'] = fields unless fields.nil?
204
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
205
+ command.query['userIp'] = user_ip unless user_ip.nil?
206
+ execute_or_queue_command(command, &block)
207
+ end
208
+
209
+ # Returns real time data for a view (profile).
210
+ # @param [String] ids
211
+ # Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX,
212
+ # where XXXX is the Analytics view (profile) ID.
213
+ # @param [String] metrics
214
+ # A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least
215
+ # one metric must be specified.
216
+ # @param [String] dimensions
217
+ # A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.
218
+ # @param [String] filters
219
+ # A comma-separated list of dimension or metric filters to be applied to real
220
+ # time data.
221
+ # @param [Fixnum] max_results
222
+ # The maximum number of entries to include in this feed.
223
+ # @param [String] sort
224
+ # A comma-separated list of dimensions or metrics that determine the sort order
225
+ # for real time data.
226
+ # @param [String] fields
227
+ # Selector specifying which fields to include in a partial response.
228
+ # @param [String] quota_user
229
+ # Available to use for quota purposes for server-side applications. Can be any
230
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
231
+ # Overrides userIp if both are provided.
232
+ # @param [String] user_ip
233
+ # IP address of the site where the request originates. Use this if you want to
234
+ # enforce per-user limits.
235
+ # @param [Google::Apis::RequestOptions] options
236
+ # Request-specific options
237
+ #
238
+ # @yield [result, err] Result & error if block supplied
239
+ # @yieldparam result [Google::Apis::AnalyticsV3::RealtimeData] parsed result object
240
+ # @yieldparam err [StandardError] error object if request failed
241
+ #
242
+ # @return [Google::Apis::AnalyticsV3::RealtimeData]
243
+ #
244
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
245
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
246
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
247
+ def get_realtime_data(ids, metrics, dimensions: nil, filters: nil, max_results: nil, sort: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
248
+ command = make_simple_command(:get, 'data/realtime', options)
249
+ command.response_representation = Google::Apis::AnalyticsV3::RealtimeData::Representation
250
+ command.response_class = Google::Apis::AnalyticsV3::RealtimeData
251
+ command.query['dimensions'] = dimensions unless dimensions.nil?
252
+ command.query['filters'] = filters unless filters.nil?
253
+ command.query['ids'] = ids unless ids.nil?
254
+ command.query['max-results'] = max_results unless max_results.nil?
255
+ command.query['metrics'] = metrics unless metrics.nil?
256
+ command.query['sort'] = sort unless sort.nil?
257
+ command.query['fields'] = fields unless fields.nil?
258
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
259
+ command.query['userIp'] = user_ip unless user_ip.nil?
260
+ execute_or_queue_command(command, &block)
261
+ end
262
+
263
+ # Lists account summaries (lightweight tree comprised of accounts/properties/
264
+ # profiles) to which the user has access.
265
+ # @param [Fixnum] max_results
266
+ # The maximum number of account summaries to include in this response, where the
267
+ # largest acceptable value is 1000.
268
+ # @param [Fixnum] start_index
269
+ # An index of the first entity to retrieve. Use this parameter as a pagination
270
+ # mechanism along with the max-results parameter.
271
+ # @param [String] fields
272
+ # Selector specifying which fields to include in a partial response.
273
+ # @param [String] quota_user
274
+ # Available to use for quota purposes for server-side applications. Can be any
275
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
276
+ # Overrides userIp if both are provided.
277
+ # @param [String] user_ip
278
+ # IP address of the site where the request originates. Use this if you want to
279
+ # enforce per-user limits.
280
+ # @param [Google::Apis::RequestOptions] options
281
+ # Request-specific options
282
+ #
283
+ # @yield [result, err] Result & error if block supplied
284
+ # @yieldparam result [Google::Apis::AnalyticsV3::AccountSummaries] parsed result object
285
+ # @yieldparam err [StandardError] error object if request failed
286
+ #
287
+ # @return [Google::Apis::AnalyticsV3::AccountSummaries]
288
+ #
289
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
290
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
291
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
292
+ def list_account_summaries(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
293
+ command = make_simple_command(:get, 'management/accountSummaries', options)
294
+ command.response_representation = Google::Apis::AnalyticsV3::AccountSummaries::Representation
295
+ command.response_class = Google::Apis::AnalyticsV3::AccountSummaries
296
+ command.query['max-results'] = max_results unless max_results.nil?
297
+ command.query['start-index'] = start_index unless start_index.nil?
298
+ command.query['fields'] = fields unless fields.nil?
299
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
300
+ command.query['userIp'] = user_ip unless user_ip.nil?
301
+ execute_or_queue_command(command, &block)
302
+ end
303
+
304
+ # Removes a user from the given account.
305
+ # @param [String] account_id
306
+ # Account ID to delete the user link for.
307
+ # @param [String] link_id
308
+ # Link ID to delete the user link for.
309
+ # @param [String] fields
310
+ # Selector specifying which fields to include in a partial response.
311
+ # @param [String] quota_user
312
+ # Available to use for quota purposes for server-side applications. Can be any
313
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
314
+ # Overrides userIp if both are provided.
315
+ # @param [String] user_ip
316
+ # IP address of the site where the request originates. Use this if you want to
317
+ # enforce per-user limits.
318
+ # @param [Google::Apis::RequestOptions] options
319
+ # Request-specific options
320
+ #
321
+ # @yield [result, err] Result & error if block supplied
322
+ # @yieldparam result [NilClass] No result returned for this method
323
+ # @yieldparam err [StandardError] error object if request failed
324
+ #
325
+ # @return [void]
326
+ #
327
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
328
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
329
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
330
+ def delete_account_user_link(account_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
331
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/entityUserLinks/{linkId}', options)
332
+ command.params['accountId'] = account_id unless account_id.nil?
333
+ command.params['linkId'] = link_id unless link_id.nil?
334
+ command.query['fields'] = fields unless fields.nil?
335
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
336
+ command.query['userIp'] = user_ip unless user_ip.nil?
337
+ execute_or_queue_command(command, &block)
338
+ end
339
+
340
+ # Adds a new user to the given account.
341
+ # @param [String] account_id
342
+ # Account ID to create the user link for.
343
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
344
+ # @param [String] fields
345
+ # Selector specifying which fields to include in a partial response.
346
+ # @param [String] quota_user
347
+ # Available to use for quota purposes for server-side applications. Can be any
348
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
349
+ # Overrides userIp if both are provided.
350
+ # @param [String] user_ip
351
+ # IP address of the site where the request originates. Use this if you want to
352
+ # enforce per-user limits.
353
+ # @param [Google::Apis::RequestOptions] options
354
+ # Request-specific options
355
+ #
356
+ # @yield [result, err] Result & error if block supplied
357
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
358
+ # @yieldparam err [StandardError] error object if request failed
359
+ #
360
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
361
+ #
362
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
363
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
364
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
365
+ def insert_account_user_link(account_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
366
+ command = make_simple_command(:post, 'management/accounts/{accountId}/entityUserLinks', options)
367
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
368
+ command.request_object = entity_user_link_object
369
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
370
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
371
+ command.params['accountId'] = account_id unless account_id.nil?
372
+ command.query['fields'] = fields unless fields.nil?
373
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
374
+ command.query['userIp'] = user_ip unless user_ip.nil?
375
+ execute_or_queue_command(command, &block)
376
+ end
377
+
378
+ # Lists account-user links for a given account.
379
+ # @param [String] account_id
380
+ # Account ID to retrieve the user links for.
381
+ # @param [Fixnum] max_results
382
+ # The maximum number of account-user links to include in this response.
383
+ # @param [Fixnum] start_index
384
+ # An index of the first account-user link to retrieve. Use this parameter as a
385
+ # pagination mechanism along with the max-results parameter.
386
+ # @param [String] fields
387
+ # Selector specifying which fields to include in a partial response.
388
+ # @param [String] quota_user
389
+ # Available to use for quota purposes for server-side applications. Can be any
390
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
391
+ # Overrides userIp if both are provided.
392
+ # @param [String] user_ip
393
+ # IP address of the site where the request originates. Use this if you want to
394
+ # enforce per-user limits.
395
+ # @param [Google::Apis::RequestOptions] options
396
+ # Request-specific options
397
+ #
398
+ # @yield [result, err] Result & error if block supplied
399
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLinks] parsed result object
400
+ # @yieldparam err [StandardError] error object if request failed
401
+ #
402
+ # @return [Google::Apis::AnalyticsV3::EntityUserLinks]
403
+ #
404
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
405
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
406
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
407
+ def list_account_user_links(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
408
+ command = make_simple_command(:get, 'management/accounts/{accountId}/entityUserLinks', options)
409
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
410
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
411
+ command.params['accountId'] = account_id unless account_id.nil?
412
+ command.query['max-results'] = max_results unless max_results.nil?
413
+ command.query['start-index'] = start_index unless start_index.nil?
414
+ command.query['fields'] = fields unless fields.nil?
415
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
416
+ command.query['userIp'] = user_ip unless user_ip.nil?
417
+ execute_or_queue_command(command, &block)
418
+ end
419
+
420
+ # Updates permissions for an existing user on the given account.
421
+ # @param [String] account_id
422
+ # Account ID to update the account-user link for.
423
+ # @param [String] link_id
424
+ # Link ID to update the account-user link for.
425
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
426
+ # @param [String] fields
427
+ # Selector specifying which fields to include in a partial response.
428
+ # @param [String] quota_user
429
+ # Available to use for quota purposes for server-side applications. Can be any
430
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
431
+ # Overrides userIp if both are provided.
432
+ # @param [String] user_ip
433
+ # IP address of the site where the request originates. Use this if you want to
434
+ # enforce per-user limits.
435
+ # @param [Google::Apis::RequestOptions] options
436
+ # Request-specific options
437
+ #
438
+ # @yield [result, err] Result & error if block supplied
439
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
440
+ # @yieldparam err [StandardError] error object if request failed
441
+ #
442
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
443
+ #
444
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
445
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
446
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
447
+ def update_account_user_link(account_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
448
+ command = make_simple_command(:put, 'management/accounts/{accountId}/entityUserLinks/{linkId}', options)
449
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
450
+ command.request_object = entity_user_link_object
451
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
452
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
453
+ command.params['accountId'] = account_id unless account_id.nil?
454
+ command.params['linkId'] = link_id unless link_id.nil?
455
+ command.query['fields'] = fields unless fields.nil?
456
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
457
+ command.query['userIp'] = user_ip unless user_ip.nil?
458
+ execute_or_queue_command(command, &block)
459
+ end
460
+
461
+ # Lists all accounts to which the user has access.
462
+ # @param [Fixnum] max_results
463
+ # The maximum number of accounts to include in this response.
464
+ # @param [Fixnum] start_index
465
+ # An index of the first account to retrieve. Use this parameter as a pagination
466
+ # mechanism along with the max-results parameter.
467
+ # @param [String] fields
468
+ # Selector specifying which fields to include in a partial response.
469
+ # @param [String] quota_user
470
+ # Available to use for quota purposes for server-side applications. Can be any
471
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
472
+ # Overrides userIp if both are provided.
473
+ # @param [String] user_ip
474
+ # IP address of the site where the request originates. Use this if you want to
475
+ # enforce per-user limits.
476
+ # @param [Google::Apis::RequestOptions] options
477
+ # Request-specific options
478
+ #
479
+ # @yield [result, err] Result & error if block supplied
480
+ # @yieldparam result [Google::Apis::AnalyticsV3::Accounts] parsed result object
481
+ # @yieldparam err [StandardError] error object if request failed
482
+ #
483
+ # @return [Google::Apis::AnalyticsV3::Accounts]
484
+ #
485
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
486
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
487
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
488
+ def list_accounts(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
489
+ command = make_simple_command(:get, 'management/accounts', options)
490
+ command.response_representation = Google::Apis::AnalyticsV3::Accounts::Representation
491
+ command.response_class = Google::Apis::AnalyticsV3::Accounts
492
+ command.query['max-results'] = max_results unless max_results.nil?
493
+ command.query['start-index'] = start_index unless start_index.nil?
494
+ command.query['fields'] = fields unless fields.nil?
495
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
496
+ command.query['userIp'] = user_ip unless user_ip.nil?
497
+ execute_or_queue_command(command, &block)
498
+ end
499
+
500
+ # List custom data sources to which the user has access.
501
+ # @param [String] account_id
502
+ # Account Id for the custom data sources to retrieve.
503
+ # @param [String] web_property_id
504
+ # Web property Id for the custom data sources to retrieve.
505
+ # @param [Fixnum] max_results
506
+ # The maximum number of custom data sources to include in this response.
507
+ # @param [Fixnum] start_index
508
+ # A 1-based index of the first custom data source to retrieve. Use this
509
+ # parameter as a pagination mechanism along with the max-results parameter.
510
+ # @param [String] fields
511
+ # Selector specifying which fields to include in a partial response.
512
+ # @param [String] quota_user
513
+ # Available to use for quota purposes for server-side applications. Can be any
514
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
515
+ # Overrides userIp if both are provided.
516
+ # @param [String] user_ip
517
+ # IP address of the site where the request originates. Use this if you want to
518
+ # enforce per-user limits.
519
+ # @param [Google::Apis::RequestOptions] options
520
+ # Request-specific options
521
+ #
522
+ # @yield [result, err] Result & error if block supplied
523
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDataSources] parsed result object
524
+ # @yieldparam err [StandardError] error object if request failed
525
+ #
526
+ # @return [Google::Apis::AnalyticsV3::CustomDataSources]
527
+ #
528
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
529
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
530
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
531
+ def list_custom_data_sources(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
532
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources', options)
533
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDataSources::Representation
534
+ command.response_class = Google::Apis::AnalyticsV3::CustomDataSources
535
+ command.params['accountId'] = account_id unless account_id.nil?
536
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
537
+ command.query['max-results'] = max_results unless max_results.nil?
538
+ command.query['start-index'] = start_index unless start_index.nil?
539
+ command.query['fields'] = fields unless fields.nil?
540
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
541
+ command.query['userIp'] = user_ip unless user_ip.nil?
542
+ execute_or_queue_command(command, &block)
543
+ end
544
+
545
+ # Get a custom dimension to which the user has access.
546
+ # @param [String] account_id
547
+ # Account ID for the custom dimension to retrieve.
548
+ # @param [String] web_property_id
549
+ # Web property ID for the custom dimension to retrieve.
550
+ # @param [String] custom_dimension_id
551
+ # The ID of the custom dimension to retrieve.
552
+ # @param [String] fields
553
+ # Selector specifying which fields to include in a partial response.
554
+ # @param [String] quota_user
555
+ # Available to use for quota purposes for server-side applications. Can be any
556
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
557
+ # Overrides userIp if both are provided.
558
+ # @param [String] user_ip
559
+ # IP address of the site where the request originates. Use this if you want to
560
+ # enforce per-user limits.
561
+ # @param [Google::Apis::RequestOptions] options
562
+ # Request-specific options
563
+ #
564
+ # @yield [result, err] Result & error if block supplied
565
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object
566
+ # @yieldparam err [StandardError] error object if request failed
567
+ #
568
+ # @return [Google::Apis::AnalyticsV3::CustomDimension]
569
+ #
570
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
571
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
572
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
573
+ def get_custom_dimension(account_id, web_property_id, custom_dimension_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
574
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options)
575
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
576
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimension
577
+ command.params['accountId'] = account_id unless account_id.nil?
578
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
579
+ command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil?
580
+ command.query['fields'] = fields unless fields.nil?
581
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
582
+ command.query['userIp'] = user_ip unless user_ip.nil?
583
+ execute_or_queue_command(command, &block)
584
+ end
585
+
586
+ # Create a new custom dimension.
587
+ # @param [String] account_id
588
+ # Account ID for the custom dimension to create.
589
+ # @param [String] web_property_id
590
+ # Web property ID for the custom dimension to create.
591
+ # @param [Google::Apis::AnalyticsV3::CustomDimension] custom_dimension_object
592
+ # @param [String] fields
593
+ # Selector specifying which fields to include in a partial response.
594
+ # @param [String] quota_user
595
+ # Available to use for quota purposes for server-side applications. Can be any
596
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
597
+ # Overrides userIp if both are provided.
598
+ # @param [String] user_ip
599
+ # IP address of the site where the request originates. Use this if you want to
600
+ # enforce per-user limits.
601
+ # @param [Google::Apis::RequestOptions] options
602
+ # Request-specific options
603
+ #
604
+ # @yield [result, err] Result & error if block supplied
605
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object
606
+ # @yieldparam err [StandardError] error object if request failed
607
+ #
608
+ # @return [Google::Apis::AnalyticsV3::CustomDimension]
609
+ #
610
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
611
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
612
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
613
+ def insert_custom_dimension(account_id, web_property_id, custom_dimension_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
614
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions', options)
615
+ command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
616
+ command.request_object = custom_dimension_object
617
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
618
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimension
619
+ command.params['accountId'] = account_id unless account_id.nil?
620
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
621
+ command.query['fields'] = fields unless fields.nil?
622
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
623
+ command.query['userIp'] = user_ip unless user_ip.nil?
624
+ execute_or_queue_command(command, &block)
625
+ end
626
+
627
+ # Lists custom dimensions to which the user has access.
628
+ # @param [String] account_id
629
+ # Account ID for the custom dimensions to retrieve.
630
+ # @param [String] web_property_id
631
+ # Web property ID for the custom dimensions to retrieve.
632
+ # @param [Fixnum] max_results
633
+ # The maximum number of custom dimensions to include in this response.
634
+ # @param [Fixnum] start_index
635
+ # An index of the first entity to retrieve. Use this parameter as a pagination
636
+ # mechanism along with the max-results parameter.
637
+ # @param [String] fields
638
+ # Selector specifying which fields to include in a partial response.
639
+ # @param [String] quota_user
640
+ # Available to use for quota purposes for server-side applications. Can be any
641
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
642
+ # Overrides userIp if both are provided.
643
+ # @param [String] user_ip
644
+ # IP address of the site where the request originates. Use this if you want to
645
+ # enforce per-user limits.
646
+ # @param [Google::Apis::RequestOptions] options
647
+ # Request-specific options
648
+ #
649
+ # @yield [result, err] Result & error if block supplied
650
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimensions] parsed result object
651
+ # @yieldparam err [StandardError] error object if request failed
652
+ #
653
+ # @return [Google::Apis::AnalyticsV3::CustomDimensions]
654
+ #
655
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
656
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
657
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
658
+ def list_custom_dimensions(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
659
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions', options)
660
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimensions::Representation
661
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimensions
662
+ command.params['accountId'] = account_id unless account_id.nil?
663
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
664
+ command.query['max-results'] = max_results unless max_results.nil?
665
+ command.query['start-index'] = start_index unless start_index.nil?
666
+ command.query['fields'] = fields unless fields.nil?
667
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
668
+ command.query['userIp'] = user_ip unless user_ip.nil?
669
+ execute_or_queue_command(command, &block)
670
+ end
671
+
672
+ # Updates an existing custom dimension. This method supports patch semantics.
673
+ # @param [String] account_id
674
+ # Account ID for the custom dimension to update.
675
+ # @param [String] web_property_id
676
+ # Web property ID for the custom dimension to update.
677
+ # @param [String] custom_dimension_id
678
+ # Custom dimension ID for the custom dimension to update.
679
+ # @param [Google::Apis::AnalyticsV3::CustomDimension] custom_dimension_object
680
+ # @param [Boolean] ignore_custom_data_source_links
681
+ # Force the update and ignore any warnings related to the custom dimension being
682
+ # linked to a custom data source / data set.
683
+ # @param [String] fields
684
+ # Selector specifying which fields to include in a partial response.
685
+ # @param [String] quota_user
686
+ # Available to use for quota purposes for server-side applications. Can be any
687
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
688
+ # Overrides userIp if both are provided.
689
+ # @param [String] user_ip
690
+ # IP address of the site where the request originates. Use this if you want to
691
+ # enforce per-user limits.
692
+ # @param [Google::Apis::RequestOptions] options
693
+ # Request-specific options
694
+ #
695
+ # @yield [result, err] Result & error if block supplied
696
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object
697
+ # @yieldparam err [StandardError] error object if request failed
698
+ #
699
+ # @return [Google::Apis::AnalyticsV3::CustomDimension]
700
+ #
701
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
702
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
703
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
704
+ def patch_custom_dimension(account_id, web_property_id, custom_dimension_id, custom_dimension_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
705
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options)
706
+ command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
707
+ command.request_object = custom_dimension_object
708
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
709
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimension
710
+ command.params['accountId'] = account_id unless account_id.nil?
711
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
712
+ command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil?
713
+ command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
714
+ command.query['fields'] = fields unless fields.nil?
715
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
716
+ command.query['userIp'] = user_ip unless user_ip.nil?
717
+ execute_or_queue_command(command, &block)
718
+ end
719
+
720
+ # Updates an existing custom dimension.
721
+ # @param [String] account_id
722
+ # Account ID for the custom dimension to update.
723
+ # @param [String] web_property_id
724
+ # Web property ID for the custom dimension to update.
725
+ # @param [String] custom_dimension_id
726
+ # Custom dimension ID for the custom dimension to update.
727
+ # @param [Google::Apis::AnalyticsV3::CustomDimension] custom_dimension_object
728
+ # @param [Boolean] ignore_custom_data_source_links
729
+ # Force the update and ignore any warnings related to the custom dimension being
730
+ # linked to a custom data source / data set.
731
+ # @param [String] fields
732
+ # Selector specifying which fields to include in a partial response.
733
+ # @param [String] quota_user
734
+ # Available to use for quota purposes for server-side applications. Can be any
735
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
736
+ # Overrides userIp if both are provided.
737
+ # @param [String] user_ip
738
+ # IP address of the site where the request originates. Use this if you want to
739
+ # enforce per-user limits.
740
+ # @param [Google::Apis::RequestOptions] options
741
+ # Request-specific options
742
+ #
743
+ # @yield [result, err] Result & error if block supplied
744
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object
745
+ # @yieldparam err [StandardError] error object if request failed
746
+ #
747
+ # @return [Google::Apis::AnalyticsV3::CustomDimension]
748
+ #
749
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
750
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
751
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
752
+ def update_custom_dimension(account_id, web_property_id, custom_dimension_id, custom_dimension_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
753
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options)
754
+ command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
755
+ command.request_object = custom_dimension_object
756
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
757
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimension
758
+ command.params['accountId'] = account_id unless account_id.nil?
759
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
760
+ command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil?
761
+ command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
762
+ command.query['fields'] = fields unless fields.nil?
763
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
764
+ command.query['userIp'] = user_ip unless user_ip.nil?
765
+ execute_or_queue_command(command, &block)
766
+ end
767
+
768
+ # Get a custom metric to which the user has access.
769
+ # @param [String] account_id
770
+ # Account ID for the custom metric to retrieve.
771
+ # @param [String] web_property_id
772
+ # Web property ID for the custom metric to retrieve.
773
+ # @param [String] custom_metric_id
774
+ # The ID of the custom metric to retrieve.
775
+ # @param [String] fields
776
+ # Selector specifying which fields to include in a partial response.
777
+ # @param [String] quota_user
778
+ # Available to use for quota purposes for server-side applications. Can be any
779
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
780
+ # Overrides userIp if both are provided.
781
+ # @param [String] user_ip
782
+ # IP address of the site where the request originates. Use this if you want to
783
+ # enforce per-user limits.
784
+ # @param [Google::Apis::RequestOptions] options
785
+ # Request-specific options
786
+ #
787
+ # @yield [result, err] Result & error if block supplied
788
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object
789
+ # @yieldparam err [StandardError] error object if request failed
790
+ #
791
+ # @return [Google::Apis::AnalyticsV3::CustomMetric]
792
+ #
793
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
794
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
795
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
796
+ def get_custom_metric(account_id, web_property_id, custom_metric_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
797
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options)
798
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
799
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetric
800
+ command.params['accountId'] = account_id unless account_id.nil?
801
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
802
+ command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil?
803
+ command.query['fields'] = fields unless fields.nil?
804
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
805
+ command.query['userIp'] = user_ip unless user_ip.nil?
806
+ execute_or_queue_command(command, &block)
807
+ end
808
+
809
+ # Create a new custom metric.
810
+ # @param [String] account_id
811
+ # Account ID for the custom metric to create.
812
+ # @param [String] web_property_id
813
+ # Web property ID for the custom dimension to create.
814
+ # @param [Google::Apis::AnalyticsV3::CustomMetric] custom_metric_object
815
+ # @param [String] fields
816
+ # Selector specifying which fields to include in a partial response.
817
+ # @param [String] quota_user
818
+ # Available to use for quota purposes for server-side applications. Can be any
819
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
820
+ # Overrides userIp if both are provided.
821
+ # @param [String] user_ip
822
+ # IP address of the site where the request originates. Use this if you want to
823
+ # enforce per-user limits.
824
+ # @param [Google::Apis::RequestOptions] options
825
+ # Request-specific options
826
+ #
827
+ # @yield [result, err] Result & error if block supplied
828
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object
829
+ # @yieldparam err [StandardError] error object if request failed
830
+ #
831
+ # @return [Google::Apis::AnalyticsV3::CustomMetric]
832
+ #
833
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
834
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
835
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
836
+ def insert_custom_metric(account_id, web_property_id, custom_metric_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
837
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics', options)
838
+ command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
839
+ command.request_object = custom_metric_object
840
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
841
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetric
842
+ command.params['accountId'] = account_id unless account_id.nil?
843
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
844
+ command.query['fields'] = fields unless fields.nil?
845
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
846
+ command.query['userIp'] = user_ip unless user_ip.nil?
847
+ execute_or_queue_command(command, &block)
848
+ end
849
+
850
+ # Lists custom metrics to which the user has access.
851
+ # @param [String] account_id
852
+ # Account ID for the custom metrics to retrieve.
853
+ # @param [String] web_property_id
854
+ # Web property ID for the custom metrics to retrieve.
855
+ # @param [Fixnum] max_results
856
+ # The maximum number of custom metrics to include in this response.
857
+ # @param [Fixnum] start_index
858
+ # An index of the first entity to retrieve. Use this parameter as a pagination
859
+ # mechanism along with the max-results parameter.
860
+ # @param [String] fields
861
+ # Selector specifying which fields to include in a partial response.
862
+ # @param [String] quota_user
863
+ # Available to use for quota purposes for server-side applications. Can be any
864
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
865
+ # Overrides userIp if both are provided.
866
+ # @param [String] user_ip
867
+ # IP address of the site where the request originates. Use this if you want to
868
+ # enforce per-user limits.
869
+ # @param [Google::Apis::RequestOptions] options
870
+ # Request-specific options
871
+ #
872
+ # @yield [result, err] Result & error if block supplied
873
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetrics] parsed result object
874
+ # @yieldparam err [StandardError] error object if request failed
875
+ #
876
+ # @return [Google::Apis::AnalyticsV3::CustomMetrics]
877
+ #
878
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
879
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
880
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
881
+ def list_custom_metrics(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
882
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics', options)
883
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetrics::Representation
884
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetrics
885
+ command.params['accountId'] = account_id unless account_id.nil?
886
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
887
+ command.query['max-results'] = max_results unless max_results.nil?
888
+ command.query['start-index'] = start_index unless start_index.nil?
889
+ command.query['fields'] = fields unless fields.nil?
890
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
891
+ command.query['userIp'] = user_ip unless user_ip.nil?
892
+ execute_or_queue_command(command, &block)
893
+ end
894
+
895
+ # Updates an existing custom metric. This method supports patch semantics.
896
+ # @param [String] account_id
897
+ # Account ID for the custom metric to update.
898
+ # @param [String] web_property_id
899
+ # Web property ID for the custom metric to update.
900
+ # @param [String] custom_metric_id
901
+ # Custom metric ID for the custom metric to update.
902
+ # @param [Google::Apis::AnalyticsV3::CustomMetric] custom_metric_object
903
+ # @param [Boolean] ignore_custom_data_source_links
904
+ # Force the update and ignore any warnings related to the custom metric being
905
+ # linked to a custom data source / data set.
906
+ # @param [String] fields
907
+ # Selector specifying which fields to include in a partial response.
908
+ # @param [String] quota_user
909
+ # Available to use for quota purposes for server-side applications. Can be any
910
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
911
+ # Overrides userIp if both are provided.
912
+ # @param [String] user_ip
913
+ # IP address of the site where the request originates. Use this if you want to
914
+ # enforce per-user limits.
915
+ # @param [Google::Apis::RequestOptions] options
916
+ # Request-specific options
917
+ #
918
+ # @yield [result, err] Result & error if block supplied
919
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object
920
+ # @yieldparam err [StandardError] error object if request failed
921
+ #
922
+ # @return [Google::Apis::AnalyticsV3::CustomMetric]
923
+ #
924
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
925
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
926
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
927
+ def patch_custom_metric(account_id, web_property_id, custom_metric_id, custom_metric_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
928
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options)
929
+ command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
930
+ command.request_object = custom_metric_object
931
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
932
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetric
933
+ command.params['accountId'] = account_id unless account_id.nil?
934
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
935
+ command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil?
936
+ command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
937
+ command.query['fields'] = fields unless fields.nil?
938
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
939
+ command.query['userIp'] = user_ip unless user_ip.nil?
940
+ execute_or_queue_command(command, &block)
941
+ end
942
+
943
+ # Updates an existing custom metric.
944
+ # @param [String] account_id
945
+ # Account ID for the custom metric to update.
946
+ # @param [String] web_property_id
947
+ # Web property ID for the custom metric to update.
948
+ # @param [String] custom_metric_id
949
+ # Custom metric ID for the custom metric to update.
950
+ # @param [Google::Apis::AnalyticsV3::CustomMetric] custom_metric_object
951
+ # @param [Boolean] ignore_custom_data_source_links
952
+ # Force the update and ignore any warnings related to the custom metric being
953
+ # linked to a custom data source / data set.
954
+ # @param [String] fields
955
+ # Selector specifying which fields to include in a partial response.
956
+ # @param [String] quota_user
957
+ # Available to use for quota purposes for server-side applications. Can be any
958
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
959
+ # Overrides userIp if both are provided.
960
+ # @param [String] user_ip
961
+ # IP address of the site where the request originates. Use this if you want to
962
+ # enforce per-user limits.
963
+ # @param [Google::Apis::RequestOptions] options
964
+ # Request-specific options
965
+ #
966
+ # @yield [result, err] Result & error if block supplied
967
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object
968
+ # @yieldparam err [StandardError] error object if request failed
969
+ #
970
+ # @return [Google::Apis::AnalyticsV3::CustomMetric]
971
+ #
972
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
973
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
974
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
975
+ def update_custom_metric(account_id, web_property_id, custom_metric_id, custom_metric_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
976
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options)
977
+ command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
978
+ command.request_object = custom_metric_object
979
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
980
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetric
981
+ command.params['accountId'] = account_id unless account_id.nil?
982
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
983
+ command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil?
984
+ command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
985
+ command.query['fields'] = fields unless fields.nil?
986
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
987
+ command.query['userIp'] = user_ip unless user_ip.nil?
988
+ execute_or_queue_command(command, &block)
989
+ end
990
+
991
+ # Delete an experiment.
992
+ # @param [String] account_id
993
+ # Account ID to which the experiment belongs
994
+ # @param [String] web_property_id
995
+ # Web property ID to which the experiment belongs
996
+ # @param [String] profile_id
997
+ # View (Profile) ID to which the experiment belongs
998
+ # @param [String] experiment_id
999
+ # ID of the experiment to delete
1000
+ # @param [String] fields
1001
+ # Selector specifying which fields to include in a partial response.
1002
+ # @param [String] quota_user
1003
+ # Available to use for quota purposes for server-side applications. Can be any
1004
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1005
+ # Overrides userIp if both are provided.
1006
+ # @param [String] user_ip
1007
+ # IP address of the site where the request originates. Use this if you want to
1008
+ # enforce per-user limits.
1009
+ # @param [Google::Apis::RequestOptions] options
1010
+ # Request-specific options
1011
+ #
1012
+ # @yield [result, err] Result & error if block supplied
1013
+ # @yieldparam result [NilClass] No result returned for this method
1014
+ # @yieldparam err [StandardError] error object if request failed
1015
+ #
1016
+ # @return [void]
1017
+ #
1018
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1019
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1020
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1021
+ def delete_experiment(account_id, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1022
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
1023
+ command.params['accountId'] = account_id unless account_id.nil?
1024
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1025
+ command.params['profileId'] = profile_id unless profile_id.nil?
1026
+ command.params['experimentId'] = experiment_id unless experiment_id.nil?
1027
+ command.query['fields'] = fields unless fields.nil?
1028
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1029
+ command.query['userIp'] = user_ip unless user_ip.nil?
1030
+ execute_or_queue_command(command, &block)
1031
+ end
1032
+
1033
+ # Returns an experiment to which the user has access.
1034
+ # @param [String] account_id
1035
+ # Account ID to retrieve the experiment for.
1036
+ # @param [String] web_property_id
1037
+ # Web property ID to retrieve the experiment for.
1038
+ # @param [String] profile_id
1039
+ # View (Profile) ID to retrieve the experiment for.
1040
+ # @param [String] experiment_id
1041
+ # Experiment ID to retrieve the experiment for.
1042
+ # @param [String] fields
1043
+ # Selector specifying which fields to include in a partial response.
1044
+ # @param [String] quota_user
1045
+ # Available to use for quota purposes for server-side applications. Can be any
1046
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1047
+ # Overrides userIp if both are provided.
1048
+ # @param [String] user_ip
1049
+ # IP address of the site where the request originates. Use this if you want to
1050
+ # enforce per-user limits.
1051
+ # @param [Google::Apis::RequestOptions] options
1052
+ # Request-specific options
1053
+ #
1054
+ # @yield [result, err] Result & error if block supplied
1055
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object
1056
+ # @yieldparam err [StandardError] error object if request failed
1057
+ #
1058
+ # @return [Google::Apis::AnalyticsV3::Experiment]
1059
+ #
1060
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1061
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1062
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1063
+ def get_experiment(account_id, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1064
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
1065
+ command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1066
+ command.response_class = Google::Apis::AnalyticsV3::Experiment
1067
+ command.params['accountId'] = account_id unless account_id.nil?
1068
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1069
+ command.params['profileId'] = profile_id unless profile_id.nil?
1070
+ command.params['experimentId'] = experiment_id unless experiment_id.nil?
1071
+ command.query['fields'] = fields unless fields.nil?
1072
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1073
+ command.query['userIp'] = user_ip unless user_ip.nil?
1074
+ execute_or_queue_command(command, &block)
1075
+ end
1076
+
1077
+ # Create a new experiment.
1078
+ # @param [String] account_id
1079
+ # Account ID to create the experiment for.
1080
+ # @param [String] web_property_id
1081
+ # Web property ID to create the experiment for.
1082
+ # @param [String] profile_id
1083
+ # View (Profile) ID to create the experiment for.
1084
+ # @param [Google::Apis::AnalyticsV3::Experiment] experiment_object
1085
+ # @param [String] fields
1086
+ # Selector specifying which fields to include in a partial response.
1087
+ # @param [String] quota_user
1088
+ # Available to use for quota purposes for server-side applications. Can be any
1089
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1090
+ # Overrides userIp if both are provided.
1091
+ # @param [String] user_ip
1092
+ # IP address of the site where the request originates. Use this if you want to
1093
+ # enforce per-user limits.
1094
+ # @param [Google::Apis::RequestOptions] options
1095
+ # Request-specific options
1096
+ #
1097
+ # @yield [result, err] Result & error if block supplied
1098
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object
1099
+ # @yieldparam err [StandardError] error object if request failed
1100
+ #
1101
+ # @return [Google::Apis::AnalyticsV3::Experiment]
1102
+ #
1103
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1104
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1105
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1106
+ def insert_experiment(account_id, web_property_id, profile_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1107
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments', options)
1108
+ command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1109
+ command.request_object = experiment_object
1110
+ command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1111
+ command.response_class = Google::Apis::AnalyticsV3::Experiment
1112
+ command.params['accountId'] = account_id unless account_id.nil?
1113
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1114
+ command.params['profileId'] = profile_id unless profile_id.nil?
1115
+ command.query['fields'] = fields unless fields.nil?
1116
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1117
+ command.query['userIp'] = user_ip unless user_ip.nil?
1118
+ execute_or_queue_command(command, &block)
1119
+ end
1120
+
1121
+ # Lists experiments to which the user has access.
1122
+ # @param [String] account_id
1123
+ # Account ID to retrieve experiments for.
1124
+ # @param [String] web_property_id
1125
+ # Web property ID to retrieve experiments for.
1126
+ # @param [String] profile_id
1127
+ # View (Profile) ID to retrieve experiments for.
1128
+ # @param [Fixnum] max_results
1129
+ # The maximum number of experiments to include in this response.
1130
+ # @param [Fixnum] start_index
1131
+ # An index of the first experiment to retrieve. Use this parameter as a
1132
+ # pagination mechanism along with the max-results parameter.
1133
+ # @param [String] fields
1134
+ # Selector specifying which fields to include in a partial response.
1135
+ # @param [String] quota_user
1136
+ # Available to use for quota purposes for server-side applications. Can be any
1137
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1138
+ # Overrides userIp if both are provided.
1139
+ # @param [String] user_ip
1140
+ # IP address of the site where the request originates. Use this if you want to
1141
+ # enforce per-user limits.
1142
+ # @param [Google::Apis::RequestOptions] options
1143
+ # Request-specific options
1144
+ #
1145
+ # @yield [result, err] Result & error if block supplied
1146
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiments] parsed result object
1147
+ # @yieldparam err [StandardError] error object if request failed
1148
+ #
1149
+ # @return [Google::Apis::AnalyticsV3::Experiments]
1150
+ #
1151
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1152
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1153
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1154
+ def list_experiments(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1155
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments', options)
1156
+ command.response_representation = Google::Apis::AnalyticsV3::Experiments::Representation
1157
+ command.response_class = Google::Apis::AnalyticsV3::Experiments
1158
+ command.params['accountId'] = account_id unless account_id.nil?
1159
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1160
+ command.params['profileId'] = profile_id unless profile_id.nil?
1161
+ command.query['max-results'] = max_results unless max_results.nil?
1162
+ command.query['start-index'] = start_index unless start_index.nil?
1163
+ command.query['fields'] = fields unless fields.nil?
1164
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1165
+ command.query['userIp'] = user_ip unless user_ip.nil?
1166
+ execute_or_queue_command(command, &block)
1167
+ end
1168
+
1169
+ # Update an existing experiment. This method supports patch semantics.
1170
+ # @param [String] account_id
1171
+ # Account ID of the experiment to update.
1172
+ # @param [String] web_property_id
1173
+ # Web property ID of the experiment to update.
1174
+ # @param [String] profile_id
1175
+ # View (Profile) ID of the experiment to update.
1176
+ # @param [String] experiment_id
1177
+ # Experiment ID of the experiment to update.
1178
+ # @param [Google::Apis::AnalyticsV3::Experiment] experiment_object
1179
+ # @param [String] fields
1180
+ # Selector specifying which fields to include in a partial response.
1181
+ # @param [String] quota_user
1182
+ # Available to use for quota purposes for server-side applications. Can be any
1183
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1184
+ # Overrides userIp if both are provided.
1185
+ # @param [String] user_ip
1186
+ # IP address of the site where the request originates. Use this if you want to
1187
+ # enforce per-user limits.
1188
+ # @param [Google::Apis::RequestOptions] options
1189
+ # Request-specific options
1190
+ #
1191
+ # @yield [result, err] Result & error if block supplied
1192
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object
1193
+ # @yieldparam err [StandardError] error object if request failed
1194
+ #
1195
+ # @return [Google::Apis::AnalyticsV3::Experiment]
1196
+ #
1197
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1198
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1199
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1200
+ def patch_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1201
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
1202
+ command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1203
+ command.request_object = experiment_object
1204
+ command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1205
+ command.response_class = Google::Apis::AnalyticsV3::Experiment
1206
+ command.params['accountId'] = account_id unless account_id.nil?
1207
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1208
+ command.params['profileId'] = profile_id unless profile_id.nil?
1209
+ command.params['experimentId'] = experiment_id unless experiment_id.nil?
1210
+ command.query['fields'] = fields unless fields.nil?
1211
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1212
+ command.query['userIp'] = user_ip unless user_ip.nil?
1213
+ execute_or_queue_command(command, &block)
1214
+ end
1215
+
1216
+ # Update an existing experiment.
1217
+ # @param [String] account_id
1218
+ # Account ID of the experiment to update.
1219
+ # @param [String] web_property_id
1220
+ # Web property ID of the experiment to update.
1221
+ # @param [String] profile_id
1222
+ # View (Profile) ID of the experiment to update.
1223
+ # @param [String] experiment_id
1224
+ # Experiment ID of the experiment to update.
1225
+ # @param [Google::Apis::AnalyticsV3::Experiment] experiment_object
1226
+ # @param [String] fields
1227
+ # Selector specifying which fields to include in a partial response.
1228
+ # @param [String] quota_user
1229
+ # Available to use for quota purposes for server-side applications. Can be any
1230
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1231
+ # Overrides userIp if both are provided.
1232
+ # @param [String] user_ip
1233
+ # IP address of the site where the request originates. Use this if you want to
1234
+ # enforce per-user limits.
1235
+ # @param [Google::Apis::RequestOptions] options
1236
+ # Request-specific options
1237
+ #
1238
+ # @yield [result, err] Result & error if block supplied
1239
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object
1240
+ # @yieldparam err [StandardError] error object if request failed
1241
+ #
1242
+ # @return [Google::Apis::AnalyticsV3::Experiment]
1243
+ #
1244
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1245
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1246
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1247
+ def update_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1248
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
1249
+ command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1250
+ command.request_object = experiment_object
1251
+ command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1252
+ command.response_class = Google::Apis::AnalyticsV3::Experiment
1253
+ command.params['accountId'] = account_id unless account_id.nil?
1254
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1255
+ command.params['profileId'] = profile_id unless profile_id.nil?
1256
+ command.params['experimentId'] = experiment_id unless experiment_id.nil?
1257
+ command.query['fields'] = fields unless fields.nil?
1258
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1259
+ command.query['userIp'] = user_ip unless user_ip.nil?
1260
+ execute_or_queue_command(command, &block)
1261
+ end
1262
+
1263
+ # Delete a filter.
1264
+ # @param [String] account_id
1265
+ # Account ID to delete the filter for.
1266
+ # @param [String] filter_id
1267
+ # ID of the filter to be deleted.
1268
+ # @param [String] fields
1269
+ # Selector specifying which fields to include in a partial response.
1270
+ # @param [String] quota_user
1271
+ # Available to use for quota purposes for server-side applications. Can be any
1272
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1273
+ # Overrides userIp if both are provided.
1274
+ # @param [String] user_ip
1275
+ # IP address of the site where the request originates. Use this if you want to
1276
+ # enforce per-user limits.
1277
+ # @param [Google::Apis::RequestOptions] options
1278
+ # Request-specific options
1279
+ #
1280
+ # @yield [result, err] Result & error if block supplied
1281
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object
1282
+ # @yieldparam err [StandardError] error object if request failed
1283
+ #
1284
+ # @return [Google::Apis::AnalyticsV3::Filter]
1285
+ #
1286
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1287
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1288
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1289
+ def delete_filter(account_id, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1290
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/filters/{filterId}', options)
1291
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1292
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1293
+ command.params['accountId'] = account_id unless account_id.nil?
1294
+ command.params['filterId'] = filter_id unless filter_id.nil?
1295
+ command.query['fields'] = fields unless fields.nil?
1296
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1297
+ command.query['userIp'] = user_ip unless user_ip.nil?
1298
+ execute_or_queue_command(command, &block)
1299
+ end
1300
+
1301
+ # Returns a filters to which the user has access.
1302
+ # @param [String] account_id
1303
+ # Account ID to retrieve filters for.
1304
+ # @param [String] filter_id
1305
+ # Filter ID to retrieve filters for.
1306
+ # @param [String] fields
1307
+ # Selector specifying which fields to include in a partial response.
1308
+ # @param [String] quota_user
1309
+ # Available to use for quota purposes for server-side applications. Can be any
1310
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1311
+ # Overrides userIp if both are provided.
1312
+ # @param [String] user_ip
1313
+ # IP address of the site where the request originates. Use this if you want to
1314
+ # enforce per-user limits.
1315
+ # @param [Google::Apis::RequestOptions] options
1316
+ # Request-specific options
1317
+ #
1318
+ # @yield [result, err] Result & error if block supplied
1319
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object
1320
+ # @yieldparam err [StandardError] error object if request failed
1321
+ #
1322
+ # @return [Google::Apis::AnalyticsV3::Filter]
1323
+ #
1324
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1325
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1326
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1327
+ def get_filter(account_id, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1328
+ command = make_simple_command(:get, 'management/accounts/{accountId}/filters/{filterId}', options)
1329
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1330
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1331
+ command.params['accountId'] = account_id unless account_id.nil?
1332
+ command.params['filterId'] = filter_id unless filter_id.nil?
1333
+ command.query['fields'] = fields unless fields.nil?
1334
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1335
+ command.query['userIp'] = user_ip unless user_ip.nil?
1336
+ execute_or_queue_command(command, &block)
1337
+ end
1338
+
1339
+ # Create a new filter.
1340
+ # @param [String] account_id
1341
+ # Account ID to create filter for.
1342
+ # @param [Google::Apis::AnalyticsV3::Filter] filter_object
1343
+ # @param [String] fields
1344
+ # Selector specifying which fields to include in a partial response.
1345
+ # @param [String] quota_user
1346
+ # Available to use for quota purposes for server-side applications. Can be any
1347
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1348
+ # Overrides userIp if both are provided.
1349
+ # @param [String] user_ip
1350
+ # IP address of the site where the request originates. Use this if you want to
1351
+ # enforce per-user limits.
1352
+ # @param [Google::Apis::RequestOptions] options
1353
+ # Request-specific options
1354
+ #
1355
+ # @yield [result, err] Result & error if block supplied
1356
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object
1357
+ # @yieldparam err [StandardError] error object if request failed
1358
+ #
1359
+ # @return [Google::Apis::AnalyticsV3::Filter]
1360
+ #
1361
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1362
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1363
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1364
+ def insert_filter(account_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1365
+ command = make_simple_command(:post, 'management/accounts/{accountId}/filters', options)
1366
+ command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation
1367
+ command.request_object = filter_object
1368
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1369
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1370
+ command.params['accountId'] = account_id unless account_id.nil?
1371
+ command.query['fields'] = fields unless fields.nil?
1372
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1373
+ command.query['userIp'] = user_ip unless user_ip.nil?
1374
+ execute_or_queue_command(command, &block)
1375
+ end
1376
+
1377
+ # Lists all filters for an account
1378
+ # @param [String] account_id
1379
+ # Account ID to retrieve filters for.
1380
+ # @param [Fixnum] max_results
1381
+ # The maximum number of filters to include in this response.
1382
+ # @param [Fixnum] start_index
1383
+ # An index of the first entity to retrieve. Use this parameter as a pagination
1384
+ # mechanism along with the max-results parameter.
1385
+ # @param [String] fields
1386
+ # Selector specifying which fields to include in a partial response.
1387
+ # @param [String] quota_user
1388
+ # Available to use for quota purposes for server-side applications. Can be any
1389
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1390
+ # Overrides userIp if both are provided.
1391
+ # @param [String] user_ip
1392
+ # IP address of the site where the request originates. Use this if you want to
1393
+ # enforce per-user limits.
1394
+ # @param [Google::Apis::RequestOptions] options
1395
+ # Request-specific options
1396
+ #
1397
+ # @yield [result, err] Result & error if block supplied
1398
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filters] parsed result object
1399
+ # @yieldparam err [StandardError] error object if request failed
1400
+ #
1401
+ # @return [Google::Apis::AnalyticsV3::Filters]
1402
+ #
1403
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1404
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1405
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1406
+ def list_filters(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1407
+ command = make_simple_command(:get, 'management/accounts/{accountId}/filters', options)
1408
+ command.response_representation = Google::Apis::AnalyticsV3::Filters::Representation
1409
+ command.response_class = Google::Apis::AnalyticsV3::Filters
1410
+ command.params['accountId'] = account_id unless account_id.nil?
1411
+ command.query['max-results'] = max_results unless max_results.nil?
1412
+ command.query['start-index'] = start_index unless start_index.nil?
1413
+ command.query['fields'] = fields unless fields.nil?
1414
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1415
+ command.query['userIp'] = user_ip unless user_ip.nil?
1416
+ execute_or_queue_command(command, &block)
1417
+ end
1418
+
1419
+ # Updates an existing filter. This method supports patch semantics.
1420
+ # @param [String] account_id
1421
+ # Account ID to which the filter belongs.
1422
+ # @param [String] filter_id
1423
+ # ID of the filter to be updated.
1424
+ # @param [Google::Apis::AnalyticsV3::Filter] filter_object
1425
+ # @param [String] fields
1426
+ # Selector specifying which fields to include in a partial response.
1427
+ # @param [String] quota_user
1428
+ # Available to use for quota purposes for server-side applications. Can be any
1429
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1430
+ # Overrides userIp if both are provided.
1431
+ # @param [String] user_ip
1432
+ # IP address of the site where the request originates. Use this if you want to
1433
+ # enforce per-user limits.
1434
+ # @param [Google::Apis::RequestOptions] options
1435
+ # Request-specific options
1436
+ #
1437
+ # @yield [result, err] Result & error if block supplied
1438
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object
1439
+ # @yieldparam err [StandardError] error object if request failed
1440
+ #
1441
+ # @return [Google::Apis::AnalyticsV3::Filter]
1442
+ #
1443
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1444
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1445
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1446
+ def patch_filter(account_id, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1447
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/filters/{filterId}', options)
1448
+ command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation
1449
+ command.request_object = filter_object
1450
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1451
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1452
+ command.params['accountId'] = account_id unless account_id.nil?
1453
+ command.params['filterId'] = filter_id unless filter_id.nil?
1454
+ command.query['fields'] = fields unless fields.nil?
1455
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1456
+ command.query['userIp'] = user_ip unless user_ip.nil?
1457
+ execute_or_queue_command(command, &block)
1458
+ end
1459
+
1460
+ # Updates an existing filter.
1461
+ # @param [String] account_id
1462
+ # Account ID to which the filter belongs.
1463
+ # @param [String] filter_id
1464
+ # ID of the filter to be updated.
1465
+ # @param [Google::Apis::AnalyticsV3::Filter] filter_object
1466
+ # @param [String] fields
1467
+ # Selector specifying which fields to include in a partial response.
1468
+ # @param [String] quota_user
1469
+ # Available to use for quota purposes for server-side applications. Can be any
1470
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1471
+ # Overrides userIp if both are provided.
1472
+ # @param [String] user_ip
1473
+ # IP address of the site where the request originates. Use this if you want to
1474
+ # enforce per-user limits.
1475
+ # @param [Google::Apis::RequestOptions] options
1476
+ # Request-specific options
1477
+ #
1478
+ # @yield [result, err] Result & error if block supplied
1479
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object
1480
+ # @yieldparam err [StandardError] error object if request failed
1481
+ #
1482
+ # @return [Google::Apis::AnalyticsV3::Filter]
1483
+ #
1484
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1485
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1486
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1487
+ def update_filter(account_id, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1488
+ command = make_simple_command(:put, 'management/accounts/{accountId}/filters/{filterId}', options)
1489
+ command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation
1490
+ command.request_object = filter_object
1491
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1492
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1493
+ command.params['accountId'] = account_id unless account_id.nil?
1494
+ command.params['filterId'] = filter_id unless filter_id.nil?
1495
+ command.query['fields'] = fields unless fields.nil?
1496
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1497
+ command.query['userIp'] = user_ip unless user_ip.nil?
1498
+ execute_or_queue_command(command, &block)
1499
+ end
1500
+
1501
+ # Gets a goal to which the user has access.
1502
+ # @param [String] account_id
1503
+ # Account ID to retrieve the goal for.
1504
+ # @param [String] web_property_id
1505
+ # Web property ID to retrieve the goal for.
1506
+ # @param [String] profile_id
1507
+ # View (Profile) ID to retrieve the goal for.
1508
+ # @param [String] goal_id
1509
+ # Goal ID to retrieve the goal for.
1510
+ # @param [String] fields
1511
+ # Selector specifying which fields to include in a partial response.
1512
+ # @param [String] quota_user
1513
+ # Available to use for quota purposes for server-side applications. Can be any
1514
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1515
+ # Overrides userIp if both are provided.
1516
+ # @param [String] user_ip
1517
+ # IP address of the site where the request originates. Use this if you want to
1518
+ # enforce per-user limits.
1519
+ # @param [Google::Apis::RequestOptions] options
1520
+ # Request-specific options
1521
+ #
1522
+ # @yield [result, err] Result & error if block supplied
1523
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object
1524
+ # @yieldparam err [StandardError] error object if request failed
1525
+ #
1526
+ # @return [Google::Apis::AnalyticsV3::Goal]
1527
+ #
1528
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1529
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1530
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1531
+ def get_goal(account_id, web_property_id, profile_id, goal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1532
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options)
1533
+ command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
1534
+ command.response_class = Google::Apis::AnalyticsV3::Goal
1535
+ command.params['accountId'] = account_id unless account_id.nil?
1536
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1537
+ command.params['profileId'] = profile_id unless profile_id.nil?
1538
+ command.params['goalId'] = goal_id unless goal_id.nil?
1539
+ command.query['fields'] = fields unless fields.nil?
1540
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1541
+ command.query['userIp'] = user_ip unless user_ip.nil?
1542
+ execute_or_queue_command(command, &block)
1543
+ end
1544
+
1545
+ # Create a new goal.
1546
+ # @param [String] account_id
1547
+ # Account ID to create the goal for.
1548
+ # @param [String] web_property_id
1549
+ # Web property ID to create the goal for.
1550
+ # @param [String] profile_id
1551
+ # View (Profile) ID to create the goal for.
1552
+ # @param [Google::Apis::AnalyticsV3::Goal] goal_object
1553
+ # @param [String] fields
1554
+ # Selector specifying which fields to include in a partial response.
1555
+ # @param [String] quota_user
1556
+ # Available to use for quota purposes for server-side applications. Can be any
1557
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1558
+ # Overrides userIp if both are provided.
1559
+ # @param [String] user_ip
1560
+ # IP address of the site where the request originates. Use this if you want to
1561
+ # enforce per-user limits.
1562
+ # @param [Google::Apis::RequestOptions] options
1563
+ # Request-specific options
1564
+ #
1565
+ # @yield [result, err] Result & error if block supplied
1566
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object
1567
+ # @yieldparam err [StandardError] error object if request failed
1568
+ #
1569
+ # @return [Google::Apis::AnalyticsV3::Goal]
1570
+ #
1571
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1572
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1573
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1574
+ def insert_goal(account_id, web_property_id, profile_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1575
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals', options)
1576
+ command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation
1577
+ command.request_object = goal_object
1578
+ command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
1579
+ command.response_class = Google::Apis::AnalyticsV3::Goal
1580
+ command.params['accountId'] = account_id unless account_id.nil?
1581
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1582
+ command.params['profileId'] = profile_id unless profile_id.nil?
1583
+ command.query['fields'] = fields unless fields.nil?
1584
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1585
+ command.query['userIp'] = user_ip unless user_ip.nil?
1586
+ execute_or_queue_command(command, &block)
1587
+ end
1588
+
1589
+ # Lists goals to which the user has access.
1590
+ # @param [String] account_id
1591
+ # Account ID to retrieve goals for. Can either be a specific account ID or '~all'
1592
+ # , which refers to all the accounts that user has access to.
1593
+ # @param [String] web_property_id
1594
+ # Web property ID to retrieve goals for. Can either be a specific web property
1595
+ # ID or '~all', which refers to all the web properties that user has access to.
1596
+ # @param [String] profile_id
1597
+ # View (Profile) ID to retrieve goals for. Can either be a specific view (
1598
+ # profile) ID or '~all', which refers to all the views (profiles) that user has
1599
+ # access to.
1600
+ # @param [Fixnum] max_results
1601
+ # The maximum number of goals to include in this response.
1602
+ # @param [Fixnum] start_index
1603
+ # An index of the first goal to retrieve. Use this parameter as a pagination
1604
+ # mechanism along with the max-results parameter.
1605
+ # @param [String] fields
1606
+ # Selector specifying which fields to include in a partial response.
1607
+ # @param [String] quota_user
1608
+ # Available to use for quota purposes for server-side applications. Can be any
1609
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1610
+ # Overrides userIp if both are provided.
1611
+ # @param [String] user_ip
1612
+ # IP address of the site where the request originates. Use this if you want to
1613
+ # enforce per-user limits.
1614
+ # @param [Google::Apis::RequestOptions] options
1615
+ # Request-specific options
1616
+ #
1617
+ # @yield [result, err] Result & error if block supplied
1618
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goals] parsed result object
1619
+ # @yieldparam err [StandardError] error object if request failed
1620
+ #
1621
+ # @return [Google::Apis::AnalyticsV3::Goals]
1622
+ #
1623
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1624
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1625
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1626
+ def list_goals(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1627
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals', options)
1628
+ command.response_representation = Google::Apis::AnalyticsV3::Goals::Representation
1629
+ command.response_class = Google::Apis::AnalyticsV3::Goals
1630
+ command.params['accountId'] = account_id unless account_id.nil?
1631
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1632
+ command.params['profileId'] = profile_id unless profile_id.nil?
1633
+ command.query['max-results'] = max_results unless max_results.nil?
1634
+ command.query['start-index'] = start_index unless start_index.nil?
1635
+ command.query['fields'] = fields unless fields.nil?
1636
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1637
+ command.query['userIp'] = user_ip unless user_ip.nil?
1638
+ execute_or_queue_command(command, &block)
1639
+ end
1640
+
1641
+ # Updates an existing view (profile). This method supports patch semantics.
1642
+ # @param [String] account_id
1643
+ # Account ID to update the goal.
1644
+ # @param [String] web_property_id
1645
+ # Web property ID to update the goal.
1646
+ # @param [String] profile_id
1647
+ # View (Profile) ID to update the goal.
1648
+ # @param [String] goal_id
1649
+ # Index of the goal to be updated.
1650
+ # @param [Google::Apis::AnalyticsV3::Goal] goal_object
1651
+ # @param [String] fields
1652
+ # Selector specifying which fields to include in a partial response.
1653
+ # @param [String] quota_user
1654
+ # Available to use for quota purposes for server-side applications. Can be any
1655
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1656
+ # Overrides userIp if both are provided.
1657
+ # @param [String] user_ip
1658
+ # IP address of the site where the request originates. Use this if you want to
1659
+ # enforce per-user limits.
1660
+ # @param [Google::Apis::RequestOptions] options
1661
+ # Request-specific options
1662
+ #
1663
+ # @yield [result, err] Result & error if block supplied
1664
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object
1665
+ # @yieldparam err [StandardError] error object if request failed
1666
+ #
1667
+ # @return [Google::Apis::AnalyticsV3::Goal]
1668
+ #
1669
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1670
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1671
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1672
+ def patch_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1673
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options)
1674
+ command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation
1675
+ command.request_object = goal_object
1676
+ command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
1677
+ command.response_class = Google::Apis::AnalyticsV3::Goal
1678
+ command.params['accountId'] = account_id unless account_id.nil?
1679
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1680
+ command.params['profileId'] = profile_id unless profile_id.nil?
1681
+ command.params['goalId'] = goal_id unless goal_id.nil?
1682
+ command.query['fields'] = fields unless fields.nil?
1683
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1684
+ command.query['userIp'] = user_ip unless user_ip.nil?
1685
+ execute_or_queue_command(command, &block)
1686
+ end
1687
+
1688
+ # Updates an existing view (profile).
1689
+ # @param [String] account_id
1690
+ # Account ID to update the goal.
1691
+ # @param [String] web_property_id
1692
+ # Web property ID to update the goal.
1693
+ # @param [String] profile_id
1694
+ # View (Profile) ID to update the goal.
1695
+ # @param [String] goal_id
1696
+ # Index of the goal to be updated.
1697
+ # @param [Google::Apis::AnalyticsV3::Goal] goal_object
1698
+ # @param [String] fields
1699
+ # Selector specifying which fields to include in a partial response.
1700
+ # @param [String] quota_user
1701
+ # Available to use for quota purposes for server-side applications. Can be any
1702
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1703
+ # Overrides userIp if both are provided.
1704
+ # @param [String] user_ip
1705
+ # IP address of the site where the request originates. Use this if you want to
1706
+ # enforce per-user limits.
1707
+ # @param [Google::Apis::RequestOptions] options
1708
+ # Request-specific options
1709
+ #
1710
+ # @yield [result, err] Result & error if block supplied
1711
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object
1712
+ # @yieldparam err [StandardError] error object if request failed
1713
+ #
1714
+ # @return [Google::Apis::AnalyticsV3::Goal]
1715
+ #
1716
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1717
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1718
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1719
+ def update_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1720
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options)
1721
+ command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation
1722
+ command.request_object = goal_object
1723
+ command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
1724
+ command.response_class = Google::Apis::AnalyticsV3::Goal
1725
+ command.params['accountId'] = account_id unless account_id.nil?
1726
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1727
+ command.params['profileId'] = profile_id unless profile_id.nil?
1728
+ command.params['goalId'] = goal_id unless goal_id.nil?
1729
+ command.query['fields'] = fields unless fields.nil?
1730
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1731
+ command.query['userIp'] = user_ip unless user_ip.nil?
1732
+ execute_or_queue_command(command, &block)
1733
+ end
1734
+
1735
+ # Delete a profile filter link.
1736
+ # @param [String] account_id
1737
+ # Account ID to which the profile filter link belongs.
1738
+ # @param [String] web_property_id
1739
+ # Web property Id to which the profile filter link belongs.
1740
+ # @param [String] profile_id
1741
+ # Profile ID to which the filter link belongs.
1742
+ # @param [String] link_id
1743
+ # ID of the profile filter link to delete.
1744
+ # @param [String] fields
1745
+ # Selector specifying which fields to include in a partial response.
1746
+ # @param [String] quota_user
1747
+ # Available to use for quota purposes for server-side applications. Can be any
1748
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1749
+ # Overrides userIp if both are provided.
1750
+ # @param [String] user_ip
1751
+ # IP address of the site where the request originates. Use this if you want to
1752
+ # enforce per-user limits.
1753
+ # @param [Google::Apis::RequestOptions] options
1754
+ # Request-specific options
1755
+ #
1756
+ # @yield [result, err] Result & error if block supplied
1757
+ # @yieldparam result [NilClass] No result returned for this method
1758
+ # @yieldparam err [StandardError] error object if request failed
1759
+ #
1760
+ # @return [void]
1761
+ #
1762
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1763
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1764
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1765
+ def delete_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1766
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
1767
+ command.params['accountId'] = account_id unless account_id.nil?
1768
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1769
+ command.params['profileId'] = profile_id unless profile_id.nil?
1770
+ command.params['linkId'] = link_id unless link_id.nil?
1771
+ command.query['fields'] = fields unless fields.nil?
1772
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1773
+ command.query['userIp'] = user_ip unless user_ip.nil?
1774
+ execute_or_queue_command(command, &block)
1775
+ end
1776
+
1777
+ # Returns a single profile filter link.
1778
+ # @param [String] account_id
1779
+ # Account ID to retrieve profile filter link for.
1780
+ # @param [String] web_property_id
1781
+ # Web property Id to retrieve profile filter link for.
1782
+ # @param [String] profile_id
1783
+ # Profile ID to retrieve filter link for.
1784
+ # @param [String] link_id
1785
+ # ID of the profile filter link.
1786
+ # @param [String] fields
1787
+ # Selector specifying which fields to include in a partial response.
1788
+ # @param [String] quota_user
1789
+ # Available to use for quota purposes for server-side applications. Can be any
1790
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1791
+ # Overrides userIp if both are provided.
1792
+ # @param [String] user_ip
1793
+ # IP address of the site where the request originates. Use this if you want to
1794
+ # enforce per-user limits.
1795
+ # @param [Google::Apis::RequestOptions] options
1796
+ # Request-specific options
1797
+ #
1798
+ # @yield [result, err] Result & error if block supplied
1799
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object
1800
+ # @yieldparam err [StandardError] error object if request failed
1801
+ #
1802
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLink]
1803
+ #
1804
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1805
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1806
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1807
+ def get_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1808
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
1809
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1810
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
1811
+ command.params['accountId'] = account_id unless account_id.nil?
1812
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1813
+ command.params['profileId'] = profile_id unless profile_id.nil?
1814
+ command.params['linkId'] = link_id unless link_id.nil?
1815
+ command.query['fields'] = fields unless fields.nil?
1816
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1817
+ command.query['userIp'] = user_ip unless user_ip.nil?
1818
+ execute_or_queue_command(command, &block)
1819
+ end
1820
+
1821
+ # Create a new profile filter link.
1822
+ # @param [String] account_id
1823
+ # Account ID to create profile filter link for.
1824
+ # @param [String] web_property_id
1825
+ # Web property Id to create profile filter link for.
1826
+ # @param [String] profile_id
1827
+ # Profile ID to create filter link for.
1828
+ # @param [Google::Apis::AnalyticsV3::ProfileFilterLink] profile_filter_link_object
1829
+ # @param [String] fields
1830
+ # Selector specifying which fields to include in a partial response.
1831
+ # @param [String] quota_user
1832
+ # Available to use for quota purposes for server-side applications. Can be any
1833
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1834
+ # Overrides userIp if both are provided.
1835
+ # @param [String] user_ip
1836
+ # IP address of the site where the request originates. Use this if you want to
1837
+ # enforce per-user limits.
1838
+ # @param [Google::Apis::RequestOptions] options
1839
+ # Request-specific options
1840
+ #
1841
+ # @yield [result, err] Result & error if block supplied
1842
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object
1843
+ # @yieldparam err [StandardError] error object if request failed
1844
+ #
1845
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLink]
1846
+ #
1847
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1848
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1849
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1850
+ def insert_profile_filter_link(account_id, web_property_id, profile_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1851
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks', options)
1852
+ command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1853
+ command.request_object = profile_filter_link_object
1854
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1855
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
1856
+ command.params['accountId'] = account_id unless account_id.nil?
1857
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1858
+ command.params['profileId'] = profile_id unless profile_id.nil?
1859
+ command.query['fields'] = fields unless fields.nil?
1860
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1861
+ command.query['userIp'] = user_ip unless user_ip.nil?
1862
+ execute_or_queue_command(command, &block)
1863
+ end
1864
+
1865
+ # Lists all profile filter links for a profile.
1866
+ # @param [String] account_id
1867
+ # Account ID to retrieve profile filter links for.
1868
+ # @param [String] web_property_id
1869
+ # Web property Id for profile filter links for. Can either be a specific web
1870
+ # property ID or '~all', which refers to all the web properties that user has
1871
+ # access to.
1872
+ # @param [String] profile_id
1873
+ # Profile ID to retrieve filter links for. Can either be a specific profile ID
1874
+ # or '~all', which refers to all the profiles that user has access to.
1875
+ # @param [Fixnum] max_results
1876
+ # The maximum number of profile filter links to include in this response.
1877
+ # @param [Fixnum] start_index
1878
+ # An index of the first entity to retrieve. Use this parameter as a pagination
1879
+ # mechanism along with the max-results parameter.
1880
+ # @param [String] fields
1881
+ # Selector specifying which fields to include in a partial response.
1882
+ # @param [String] quota_user
1883
+ # Available to use for quota purposes for server-side applications. Can be any
1884
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1885
+ # Overrides userIp if both are provided.
1886
+ # @param [String] user_ip
1887
+ # IP address of the site where the request originates. Use this if you want to
1888
+ # enforce per-user limits.
1889
+ # @param [Google::Apis::RequestOptions] options
1890
+ # Request-specific options
1891
+ #
1892
+ # @yield [result, err] Result & error if block supplied
1893
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLinks] parsed result object
1894
+ # @yieldparam err [StandardError] error object if request failed
1895
+ #
1896
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLinks]
1897
+ #
1898
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1899
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1900
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1901
+ def list_profile_filter_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1902
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks', options)
1903
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLinks::Representation
1904
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLinks
1905
+ command.params['accountId'] = account_id unless account_id.nil?
1906
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1907
+ command.params['profileId'] = profile_id unless profile_id.nil?
1908
+ command.query['max-results'] = max_results unless max_results.nil?
1909
+ command.query['start-index'] = start_index unless start_index.nil?
1910
+ command.query['fields'] = fields unless fields.nil?
1911
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1912
+ command.query['userIp'] = user_ip unless user_ip.nil?
1913
+ execute_or_queue_command(command, &block)
1914
+ end
1915
+
1916
+ # Update an existing profile filter link. This method supports patch semantics.
1917
+ # @param [String] account_id
1918
+ # Account ID to which profile filter link belongs.
1919
+ # @param [String] web_property_id
1920
+ # Web property Id to which profile filter link belongs
1921
+ # @param [String] profile_id
1922
+ # Profile ID to which filter link belongs
1923
+ # @param [String] link_id
1924
+ # ID of the profile filter link to be updated.
1925
+ # @param [Google::Apis::AnalyticsV3::ProfileFilterLink] profile_filter_link_object
1926
+ # @param [String] fields
1927
+ # Selector specifying which fields to include in a partial response.
1928
+ # @param [String] quota_user
1929
+ # Available to use for quota purposes for server-side applications. Can be any
1930
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1931
+ # Overrides userIp if both are provided.
1932
+ # @param [String] user_ip
1933
+ # IP address of the site where the request originates. Use this if you want to
1934
+ # enforce per-user limits.
1935
+ # @param [Google::Apis::RequestOptions] options
1936
+ # Request-specific options
1937
+ #
1938
+ # @yield [result, err] Result & error if block supplied
1939
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object
1940
+ # @yieldparam err [StandardError] error object if request failed
1941
+ #
1942
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLink]
1943
+ #
1944
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1945
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1946
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1947
+ def patch_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1948
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
1949
+ command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1950
+ command.request_object = profile_filter_link_object
1951
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1952
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
1953
+ command.params['accountId'] = account_id unless account_id.nil?
1954
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1955
+ command.params['profileId'] = profile_id unless profile_id.nil?
1956
+ command.params['linkId'] = link_id unless link_id.nil?
1957
+ command.query['fields'] = fields unless fields.nil?
1958
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1959
+ command.query['userIp'] = user_ip unless user_ip.nil?
1960
+ execute_or_queue_command(command, &block)
1961
+ end
1962
+
1963
+ # Update an existing profile filter link.
1964
+ # @param [String] account_id
1965
+ # Account ID to which profile filter link belongs.
1966
+ # @param [String] web_property_id
1967
+ # Web property Id to which profile filter link belongs
1968
+ # @param [String] profile_id
1969
+ # Profile ID to which filter link belongs
1970
+ # @param [String] link_id
1971
+ # ID of the profile filter link to be updated.
1972
+ # @param [Google::Apis::AnalyticsV3::ProfileFilterLink] profile_filter_link_object
1973
+ # @param [String] fields
1974
+ # Selector specifying which fields to include in a partial response.
1975
+ # @param [String] quota_user
1976
+ # Available to use for quota purposes for server-side applications. Can be any
1977
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1978
+ # Overrides userIp if both are provided.
1979
+ # @param [String] user_ip
1980
+ # IP address of the site where the request originates. Use this if you want to
1981
+ # enforce per-user limits.
1982
+ # @param [Google::Apis::RequestOptions] options
1983
+ # Request-specific options
1984
+ #
1985
+ # @yield [result, err] Result & error if block supplied
1986
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object
1987
+ # @yieldparam err [StandardError] error object if request failed
1988
+ #
1989
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLink]
1990
+ #
1991
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1992
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1993
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1994
+ def update_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1995
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
1996
+ command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1997
+ command.request_object = profile_filter_link_object
1998
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1999
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
2000
+ command.params['accountId'] = account_id unless account_id.nil?
2001
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2002
+ command.params['profileId'] = profile_id unless profile_id.nil?
2003
+ command.params['linkId'] = link_id unless link_id.nil?
2004
+ command.query['fields'] = fields unless fields.nil?
2005
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2006
+ command.query['userIp'] = user_ip unless user_ip.nil?
2007
+ execute_or_queue_command(command, &block)
2008
+ end
2009
+
2010
+ # Removes a user from the given view (profile).
2011
+ # @param [String] account_id
2012
+ # Account ID to delete the user link for.
2013
+ # @param [String] web_property_id
2014
+ # Web Property ID to delete the user link for.
2015
+ # @param [String] profile_id
2016
+ # View (Profile) ID to delete the user link for.
2017
+ # @param [String] link_id
2018
+ # Link ID to delete the user link for.
2019
+ # @param [String] fields
2020
+ # Selector specifying which fields to include in a partial response.
2021
+ # @param [String] quota_user
2022
+ # Available to use for quota purposes for server-side applications. Can be any
2023
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2024
+ # Overrides userIp if both are provided.
2025
+ # @param [String] user_ip
2026
+ # IP address of the site where the request originates. Use this if you want to
2027
+ # enforce per-user limits.
2028
+ # @param [Google::Apis::RequestOptions] options
2029
+ # Request-specific options
2030
+ #
2031
+ # @yield [result, err] Result & error if block supplied
2032
+ # @yieldparam result [NilClass] No result returned for this method
2033
+ # @yieldparam err [StandardError] error object if request failed
2034
+ #
2035
+ # @return [void]
2036
+ #
2037
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2038
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2039
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2040
+ def delete_profile_user_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2041
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}', options)
2042
+ command.params['accountId'] = account_id unless account_id.nil?
2043
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2044
+ command.params['profileId'] = profile_id unless profile_id.nil?
2045
+ command.params['linkId'] = link_id unless link_id.nil?
2046
+ command.query['fields'] = fields unless fields.nil?
2047
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2048
+ command.query['userIp'] = user_ip unless user_ip.nil?
2049
+ execute_or_queue_command(command, &block)
2050
+ end
2051
+
2052
+ # Adds a new user to the given view (profile).
2053
+ # @param [String] account_id
2054
+ # Account ID to create the user link for.
2055
+ # @param [String] web_property_id
2056
+ # Web Property ID to create the user link for.
2057
+ # @param [String] profile_id
2058
+ # View (Profile) ID to create the user link for.
2059
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
2060
+ # @param [String] fields
2061
+ # Selector specifying which fields to include in a partial response.
2062
+ # @param [String] quota_user
2063
+ # Available to use for quota purposes for server-side applications. Can be any
2064
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2065
+ # Overrides userIp if both are provided.
2066
+ # @param [String] user_ip
2067
+ # IP address of the site where the request originates. Use this if you want to
2068
+ # enforce per-user limits.
2069
+ # @param [Google::Apis::RequestOptions] options
2070
+ # Request-specific options
2071
+ #
2072
+ # @yield [result, err] Result & error if block supplied
2073
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
2074
+ # @yieldparam err [StandardError] error object if request failed
2075
+ #
2076
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
2077
+ #
2078
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2079
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2080
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2081
+ def insert_profile_user_link(account_id, web_property_id, profile_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2082
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks', options)
2083
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
2084
+ command.request_object = entity_user_link_object
2085
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
2086
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
2087
+ command.params['accountId'] = account_id unless account_id.nil?
2088
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2089
+ command.params['profileId'] = profile_id unless profile_id.nil?
2090
+ command.query['fields'] = fields unless fields.nil?
2091
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2092
+ command.query['userIp'] = user_ip unless user_ip.nil?
2093
+ execute_or_queue_command(command, &block)
2094
+ end
2095
+
2096
+ # Lists profile-user links for a given view (profile).
2097
+ # @param [String] account_id
2098
+ # Account ID which the given view (profile) belongs to.
2099
+ # @param [String] web_property_id
2100
+ # Web Property ID which the given view (profile) belongs to. Can either be a
2101
+ # specific web property ID or '~all', which refers to all the web properties
2102
+ # that user has access to.
2103
+ # @param [String] profile_id
2104
+ # View (Profile) ID to retrieve the profile-user links for. Can either be a
2105
+ # specific profile ID or '~all', which refers to all the profiles that user has
2106
+ # access to.
2107
+ # @param [Fixnum] max_results
2108
+ # The maximum number of profile-user links to include in this response.
2109
+ # @param [Fixnum] start_index
2110
+ # An index of the first profile-user link to retrieve. Use this parameter as a
2111
+ # pagination mechanism along with the max-results parameter.
2112
+ # @param [String] fields
2113
+ # Selector specifying which fields to include in a partial response.
2114
+ # @param [String] quota_user
2115
+ # Available to use for quota purposes for server-side applications. Can be any
2116
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2117
+ # Overrides userIp if both are provided.
2118
+ # @param [String] user_ip
2119
+ # IP address of the site where the request originates. Use this if you want to
2120
+ # enforce per-user limits.
2121
+ # @param [Google::Apis::RequestOptions] options
2122
+ # Request-specific options
2123
+ #
2124
+ # @yield [result, err] Result & error if block supplied
2125
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLinks] parsed result object
2126
+ # @yieldparam err [StandardError] error object if request failed
2127
+ #
2128
+ # @return [Google::Apis::AnalyticsV3::EntityUserLinks]
2129
+ #
2130
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2131
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2132
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2133
+ def list_profile_user_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2134
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks', options)
2135
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
2136
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
2137
+ command.params['accountId'] = account_id unless account_id.nil?
2138
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2139
+ command.params['profileId'] = profile_id unless profile_id.nil?
2140
+ command.query['max-results'] = max_results unless max_results.nil?
2141
+ command.query['start-index'] = start_index unless start_index.nil?
2142
+ command.query['fields'] = fields unless fields.nil?
2143
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2144
+ command.query['userIp'] = user_ip unless user_ip.nil?
2145
+ execute_or_queue_command(command, &block)
2146
+ end
2147
+
2148
+ # Updates permissions for an existing user on the given view (profile).
2149
+ # @param [String] account_id
2150
+ # Account ID to update the user link for.
2151
+ # @param [String] web_property_id
2152
+ # Web Property ID to update the user link for.
2153
+ # @param [String] profile_id
2154
+ # View (Profile ID) to update the user link for.
2155
+ # @param [String] link_id
2156
+ # Link ID to update the user link for.
2157
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
2158
+ # @param [String] fields
2159
+ # Selector specifying which fields to include in a partial response.
2160
+ # @param [String] quota_user
2161
+ # Available to use for quota purposes for server-side applications. Can be any
2162
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2163
+ # Overrides userIp if both are provided.
2164
+ # @param [String] user_ip
2165
+ # IP address of the site where the request originates. Use this if you want to
2166
+ # enforce per-user limits.
2167
+ # @param [Google::Apis::RequestOptions] options
2168
+ # Request-specific options
2169
+ #
2170
+ # @yield [result, err] Result & error if block supplied
2171
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
2172
+ # @yieldparam err [StandardError] error object if request failed
2173
+ #
2174
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
2175
+ #
2176
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2177
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2178
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2179
+ def update_profile_user_link(account_id, web_property_id, profile_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2180
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}', options)
2181
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
2182
+ command.request_object = entity_user_link_object
2183
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
2184
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
2185
+ command.params['accountId'] = account_id unless account_id.nil?
2186
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2187
+ command.params['profileId'] = profile_id unless profile_id.nil?
2188
+ command.params['linkId'] = link_id unless link_id.nil?
2189
+ command.query['fields'] = fields unless fields.nil?
2190
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2191
+ command.query['userIp'] = user_ip unless user_ip.nil?
2192
+ execute_or_queue_command(command, &block)
2193
+ end
2194
+
2195
+ # Deletes a view (profile).
2196
+ # @param [String] account_id
2197
+ # Account ID to delete the view (profile) for.
2198
+ # @param [String] web_property_id
2199
+ # Web property ID to delete the view (profile) for.
2200
+ # @param [String] profile_id
2201
+ # ID of the view (profile) to be deleted.
2202
+ # @param [String] fields
2203
+ # Selector specifying which fields to include in a partial response.
2204
+ # @param [String] quota_user
2205
+ # Available to use for quota purposes for server-side applications. Can be any
2206
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2207
+ # Overrides userIp if both are provided.
2208
+ # @param [String] user_ip
2209
+ # IP address of the site where the request originates. Use this if you want to
2210
+ # enforce per-user limits.
2211
+ # @param [Google::Apis::RequestOptions] options
2212
+ # Request-specific options
2213
+ #
2214
+ # @yield [result, err] Result & error if block supplied
2215
+ # @yieldparam result [NilClass] No result returned for this method
2216
+ # @yieldparam err [StandardError] error object if request failed
2217
+ #
2218
+ # @return [void]
2219
+ #
2220
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2221
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2222
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2223
+ def delete_profile(account_id, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2224
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
2225
+ command.params['accountId'] = account_id unless account_id.nil?
2226
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2227
+ command.params['profileId'] = profile_id unless profile_id.nil?
2228
+ command.query['fields'] = fields unless fields.nil?
2229
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2230
+ command.query['userIp'] = user_ip unless user_ip.nil?
2231
+ execute_or_queue_command(command, &block)
2232
+ end
2233
+
2234
+ # Gets a view (profile) to which the user has access.
2235
+ # @param [String] account_id
2236
+ # Account ID to retrieve the goal for.
2237
+ # @param [String] web_property_id
2238
+ # Web property ID to retrieve the goal for.
2239
+ # @param [String] profile_id
2240
+ # View (Profile) ID to retrieve the goal for.
2241
+ # @param [String] fields
2242
+ # Selector specifying which fields to include in a partial response.
2243
+ # @param [String] quota_user
2244
+ # Available to use for quota purposes for server-side applications. Can be any
2245
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2246
+ # Overrides userIp if both are provided.
2247
+ # @param [String] user_ip
2248
+ # IP address of the site where the request originates. Use this if you want to
2249
+ # enforce per-user limits.
2250
+ # @param [Google::Apis::RequestOptions] options
2251
+ # Request-specific options
2252
+ #
2253
+ # @yield [result, err] Result & error if block supplied
2254
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object
2255
+ # @yieldparam err [StandardError] error object if request failed
2256
+ #
2257
+ # @return [Google::Apis::AnalyticsV3::Profile]
2258
+ #
2259
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2260
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2261
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2262
+ def get_profile(account_id, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2263
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
2264
+ command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
2265
+ command.response_class = Google::Apis::AnalyticsV3::Profile
2266
+ command.params['accountId'] = account_id unless account_id.nil?
2267
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2268
+ command.params['profileId'] = profile_id unless profile_id.nil?
2269
+ command.query['fields'] = fields unless fields.nil?
2270
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2271
+ command.query['userIp'] = user_ip unless user_ip.nil?
2272
+ execute_or_queue_command(command, &block)
2273
+ end
2274
+
2275
+ # Create a new view (profile).
2276
+ # @param [String] account_id
2277
+ # Account ID to create the view (profile) for.
2278
+ # @param [String] web_property_id
2279
+ # Web property ID to create the view (profile) for.
2280
+ # @param [Google::Apis::AnalyticsV3::Profile] profile_object
2281
+ # @param [String] fields
2282
+ # Selector specifying which fields to include in a partial response.
2283
+ # @param [String] quota_user
2284
+ # Available to use for quota purposes for server-side applications. Can be any
2285
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2286
+ # Overrides userIp if both are provided.
2287
+ # @param [String] user_ip
2288
+ # IP address of the site where the request originates. Use this if you want to
2289
+ # enforce per-user limits.
2290
+ # @param [Google::Apis::RequestOptions] options
2291
+ # Request-specific options
2292
+ #
2293
+ # @yield [result, err] Result & error if block supplied
2294
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object
2295
+ # @yieldparam err [StandardError] error object if request failed
2296
+ #
2297
+ # @return [Google::Apis::AnalyticsV3::Profile]
2298
+ #
2299
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2300
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2301
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2302
+ def insert_profile(account_id, web_property_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2303
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles', options)
2304
+ command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
2305
+ command.request_object = profile_object
2306
+ command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
2307
+ command.response_class = Google::Apis::AnalyticsV3::Profile
2308
+ command.params['accountId'] = account_id unless account_id.nil?
2309
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2310
+ command.query['fields'] = fields unless fields.nil?
2311
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2312
+ command.query['userIp'] = user_ip unless user_ip.nil?
2313
+ execute_or_queue_command(command, &block)
2314
+ end
2315
+
2316
+ # Lists views (profiles) to which the user has access.
2317
+ # @param [String] account_id
2318
+ # Account ID for the view (profiles) to retrieve. Can either be a specific
2319
+ # account ID or '~all', which refers to all the accounts to which the user has
2320
+ # access.
2321
+ # @param [String] web_property_id
2322
+ # Web property ID for the views (profiles) to retrieve. Can either be a specific
2323
+ # web property ID or '~all', which refers to all the web properties to which the
2324
+ # user has access.
2325
+ # @param [Fixnum] max_results
2326
+ # The maximum number of views (profiles) to include in this response.
2327
+ # @param [Fixnum] start_index
2328
+ # An index of the first entity to retrieve. Use this parameter as a pagination
2329
+ # mechanism along with the max-results parameter.
2330
+ # @param [String] fields
2331
+ # Selector specifying which fields to include in a partial response.
2332
+ # @param [String] quota_user
2333
+ # Available to use for quota purposes for server-side applications. Can be any
2334
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2335
+ # Overrides userIp if both are provided.
2336
+ # @param [String] user_ip
2337
+ # IP address of the site where the request originates. Use this if you want to
2338
+ # enforce per-user limits.
2339
+ # @param [Google::Apis::RequestOptions] options
2340
+ # Request-specific options
2341
+ #
2342
+ # @yield [result, err] Result & error if block supplied
2343
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profiles] parsed result object
2344
+ # @yieldparam err [StandardError] error object if request failed
2345
+ #
2346
+ # @return [Google::Apis::AnalyticsV3::Profiles]
2347
+ #
2348
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2349
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2350
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2351
+ def list_profiles(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2352
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles', options)
2353
+ command.response_representation = Google::Apis::AnalyticsV3::Profiles::Representation
2354
+ command.response_class = Google::Apis::AnalyticsV3::Profiles
2355
+ command.params['accountId'] = account_id unless account_id.nil?
2356
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2357
+ command.query['max-results'] = max_results unless max_results.nil?
2358
+ command.query['start-index'] = start_index unless start_index.nil?
2359
+ command.query['fields'] = fields unless fields.nil?
2360
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2361
+ command.query['userIp'] = user_ip unless user_ip.nil?
2362
+ execute_or_queue_command(command, &block)
2363
+ end
2364
+
2365
+ # Updates an existing view (profile). This method supports patch semantics.
2366
+ # @param [String] account_id
2367
+ # Account ID to which the view (profile) belongs
2368
+ # @param [String] web_property_id
2369
+ # Web property ID to which the view (profile) belongs
2370
+ # @param [String] profile_id
2371
+ # ID of the view (profile) to be updated.
2372
+ # @param [Google::Apis::AnalyticsV3::Profile] profile_object
2373
+ # @param [String] fields
2374
+ # Selector specifying which fields to include in a partial response.
2375
+ # @param [String] quota_user
2376
+ # Available to use for quota purposes for server-side applications. Can be any
2377
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2378
+ # Overrides userIp if both are provided.
2379
+ # @param [String] user_ip
2380
+ # IP address of the site where the request originates. Use this if you want to
2381
+ # enforce per-user limits.
2382
+ # @param [Google::Apis::RequestOptions] options
2383
+ # Request-specific options
2384
+ #
2385
+ # @yield [result, err] Result & error if block supplied
2386
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object
2387
+ # @yieldparam err [StandardError] error object if request failed
2388
+ #
2389
+ # @return [Google::Apis::AnalyticsV3::Profile]
2390
+ #
2391
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2392
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2393
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2394
+ def patch_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2395
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
2396
+ command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
2397
+ command.request_object = profile_object
2398
+ command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
2399
+ command.response_class = Google::Apis::AnalyticsV3::Profile
2400
+ command.params['accountId'] = account_id unless account_id.nil?
2401
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2402
+ command.params['profileId'] = profile_id unless profile_id.nil?
2403
+ command.query['fields'] = fields unless fields.nil?
2404
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2405
+ command.query['userIp'] = user_ip unless user_ip.nil?
2406
+ execute_or_queue_command(command, &block)
2407
+ end
2408
+
2409
+ # Updates an existing view (profile).
2410
+ # @param [String] account_id
2411
+ # Account ID to which the view (profile) belongs
2412
+ # @param [String] web_property_id
2413
+ # Web property ID to which the view (profile) belongs
2414
+ # @param [String] profile_id
2415
+ # ID of the view (profile) to be updated.
2416
+ # @param [Google::Apis::AnalyticsV3::Profile] profile_object
2417
+ # @param [String] fields
2418
+ # Selector specifying which fields to include in a partial response.
2419
+ # @param [String] quota_user
2420
+ # Available to use for quota purposes for server-side applications. Can be any
2421
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2422
+ # Overrides userIp if both are provided.
2423
+ # @param [String] user_ip
2424
+ # IP address of the site where the request originates. Use this if you want to
2425
+ # enforce per-user limits.
2426
+ # @param [Google::Apis::RequestOptions] options
2427
+ # Request-specific options
2428
+ #
2429
+ # @yield [result, err] Result & error if block supplied
2430
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object
2431
+ # @yieldparam err [StandardError] error object if request failed
2432
+ #
2433
+ # @return [Google::Apis::AnalyticsV3::Profile]
2434
+ #
2435
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2436
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2437
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2438
+ def update_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2439
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
2440
+ command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
2441
+ command.request_object = profile_object
2442
+ command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
2443
+ command.response_class = Google::Apis::AnalyticsV3::Profile
2444
+ command.params['accountId'] = account_id unless account_id.nil?
2445
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2446
+ command.params['profileId'] = profile_id unless profile_id.nil?
2447
+ command.query['fields'] = fields unless fields.nil?
2448
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2449
+ command.query['userIp'] = user_ip unless user_ip.nil?
2450
+ execute_or_queue_command(command, &block)
2451
+ end
2452
+
2453
+ # Lists segments to which the user has access.
2454
+ # @param [Fixnum] max_results
2455
+ # The maximum number of segments to include in this response.
2456
+ # @param [Fixnum] start_index
2457
+ # An index of the first segment to retrieve. Use this parameter as a pagination
2458
+ # mechanism along with the max-results parameter.
2459
+ # @param [String] fields
2460
+ # Selector specifying which fields to include in a partial response.
2461
+ # @param [String] quota_user
2462
+ # Available to use for quota purposes for server-side applications. Can be any
2463
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2464
+ # Overrides userIp if both are provided.
2465
+ # @param [String] user_ip
2466
+ # IP address of the site where the request originates. Use this if you want to
2467
+ # enforce per-user limits.
2468
+ # @param [Google::Apis::RequestOptions] options
2469
+ # Request-specific options
2470
+ #
2471
+ # @yield [result, err] Result & error if block supplied
2472
+ # @yieldparam result [Google::Apis::AnalyticsV3::Segments] parsed result object
2473
+ # @yieldparam err [StandardError] error object if request failed
2474
+ #
2475
+ # @return [Google::Apis::AnalyticsV3::Segments]
2476
+ #
2477
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2478
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2479
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2480
+ def list_segments(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2481
+ command = make_simple_command(:get, 'management/segments', options)
2482
+ command.response_representation = Google::Apis::AnalyticsV3::Segments::Representation
2483
+ command.response_class = Google::Apis::AnalyticsV3::Segments
2484
+ command.query['max-results'] = max_results unless max_results.nil?
2485
+ command.query['start-index'] = start_index unless start_index.nil?
2486
+ command.query['fields'] = fields unless fields.nil?
2487
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2488
+ command.query['userIp'] = user_ip unless user_ip.nil?
2489
+ execute_or_queue_command(command, &block)
2490
+ end
2491
+
2492
+ # Deletes an unsampled report.
2493
+ # @param [String] account_id
2494
+ # Account ID to delete the unsampled report for.
2495
+ # @param [String] web_property_id
2496
+ # Web property ID to delete the unsampled reports for.
2497
+ # @param [String] profile_id
2498
+ # View (Profile) ID to delete the unsampled report for.
2499
+ # @param [String] unsampled_report_id
2500
+ # ID of the unsampled report to be deleted.
2501
+ # @param [String] fields
2502
+ # Selector specifying which fields to include in a partial response.
2503
+ # @param [String] quota_user
2504
+ # Available to use for quota purposes for server-side applications. Can be any
2505
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2506
+ # Overrides userIp if both are provided.
2507
+ # @param [String] user_ip
2508
+ # IP address of the site where the request originates. Use this if you want to
2509
+ # enforce per-user limits.
2510
+ # @param [Google::Apis::RequestOptions] options
2511
+ # Request-specific options
2512
+ #
2513
+ # @yield [result, err] Result & error if block supplied
2514
+ # @yieldparam result [NilClass] No result returned for this method
2515
+ # @yieldparam err [StandardError] error object if request failed
2516
+ #
2517
+ # @return [void]
2518
+ #
2519
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2520
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2521
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2522
+ def delete_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2523
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}', options)
2524
+ command.params['accountId'] = account_id unless account_id.nil?
2525
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2526
+ command.params['profileId'] = profile_id unless profile_id.nil?
2527
+ command.params['unsampledReportId'] = unsampled_report_id unless unsampled_report_id.nil?
2528
+ command.query['fields'] = fields unless fields.nil?
2529
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2530
+ command.query['userIp'] = user_ip unless user_ip.nil?
2531
+ execute_or_queue_command(command, &block)
2532
+ end
2533
+
2534
+ # Returns a single unsampled report.
2535
+ # @param [String] account_id
2536
+ # Account ID to retrieve unsampled report for.
2537
+ # @param [String] web_property_id
2538
+ # Web property ID to retrieve unsampled reports for.
2539
+ # @param [String] profile_id
2540
+ # View (Profile) ID to retrieve unsampled report for.
2541
+ # @param [String] unsampled_report_id
2542
+ # ID of the unsampled report to retrieve.
2543
+ # @param [String] fields
2544
+ # Selector specifying which fields to include in a partial response.
2545
+ # @param [String] quota_user
2546
+ # Available to use for quota purposes for server-side applications. Can be any
2547
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2548
+ # Overrides userIp if both are provided.
2549
+ # @param [String] user_ip
2550
+ # IP address of the site where the request originates. Use this if you want to
2551
+ # enforce per-user limits.
2552
+ # @param [Google::Apis::RequestOptions] options
2553
+ # Request-specific options
2554
+ #
2555
+ # @yield [result, err] Result & error if block supplied
2556
+ # @yieldparam result [Google::Apis::AnalyticsV3::UnsampledReport] parsed result object
2557
+ # @yieldparam err [StandardError] error object if request failed
2558
+ #
2559
+ # @return [Google::Apis::AnalyticsV3::UnsampledReport]
2560
+ #
2561
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2562
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2563
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2564
+ def get_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2565
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}', options)
2566
+ command.response_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation
2567
+ command.response_class = Google::Apis::AnalyticsV3::UnsampledReport
2568
+ command.params['accountId'] = account_id unless account_id.nil?
2569
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2570
+ command.params['profileId'] = profile_id unless profile_id.nil?
2571
+ command.params['unsampledReportId'] = unsampled_report_id unless unsampled_report_id.nil?
2572
+ command.query['fields'] = fields unless fields.nil?
2573
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2574
+ command.query['userIp'] = user_ip unless user_ip.nil?
2575
+ execute_or_queue_command(command, &block)
2576
+ end
2577
+
2578
+ # Create a new unsampled report.
2579
+ # @param [String] account_id
2580
+ # Account ID to create the unsampled report for.
2581
+ # @param [String] web_property_id
2582
+ # Web property ID to create the unsampled report for.
2583
+ # @param [String] profile_id
2584
+ # View (Profile) ID to create the unsampled report for.
2585
+ # @param [Google::Apis::AnalyticsV3::UnsampledReport] unsampled_report_object
2586
+ # @param [String] fields
2587
+ # Selector specifying which fields to include in a partial response.
2588
+ # @param [String] quota_user
2589
+ # Available to use for quota purposes for server-side applications. Can be any
2590
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2591
+ # Overrides userIp if both are provided.
2592
+ # @param [String] user_ip
2593
+ # IP address of the site where the request originates. Use this if you want to
2594
+ # enforce per-user limits.
2595
+ # @param [Google::Apis::RequestOptions] options
2596
+ # Request-specific options
2597
+ #
2598
+ # @yield [result, err] Result & error if block supplied
2599
+ # @yieldparam result [Google::Apis::AnalyticsV3::UnsampledReport] parsed result object
2600
+ # @yieldparam err [StandardError] error object if request failed
2601
+ #
2602
+ # @return [Google::Apis::AnalyticsV3::UnsampledReport]
2603
+ #
2604
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2605
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2606
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2607
+ def insert_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2608
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports', options)
2609
+ command.request_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation
2610
+ command.request_object = unsampled_report_object
2611
+ command.response_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation
2612
+ command.response_class = Google::Apis::AnalyticsV3::UnsampledReport
2613
+ command.params['accountId'] = account_id unless account_id.nil?
2614
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2615
+ command.params['profileId'] = profile_id unless profile_id.nil?
2616
+ command.query['fields'] = fields unless fields.nil?
2617
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2618
+ command.query['userIp'] = user_ip unless user_ip.nil?
2619
+ execute_or_queue_command(command, &block)
2620
+ end
2621
+
2622
+ # Lists unsampled reports to which the user has access.
2623
+ # @param [String] account_id
2624
+ # Account ID to retrieve unsampled reports for. Must be a specific account ID, ~
2625
+ # all is not supported.
2626
+ # @param [String] web_property_id
2627
+ # Web property ID to retrieve unsampled reports for. Must be a specific web
2628
+ # property ID, ~all is not supported.
2629
+ # @param [String] profile_id
2630
+ # View (Profile) ID to retrieve unsampled reports for. Must be a specific view (
2631
+ # profile) ID, ~all is not supported.
2632
+ # @param [Fixnum] max_results
2633
+ # The maximum number of unsampled reports to include in this response.
2634
+ # @param [Fixnum] start_index
2635
+ # An index of the first unsampled report to retrieve. Use this parameter as a
2636
+ # pagination mechanism along with the max-results parameter.
2637
+ # @param [String] fields
2638
+ # Selector specifying which fields to include in a partial response.
2639
+ # @param [String] quota_user
2640
+ # Available to use for quota purposes for server-side applications. Can be any
2641
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2642
+ # Overrides userIp if both are provided.
2643
+ # @param [String] user_ip
2644
+ # IP address of the site where the request originates. Use this if you want to
2645
+ # enforce per-user limits.
2646
+ # @param [Google::Apis::RequestOptions] options
2647
+ # Request-specific options
2648
+ #
2649
+ # @yield [result, err] Result & error if block supplied
2650
+ # @yieldparam result [Google::Apis::AnalyticsV3::UnsampledReports] parsed result object
2651
+ # @yieldparam err [StandardError] error object if request failed
2652
+ #
2653
+ # @return [Google::Apis::AnalyticsV3::UnsampledReports]
2654
+ #
2655
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2656
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2657
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2658
+ def list_unsampled_reports(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2659
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports', options)
2660
+ command.response_representation = Google::Apis::AnalyticsV3::UnsampledReports::Representation
2661
+ command.response_class = Google::Apis::AnalyticsV3::UnsampledReports
2662
+ command.params['accountId'] = account_id unless account_id.nil?
2663
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2664
+ command.params['profileId'] = profile_id unless profile_id.nil?
2665
+ command.query['max-results'] = max_results unless max_results.nil?
2666
+ command.query['start-index'] = start_index unless start_index.nil?
2667
+ command.query['fields'] = fields unless fields.nil?
2668
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2669
+ command.query['userIp'] = user_ip unless user_ip.nil?
2670
+ execute_or_queue_command(command, &block)
2671
+ end
2672
+
2673
+ # Delete data associated with a previous upload.
2674
+ # @param [String] account_id
2675
+ # Account Id for the uploads to be deleted.
2676
+ # @param [String] web_property_id
2677
+ # Web property Id for the uploads to be deleted.
2678
+ # @param [String] custom_data_source_id
2679
+ # Custom data source Id for the uploads to be deleted.
2680
+ # @param [Google::Apis::AnalyticsV3::DeleteUploadDataRequest] delete_upload_data_request_object
2681
+ # @param [String] fields
2682
+ # Selector specifying which fields to include in a partial response.
2683
+ # @param [String] quota_user
2684
+ # Available to use for quota purposes for server-side applications. Can be any
2685
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2686
+ # Overrides userIp if both are provided.
2687
+ # @param [String] user_ip
2688
+ # IP address of the site where the request originates. Use this if you want to
2689
+ # enforce per-user limits.
2690
+ # @param [Google::Apis::RequestOptions] options
2691
+ # Request-specific options
2692
+ #
2693
+ # @yield [result, err] Result & error if block supplied
2694
+ # @yieldparam result [NilClass] No result returned for this method
2695
+ # @yieldparam err [StandardError] error object if request failed
2696
+ #
2697
+ # @return [void]
2698
+ #
2699
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2700
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2701
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2702
+ def delete_upload_data(account_id, web_property_id, custom_data_source_id, delete_upload_data_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2703
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData', options)
2704
+ command.request_representation = Google::Apis::AnalyticsV3::DeleteUploadDataRequest::Representation
2705
+ command.request_object = delete_upload_data_request_object
2706
+ command.params['accountId'] = account_id unless account_id.nil?
2707
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2708
+ command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
2709
+ command.query['fields'] = fields unless fields.nil?
2710
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2711
+ command.query['userIp'] = user_ip unless user_ip.nil?
2712
+ execute_or_queue_command(command, &block)
2713
+ end
2714
+
2715
+ # List uploads to which the user has access.
2716
+ # @param [String] account_id
2717
+ # Account Id for the upload to retrieve.
2718
+ # @param [String] web_property_id
2719
+ # Web property Id for the upload to retrieve.
2720
+ # @param [String] custom_data_source_id
2721
+ # Custom data source Id for upload to retrieve.
2722
+ # @param [String] upload_id
2723
+ # Upload Id to retrieve.
2724
+ # @param [String] fields
2725
+ # Selector specifying which fields to include in a partial response.
2726
+ # @param [String] quota_user
2727
+ # Available to use for quota purposes for server-side applications. Can be any
2728
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2729
+ # Overrides userIp if both are provided.
2730
+ # @param [String] user_ip
2731
+ # IP address of the site where the request originates. Use this if you want to
2732
+ # enforce per-user limits.
2733
+ # @param [Google::Apis::RequestOptions] options
2734
+ # Request-specific options
2735
+ #
2736
+ # @yield [result, err] Result & error if block supplied
2737
+ # @yieldparam result [Google::Apis::AnalyticsV3::Upload] parsed result object
2738
+ # @yieldparam err [StandardError] error object if request failed
2739
+ #
2740
+ # @return [Google::Apis::AnalyticsV3::Upload]
2741
+ #
2742
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2743
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2744
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2745
+ def get_upload(account_id, web_property_id, custom_data_source_id, upload_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2746
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}', options)
2747
+ command.response_representation = Google::Apis::AnalyticsV3::Upload::Representation
2748
+ command.response_class = Google::Apis::AnalyticsV3::Upload
2749
+ command.params['accountId'] = account_id unless account_id.nil?
2750
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2751
+ command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
2752
+ command.params['uploadId'] = upload_id unless upload_id.nil?
2753
+ command.query['fields'] = fields unless fields.nil?
2754
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2755
+ command.query['userIp'] = user_ip unless user_ip.nil?
2756
+ execute_or_queue_command(command, &block)
2757
+ end
2758
+
2759
+ # List uploads to which the user has access.
2760
+ # @param [String] account_id
2761
+ # Account Id for the uploads to retrieve.
2762
+ # @param [String] web_property_id
2763
+ # Web property Id for the uploads to retrieve.
2764
+ # @param [String] custom_data_source_id
2765
+ # Custom data source Id for uploads to retrieve.
2766
+ # @param [Fixnum] max_results
2767
+ # The maximum number of uploads to include in this response.
2768
+ # @param [Fixnum] start_index
2769
+ # A 1-based index of the first upload to retrieve. Use this parameter as a
2770
+ # pagination mechanism along with the max-results parameter.
2771
+ # @param [String] fields
2772
+ # Selector specifying which fields to include in a partial response.
2773
+ # @param [String] quota_user
2774
+ # Available to use for quota purposes for server-side applications. Can be any
2775
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2776
+ # Overrides userIp if both are provided.
2777
+ # @param [String] user_ip
2778
+ # IP address of the site where the request originates. Use this if you want to
2779
+ # enforce per-user limits.
2780
+ # @param [Google::Apis::RequestOptions] options
2781
+ # Request-specific options
2782
+ #
2783
+ # @yield [result, err] Result & error if block supplied
2784
+ # @yieldparam result [Google::Apis::AnalyticsV3::Uploads] parsed result object
2785
+ # @yieldparam err [StandardError] error object if request failed
2786
+ #
2787
+ # @return [Google::Apis::AnalyticsV3::Uploads]
2788
+ #
2789
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2790
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2791
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2792
+ def list_uploads(account_id, web_property_id, custom_data_source_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2793
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options)
2794
+ command.response_representation = Google::Apis::AnalyticsV3::Uploads::Representation
2795
+ command.response_class = Google::Apis::AnalyticsV3::Uploads
2796
+ command.params['accountId'] = account_id unless account_id.nil?
2797
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2798
+ command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
2799
+ command.query['max-results'] = max_results unless max_results.nil?
2800
+ command.query['start-index'] = start_index unless start_index.nil?
2801
+ command.query['fields'] = fields unless fields.nil?
2802
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2803
+ command.query['userIp'] = user_ip unless user_ip.nil?
2804
+ execute_or_queue_command(command, &block)
2805
+ end
2806
+
2807
+ # Upload data for a custom data source.
2808
+ # @param [String] account_id
2809
+ # Account Id associated with the upload.
2810
+ # @param [String] web_property_id
2811
+ # Web property UA-string associated with the upload.
2812
+ # @param [String] custom_data_source_id
2813
+ # Custom data source Id to which the data being uploaded belongs.
2814
+ # @param [String] fields
2815
+ # Selector specifying which fields to include in a partial response.
2816
+ # @param [String] quota_user
2817
+ # Available to use for quota purposes for server-side applications. Can be any
2818
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2819
+ # Overrides userIp if both are provided.
2820
+ # @param [String] user_ip
2821
+ # IP address of the site where the request originates. Use this if you want to
2822
+ # enforce per-user limits.
2823
+ # @param [IO, String] upload_source
2824
+ # IO stream or filename containing content to upload
2825
+ # @param [String] content_type
2826
+ # Content type of the uploaded content.
2827
+ # @param [Google::Apis::RequestOptions] options
2828
+ # Request-specific options
2829
+ #
2830
+ # @yield [result, err] Result & error if block supplied
2831
+ # @yieldparam result [Google::Apis::AnalyticsV3::Upload] parsed result object
2832
+ # @yieldparam err [StandardError] error object if request failed
2833
+ #
2834
+ # @return [Google::Apis::AnalyticsV3::Upload]
2835
+ #
2836
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2837
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2838
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2839
+ def upload_data(account_id, web_property_id, custom_data_source_id, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
2840
+ if upload_source.nil?
2841
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options)
2842
+ else
2843
+ command = make_upload_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options)
2844
+ command.upload_source = upload_source
2845
+ command.upload_content_type = content_type
2846
+ end
2847
+ command.response_representation = Google::Apis::AnalyticsV3::Upload::Representation
2848
+ command.response_class = Google::Apis::AnalyticsV3::Upload
2849
+ command.params['accountId'] = account_id unless account_id.nil?
2850
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2851
+ command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
2852
+ command.query['fields'] = fields unless fields.nil?
2853
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2854
+ command.query['userIp'] = user_ip unless user_ip.nil?
2855
+ execute_or_queue_command(command, &block)
2856
+ end
2857
+
2858
+ # Deletes a web property-AdWords link.
2859
+ # @param [String] account_id
2860
+ # ID of the account which the given web property belongs to.
2861
+ # @param [String] web_property_id
2862
+ # Web property ID to delete the AdWords link for.
2863
+ # @param [String] web_property_ad_words_link_id
2864
+ # Web property AdWords link ID.
2865
+ # @param [String] fields
2866
+ # Selector specifying which fields to include in a partial response.
2867
+ # @param [String] quota_user
2868
+ # Available to use for quota purposes for server-side applications. Can be any
2869
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2870
+ # Overrides userIp if both are provided.
2871
+ # @param [String] user_ip
2872
+ # IP address of the site where the request originates. Use this if you want to
2873
+ # enforce per-user limits.
2874
+ # @param [Google::Apis::RequestOptions] options
2875
+ # Request-specific options
2876
+ #
2877
+ # @yield [result, err] Result & error if block supplied
2878
+ # @yieldparam result [NilClass] No result returned for this method
2879
+ # @yieldparam err [StandardError] error object if request failed
2880
+ #
2881
+ # @return [void]
2882
+ #
2883
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2884
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2885
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2886
+ def delete_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2887
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
2888
+ command.params['accountId'] = account_id unless account_id.nil?
2889
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2890
+ command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
2891
+ command.query['fields'] = fields unless fields.nil?
2892
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2893
+ command.query['userIp'] = user_ip unless user_ip.nil?
2894
+ execute_or_queue_command(command, &block)
2895
+ end
2896
+
2897
+ # Returns a web property-AdWords link to which the user has access.
2898
+ # @param [String] account_id
2899
+ # ID of the account which the given web property belongs to.
2900
+ # @param [String] web_property_id
2901
+ # Web property ID to retrieve the AdWords link for.
2902
+ # @param [String] web_property_ad_words_link_id
2903
+ # Web property-AdWords link ID.
2904
+ # @param [String] fields
2905
+ # Selector specifying which fields to include in a partial response.
2906
+ # @param [String] quota_user
2907
+ # Available to use for quota purposes for server-side applications. Can be any
2908
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2909
+ # Overrides userIp if both are provided.
2910
+ # @param [String] user_ip
2911
+ # IP address of the site where the request originates. Use this if you want to
2912
+ # enforce per-user limits.
2913
+ # @param [Google::Apis::RequestOptions] options
2914
+ # Request-specific options
2915
+ #
2916
+ # @yield [result, err] Result & error if block supplied
2917
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object
2918
+ # @yieldparam err [StandardError] error object if request failed
2919
+ #
2920
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink]
2921
+ #
2922
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2923
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2924
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2925
+ def get_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2926
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
2927
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
2928
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
2929
+ command.params['accountId'] = account_id unless account_id.nil?
2930
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2931
+ command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
2932
+ command.query['fields'] = fields unless fields.nil?
2933
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2934
+ command.query['userIp'] = user_ip unless user_ip.nil?
2935
+ execute_or_queue_command(command, &block)
2936
+ end
2937
+
2938
+ # Creates a webProperty-AdWords link.
2939
+ # @param [String] account_id
2940
+ # ID of the Google Analytics account to create the link for.
2941
+ # @param [String] web_property_id
2942
+ # Web property ID to create the link for.
2943
+ # @param [Google::Apis::AnalyticsV3::EntityAdWordsLink] entity_ad_words_link_object
2944
+ # @param [String] fields
2945
+ # Selector specifying which fields to include in a partial response.
2946
+ # @param [String] quota_user
2947
+ # Available to use for quota purposes for server-side applications. Can be any
2948
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2949
+ # Overrides userIp if both are provided.
2950
+ # @param [String] user_ip
2951
+ # IP address of the site where the request originates. Use this if you want to
2952
+ # enforce per-user limits.
2953
+ # @param [Google::Apis::RequestOptions] options
2954
+ # Request-specific options
2955
+ #
2956
+ # @yield [result, err] Result & error if block supplied
2957
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object
2958
+ # @yieldparam err [StandardError] error object if request failed
2959
+ #
2960
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink]
2961
+ #
2962
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2963
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2964
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2965
+ def insert_web_property_ad_words_link(account_id, web_property_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2966
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks', options)
2967
+ command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
2968
+ command.request_object = entity_ad_words_link_object
2969
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
2970
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
2971
+ command.params['accountId'] = account_id unless account_id.nil?
2972
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2973
+ command.query['fields'] = fields unless fields.nil?
2974
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2975
+ command.query['userIp'] = user_ip unless user_ip.nil?
2976
+ execute_or_queue_command(command, &block)
2977
+ end
2978
+
2979
+ # Lists webProperty-AdWords links for a given web property.
2980
+ # @param [String] account_id
2981
+ # ID of the account which the given web property belongs to.
2982
+ # @param [String] web_property_id
2983
+ # Web property ID to retrieve the AdWords links for.
2984
+ # @param [Fixnum] max_results
2985
+ # The maximum number of webProperty-AdWords links to include in this response.
2986
+ # @param [Fixnum] start_index
2987
+ # An index of the first webProperty-AdWords link to retrieve. Use this parameter
2988
+ # as a pagination mechanism along with the max-results parameter.
2989
+ # @param [String] fields
2990
+ # Selector specifying which fields to include in a partial response.
2991
+ # @param [String] quota_user
2992
+ # Available to use for quota purposes for server-side applications. Can be any
2993
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2994
+ # Overrides userIp if both are provided.
2995
+ # @param [String] user_ip
2996
+ # IP address of the site where the request originates. Use this if you want to
2997
+ # enforce per-user limits.
2998
+ # @param [Google::Apis::RequestOptions] options
2999
+ # Request-specific options
3000
+ #
3001
+ # @yield [result, err] Result & error if block supplied
3002
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLinks] parsed result object
3003
+ # @yieldparam err [StandardError] error object if request failed
3004
+ #
3005
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLinks]
3006
+ #
3007
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3008
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3009
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3010
+ def list_web_property_ad_words_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3011
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks', options)
3012
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLinks::Representation
3013
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLinks
3014
+ command.params['accountId'] = account_id unless account_id.nil?
3015
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3016
+ command.query['max-results'] = max_results unless max_results.nil?
3017
+ command.query['start-index'] = start_index unless start_index.nil?
3018
+ command.query['fields'] = fields unless fields.nil?
3019
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3020
+ command.query['userIp'] = user_ip unless user_ip.nil?
3021
+ execute_or_queue_command(command, &block)
3022
+ end
3023
+
3024
+ # Updates an existing webProperty-AdWords link. This method supports patch
3025
+ # semantics.
3026
+ # @param [String] account_id
3027
+ # ID of the account which the given web property belongs to.
3028
+ # @param [String] web_property_id
3029
+ # Web property ID to retrieve the AdWords link for.
3030
+ # @param [String] web_property_ad_words_link_id
3031
+ # Web property-AdWords link ID.
3032
+ # @param [Google::Apis::AnalyticsV3::EntityAdWordsLink] entity_ad_words_link_object
3033
+ # @param [String] fields
3034
+ # Selector specifying which fields to include in a partial response.
3035
+ # @param [String] quota_user
3036
+ # Available to use for quota purposes for server-side applications. Can be any
3037
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3038
+ # Overrides userIp if both are provided.
3039
+ # @param [String] user_ip
3040
+ # IP address of the site where the request originates. Use this if you want to
3041
+ # enforce per-user limits.
3042
+ # @param [Google::Apis::RequestOptions] options
3043
+ # Request-specific options
3044
+ #
3045
+ # @yield [result, err] Result & error if block supplied
3046
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object
3047
+ # @yieldparam err [StandardError] error object if request failed
3048
+ #
3049
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink]
3050
+ #
3051
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3052
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3053
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3054
+ def patch_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3055
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
3056
+ command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3057
+ command.request_object = entity_ad_words_link_object
3058
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3059
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
3060
+ command.params['accountId'] = account_id unless account_id.nil?
3061
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3062
+ command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
3063
+ command.query['fields'] = fields unless fields.nil?
3064
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3065
+ command.query['userIp'] = user_ip unless user_ip.nil?
3066
+ execute_or_queue_command(command, &block)
3067
+ end
3068
+
3069
+ # Updates an existing webProperty-AdWords link.
3070
+ # @param [String] account_id
3071
+ # ID of the account which the given web property belongs to.
3072
+ # @param [String] web_property_id
3073
+ # Web property ID to retrieve the AdWords link for.
3074
+ # @param [String] web_property_ad_words_link_id
3075
+ # Web property-AdWords link ID.
3076
+ # @param [Google::Apis::AnalyticsV3::EntityAdWordsLink] entity_ad_words_link_object
3077
+ # @param [String] fields
3078
+ # Selector specifying which fields to include in a partial response.
3079
+ # @param [String] quota_user
3080
+ # Available to use for quota purposes for server-side applications. Can be any
3081
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3082
+ # Overrides userIp if both are provided.
3083
+ # @param [String] user_ip
3084
+ # IP address of the site where the request originates. Use this if you want to
3085
+ # enforce per-user limits.
3086
+ # @param [Google::Apis::RequestOptions] options
3087
+ # Request-specific options
3088
+ #
3089
+ # @yield [result, err] Result & error if block supplied
3090
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object
3091
+ # @yieldparam err [StandardError] error object if request failed
3092
+ #
3093
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink]
3094
+ #
3095
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3096
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3097
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3098
+ def update_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3099
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
3100
+ command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3101
+ command.request_object = entity_ad_words_link_object
3102
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3103
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
3104
+ command.params['accountId'] = account_id unless account_id.nil?
3105
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3106
+ command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
3107
+ command.query['fields'] = fields unless fields.nil?
3108
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3109
+ command.query['userIp'] = user_ip unless user_ip.nil?
3110
+ execute_or_queue_command(command, &block)
3111
+ end
3112
+
3113
+ # Gets a web property to which the user has access.
3114
+ # @param [String] account_id
3115
+ # Account ID to retrieve the web property for.
3116
+ # @param [String] web_property_id
3117
+ # ID to retrieve the web property for.
3118
+ # @param [String] fields
3119
+ # Selector specifying which fields to include in a partial response.
3120
+ # @param [String] quota_user
3121
+ # Available to use for quota purposes for server-side applications. Can be any
3122
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3123
+ # Overrides userIp if both are provided.
3124
+ # @param [String] user_ip
3125
+ # IP address of the site where the request originates. Use this if you want to
3126
+ # enforce per-user limits.
3127
+ # @param [Google::Apis::RequestOptions] options
3128
+ # Request-specific options
3129
+ #
3130
+ # @yield [result, err] Result & error if block supplied
3131
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object
3132
+ # @yieldparam err [StandardError] error object if request failed
3133
+ #
3134
+ # @return [Google::Apis::AnalyticsV3::Webproperty]
3135
+ #
3136
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3137
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3138
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3139
+ def get_web_property(account_id, web_property_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3140
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
3141
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3142
+ command.response_class = Google::Apis::AnalyticsV3::Webproperty
3143
+ command.params['accountId'] = account_id unless account_id.nil?
3144
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3145
+ command.query['fields'] = fields unless fields.nil?
3146
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3147
+ command.query['userIp'] = user_ip unless user_ip.nil?
3148
+ execute_or_queue_command(command, &block)
3149
+ end
3150
+
3151
+ # Create a new property if the account has fewer than 20 properties. Web
3152
+ # properties are visible in the Google Analytics interface only if they have at
3153
+ # least one profile.
3154
+ # @param [String] account_id
3155
+ # Account ID to create the web property for.
3156
+ # @param [Google::Apis::AnalyticsV3::Webproperty] webproperty_object
3157
+ # @param [String] fields
3158
+ # Selector specifying which fields to include in a partial response.
3159
+ # @param [String] quota_user
3160
+ # Available to use for quota purposes for server-side applications. Can be any
3161
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3162
+ # Overrides userIp if both are provided.
3163
+ # @param [String] user_ip
3164
+ # IP address of the site where the request originates. Use this if you want to
3165
+ # enforce per-user limits.
3166
+ # @param [Google::Apis::RequestOptions] options
3167
+ # Request-specific options
3168
+ #
3169
+ # @yield [result, err] Result & error if block supplied
3170
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object
3171
+ # @yieldparam err [StandardError] error object if request failed
3172
+ #
3173
+ # @return [Google::Apis::AnalyticsV3::Webproperty]
3174
+ #
3175
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3176
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3177
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3178
+ def insert_web_property(account_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3179
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties', options)
3180
+ command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3181
+ command.request_object = webproperty_object
3182
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3183
+ command.response_class = Google::Apis::AnalyticsV3::Webproperty
3184
+ command.params['accountId'] = account_id unless account_id.nil?
3185
+ command.query['fields'] = fields unless fields.nil?
3186
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3187
+ command.query['userIp'] = user_ip unless user_ip.nil?
3188
+ execute_or_queue_command(command, &block)
3189
+ end
3190
+
3191
+ # Lists web properties to which the user has access.
3192
+ # @param [String] account_id
3193
+ # Account ID to retrieve web properties for. Can either be a specific account ID
3194
+ # or '~all', which refers to all the accounts that user has access to.
3195
+ # @param [Fixnum] max_results
3196
+ # The maximum number of web properties to include in this response.
3197
+ # @param [Fixnum] start_index
3198
+ # An index of the first entity to retrieve. Use this parameter as a pagination
3199
+ # mechanism along with the max-results parameter.
3200
+ # @param [String] fields
3201
+ # Selector specifying which fields to include in a partial response.
3202
+ # @param [String] quota_user
3203
+ # Available to use for quota purposes for server-side applications. Can be any
3204
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3205
+ # Overrides userIp if both are provided.
3206
+ # @param [String] user_ip
3207
+ # IP address of the site where the request originates. Use this if you want to
3208
+ # enforce per-user limits.
3209
+ # @param [Google::Apis::RequestOptions] options
3210
+ # Request-specific options
3211
+ #
3212
+ # @yield [result, err] Result & error if block supplied
3213
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperties] parsed result object
3214
+ # @yieldparam err [StandardError] error object if request failed
3215
+ #
3216
+ # @return [Google::Apis::AnalyticsV3::Webproperties]
3217
+ #
3218
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3219
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3220
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3221
+ def list_web_properties(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3222
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties', options)
3223
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperties::Representation
3224
+ command.response_class = Google::Apis::AnalyticsV3::Webproperties
3225
+ command.params['accountId'] = account_id unless account_id.nil?
3226
+ command.query['max-results'] = max_results unless max_results.nil?
3227
+ command.query['start-index'] = start_index unless start_index.nil?
3228
+ command.query['fields'] = fields unless fields.nil?
3229
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3230
+ command.query['userIp'] = user_ip unless user_ip.nil?
3231
+ execute_or_queue_command(command, &block)
3232
+ end
3233
+
3234
+ # Updates an existing web property. This method supports patch semantics.
3235
+ # @param [String] account_id
3236
+ # Account ID to which the web property belongs
3237
+ # @param [String] web_property_id
3238
+ # Web property ID
3239
+ # @param [Google::Apis::AnalyticsV3::Webproperty] webproperty_object
3240
+ # @param [String] fields
3241
+ # Selector specifying which fields to include in a partial response.
3242
+ # @param [String] quota_user
3243
+ # Available to use for quota purposes for server-side applications. Can be any
3244
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3245
+ # Overrides userIp if both are provided.
3246
+ # @param [String] user_ip
3247
+ # IP address of the site where the request originates. Use this if you want to
3248
+ # enforce per-user limits.
3249
+ # @param [Google::Apis::RequestOptions] options
3250
+ # Request-specific options
3251
+ #
3252
+ # @yield [result, err] Result & error if block supplied
3253
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object
3254
+ # @yieldparam err [StandardError] error object if request failed
3255
+ #
3256
+ # @return [Google::Apis::AnalyticsV3::Webproperty]
3257
+ #
3258
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3259
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3260
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3261
+ def patch_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3262
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
3263
+ command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3264
+ command.request_object = webproperty_object
3265
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3266
+ command.response_class = Google::Apis::AnalyticsV3::Webproperty
3267
+ command.params['accountId'] = account_id unless account_id.nil?
3268
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3269
+ command.query['fields'] = fields unless fields.nil?
3270
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3271
+ command.query['userIp'] = user_ip unless user_ip.nil?
3272
+ execute_or_queue_command(command, &block)
3273
+ end
3274
+
3275
+ # Updates an existing web property.
3276
+ # @param [String] account_id
3277
+ # Account ID to which the web property belongs
3278
+ # @param [String] web_property_id
3279
+ # Web property ID
3280
+ # @param [Google::Apis::AnalyticsV3::Webproperty] webproperty_object
3281
+ # @param [String] fields
3282
+ # Selector specifying which fields to include in a partial response.
3283
+ # @param [String] quota_user
3284
+ # Available to use for quota purposes for server-side applications. Can be any
3285
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3286
+ # Overrides userIp if both are provided.
3287
+ # @param [String] user_ip
3288
+ # IP address of the site where the request originates. Use this if you want to
3289
+ # enforce per-user limits.
3290
+ # @param [Google::Apis::RequestOptions] options
3291
+ # Request-specific options
3292
+ #
3293
+ # @yield [result, err] Result & error if block supplied
3294
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object
3295
+ # @yieldparam err [StandardError] error object if request failed
3296
+ #
3297
+ # @return [Google::Apis::AnalyticsV3::Webproperty]
3298
+ #
3299
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3300
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3301
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3302
+ def update_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3303
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
3304
+ command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3305
+ command.request_object = webproperty_object
3306
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3307
+ command.response_class = Google::Apis::AnalyticsV3::Webproperty
3308
+ command.params['accountId'] = account_id unless account_id.nil?
3309
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3310
+ command.query['fields'] = fields unless fields.nil?
3311
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3312
+ command.query['userIp'] = user_ip unless user_ip.nil?
3313
+ execute_or_queue_command(command, &block)
3314
+ end
3315
+
3316
+ # Removes a user from the given web property.
3317
+ # @param [String] account_id
3318
+ # Account ID to delete the user link for.
3319
+ # @param [String] web_property_id
3320
+ # Web Property ID to delete the user link for.
3321
+ # @param [String] link_id
3322
+ # Link ID to delete the user link for.
3323
+ # @param [String] fields
3324
+ # Selector specifying which fields to include in a partial response.
3325
+ # @param [String] quota_user
3326
+ # Available to use for quota purposes for server-side applications. Can be any
3327
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3328
+ # Overrides userIp if both are provided.
3329
+ # @param [String] user_ip
3330
+ # IP address of the site where the request originates. Use this if you want to
3331
+ # enforce per-user limits.
3332
+ # @param [Google::Apis::RequestOptions] options
3333
+ # Request-specific options
3334
+ #
3335
+ # @yield [result, err] Result & error if block supplied
3336
+ # @yieldparam result [NilClass] No result returned for this method
3337
+ # @yieldparam err [StandardError] error object if request failed
3338
+ #
3339
+ # @return [void]
3340
+ #
3341
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3342
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3343
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3344
+ def delete_web_property_user_link(account_id, web_property_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3345
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}', options)
3346
+ command.params['accountId'] = account_id unless account_id.nil?
3347
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3348
+ command.params['linkId'] = link_id unless link_id.nil?
3349
+ command.query['fields'] = fields unless fields.nil?
3350
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3351
+ command.query['userIp'] = user_ip unless user_ip.nil?
3352
+ execute_or_queue_command(command, &block)
3353
+ end
3354
+
3355
+ # Adds a new user to the given web property.
3356
+ # @param [String] account_id
3357
+ # Account ID to create the user link for.
3358
+ # @param [String] web_property_id
3359
+ # Web Property ID to create the user link for.
3360
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
3361
+ # @param [String] fields
3362
+ # Selector specifying which fields to include in a partial response.
3363
+ # @param [String] quota_user
3364
+ # Available to use for quota purposes for server-side applications. Can be any
3365
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3366
+ # Overrides userIp if both are provided.
3367
+ # @param [String] user_ip
3368
+ # IP address of the site where the request originates. Use this if you want to
3369
+ # enforce per-user limits.
3370
+ # @param [Google::Apis::RequestOptions] options
3371
+ # Request-specific options
3372
+ #
3373
+ # @yield [result, err] Result & error if block supplied
3374
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
3375
+ # @yieldparam err [StandardError] error object if request failed
3376
+ #
3377
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
3378
+ #
3379
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3380
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3381
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3382
+ def insert_web_property_user_link(account_id, web_property_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3383
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks', options)
3384
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
3385
+ command.request_object = entity_user_link_object
3386
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
3387
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
3388
+ command.params['accountId'] = account_id unless account_id.nil?
3389
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3390
+ command.query['fields'] = fields unless fields.nil?
3391
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3392
+ command.query['userIp'] = user_ip unless user_ip.nil?
3393
+ execute_or_queue_command(command, &block)
3394
+ end
3395
+
3396
+ # Lists webProperty-user links for a given web property.
3397
+ # @param [String] account_id
3398
+ # Account ID which the given web property belongs to.
3399
+ # @param [String] web_property_id
3400
+ # Web Property ID for the webProperty-user links to retrieve. Can either be a
3401
+ # specific web property ID or '~all', which refers to all the web properties
3402
+ # that user has access to.
3403
+ # @param [Fixnum] max_results
3404
+ # The maximum number of webProperty-user Links to include in this response.
3405
+ # @param [Fixnum] start_index
3406
+ # An index of the first webProperty-user link to retrieve. Use this parameter as
3407
+ # a pagination mechanism along with the max-results parameter.
3408
+ # @param [String] fields
3409
+ # Selector specifying which fields to include in a partial response.
3410
+ # @param [String] quota_user
3411
+ # Available to use for quota purposes for server-side applications. Can be any
3412
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3413
+ # Overrides userIp if both are provided.
3414
+ # @param [String] user_ip
3415
+ # IP address of the site where the request originates. Use this if you want to
3416
+ # enforce per-user limits.
3417
+ # @param [Google::Apis::RequestOptions] options
3418
+ # Request-specific options
3419
+ #
3420
+ # @yield [result, err] Result & error if block supplied
3421
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLinks] parsed result object
3422
+ # @yieldparam err [StandardError] error object if request failed
3423
+ #
3424
+ # @return [Google::Apis::AnalyticsV3::EntityUserLinks]
3425
+ #
3426
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3427
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3428
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3429
+ def list_web_property_user_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3430
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks', options)
3431
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
3432
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
3433
+ command.params['accountId'] = account_id unless account_id.nil?
3434
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3435
+ command.query['max-results'] = max_results unless max_results.nil?
3436
+ command.query['start-index'] = start_index unless start_index.nil?
3437
+ command.query['fields'] = fields unless fields.nil?
3438
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3439
+ command.query['userIp'] = user_ip unless user_ip.nil?
3440
+ execute_or_queue_command(command, &block)
3441
+ end
3442
+
3443
+ # Updates permissions for an existing user on the given web property.
3444
+ # @param [String] account_id
3445
+ # Account ID to update the account-user link for.
3446
+ # @param [String] web_property_id
3447
+ # Web property ID to update the account-user link for.
3448
+ # @param [String] link_id
3449
+ # Link ID to update the account-user link for.
3450
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
3451
+ # @param [String] fields
3452
+ # Selector specifying which fields to include in a partial response.
3453
+ # @param [String] quota_user
3454
+ # Available to use for quota purposes for server-side applications. Can be any
3455
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3456
+ # Overrides userIp if both are provided.
3457
+ # @param [String] user_ip
3458
+ # IP address of the site where the request originates. Use this if you want to
3459
+ # enforce per-user limits.
3460
+ # @param [Google::Apis::RequestOptions] options
3461
+ # Request-specific options
3462
+ #
3463
+ # @yield [result, err] Result & error if block supplied
3464
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
3465
+ # @yieldparam err [StandardError] error object if request failed
3466
+ #
3467
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
3468
+ #
3469
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3470
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3471
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3472
+ def update_web_property_user_link(account_id, web_property_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3473
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}', options)
3474
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
3475
+ command.request_object = entity_user_link_object
3476
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
3477
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
3478
+ command.params['accountId'] = account_id unless account_id.nil?
3479
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3480
+ command.params['linkId'] = link_id unless link_id.nil?
3481
+ command.query['fields'] = fields unless fields.nil?
3482
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3483
+ command.query['userIp'] = user_ip unless user_ip.nil?
3484
+ execute_or_queue_command(command, &block)
3485
+ end
3486
+
3487
+ # Lists all columns for a report type
3488
+ # @param [String] report_type
3489
+ # Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core
3490
+ # Reporting API
3491
+ # @param [String] fields
3492
+ # Selector specifying which fields to include in a partial response.
3493
+ # @param [String] quota_user
3494
+ # Available to use for quota purposes for server-side applications. Can be any
3495
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3496
+ # Overrides userIp if both are provided.
3497
+ # @param [String] user_ip
3498
+ # IP address of the site where the request originates. Use this if you want to
3499
+ # enforce per-user limits.
3500
+ # @param [Google::Apis::RequestOptions] options
3501
+ # Request-specific options
3502
+ #
3503
+ # @yield [result, err] Result & error if block supplied
3504
+ # @yieldparam result [Google::Apis::AnalyticsV3::Columns] parsed result object
3505
+ # @yieldparam err [StandardError] error object if request failed
3506
+ #
3507
+ # @return [Google::Apis::AnalyticsV3::Columns]
3508
+ #
3509
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3510
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3511
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3512
+ def list_metadata_columns(report_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3513
+ command = make_simple_command(:get, 'metadata/{reportType}/columns', options)
3514
+ command.response_representation = Google::Apis::AnalyticsV3::Columns::Representation
3515
+ command.response_class = Google::Apis::AnalyticsV3::Columns
3516
+ command.params['reportType'] = report_type unless report_type.nil?
3517
+ command.query['fields'] = fields unless fields.nil?
3518
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3519
+ command.query['userIp'] = user_ip unless user_ip.nil?
3520
+ execute_or_queue_command(command, &block)
3521
+ end
3522
+
3523
+ # Creates an account ticket.
3524
+ # @param [Google::Apis::AnalyticsV3::AccountTicket] account_ticket_object
3525
+ # @param [String] fields
3526
+ # Selector specifying which fields to include in a partial response.
3527
+ # @param [String] quota_user
3528
+ # Available to use for quota purposes for server-side applications. Can be any
3529
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3530
+ # Overrides userIp if both are provided.
3531
+ # @param [String] user_ip
3532
+ # IP address of the site where the request originates. Use this if you want to
3533
+ # enforce per-user limits.
3534
+ # @param [Google::Apis::RequestOptions] options
3535
+ # Request-specific options
3536
+ #
3537
+ # @yield [result, err] Result & error if block supplied
3538
+ # @yieldparam result [Google::Apis::AnalyticsV3::AccountTicket] parsed result object
3539
+ # @yieldparam err [StandardError] error object if request failed
3540
+ #
3541
+ # @return [Google::Apis::AnalyticsV3::AccountTicket]
3542
+ #
3543
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3544
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3545
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3546
+ def create_account_ticket(account_ticket_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3547
+ command = make_simple_command(:post, 'provisioning/createAccountTicket', options)
3548
+ command.request_representation = Google::Apis::AnalyticsV3::AccountTicket::Representation
3549
+ command.request_object = account_ticket_object
3550
+ command.response_representation = Google::Apis::AnalyticsV3::AccountTicket::Representation
3551
+ command.response_class = Google::Apis::AnalyticsV3::AccountTicket
3552
+ command.query['fields'] = fields unless fields.nil?
3553
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3554
+ command.query['userIp'] = user_ip unless user_ip.nil?
3555
+ execute_or_queue_command(command, &block)
3556
+ end
3557
+
3558
+ protected
3559
+
3560
+ def apply_command_defaults(command)
3561
+ command.query['key'] = key unless key.nil?
3562
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3563
+ command.query['userIp'] = user_ip unless user_ip.nil?
3564
+ end
3565
+ end
3566
+ end
3567
+ end
3568
+ end