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,327 @@
1
+ # Copyright 2015 Google Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module AdsensehostV4_1
24
+
25
+ class Account
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+ end
28
+
29
+ class Accounts
30
+ class Representation < Google::Apis::Core::JsonRepresentation; end
31
+ end
32
+
33
+ class AdClient
34
+ class Representation < Google::Apis::Core::JsonRepresentation; end
35
+ end
36
+
37
+ class AdClients
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+ end
40
+
41
+ class AdCode
42
+ class Representation < Google::Apis::Core::JsonRepresentation; end
43
+ end
44
+
45
+ class AdStyle
46
+ class Representation < Google::Apis::Core::JsonRepresentation; end
47
+
48
+ class Colors
49
+ class Representation < Google::Apis::Core::JsonRepresentation; end
50
+ end
51
+
52
+ class Font
53
+ class Representation < Google::Apis::Core::JsonRepresentation; end
54
+ end
55
+ end
56
+
57
+ class AdUnit
58
+ class Representation < Google::Apis::Core::JsonRepresentation; end
59
+
60
+ class ContentAdsSettings
61
+ class Representation < Google::Apis::Core::JsonRepresentation; end
62
+
63
+ class BackupOption
64
+ class Representation < Google::Apis::Core::JsonRepresentation; end
65
+ end
66
+ end
67
+
68
+ class MobileContentAdsSettings
69
+ class Representation < Google::Apis::Core::JsonRepresentation; end
70
+ end
71
+ end
72
+
73
+ class AdUnits
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+ end
76
+
77
+ class AssociationSession
78
+ class Representation < Google::Apis::Core::JsonRepresentation; end
79
+ end
80
+
81
+ class CustomChannel
82
+ class Representation < Google::Apis::Core::JsonRepresentation; end
83
+ end
84
+
85
+ class CustomChannels
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+ end
88
+
89
+ class Report
90
+ class Representation < Google::Apis::Core::JsonRepresentation; end
91
+
92
+ class Header
93
+ class Representation < Google::Apis::Core::JsonRepresentation; end
94
+ end
95
+ end
96
+
97
+ class UrlChannel
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+ end
100
+
101
+ class UrlChannels
102
+ class Representation < Google::Apis::Core::JsonRepresentation; end
103
+ end
104
+
105
+ class Account
106
+ # @private
107
+ class Representation < Google::Apis::Core::JsonRepresentation
108
+ property :id, as: 'id'
109
+ property :kind, as: 'kind'
110
+ property :name, as: 'name'
111
+ property :status, as: 'status'
112
+ end
113
+ end
114
+
115
+ class Accounts
116
+ # @private
117
+ class Representation < Google::Apis::Core::JsonRepresentation
118
+ property :etag, as: 'etag'
119
+ collection :items, as: 'items', class: Google::Apis::AdsensehostV4_1::Account, decorator: Google::Apis::AdsensehostV4_1::Account::Representation
120
+
121
+ property :kind, as: 'kind'
122
+ end
123
+ end
124
+
125
+ class AdClient
126
+ # @private
127
+ class Representation < Google::Apis::Core::JsonRepresentation
128
+ property :arc_opt_in, as: 'arcOptIn'
129
+ property :id, as: 'id'
130
+ property :kind, as: 'kind'
131
+ property :product_code, as: 'productCode'
132
+ property :supports_reporting, as: 'supportsReporting'
133
+ end
134
+ end
135
+
136
+ class AdClients
137
+ # @private
138
+ class Representation < Google::Apis::Core::JsonRepresentation
139
+ property :etag, as: 'etag'
140
+ collection :items, as: 'items', class: Google::Apis::AdsensehostV4_1::AdClient, decorator: Google::Apis::AdsensehostV4_1::AdClient::Representation
141
+
142
+ property :kind, as: 'kind'
143
+ property :next_page_token, as: 'nextPageToken'
144
+ end
145
+ end
146
+
147
+ class AdCode
148
+ # @private
149
+ class Representation < Google::Apis::Core::JsonRepresentation
150
+ property :ad_code, as: 'adCode'
151
+ property :kind, as: 'kind'
152
+ end
153
+ end
154
+
155
+ class AdStyle
156
+ # @private
157
+ class Representation < Google::Apis::Core::JsonRepresentation
158
+ property :colors, as: 'colors', class: Google::Apis::AdsensehostV4_1::AdStyle::Colors, decorator: Google::Apis::AdsensehostV4_1::AdStyle::Colors::Representation
159
+
160
+ property :corners, as: 'corners'
161
+ property :font, as: 'font', class: Google::Apis::AdsensehostV4_1::AdStyle::Font, decorator: Google::Apis::AdsensehostV4_1::AdStyle::Font::Representation
162
+
163
+ property :kind, as: 'kind'
164
+ end
165
+
166
+ class Colors
167
+ # @private
168
+ class Representation < Google::Apis::Core::JsonRepresentation
169
+ property :background, as: 'background'
170
+ property :border, as: 'border'
171
+ property :text, as: 'text'
172
+ property :title, as: 'title'
173
+ property :url, as: 'url'
174
+ end
175
+ end
176
+
177
+ class Font
178
+ # @private
179
+ class Representation < Google::Apis::Core::JsonRepresentation
180
+ property :family, as: 'family'
181
+ property :size, as: 'size'
182
+ end
183
+ end
184
+ end
185
+
186
+ class AdUnit
187
+ # @private
188
+ class Representation < Google::Apis::Core::JsonRepresentation
189
+ property :code, as: 'code'
190
+ property :content_ads_settings, as: 'contentAdsSettings', class: Google::Apis::AdsensehostV4_1::AdUnit::ContentAdsSettings, decorator: Google::Apis::AdsensehostV4_1::AdUnit::ContentAdsSettings::Representation
191
+
192
+ property :custom_style, as: 'customStyle', class: Google::Apis::AdsensehostV4_1::AdStyle, decorator: Google::Apis::AdsensehostV4_1::AdStyle::Representation
193
+
194
+ property :id, as: 'id'
195
+ property :kind, as: 'kind'
196
+ property :mobile_content_ads_settings, as: 'mobileContentAdsSettings', class: Google::Apis::AdsensehostV4_1::AdUnit::MobileContentAdsSettings, decorator: Google::Apis::AdsensehostV4_1::AdUnit::MobileContentAdsSettings::Representation
197
+
198
+ property :name, as: 'name'
199
+ property :status, as: 'status'
200
+ end
201
+
202
+ class ContentAdsSettings
203
+ # @private
204
+ class Representation < Google::Apis::Core::JsonRepresentation
205
+ property :backup_option, as: 'backupOption', class: Google::Apis::AdsensehostV4_1::AdUnit::ContentAdsSettings::BackupOption, decorator: Google::Apis::AdsensehostV4_1::AdUnit::ContentAdsSettings::BackupOption::Representation
206
+
207
+ property :size, as: 'size'
208
+ property :type, as: 'type'
209
+ end
210
+
211
+ class BackupOption
212
+ # @private
213
+ class Representation < Google::Apis::Core::JsonRepresentation
214
+ property :color, as: 'color'
215
+ property :type, as: 'type'
216
+ property :url, as: 'url'
217
+ end
218
+ end
219
+ end
220
+
221
+ class MobileContentAdsSettings
222
+ # @private
223
+ class Representation < Google::Apis::Core::JsonRepresentation
224
+ property :markup_language, as: 'markupLanguage'
225
+ property :scripting_language, as: 'scriptingLanguage'
226
+ property :size, as: 'size'
227
+ property :type, as: 'type'
228
+ end
229
+ end
230
+ end
231
+
232
+ class AdUnits
233
+ # @private
234
+ class Representation < Google::Apis::Core::JsonRepresentation
235
+ property :etag, as: 'etag'
236
+ collection :items, as: 'items', class: Google::Apis::AdsensehostV4_1::AdUnit, decorator: Google::Apis::AdsensehostV4_1::AdUnit::Representation
237
+
238
+ property :kind, as: 'kind'
239
+ property :next_page_token, as: 'nextPageToken'
240
+ end
241
+ end
242
+
243
+ class AssociationSession
244
+ # @private
245
+ class Representation < Google::Apis::Core::JsonRepresentation
246
+ property :account_id, as: 'accountId'
247
+ property :id, as: 'id'
248
+ property :kind, as: 'kind'
249
+ collection :product_codes, as: 'productCodes'
250
+ property :redirect_url, as: 'redirectUrl'
251
+ property :status, as: 'status'
252
+ property :user_locale, as: 'userLocale'
253
+ property :website_locale, as: 'websiteLocale'
254
+ property :website_url, as: 'websiteUrl'
255
+ end
256
+ end
257
+
258
+ class CustomChannel
259
+ # @private
260
+ class Representation < Google::Apis::Core::JsonRepresentation
261
+ property :code, as: 'code'
262
+ property :id, as: 'id'
263
+ property :kind, as: 'kind'
264
+ property :name, as: 'name'
265
+ end
266
+ end
267
+
268
+ class CustomChannels
269
+ # @private
270
+ class Representation < Google::Apis::Core::JsonRepresentation
271
+ property :etag, as: 'etag'
272
+ collection :items, as: 'items', class: Google::Apis::AdsensehostV4_1::CustomChannel, decorator: Google::Apis::AdsensehostV4_1::CustomChannel::Representation
273
+
274
+ property :kind, as: 'kind'
275
+ property :next_page_token, as: 'nextPageToken'
276
+ end
277
+ end
278
+
279
+ class Report
280
+ # @private
281
+ class Representation < Google::Apis::Core::JsonRepresentation
282
+ collection :averages, as: 'averages'
283
+ collection :headers, as: 'headers', class: Google::Apis::AdsensehostV4_1::Report::Header, decorator: Google::Apis::AdsensehostV4_1::Report::Header::Representation
284
+
285
+ property :kind, as: 'kind'
286
+ collection :rows, as: 'rows', :class => Array do
287
+ include Representable::JSON::Collection
288
+ items
289
+ end
290
+
291
+ property :total_matched_rows, as: 'totalMatchedRows'
292
+ collection :totals, as: 'totals'
293
+ collection :warnings, as: 'warnings'
294
+ end
295
+
296
+ class Header
297
+ # @private
298
+ class Representation < Google::Apis::Core::JsonRepresentation
299
+ property :currency, as: 'currency'
300
+ property :name, as: 'name'
301
+ property :type, as: 'type'
302
+ end
303
+ end
304
+ end
305
+
306
+ class UrlChannel
307
+ # @private
308
+ class Representation < Google::Apis::Core::JsonRepresentation
309
+ property :id, as: 'id'
310
+ property :kind, as: 'kind'
311
+ property :url_pattern, as: 'urlPattern'
312
+ end
313
+ end
314
+
315
+ class UrlChannels
316
+ # @private
317
+ class Representation < Google::Apis::Core::JsonRepresentation
318
+ property :etag, as: 'etag'
319
+ collection :items, as: 'items', class: Google::Apis::AdsensehostV4_1::UrlChannel, decorator: Google::Apis::AdsensehostV4_1::UrlChannel::Representation
320
+
321
+ property :kind, as: 'kind'
322
+ property :next_page_token, as: 'nextPageToken'
323
+ end
324
+ end
325
+ end
326
+ end
327
+ end
@@ -0,0 +1,1164 @@
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 AdsensehostV4_1
23
+ # AdSense Host API
24
+ #
25
+ # Gives AdSense Hosts access to report generation, ad code generation, and
26
+ # publisher management capabilities.
27
+ #
28
+ # @example
29
+ # require 'google/apis/adsensehost_v4_1'
30
+ #
31
+ # Adsensehost = Google::Apis::AdsensehostV4_1 # Alias the module
32
+ # service = Adsensehost::AdSenseHostService.new
33
+ #
34
+ # @see https://developers.google.com/adsense/host/
35
+ class AdSenseHostService < Google::Apis::Core::BaseService
36
+ # @return [String]
37
+ # API key. Your API key identifies your project and provides you with API access,
38
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
39
+ attr_accessor :key
40
+
41
+ # @return [String]
42
+ # Available to use for quota purposes for server-side applications. Can be any
43
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
44
+ # Overrides userIp if both are provided.
45
+ attr_accessor :quota_user
46
+
47
+ # @return [String]
48
+ # IP address of the site where the request originates. Use this if you want to
49
+ # enforce per-user limits.
50
+ attr_accessor :user_ip
51
+
52
+ def initialize
53
+ super('https://www.googleapis.com/', 'adsensehost/v4.1/')
54
+ end
55
+
56
+ # Get information about the selected associated AdSense account.
57
+ # @param [String] account_id
58
+ # Account to get information about.
59
+ # @param [String] fields
60
+ # Selector specifying which fields to include in a partial response.
61
+ # @param [String] quota_user
62
+ # Available to use for quota purposes for server-side applications. Can be any
63
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
64
+ # Overrides userIp if both are provided.
65
+ # @param [String] user_ip
66
+ # IP address of the site where the request originates. Use this if you want to
67
+ # enforce per-user limits.
68
+ # @param [Google::Apis::RequestOptions] options
69
+ # Request-specific options
70
+ #
71
+ # @yield [result, err] Result & error if block supplied
72
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::Account] parsed result object
73
+ # @yieldparam err [StandardError] error object if request failed
74
+ #
75
+ # @return [Google::Apis::AdsensehostV4_1::Account]
76
+ #
77
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
78
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
79
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
80
+ def get_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
81
+ command = make_simple_command(:get, 'accounts/{accountId}', options)
82
+ command.response_representation = Google::Apis::AdsensehostV4_1::Account::Representation
83
+ command.response_class = Google::Apis::AdsensehostV4_1::Account
84
+ command.params['accountId'] = account_id unless account_id.nil?
85
+ command.query['fields'] = fields unless fields.nil?
86
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
87
+ command.query['userIp'] = user_ip unless user_ip.nil?
88
+ execute_or_queue_command(command, &block)
89
+ end
90
+
91
+ # List hosted accounts associated with this AdSense account by ad client id.
92
+ # @param [Array<String>, String] filter_ad_client_id
93
+ # Ad clients to list accounts for.
94
+ # @param [String] fields
95
+ # Selector specifying which fields to include in a partial response.
96
+ # @param [String] quota_user
97
+ # Available to use for quota purposes for server-side applications. Can be any
98
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
99
+ # Overrides userIp if both are provided.
100
+ # @param [String] user_ip
101
+ # IP address of the site where the request originates. Use this if you want to
102
+ # enforce per-user limits.
103
+ # @param [Google::Apis::RequestOptions] options
104
+ # Request-specific options
105
+ #
106
+ # @yield [result, err] Result & error if block supplied
107
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::Accounts] parsed result object
108
+ # @yieldparam err [StandardError] error object if request failed
109
+ #
110
+ # @return [Google::Apis::AdsensehostV4_1::Accounts]
111
+ #
112
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
113
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
114
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
115
+ def list_accounts(filter_ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
116
+ command = make_simple_command(:get, 'accounts', options)
117
+ command.response_representation = Google::Apis::AdsensehostV4_1::Accounts::Representation
118
+ command.response_class = Google::Apis::AdsensehostV4_1::Accounts
119
+ command.query['filterAdClientId'] = filter_ad_client_id unless filter_ad_client_id.nil?
120
+ command.query['fields'] = fields unless fields.nil?
121
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
122
+ command.query['userIp'] = user_ip unless user_ip.nil?
123
+ execute_or_queue_command(command, &block)
124
+ end
125
+
126
+ # Get information about one of the ad clients in the specified publisher's
127
+ # AdSense account.
128
+ # @param [String] account_id
129
+ # Account which contains the ad client.
130
+ # @param [String] ad_client_id
131
+ # Ad client to get.
132
+ # @param [String] fields
133
+ # Selector specifying which fields to include in a partial response.
134
+ # @param [String] quota_user
135
+ # Available to use for quota purposes for server-side applications. Can be any
136
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
137
+ # Overrides userIp if both are provided.
138
+ # @param [String] user_ip
139
+ # IP address of the site where the request originates. Use this if you want to
140
+ # enforce per-user limits.
141
+ # @param [Google::Apis::RequestOptions] options
142
+ # Request-specific options
143
+ #
144
+ # @yield [result, err] Result & error if block supplied
145
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdClient] parsed result object
146
+ # @yieldparam err [StandardError] error object if request failed
147
+ #
148
+ # @return [Google::Apis::AdsensehostV4_1::AdClient]
149
+ #
150
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
151
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
152
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
153
+ def get_account_ad_client(account_id, ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
154
+ command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}', options)
155
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdClient::Representation
156
+ command.response_class = Google::Apis::AdsensehostV4_1::AdClient
157
+ command.params['accountId'] = account_id unless account_id.nil?
158
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
159
+ command.query['fields'] = fields unless fields.nil?
160
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
161
+ command.query['userIp'] = user_ip unless user_ip.nil?
162
+ execute_or_queue_command(command, &block)
163
+ end
164
+
165
+ # List all hosted ad clients in the specified hosted account.
166
+ # @param [String] account_id
167
+ # Account for which to list ad clients.
168
+ # @param [Fixnum] max_results
169
+ # The maximum number of ad clients to include in the response, used for paging.
170
+ # @param [String] page_token
171
+ # A continuation token, used to page through ad clients. To retrieve the next
172
+ # page, set this parameter to the value of "nextPageToken" from the previous
173
+ # response.
174
+ # @param [String] fields
175
+ # Selector specifying which fields to include in a partial response.
176
+ # @param [String] quota_user
177
+ # Available to use for quota purposes for server-side applications. Can be any
178
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
179
+ # Overrides userIp if both are provided.
180
+ # @param [String] user_ip
181
+ # IP address of the site where the request originates. Use this if you want to
182
+ # enforce per-user limits.
183
+ # @param [Google::Apis::RequestOptions] options
184
+ # Request-specific options
185
+ #
186
+ # @yield [result, err] Result & error if block supplied
187
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdClients] parsed result object
188
+ # @yieldparam err [StandardError] error object if request failed
189
+ #
190
+ # @return [Google::Apis::AdsensehostV4_1::AdClients]
191
+ #
192
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
193
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
194
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
195
+ def list_account_ad_clients(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
196
+ command = make_simple_command(:get, 'accounts/{accountId}/adclients', options)
197
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdClients::Representation
198
+ command.response_class = Google::Apis::AdsensehostV4_1::AdClients
199
+ command.params['accountId'] = account_id unless account_id.nil?
200
+ command.query['maxResults'] = max_results unless max_results.nil?
201
+ command.query['pageToken'] = page_token unless page_token.nil?
202
+ command.query['fields'] = fields unless fields.nil?
203
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
204
+ command.query['userIp'] = user_ip unless user_ip.nil?
205
+ execute_or_queue_command(command, &block)
206
+ end
207
+
208
+ # Delete the specified ad unit from the specified publisher AdSense account.
209
+ # @param [String] account_id
210
+ # Account which contains the ad unit.
211
+ # @param [String] ad_client_id
212
+ # Ad client for which to get ad unit.
213
+ # @param [String] ad_unit_id
214
+ # Ad unit to delete.
215
+ # @param [String] fields
216
+ # Selector specifying which fields to include in a partial response.
217
+ # @param [String] quota_user
218
+ # Available to use for quota purposes for server-side applications. Can be any
219
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
220
+ # Overrides userIp if both are provided.
221
+ # @param [String] user_ip
222
+ # IP address of the site where the request originates. Use this if you want to
223
+ # enforce per-user limits.
224
+ # @param [Google::Apis::RequestOptions] options
225
+ # Request-specific options
226
+ #
227
+ # @yield [result, err] Result & error if block supplied
228
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdUnit] parsed result object
229
+ # @yieldparam err [StandardError] error object if request failed
230
+ #
231
+ # @return [Google::Apis::AdsensehostV4_1::AdUnit]
232
+ #
233
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
234
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
235
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
236
+ def delete_account_ad_unit(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
237
+ command = make_simple_command(:delete, 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}', options)
238
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation
239
+ command.response_class = Google::Apis::AdsensehostV4_1::AdUnit
240
+ command.params['accountId'] = account_id unless account_id.nil?
241
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
242
+ command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
243
+ command.query['fields'] = fields unless fields.nil?
244
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
245
+ command.query['userIp'] = user_ip unless user_ip.nil?
246
+ execute_or_queue_command(command, &block)
247
+ end
248
+
249
+ # Get the specified host ad unit in this AdSense account.
250
+ # @param [String] account_id
251
+ # Account which contains the ad unit.
252
+ # @param [String] ad_client_id
253
+ # Ad client for which to get ad unit.
254
+ # @param [String] ad_unit_id
255
+ # Ad unit to get.
256
+ # @param [String] fields
257
+ # Selector specifying which fields to include in a partial response.
258
+ # @param [String] quota_user
259
+ # Available to use for quota purposes for server-side applications. Can be any
260
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
261
+ # Overrides userIp if both are provided.
262
+ # @param [String] user_ip
263
+ # IP address of the site where the request originates. Use this if you want to
264
+ # enforce per-user limits.
265
+ # @param [Google::Apis::RequestOptions] options
266
+ # Request-specific options
267
+ #
268
+ # @yield [result, err] Result & error if block supplied
269
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdUnit] parsed result object
270
+ # @yieldparam err [StandardError] error object if request failed
271
+ #
272
+ # @return [Google::Apis::AdsensehostV4_1::AdUnit]
273
+ #
274
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
275
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
276
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
277
+ def get_account_ad_unit(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
278
+ command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}', options)
279
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation
280
+ command.response_class = Google::Apis::AdsensehostV4_1::AdUnit
281
+ command.params['accountId'] = account_id unless account_id.nil?
282
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
283
+ command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
284
+ command.query['fields'] = fields unless fields.nil?
285
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
286
+ command.query['userIp'] = user_ip unless user_ip.nil?
287
+ execute_or_queue_command(command, &block)
288
+ end
289
+
290
+ # Get ad code for the specified ad unit, attaching the specified host custom
291
+ # channels.
292
+ # @param [String] account_id
293
+ # Account which contains the ad client.
294
+ # @param [String] ad_client_id
295
+ # Ad client with contains the ad unit.
296
+ # @param [String] ad_unit_id
297
+ # Ad unit to get the code for.
298
+ # @param [Array<String>, String] host_custom_channel_id
299
+ # Host custom channel to attach to the ad code.
300
+ # @param [String] fields
301
+ # Selector specifying which fields to include in a partial response.
302
+ # @param [String] quota_user
303
+ # Available to use for quota purposes for server-side applications. Can be any
304
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
305
+ # Overrides userIp if both are provided.
306
+ # @param [String] user_ip
307
+ # IP address of the site where the request originates. Use this if you want to
308
+ # enforce per-user limits.
309
+ # @param [Google::Apis::RequestOptions] options
310
+ # Request-specific options
311
+ #
312
+ # @yield [result, err] Result & error if block supplied
313
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdCode] parsed result object
314
+ # @yieldparam err [StandardError] error object if request failed
315
+ #
316
+ # @return [Google::Apis::AdsensehostV4_1::AdCode]
317
+ #
318
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
319
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
320
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
321
+ def get_account_ad_unit_ad_code(account_id, ad_client_id, ad_unit_id, host_custom_channel_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
322
+ command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode', options)
323
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdCode::Representation
324
+ command.response_class = Google::Apis::AdsensehostV4_1::AdCode
325
+ command.params['accountId'] = account_id unless account_id.nil?
326
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
327
+ command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
328
+ command.query['hostCustomChannelId'] = host_custom_channel_id unless host_custom_channel_id.nil?
329
+ command.query['fields'] = fields unless fields.nil?
330
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
331
+ command.query['userIp'] = user_ip unless user_ip.nil?
332
+ execute_or_queue_command(command, &block)
333
+ end
334
+
335
+ # Insert the supplied ad unit into the specified publisher AdSense account.
336
+ # @param [String] account_id
337
+ # Account which will contain the ad unit.
338
+ # @param [String] ad_client_id
339
+ # Ad client into which to insert the ad unit.
340
+ # @param [Google::Apis::AdsensehostV4_1::AdUnit] ad_unit_object
341
+ # @param [String] fields
342
+ # Selector specifying which fields to include in a partial response.
343
+ # @param [String] quota_user
344
+ # Available to use for quota purposes for server-side applications. Can be any
345
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
346
+ # Overrides userIp if both are provided.
347
+ # @param [String] user_ip
348
+ # IP address of the site where the request originates. Use this if you want to
349
+ # enforce per-user limits.
350
+ # @param [Google::Apis::RequestOptions] options
351
+ # Request-specific options
352
+ #
353
+ # @yield [result, err] Result & error if block supplied
354
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdUnit] parsed result object
355
+ # @yieldparam err [StandardError] error object if request failed
356
+ #
357
+ # @return [Google::Apis::AdsensehostV4_1::AdUnit]
358
+ #
359
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
360
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
361
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
362
+ def insert_account_ad_unit(account_id, ad_client_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
363
+ command = make_simple_command(:post, 'accounts/{accountId}/adclients/{adClientId}/adunits', options)
364
+ command.request_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation
365
+ command.request_object = ad_unit_object
366
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation
367
+ command.response_class = Google::Apis::AdsensehostV4_1::AdUnit
368
+ command.params['accountId'] = account_id unless account_id.nil?
369
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
370
+ command.query['fields'] = fields unless fields.nil?
371
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
372
+ command.query['userIp'] = user_ip unless user_ip.nil?
373
+ execute_or_queue_command(command, &block)
374
+ end
375
+
376
+ # List all ad units in the specified publisher's AdSense account.
377
+ # @param [String] account_id
378
+ # Account which contains the ad client.
379
+ # @param [String] ad_client_id
380
+ # Ad client for which to list ad units.
381
+ # @param [Boolean] include_inactive
382
+ # Whether to include inactive ad units. Default: true.
383
+ # @param [Fixnum] max_results
384
+ # The maximum number of ad units to include in the response, used for paging.
385
+ # @param [String] page_token
386
+ # A continuation token, used to page through ad units. To retrieve the next page,
387
+ # set this parameter to the value of "nextPageToken" from the previous response.
388
+ # @param [String] fields
389
+ # Selector specifying which fields to include in a partial response.
390
+ # @param [String] quota_user
391
+ # Available to use for quota purposes for server-side applications. Can be any
392
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
393
+ # Overrides userIp if both are provided.
394
+ # @param [String] user_ip
395
+ # IP address of the site where the request originates. Use this if you want to
396
+ # enforce per-user limits.
397
+ # @param [Google::Apis::RequestOptions] options
398
+ # Request-specific options
399
+ #
400
+ # @yield [result, err] Result & error if block supplied
401
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdUnits] parsed result object
402
+ # @yieldparam err [StandardError] error object if request failed
403
+ #
404
+ # @return [Google::Apis::AdsensehostV4_1::AdUnits]
405
+ #
406
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
407
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
408
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
409
+ def list_account_ad_units(account_id, ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
410
+ command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adunits', options)
411
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdUnits::Representation
412
+ command.response_class = Google::Apis::AdsensehostV4_1::AdUnits
413
+ command.params['accountId'] = account_id unless account_id.nil?
414
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
415
+ command.query['includeInactive'] = include_inactive unless include_inactive.nil?
416
+ command.query['maxResults'] = max_results unless max_results.nil?
417
+ command.query['pageToken'] = page_token unless page_token.nil?
418
+ command.query['fields'] = fields unless fields.nil?
419
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
420
+ command.query['userIp'] = user_ip unless user_ip.nil?
421
+ execute_or_queue_command(command, &block)
422
+ end
423
+
424
+ # Update the supplied ad unit in the specified publisher AdSense account. This
425
+ # method supports patch semantics.
426
+ # @param [String] account_id
427
+ # Account which contains the ad client.
428
+ # @param [String] ad_client_id
429
+ # Ad client which contains the ad unit.
430
+ # @param [String] ad_unit_id
431
+ # Ad unit to get.
432
+ # @param [Google::Apis::AdsensehostV4_1::AdUnit] ad_unit_object
433
+ # @param [String] fields
434
+ # Selector specifying which fields to include in a partial response.
435
+ # @param [String] quota_user
436
+ # Available to use for quota purposes for server-side applications. Can be any
437
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
438
+ # Overrides userIp if both are provided.
439
+ # @param [String] user_ip
440
+ # IP address of the site where the request originates. Use this if you want to
441
+ # enforce per-user limits.
442
+ # @param [Google::Apis::RequestOptions] options
443
+ # Request-specific options
444
+ #
445
+ # @yield [result, err] Result & error if block supplied
446
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdUnit] parsed result object
447
+ # @yieldparam err [StandardError] error object if request failed
448
+ #
449
+ # @return [Google::Apis::AdsensehostV4_1::AdUnit]
450
+ #
451
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
452
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
453
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
454
+ def patch_account_ad_unit(account_id, ad_client_id, ad_unit_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
455
+ command = make_simple_command(:patch, 'accounts/{accountId}/adclients/{adClientId}/adunits', options)
456
+ command.request_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation
457
+ command.request_object = ad_unit_object
458
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation
459
+ command.response_class = Google::Apis::AdsensehostV4_1::AdUnit
460
+ command.params['accountId'] = account_id unless account_id.nil?
461
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
462
+ command.query['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
463
+ command.query['fields'] = fields unless fields.nil?
464
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
465
+ command.query['userIp'] = user_ip unless user_ip.nil?
466
+ execute_or_queue_command(command, &block)
467
+ end
468
+
469
+ # Update the supplied ad unit in the specified publisher AdSense account.
470
+ # @param [String] account_id
471
+ # Account which contains the ad client.
472
+ # @param [String] ad_client_id
473
+ # Ad client which contains the ad unit.
474
+ # @param [Google::Apis::AdsensehostV4_1::AdUnit] ad_unit_object
475
+ # @param [String] fields
476
+ # Selector specifying which fields to include in a partial response.
477
+ # @param [String] quota_user
478
+ # Available to use for quota purposes for server-side applications. Can be any
479
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
480
+ # Overrides userIp if both are provided.
481
+ # @param [String] user_ip
482
+ # IP address of the site where the request originates. Use this if you want to
483
+ # enforce per-user limits.
484
+ # @param [Google::Apis::RequestOptions] options
485
+ # Request-specific options
486
+ #
487
+ # @yield [result, err] Result & error if block supplied
488
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdUnit] parsed result object
489
+ # @yieldparam err [StandardError] error object if request failed
490
+ #
491
+ # @return [Google::Apis::AdsensehostV4_1::AdUnit]
492
+ #
493
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
494
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
495
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
496
+ def update_account_ad_unit(account_id, ad_client_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
497
+ command = make_simple_command(:put, 'accounts/{accountId}/adclients/{adClientId}/adunits', options)
498
+ command.request_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation
499
+ command.request_object = ad_unit_object
500
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation
501
+ command.response_class = Google::Apis::AdsensehostV4_1::AdUnit
502
+ command.params['accountId'] = account_id unless account_id.nil?
503
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
504
+ command.query['fields'] = fields unless fields.nil?
505
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
506
+ command.query['userIp'] = user_ip unless user_ip.nil?
507
+ execute_or_queue_command(command, &block)
508
+ end
509
+
510
+ # Generate an AdSense report based on the report request sent in the query
511
+ # parameters. Returns the result as JSON; to retrieve output in CSV format
512
+ # specify "alt=csv" as a query parameter.
513
+ # @param [String] account_id
514
+ # Hosted account upon which to report.
515
+ # @param [String] start_date
516
+ # Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
517
+ # @param [String] end_date
518
+ # End of the date range to report on in "YYYY-MM-DD" format, inclusive.
519
+ # @param [Array<String>, String] dimension
520
+ # Dimensions to base the report on.
521
+ # @param [Array<String>, String] filter
522
+ # Filters to be run on the report.
523
+ # @param [String] locale
524
+ # Optional locale to use for translating report output to a local language.
525
+ # Defaults to "en_US" if not specified.
526
+ # @param [Fixnum] max_results
527
+ # The maximum number of rows of report data to return.
528
+ # @param [Array<String>, String] metric
529
+ # Numeric columns to include in the report.
530
+ # @param [Array<String>, String] sort
531
+ # The name of a dimension or metric to sort the resulting report on, optionally
532
+ # prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is
533
+ # specified, the column is sorted ascending.
534
+ # @param [Fixnum] start_index
535
+ # Index of the first row of report data to return.
536
+ # @param [String] fields
537
+ # Selector specifying which fields to include in a partial response.
538
+ # @param [String] quota_user
539
+ # Available to use for quota purposes for server-side applications. Can be any
540
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
541
+ # Overrides userIp if both are provided.
542
+ # @param [String] user_ip
543
+ # IP address of the site where the request originates. Use this if you want to
544
+ # enforce per-user limits.
545
+ # @param [Google::Apis::RequestOptions] options
546
+ # Request-specific options
547
+ #
548
+ # @yield [result, err] Result & error if block supplied
549
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::Report] parsed result object
550
+ # @yieldparam err [StandardError] error object if request failed
551
+ #
552
+ # @return [Google::Apis::AdsensehostV4_1::Report]
553
+ #
554
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
555
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
556
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
557
+ def generate_account_report(account_id, start_date, end_date, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
558
+ command = make_simple_command(:get, 'accounts/{accountId}/reports', options)
559
+ command.response_representation = Google::Apis::AdsensehostV4_1::Report::Representation
560
+ command.response_class = Google::Apis::AdsensehostV4_1::Report
561
+ command.params['accountId'] = account_id unless account_id.nil?
562
+ command.query['dimension'] = dimension unless dimension.nil?
563
+ command.query['endDate'] = end_date unless end_date.nil?
564
+ command.query['filter'] = filter unless filter.nil?
565
+ command.query['locale'] = locale unless locale.nil?
566
+ command.query['maxResults'] = max_results unless max_results.nil?
567
+ command.query['metric'] = metric unless metric.nil?
568
+ command.query['sort'] = sort unless sort.nil?
569
+ command.query['startDate'] = start_date unless start_date.nil?
570
+ command.query['startIndex'] = start_index unless start_index.nil?
571
+ command.query['fields'] = fields unless fields.nil?
572
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
573
+ command.query['userIp'] = user_ip unless user_ip.nil?
574
+ execute_or_queue_command(command, &block)
575
+ end
576
+
577
+ # Get information about one of the ad clients in the Host AdSense account.
578
+ # @param [String] ad_client_id
579
+ # Ad client to get.
580
+ # @param [String] fields
581
+ # Selector specifying which fields to include in a partial response.
582
+ # @param [String] quota_user
583
+ # Available to use for quota purposes for server-side applications. Can be any
584
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
585
+ # Overrides userIp if both are provided.
586
+ # @param [String] user_ip
587
+ # IP address of the site where the request originates. Use this if you want to
588
+ # enforce per-user limits.
589
+ # @param [Google::Apis::RequestOptions] options
590
+ # Request-specific options
591
+ #
592
+ # @yield [result, err] Result & error if block supplied
593
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdClient] parsed result object
594
+ # @yieldparam err [StandardError] error object if request failed
595
+ #
596
+ # @return [Google::Apis::AdsensehostV4_1::AdClient]
597
+ #
598
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
599
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
600
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
601
+ def get_ad_client(ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
602
+ command = make_simple_command(:get, 'adclients/{adClientId}', options)
603
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdClient::Representation
604
+ command.response_class = Google::Apis::AdsensehostV4_1::AdClient
605
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
606
+ command.query['fields'] = fields unless fields.nil?
607
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
608
+ command.query['userIp'] = user_ip unless user_ip.nil?
609
+ execute_or_queue_command(command, &block)
610
+ end
611
+
612
+ # List all host ad clients in this AdSense account.
613
+ # @param [Fixnum] max_results
614
+ # The maximum number of ad clients to include in the response, used for paging.
615
+ # @param [String] page_token
616
+ # A continuation token, used to page through ad clients. To retrieve the next
617
+ # page, set this parameter to the value of "nextPageToken" from the previous
618
+ # response.
619
+ # @param [String] fields
620
+ # Selector specifying which fields to include in a partial response.
621
+ # @param [String] quota_user
622
+ # Available to use for quota purposes for server-side applications. Can be any
623
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
624
+ # Overrides userIp if both are provided.
625
+ # @param [String] user_ip
626
+ # IP address of the site where the request originates. Use this if you want to
627
+ # enforce per-user limits.
628
+ # @param [Google::Apis::RequestOptions] options
629
+ # Request-specific options
630
+ #
631
+ # @yield [result, err] Result & error if block supplied
632
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AdClients] parsed result object
633
+ # @yieldparam err [StandardError] error object if request failed
634
+ #
635
+ # @return [Google::Apis::AdsensehostV4_1::AdClients]
636
+ #
637
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
638
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
639
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
640
+ def list_ad_clients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
641
+ command = make_simple_command(:get, 'adclients', options)
642
+ command.response_representation = Google::Apis::AdsensehostV4_1::AdClients::Representation
643
+ command.response_class = Google::Apis::AdsensehostV4_1::AdClients
644
+ command.query['maxResults'] = max_results unless max_results.nil?
645
+ command.query['pageToken'] = page_token unless page_token.nil?
646
+ command.query['fields'] = fields unless fields.nil?
647
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
648
+ command.query['userIp'] = user_ip unless user_ip.nil?
649
+ execute_or_queue_command(command, &block)
650
+ end
651
+
652
+ # Create an association session for initiating an association with an AdSense
653
+ # user.
654
+ # @param [Array<String>, String] product_code
655
+ # Products to associate with the user.
656
+ # @param [String] website_url
657
+ # The URL of the user's hosted website.
658
+ # @param [String] user_locale
659
+ # The preferred locale of the user.
660
+ # @param [String] website_locale
661
+ # The locale of the user's hosted website.
662
+ # @param [String] fields
663
+ # Selector specifying which fields to include in a partial response.
664
+ # @param [String] quota_user
665
+ # Available to use for quota purposes for server-side applications. Can be any
666
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
667
+ # Overrides userIp if both are provided.
668
+ # @param [String] user_ip
669
+ # IP address of the site where the request originates. Use this if you want to
670
+ # enforce per-user limits.
671
+ # @param [Google::Apis::RequestOptions] options
672
+ # Request-specific options
673
+ #
674
+ # @yield [result, err] Result & error if block supplied
675
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AssociationSession] parsed result object
676
+ # @yieldparam err [StandardError] error object if request failed
677
+ #
678
+ # @return [Google::Apis::AdsensehostV4_1::AssociationSession]
679
+ #
680
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
681
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
682
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
683
+ def start_association_session(product_code, website_url, user_locale: nil, website_locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
684
+ command = make_simple_command(:get, 'associationsessions/start', options)
685
+ command.response_representation = Google::Apis::AdsensehostV4_1::AssociationSession::Representation
686
+ command.response_class = Google::Apis::AdsensehostV4_1::AssociationSession
687
+ command.query['productCode'] = product_code unless product_code.nil?
688
+ command.query['userLocale'] = user_locale unless user_locale.nil?
689
+ command.query['websiteLocale'] = website_locale unless website_locale.nil?
690
+ command.query['websiteUrl'] = website_url unless website_url.nil?
691
+ command.query['fields'] = fields unless fields.nil?
692
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
693
+ command.query['userIp'] = user_ip unless user_ip.nil?
694
+ execute_or_queue_command(command, &block)
695
+ end
696
+
697
+ # Verify an association session after the association callback returns from
698
+ # AdSense signup.
699
+ # @param [String] token
700
+ # The token returned to the association callback URL.
701
+ # @param [String] fields
702
+ # Selector specifying which fields to include in a partial response.
703
+ # @param [String] quota_user
704
+ # Available to use for quota purposes for server-side applications. Can be any
705
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
706
+ # Overrides userIp if both are provided.
707
+ # @param [String] user_ip
708
+ # IP address of the site where the request originates. Use this if you want to
709
+ # enforce per-user limits.
710
+ # @param [Google::Apis::RequestOptions] options
711
+ # Request-specific options
712
+ #
713
+ # @yield [result, err] Result & error if block supplied
714
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::AssociationSession] parsed result object
715
+ # @yieldparam err [StandardError] error object if request failed
716
+ #
717
+ # @return [Google::Apis::AdsensehostV4_1::AssociationSession]
718
+ #
719
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
720
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
721
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
722
+ def verify_association_session(token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
723
+ command = make_simple_command(:get, 'associationsessions/verify', options)
724
+ command.response_representation = Google::Apis::AdsensehostV4_1::AssociationSession::Representation
725
+ command.response_class = Google::Apis::AdsensehostV4_1::AssociationSession
726
+ command.query['token'] = token unless token.nil?
727
+ command.query['fields'] = fields unless fields.nil?
728
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
729
+ command.query['userIp'] = user_ip unless user_ip.nil?
730
+ execute_or_queue_command(command, &block)
731
+ end
732
+
733
+ # Delete a specific custom channel from the host AdSense account.
734
+ # @param [String] ad_client_id
735
+ # Ad client from which to delete the custom channel.
736
+ # @param [String] custom_channel_id
737
+ # Custom channel to delete.
738
+ # @param [String] fields
739
+ # Selector specifying which fields to include in a partial response.
740
+ # @param [String] quota_user
741
+ # Available to use for quota purposes for server-side applications. Can be any
742
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
743
+ # Overrides userIp if both are provided.
744
+ # @param [String] user_ip
745
+ # IP address of the site where the request originates. Use this if you want to
746
+ # enforce per-user limits.
747
+ # @param [Google::Apis::RequestOptions] options
748
+ # Request-specific options
749
+ #
750
+ # @yield [result, err] Result & error if block supplied
751
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::CustomChannel] parsed result object
752
+ # @yieldparam err [StandardError] error object if request failed
753
+ #
754
+ # @return [Google::Apis::AdsensehostV4_1::CustomChannel]
755
+ #
756
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
757
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
758
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
759
+ def delete_custom_channel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
760
+ command = make_simple_command(:delete, 'adclients/{adClientId}/customchannels/{customChannelId}', options)
761
+ command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation
762
+ command.response_class = Google::Apis::AdsensehostV4_1::CustomChannel
763
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
764
+ command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
765
+ command.query['fields'] = fields unless fields.nil?
766
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
767
+ command.query['userIp'] = user_ip unless user_ip.nil?
768
+ execute_or_queue_command(command, &block)
769
+ end
770
+
771
+ # Get a specific custom channel from the host AdSense account.
772
+ # @param [String] ad_client_id
773
+ # Ad client from which to get the custom channel.
774
+ # @param [String] custom_channel_id
775
+ # Custom channel to get.
776
+ # @param [String] fields
777
+ # Selector specifying which fields to include in a partial response.
778
+ # @param [String] quota_user
779
+ # Available to use for quota purposes for server-side applications. Can be any
780
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
781
+ # Overrides userIp if both are provided.
782
+ # @param [String] user_ip
783
+ # IP address of the site where the request originates. Use this if you want to
784
+ # enforce per-user limits.
785
+ # @param [Google::Apis::RequestOptions] options
786
+ # Request-specific options
787
+ #
788
+ # @yield [result, err] Result & error if block supplied
789
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::CustomChannel] parsed result object
790
+ # @yieldparam err [StandardError] error object if request failed
791
+ #
792
+ # @return [Google::Apis::AdsensehostV4_1::CustomChannel]
793
+ #
794
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
795
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
796
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
797
+ def get_custom_channel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
798
+ command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}', options)
799
+ command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation
800
+ command.response_class = Google::Apis::AdsensehostV4_1::CustomChannel
801
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
802
+ command.params['customChannelId'] = custom_channel_id unless custom_channel_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
+ # Add a new custom channel to the host AdSense account.
810
+ # @param [String] ad_client_id
811
+ # Ad client to which the new custom channel will be added.
812
+ # @param [Google::Apis::AdsensehostV4_1::CustomChannel] custom_channel_object
813
+ # @param [String] fields
814
+ # Selector specifying which fields to include in a partial response.
815
+ # @param [String] quota_user
816
+ # Available to use for quota purposes for server-side applications. Can be any
817
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
818
+ # Overrides userIp if both are provided.
819
+ # @param [String] user_ip
820
+ # IP address of the site where the request originates. Use this if you want to
821
+ # enforce per-user limits.
822
+ # @param [Google::Apis::RequestOptions] options
823
+ # Request-specific options
824
+ #
825
+ # @yield [result, err] Result & error if block supplied
826
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::CustomChannel] parsed result object
827
+ # @yieldparam err [StandardError] error object if request failed
828
+ #
829
+ # @return [Google::Apis::AdsensehostV4_1::CustomChannel]
830
+ #
831
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
832
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
833
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
834
+ def insert_custom_channel(ad_client_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
835
+ command = make_simple_command(:post, 'adclients/{adClientId}/customchannels', options)
836
+ command.request_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation
837
+ command.request_object = custom_channel_object
838
+ command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation
839
+ command.response_class = Google::Apis::AdsensehostV4_1::CustomChannel
840
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
841
+ command.query['fields'] = fields unless fields.nil?
842
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
843
+ command.query['userIp'] = user_ip unless user_ip.nil?
844
+ execute_or_queue_command(command, &block)
845
+ end
846
+
847
+ # List all host custom channels in this AdSense account.
848
+ # @param [String] ad_client_id
849
+ # Ad client for which to list custom channels.
850
+ # @param [Fixnum] max_results
851
+ # The maximum number of custom channels to include in the response, used for
852
+ # paging.
853
+ # @param [String] page_token
854
+ # A continuation token, used to page through custom channels. To retrieve the
855
+ # next page, set this parameter to the value of "nextPageToken" from the
856
+ # previous response.
857
+ # @param [String] fields
858
+ # Selector specifying which fields to include in a partial response.
859
+ # @param [String] quota_user
860
+ # Available to use for quota purposes for server-side applications. Can be any
861
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
862
+ # Overrides userIp if both are provided.
863
+ # @param [String] user_ip
864
+ # IP address of the site where the request originates. Use this if you want to
865
+ # enforce per-user limits.
866
+ # @param [Google::Apis::RequestOptions] options
867
+ # Request-specific options
868
+ #
869
+ # @yield [result, err] Result & error if block supplied
870
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::CustomChannels] parsed result object
871
+ # @yieldparam err [StandardError] error object if request failed
872
+ #
873
+ # @return [Google::Apis::AdsensehostV4_1::CustomChannels]
874
+ #
875
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
876
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
877
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
878
+ def list_custom_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
879
+ command = make_simple_command(:get, 'adclients/{adClientId}/customchannels', options)
880
+ command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannels::Representation
881
+ command.response_class = Google::Apis::AdsensehostV4_1::CustomChannels
882
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
883
+ command.query['maxResults'] = max_results unless max_results.nil?
884
+ command.query['pageToken'] = page_token unless page_token.nil?
885
+ command.query['fields'] = fields unless fields.nil?
886
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
887
+ command.query['userIp'] = user_ip unless user_ip.nil?
888
+ execute_or_queue_command(command, &block)
889
+ end
890
+
891
+ # Update a custom channel in the host AdSense account. This method supports
892
+ # patch semantics.
893
+ # @param [String] ad_client_id
894
+ # Ad client in which the custom channel will be updated.
895
+ # @param [String] custom_channel_id
896
+ # Custom channel to get.
897
+ # @param [Google::Apis::AdsensehostV4_1::CustomChannel] custom_channel_object
898
+ # @param [String] fields
899
+ # Selector specifying which fields to include in a partial response.
900
+ # @param [String] quota_user
901
+ # Available to use for quota purposes for server-side applications. Can be any
902
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
903
+ # Overrides userIp if both are provided.
904
+ # @param [String] user_ip
905
+ # IP address of the site where the request originates. Use this if you want to
906
+ # enforce per-user limits.
907
+ # @param [Google::Apis::RequestOptions] options
908
+ # Request-specific options
909
+ #
910
+ # @yield [result, err] Result & error if block supplied
911
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::CustomChannel] parsed result object
912
+ # @yieldparam err [StandardError] error object if request failed
913
+ #
914
+ # @return [Google::Apis::AdsensehostV4_1::CustomChannel]
915
+ #
916
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
917
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
918
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
919
+ def patch_custom_channel(ad_client_id, custom_channel_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
920
+ command = make_simple_command(:patch, 'adclients/{adClientId}/customchannels', options)
921
+ command.request_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation
922
+ command.request_object = custom_channel_object
923
+ command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation
924
+ command.response_class = Google::Apis::AdsensehostV4_1::CustomChannel
925
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
926
+ command.query['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
927
+ command.query['fields'] = fields unless fields.nil?
928
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
929
+ command.query['userIp'] = user_ip unless user_ip.nil?
930
+ execute_or_queue_command(command, &block)
931
+ end
932
+
933
+ # Update a custom channel in the host AdSense account.
934
+ # @param [String] ad_client_id
935
+ # Ad client in which the custom channel will be updated.
936
+ # @param [Google::Apis::AdsensehostV4_1::CustomChannel] custom_channel_object
937
+ # @param [String] fields
938
+ # Selector specifying which fields to include in a partial response.
939
+ # @param [String] quota_user
940
+ # Available to use for quota purposes for server-side applications. Can be any
941
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
942
+ # Overrides userIp if both are provided.
943
+ # @param [String] user_ip
944
+ # IP address of the site where the request originates. Use this if you want to
945
+ # enforce per-user limits.
946
+ # @param [Google::Apis::RequestOptions] options
947
+ # Request-specific options
948
+ #
949
+ # @yield [result, err] Result & error if block supplied
950
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::CustomChannel] parsed result object
951
+ # @yieldparam err [StandardError] error object if request failed
952
+ #
953
+ # @return [Google::Apis::AdsensehostV4_1::CustomChannel]
954
+ #
955
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
956
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
957
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
958
+ def update_custom_channel(ad_client_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
959
+ command = make_simple_command(:put, 'adclients/{adClientId}/customchannels', options)
960
+ command.request_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation
961
+ command.request_object = custom_channel_object
962
+ command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation
963
+ command.response_class = Google::Apis::AdsensehostV4_1::CustomChannel
964
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
965
+ command.query['fields'] = fields unless fields.nil?
966
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
967
+ command.query['userIp'] = user_ip unless user_ip.nil?
968
+ execute_or_queue_command(command, &block)
969
+ end
970
+
971
+ # Generate an AdSense report based on the report request sent in the query
972
+ # parameters. Returns the result as JSON; to retrieve output in CSV format
973
+ # specify "alt=csv" as a query parameter.
974
+ # @param [String] start_date
975
+ # Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
976
+ # @param [String] end_date
977
+ # End of the date range to report on in "YYYY-MM-DD" format, inclusive.
978
+ # @param [Array<String>, String] dimension
979
+ # Dimensions to base the report on.
980
+ # @param [Array<String>, String] filter
981
+ # Filters to be run on the report.
982
+ # @param [String] locale
983
+ # Optional locale to use for translating report output to a local language.
984
+ # Defaults to "en_US" if not specified.
985
+ # @param [Fixnum] max_results
986
+ # The maximum number of rows of report data to return.
987
+ # @param [Array<String>, String] metric
988
+ # Numeric columns to include in the report.
989
+ # @param [Array<String>, String] sort
990
+ # The name of a dimension or metric to sort the resulting report on, optionally
991
+ # prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is
992
+ # specified, the column is sorted ascending.
993
+ # @param [Fixnum] start_index
994
+ # Index of the first row of report data to return.
995
+ # @param [String] fields
996
+ # Selector specifying which fields to include in a partial response.
997
+ # @param [String] quota_user
998
+ # Available to use for quota purposes for server-side applications. Can be any
999
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1000
+ # Overrides userIp if both are provided.
1001
+ # @param [String] user_ip
1002
+ # IP address of the site where the request originates. Use this if you want to
1003
+ # enforce per-user limits.
1004
+ # @param [Google::Apis::RequestOptions] options
1005
+ # Request-specific options
1006
+ #
1007
+ # @yield [result, err] Result & error if block supplied
1008
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::Report] parsed result object
1009
+ # @yieldparam err [StandardError] error object if request failed
1010
+ #
1011
+ # @return [Google::Apis::AdsensehostV4_1::Report]
1012
+ #
1013
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1014
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1015
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1016
+ def generate_report(start_date, end_date, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1017
+ command = make_simple_command(:get, 'reports', options)
1018
+ command.response_representation = Google::Apis::AdsensehostV4_1::Report::Representation
1019
+ command.response_class = Google::Apis::AdsensehostV4_1::Report
1020
+ command.query['dimension'] = dimension unless dimension.nil?
1021
+ command.query['endDate'] = end_date unless end_date.nil?
1022
+ command.query['filter'] = filter unless filter.nil?
1023
+ command.query['locale'] = locale unless locale.nil?
1024
+ command.query['maxResults'] = max_results unless max_results.nil?
1025
+ command.query['metric'] = metric unless metric.nil?
1026
+ command.query['sort'] = sort unless sort.nil?
1027
+ command.query['startDate'] = start_date unless start_date.nil?
1028
+ command.query['startIndex'] = start_index unless start_index.nil?
1029
+ command.query['fields'] = fields unless fields.nil?
1030
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1031
+ command.query['userIp'] = user_ip unless user_ip.nil?
1032
+ execute_or_queue_command(command, &block)
1033
+ end
1034
+
1035
+ # Delete a URL channel from the host AdSense account.
1036
+ # @param [String] ad_client_id
1037
+ # Ad client from which to delete the URL channel.
1038
+ # @param [String] url_channel_id
1039
+ # URL channel to delete.
1040
+ # @param [String] fields
1041
+ # Selector specifying which fields to include in a partial response.
1042
+ # @param [String] quota_user
1043
+ # Available to use for quota purposes for server-side applications. Can be any
1044
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1045
+ # Overrides userIp if both are provided.
1046
+ # @param [String] user_ip
1047
+ # IP address of the site where the request originates. Use this if you want to
1048
+ # enforce per-user limits.
1049
+ # @param [Google::Apis::RequestOptions] options
1050
+ # Request-specific options
1051
+ #
1052
+ # @yield [result, err] Result & error if block supplied
1053
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::UrlChannel] parsed result object
1054
+ # @yieldparam err [StandardError] error object if request failed
1055
+ #
1056
+ # @return [Google::Apis::AdsensehostV4_1::UrlChannel]
1057
+ #
1058
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1059
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1060
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1061
+ def delete_url_channel(ad_client_id, url_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1062
+ command = make_simple_command(:delete, 'adclients/{adClientId}/urlchannels/{urlChannelId}', options)
1063
+ command.response_representation = Google::Apis::AdsensehostV4_1::UrlChannel::Representation
1064
+ command.response_class = Google::Apis::AdsensehostV4_1::UrlChannel
1065
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
1066
+ command.params['urlChannelId'] = url_channel_id unless url_channel_id.nil?
1067
+ command.query['fields'] = fields unless fields.nil?
1068
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1069
+ command.query['userIp'] = user_ip unless user_ip.nil?
1070
+ execute_or_queue_command(command, &block)
1071
+ end
1072
+
1073
+ # Add a new URL channel to the host AdSense account.
1074
+ # @param [String] ad_client_id
1075
+ # Ad client to which the new URL channel will be added.
1076
+ # @param [Google::Apis::AdsensehostV4_1::UrlChannel] url_channel_object
1077
+ # @param [String] fields
1078
+ # Selector specifying which fields to include in a partial response.
1079
+ # @param [String] quota_user
1080
+ # Available to use for quota purposes for server-side applications. Can be any
1081
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1082
+ # Overrides userIp if both are provided.
1083
+ # @param [String] user_ip
1084
+ # IP address of the site where the request originates. Use this if you want to
1085
+ # enforce per-user limits.
1086
+ # @param [Google::Apis::RequestOptions] options
1087
+ # Request-specific options
1088
+ #
1089
+ # @yield [result, err] Result & error if block supplied
1090
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::UrlChannel] parsed result object
1091
+ # @yieldparam err [StandardError] error object if request failed
1092
+ #
1093
+ # @return [Google::Apis::AdsensehostV4_1::UrlChannel]
1094
+ #
1095
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1096
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1097
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1098
+ def insert_url_channel(ad_client_id, url_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1099
+ command = make_simple_command(:post, 'adclients/{adClientId}/urlchannels', options)
1100
+ command.request_representation = Google::Apis::AdsensehostV4_1::UrlChannel::Representation
1101
+ command.request_object = url_channel_object
1102
+ command.response_representation = Google::Apis::AdsensehostV4_1::UrlChannel::Representation
1103
+ command.response_class = Google::Apis::AdsensehostV4_1::UrlChannel
1104
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
1105
+ command.query['fields'] = fields unless fields.nil?
1106
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1107
+ command.query['userIp'] = user_ip unless user_ip.nil?
1108
+ execute_or_queue_command(command, &block)
1109
+ end
1110
+
1111
+ # List all host URL channels in the host AdSense account.
1112
+ # @param [String] ad_client_id
1113
+ # Ad client for which to list URL channels.
1114
+ # @param [Fixnum] max_results
1115
+ # The maximum number of URL channels to include in the response, used for paging.
1116
+ # @param [String] page_token
1117
+ # A continuation token, used to page through URL channels. To retrieve the next
1118
+ # page, set this parameter to the value of "nextPageToken" from the previous
1119
+ # response.
1120
+ # @param [String] fields
1121
+ # Selector specifying which fields to include in a partial response.
1122
+ # @param [String] quota_user
1123
+ # Available to use for quota purposes for server-side applications. Can be any
1124
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1125
+ # Overrides userIp if both are provided.
1126
+ # @param [String] user_ip
1127
+ # IP address of the site where the request originates. Use this if you want to
1128
+ # enforce per-user limits.
1129
+ # @param [Google::Apis::RequestOptions] options
1130
+ # Request-specific options
1131
+ #
1132
+ # @yield [result, err] Result & error if block supplied
1133
+ # @yieldparam result [Google::Apis::AdsensehostV4_1::UrlChannels] parsed result object
1134
+ # @yieldparam err [StandardError] error object if request failed
1135
+ #
1136
+ # @return [Google::Apis::AdsensehostV4_1::UrlChannels]
1137
+ #
1138
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1139
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1140
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1141
+ def list_url_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1142
+ command = make_simple_command(:get, 'adclients/{adClientId}/urlchannels', options)
1143
+ command.response_representation = Google::Apis::AdsensehostV4_1::UrlChannels::Representation
1144
+ command.response_class = Google::Apis::AdsensehostV4_1::UrlChannels
1145
+ command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
1146
+ command.query['maxResults'] = max_results unless max_results.nil?
1147
+ command.query['pageToken'] = page_token unless page_token.nil?
1148
+ command.query['fields'] = fields unless fields.nil?
1149
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1150
+ command.query['userIp'] = user_ip unless user_ip.nil?
1151
+ execute_or_queue_command(command, &block)
1152
+ end
1153
+
1154
+ protected
1155
+
1156
+ def apply_command_defaults(command)
1157
+ command.query['key'] = key unless key.nil?
1158
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1159
+ command.query['userIp'] = user_ip unless user_ip.nil?
1160
+ end
1161
+ end
1162
+ end
1163
+ end
1164
+ end