google-api-client 0.8.3 → 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 +52 -2
  9. data/CONTRIBUTING.md +31 -0
  10. data/Gemfile +35 -1
  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/classes.rb +1335 -0
  18. data/generated/google/apis/adexchangebuyer_v1_3/representations.rb +446 -0
  19. data/generated/google/apis/adexchangebuyer_v1_3/service.rb +872 -0
  20. data/generated/google/apis/adexchangebuyer_v1_3.rb +35 -0
  21. data/generated/google/apis/adexchangeseller_v2_0/classes.rb +792 -0
  22. data/generated/google/apis/adexchangeseller_v2_0/representations.rb +309 -0
  23. data/generated/google/apis/adexchangeseller_v2_0/service.rb +668 -0
  24. data/generated/google/apis/adexchangeseller_v2_0.rb +38 -0
  25. data/generated/google/apis/admin_datatransfer_v1/classes.rb +267 -0
  26. data/generated/google/apis/admin_datatransfer_v1/representations.rb +118 -0
  27. data/generated/google/apis/admin_datatransfer_v1/service.rb +262 -0
  28. data/generated/google/apis/admin_datatransfer_v1.rb +37 -0
  29. data/generated/google/apis/admin_directory_v1/classes.rb +3141 -0
  30. data/generated/google/apis/admin_directory_v1/representations.rb +1029 -0
  31. data/generated/google/apis/admin_directory_v1/service.rb +3818 -0
  32. data/generated/google/apis/admin_directory_v1.rb +113 -0
  33. data/generated/google/apis/admin_reports_v1/classes.rb +582 -0
  34. data/generated/google/apis/admin_reports_v1/representations.rb +231 -0
  35. data/generated/google/apis/admin_reports_v1/service.rb +336 -0
  36. data/generated/google/apis/admin_reports_v1.rb +38 -0
  37. data/generated/google/apis/adsense_v1_4/classes.rb +1285 -0
  38. data/generated/google/apis/adsense_v1_4/representations.rb +494 -0
  39. data/generated/google/apis/adsense_v1_4/service.rb +1714 -0
  40. data/generated/google/apis/adsense_v1_4.rb +38 -0
  41. data/generated/google/apis/adsensehost_v4_1/classes.rb +834 -0
  42. data/generated/google/apis/adsensehost_v4_1/representations.rb +327 -0
  43. data/generated/google/apis/adsensehost_v4_1/service.rb +1164 -0
  44. data/generated/google/apis/adsensehost_v4_1.rb +35 -0
  45. data/generated/google/apis/analytics_v3/classes.rb +5118 -0
  46. data/generated/google/apis/analytics_v3/representations.rb +1662 -0
  47. data/generated/google/apis/analytics_v3/service.rb +3568 -0
  48. data/generated/google/apis/analytics_v3.rb +49 -0
  49. data/generated/google/apis/androidenterprise_v1/classes.rb +1443 -0
  50. data/generated/google/apis/androidenterprise_v1/representations.rb +538 -0
  51. data/generated/google/apis/androidenterprise_v1/service.rb +2602 -0
  52. data/generated/google/apis/androidenterprise_v1.rb +35 -0
  53. data/generated/google/apis/androidpublisher_v2/classes.rb +1411 -0
  54. data/generated/google/apis/androidpublisher_v2/representations.rb +646 -0
  55. data/generated/google/apis/androidpublisher_v2/service.rb +2338 -0
  56. data/generated/google/apis/androidpublisher_v2.rb +34 -0
  57. data/generated/google/apis/appengine_v1beta4/classes.rb +1532 -0
  58. data/generated/google/apis/appengine_v1beta4/representations.rb +526 -0
  59. data/generated/google/apis/appengine_v1beta4/service.rb +476 -0
  60. data/generated/google/apis/appengine_v1beta4.rb +35 -0
  61. data/generated/google/apis/appsactivity_v1/classes.rb +392 -0
  62. data/generated/google/apis/appsactivity_v1/representations.rb +184 -0
  63. data/generated/google/apis/appsactivity_v1/service.rb +128 -0
  64. data/generated/google/apis/appsactivity_v1.rb +46 -0
  65. data/generated/google/apis/appstate_v1/classes.rb +154 -0
  66. data/generated/google/apis/appstate_v1/representations.rb +79 -0
  67. data/generated/google/apis/appstate_v1/service.rb +260 -0
  68. data/generated/google/apis/appstate_v1.rb +34 -0
  69. data/generated/google/apis/autoscaler_v1beta2/classes.rb +747 -0
  70. data/generated/google/apis/autoscaler_v1beta2/representations.rb +281 -0
  71. data/generated/google/apis/autoscaler_v1beta2/service.rb +478 -0
  72. data/generated/google/apis/autoscaler_v1beta2.rb +38 -0
  73. data/generated/google/apis/bigquery_v2/classes.rb +2471 -0
  74. data/generated/google/apis/bigquery_v2/representations.rb +816 -0
  75. data/generated/google/apis/bigquery_v2/service.rb +982 -0
  76. data/generated/google/apis/bigquery_v2.rb +52 -0
  77. data/generated/google/apis/blogger_v3/classes.rb +1354 -0
  78. data/generated/google/apis/blogger_v3/representations.rb +562 -0
  79. data/generated/google/apis/blogger_v3/service.rb +1587 -0
  80. data/generated/google/apis/blogger_v3.rb +37 -0
  81. data/generated/google/apis/books_v1/classes.rb +3956 -0
  82. data/generated/google/apis/books_v1/representations.rb +1538 -0
  83. data/generated/google/apis/books_v1/service.rb +2290 -0
  84. data/generated/google/apis/books_v1.rb +34 -0
  85. data/generated/google/apis/calendar_v3/classes.rb +1742 -0
  86. data/generated/google/apis/calendar_v3/representations.rb +567 -0
  87. data/generated/google/apis/calendar_v3/service.rb +1968 -0
  88. data/generated/google/apis/calendar_v3.rb +37 -0
  89. data/generated/google/apis/civicinfo_v2/classes.rb +1127 -0
  90. data/generated/google/apis/civicinfo_v2/representations.rb +383 -0
  91. data/generated/google/apis/civicinfo_v2/service.rb +279 -0
  92. data/{lib/google/api_client/service_account.rb → generated/google/apis/civicinfo_v2.rb} +18 -8
  93. data/generated/google/apis/classroom_v1/classes.rb +512 -0
  94. data/generated/google/apis/classroom_v1/representations.rb +217 -0
  95. data/generated/google/apis/classroom_v1/service.rb +970 -0
  96. data/generated/google/apis/classroom_v1.rb +49 -0
  97. data/generated/google/apis/classroom_v1beta1/classes.rb +447 -0
  98. data/generated/google/apis/classroom_v1beta1/representations.rb +190 -0
  99. data/generated/google/apis/classroom_v1beta1/service.rb +791 -0
  100. data/generated/google/apis/classroom_v1beta1.rb +49 -0
  101. data/generated/google/apis/cloudbilling_v1/classes.rb +169 -0
  102. data/generated/google/apis/cloudbilling_v1/representations.rb +79 -0
  103. data/generated/google/apis/cloudbilling_v1/service.rb +258 -0
  104. data/generated/google/apis/cloudbilling_v1.rb +35 -0
  105. data/generated/google/apis/clouddebugger_v2/classes.rb +1004 -0
  106. data/generated/google/apis/clouddebugger_v2/representations.rb +410 -0
  107. data/generated/google/apis/clouddebugger_v2/service.rb +370 -0
  108. data/generated/google/apis/clouddebugger_v2.rb +41 -0
  109. data/generated/google/apis/cloudmonitoring_v2beta2/classes.rb +679 -0
  110. data/generated/google/apis/cloudmonitoring_v2beta2/representations.rb +311 -0
  111. data/generated/google/apis/cloudmonitoring_v2beta2/service.rb +452 -0
  112. data/generated/google/apis/cloudmonitoring_v2beta2.rb +37 -0
  113. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +437 -0
  114. data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +188 -0
  115. data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +623 -0
  116. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +38 -0
  117. data/generated/google/apis/cloudtrace_v1/classes.rb +188 -0
  118. data/generated/google/apis/cloudtrace_v1/representations.rb +92 -0
  119. data/generated/google/apis/cloudtrace_v1/service.rb +190 -0
  120. data/generated/google/apis/cloudtrace_v1.rb +35 -0
  121. data/generated/google/apis/clouduseraccounts_beta/classes.rb +823 -0
  122. data/generated/google/apis/clouduseraccounts_beta/representations.rb +313 -0
  123. data/generated/google/apis/clouduseraccounts_beta/service.rb +854 -0
  124. data/generated/google/apis/clouduseraccounts_beta.rb +43 -0
  125. data/generated/google/apis/compute_beta/classes.rb +9128 -0
  126. data/generated/google/apis/compute_beta/representations.rb +3048 -0
  127. data/generated/google/apis/compute_beta/service.rb +10154 -0
  128. data/generated/google/apis/compute_beta.rb +49 -0
  129. data/generated/google/apis/compute_v1/classes.rb +8681 -0
  130. data/generated/google/apis/compute_v1/representations.rb +2895 -0
  131. data/generated/google/apis/compute_v1/service.rb +9252 -0
  132. data/generated/google/apis/compute_v1.rb +49 -0
  133. data/generated/google/apis/container_v1/classes.rb +463 -0
  134. data/generated/google/apis/container_v1/representations.rb +175 -0
  135. data/generated/google/apis/container_v1/service.rb +367 -0
  136. data/generated/google/apis/container_v1.rb +35 -0
  137. data/generated/google/apis/container_v1beta1/classes.rb +466 -0
  138. data/generated/google/apis/container_v1beta1/representations.rb +177 -0
  139. data/generated/google/apis/container_v1beta1/service.rb +394 -0
  140. data/generated/google/apis/container_v1beta1.rb +35 -0
  141. data/generated/google/apis/content_v2/classes.rb +5986 -0
  142. data/generated/google/apis/content_v2/representations.rb +2288 -0
  143. data/generated/google/apis/content_v2/service.rb +2338 -0
  144. data/generated/google/apis/content_v2.rb +35 -0
  145. data/generated/google/apis/coordinate_v1/classes.rb +669 -0
  146. data/generated/google/apis/coordinate_v1/representations.rb +285 -0
  147. data/generated/google/apis/coordinate_v1/service.rb +678 -0
  148. data/generated/google/apis/coordinate_v1.rb +37 -0
  149. data/generated/google/apis/customsearch_v1/classes.rb +771 -0
  150. data/generated/google/apis/customsearch_v1/representations.rb +276 -0
  151. data/generated/google/apis/customsearch_v1/service.rb +207 -0
  152. data/{lib/google/api_client/auth/compute_service_account.rb → generated/google/apis/customsearch_v1.rb} +13 -10
  153. data/generated/google/apis/datastore_v1beta2/classes.rb +1186 -0
  154. data/generated/google/apis/datastore_v1beta2/representations.rb +526 -0
  155. data/generated/google/apis/datastore_v1beta2/service.rb +294 -0
  156. data/generated/google/apis/datastore_v1beta2.rb +40 -0
  157. data/generated/google/apis/deploymentmanager_v2/classes.rb +1091 -0
  158. data/generated/google/apis/deploymentmanager_v2/representations.rb +422 -0
  159. data/generated/google/apis/deploymentmanager_v2/service.rb +857 -0
  160. data/generated/google/apis/deploymentmanager_v2.rb +44 -0
  161. data/generated/google/apis/deploymentmanager_v2beta2/classes.rb +843 -0
  162. data/generated/google/apis/deploymentmanager_v2beta2/representations.rb +306 -0
  163. data/generated/google/apis/deploymentmanager_v2beta2/service.rb +689 -0
  164. data/generated/google/apis/deploymentmanager_v2beta2.rb +44 -0
  165. data/generated/google/apis/dfareporting_v2_1/classes.rb +10770 -0
  166. data/generated/google/apis/dfareporting_v2_1/representations.rb +3438 -0
  167. data/generated/google/apis/dfareporting_v2_1/service.rb +8585 -0
  168. data/generated/google/apis/dfareporting_v2_1.rb +37 -0
  169. data/generated/google/apis/discovery_v1/classes.rb +961 -0
  170. data/generated/google/apis/discovery_v1/representations.rb +357 -0
  171. data/generated/google/apis/discovery_v1/service.rb +142 -0
  172. data/generated/google/apis/discovery_v1.rb +32 -0
  173. data/generated/google/apis/dns_v1/classes.rb +406 -0
  174. data/generated/google/apis/dns_v1/representations.rb +151 -0
  175. data/generated/google/apis/dns_v1/service.rb +454 -0
  176. data/generated/google/apis/dns_v1.rb +44 -0
  177. data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +716 -0
  178. data/generated/google/apis/doubleclickbidmanager_v1/representations.rb +298 -0
  179. data/generated/google/apis/doubleclickbidmanager_v1/service.rb +341 -0
  180. data/generated/google/apis/doubleclickbidmanager_v1.rb +31 -0
  181. data/generated/google/apis/doubleclicksearch_v2/classes.rb +956 -0
  182. data/generated/google/apis/doubleclicksearch_v2/representations.rb +316 -0
  183. data/generated/google/apis/doubleclicksearch_v2/service.rb +480 -0
  184. data/generated/google/apis/doubleclicksearch_v2.rb +35 -0
  185. data/generated/google/apis/drive_v2/classes.rb +2562 -0
  186. data/generated/google/apis/drive_v2/representations.rb +795 -0
  187. data/generated/google/apis/drive_v2/service.rb +2696 -0
  188. data/generated/google/apis/drive_v2.rb +58 -0
  189. data/generated/google/apis/drive_v3/classes.rb +1534 -0
  190. data/generated/google/apis/drive_v3/representations.rb +497 -0
  191. data/generated/google/apis/drive_v3/service.rb +1541 -0
  192. data/generated/google/apis/drive_v3.rb +55 -0
  193. data/generated/google/apis/fitness_v1/classes.rb +885 -0
  194. data/generated/google/apis/fitness_v1/representations.rb +320 -0
  195. data/generated/google/apis/fitness_v1/service.rb +675 -0
  196. data/generated/google/apis/fitness_v1.rb +49 -0
  197. data/generated/google/apis/fusiontables_v2/classes.rb +1048 -0
  198. data/generated/google/apis/fusiontables_v2/representations.rb +409 -0
  199. data/generated/google/apis/fusiontables_v2/service.rb +1463 -0
  200. data/generated/google/apis/fusiontables_v2.rb +37 -0
  201. data/generated/google/apis/games_configuration_v1configuration/classes.rb +506 -0
  202. data/generated/google/apis/games_configuration_v1configuration/representations.rb +206 -0
  203. data/generated/google/apis/games_configuration_v1configuration/service.rb +565 -0
  204. data/generated/google/apis/games_configuration_v1configuration.rb +34 -0
  205. data/generated/google/apis/games_management_v1management/classes.rb +524 -0
  206. data/generated/google/apis/games_management_v1management/representations.rb +231 -0
  207. data/generated/google/apis/games_management_v1management/service.rb +994 -0
  208. data/generated/google/apis/games_management_v1management.rb +37 -0
  209. data/generated/google/apis/games_v1/classes.rb +4617 -0
  210. data/generated/google/apis/games_v1/representations.rb +1584 -0
  211. data/generated/google/apis/games_v1/service.rb +2290 -0
  212. data/generated/google/apis/games_v1.rb +40 -0
  213. data/generated/google/apis/gan_v1beta1/classes.rb +1428 -0
  214. data/generated/google/apis/gan_v1beta1/representations.rb +428 -0
  215. data/generated/google/apis/gan_v1beta1/service.rb +682 -0
  216. data/generated/google/apis/gan_v1beta1.rb +31 -0
  217. data/generated/google/apis/genomics_v1/classes.rb +2609 -0
  218. data/generated/google/apis/genomics_v1/representations.rb +909 -0
  219. data/generated/google/apis/genomics_v1/service.rb +1676 -0
  220. data/generated/google/apis/genomics_v1.rb +49 -0
  221. data/generated/google/apis/genomics_v1beta2/classes.rb +3288 -0
  222. data/generated/google/apis/genomics_v1beta2/representations.rb +1194 -0
  223. data/generated/google/apis/genomics_v1beta2/service.rb +2392 -0
  224. data/generated/google/apis/genomics_v1beta2.rb +46 -0
  225. data/generated/google/apis/gmail_v1/classes.rb +794 -0
  226. data/generated/google/apis/gmail_v1/representations.rb +339 -0
  227. data/generated/google/apis/gmail_v1/service.rb +1470 -0
  228. data/generated/google/apis/gmail_v1.rb +52 -0
  229. data/generated/google/apis/groupsmigration_v1/classes.rb +51 -0
  230. data/generated/google/apis/groupsmigration_v1/representations.rb +38 -0
  231. data/generated/google/apis/groupsmigration_v1/service.rb +110 -0
  232. data/generated/google/apis/groupsmigration_v1.rb +34 -0
  233. data/generated/google/apis/groupssettings_v1/classes.rb +221 -0
  234. data/generated/google/apis/groupssettings_v1/representations.rb +64 -0
  235. data/generated/google/apis/groupssettings_v1/service.rb +179 -0
  236. data/generated/google/apis/groupssettings_v1.rb +34 -0
  237. data/generated/google/apis/identitytoolkit_v3/classes.rb +1466 -0
  238. data/generated/google/apis/identitytoolkit_v3/representations.rb +509 -0
  239. data/generated/google/apis/identitytoolkit_v3/service.rb +581 -0
  240. data/generated/google/apis/identitytoolkit_v3.rb +31 -0
  241. data/generated/google/apis/kgsearch_v1/classes.rb +59 -0
  242. data/generated/google/apis/kgsearch_v1/representations.rb +39 -0
  243. data/generated/google/apis/kgsearch_v1/service.rb +111 -0
  244. data/{spec/google/api_client/request_spec.rb → generated/google/apis/kgsearch_v1.rb} +16 -13
  245. data/generated/google/apis/licensing_v1/classes.rb +132 -0
  246. data/generated/google/apis/licensing_v1/representations.rb +68 -0
  247. data/generated/google/apis/licensing_v1/service.rb +369 -0
  248. data/generated/google/apis/licensing_v1.rb +34 -0
  249. data/generated/google/apis/logging_v1beta3/classes.rb +1079 -0
  250. data/generated/google/apis/logging_v1beta3/representations.rb +366 -0
  251. data/generated/google/apis/logging_v1beta3/service.rb +1001 -0
  252. data/generated/google/apis/logging_v1beta3.rb +47 -0
  253. data/generated/google/apis/manager_v1beta2/classes.rb +1287 -0
  254. data/generated/google/apis/manager_v1beta2/representations.rb +536 -0
  255. data/generated/google/apis/manager_v1beta2/service.rb +372 -0
  256. data/generated/google/apis/manager_v1beta2.rb +53 -0
  257. data/generated/google/apis/mapsengine_v1/classes.rb +2873 -0
  258. data/generated/google/apis/mapsengine_v1/representations.rb +1235 -0
  259. data/generated/google/apis/mapsengine_v1/service.rb +3388 -0
  260. data/generated/google/apis/mapsengine_v1.rb +38 -0
  261. data/generated/google/apis/mirror_v1/classes.rb +1072 -0
  262. data/generated/google/apis/mirror_v1/representations.rb +350 -0
  263. data/generated/google/apis/mirror_v1/service.rb +977 -0
  264. data/generated/google/apis/mirror_v1.rb +37 -0
  265. data/generated/google/apis/oauth2_v2/classes.rb +245 -0
  266. data/generated/google/apis/oauth2_v2/representations.rb +94 -0
  267. data/generated/google/apis/oauth2_v2/service.rb +199 -0
  268. data/generated/google/apis/oauth2_v2.rb +43 -0
  269. data/generated/google/apis/pagespeedonline_v2/classes.rb +614 -0
  270. data/generated/google/apis/pagespeedonline_v2/representations.rb +244 -0
  271. data/generated/google/apis/pagespeedonline_v2/service.rb +119 -0
  272. data/generated/google/apis/pagespeedonline_v2.rb +32 -0
  273. data/generated/google/apis/partners_v2/classes.rb +942 -0
  274. data/generated/google/apis/partners_v2/representations.rb +402 -0
  275. data/generated/google/apis/partners_v2/service.rb +400 -0
  276. data/generated/google/apis/partners_v2.rb +32 -0
  277. data/generated/google/apis/plus_domains_v1/classes.rb +2609 -0
  278. data/generated/google/apis/plus_domains_v1/representations.rb +987 -0
  279. data/generated/google/apis/plus_domains_v1/service.rb +904 -0
  280. data/generated/google/apis/plus_domains_v1.rb +61 -0
  281. data/generated/google/apis/plus_v1/classes.rb +2094 -0
  282. data/generated/google/apis/plus_v1/representations.rb +805 -0
  283. data/generated/google/apis/plus_v1/service.rb +470 -0
  284. data/generated/google/apis/plus_v1.rb +43 -0
  285. data/generated/google/apis/prediction_v1_6/classes.rb +751 -0
  286. data/generated/google/apis/prediction_v1_6/representations.rb +327 -0
  287. data/generated/google/apis/prediction_v1_6/service.rb +380 -0
  288. data/generated/google/apis/prediction_v1_6.rb +44 -0
  289. data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +639 -0
  290. data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +274 -0
  291. data/generated/google/apis/proximitybeacon_v1beta1/service.rb +591 -0
  292. data/generated/google/apis/proximitybeacon_v1beta1.rb +31 -0
  293. data/generated/google/apis/pubsub_v1/classes.rb +614 -0
  294. data/generated/google/apis/pubsub_v1/representations.rb +281 -0
  295. data/generated/google/apis/pubsub_v1/service.rb +774 -0
  296. data/generated/google/apis/pubsub_v1.rb +37 -0
  297. data/generated/google/apis/pubsub_v1beta2/classes.rb +620 -0
  298. data/generated/google/apis/pubsub_v1beta2/representations.rb +282 -0
  299. data/generated/google/apis/pubsub_v1beta2/service.rb +774 -0
  300. data/generated/google/apis/pubsub_v1beta2.rb +37 -0
  301. data/generated/google/apis/qpx_express_v1/classes.rb +1268 -0
  302. data/generated/google/apis/qpx_express_v1/representations.rb +424 -0
  303. data/generated/google/apis/qpx_express_v1/service.rb +100 -0
  304. data/generated/google/apis/qpx_express_v1.rb +31 -0
  305. data/generated/google/apis/replicapool_v1beta2/classes.rb +631 -0
  306. data/generated/google/apis/replicapool_v1beta2/representations.rb +236 -0
  307. data/generated/google/apis/replicapool_v1beta2/service.rb +608 -0
  308. data/generated/google/apis/replicapool_v1beta2.rb +44 -0
  309. data/generated/google/apis/replicapoolupdater_v1beta1/classes.rb +733 -0
  310. data/generated/google/apis/replicapoolupdater_v1beta1/representations.rb +264 -0
  311. data/generated/google/apis/replicapoolupdater_v1beta1/service.rb +508 -0
  312. data/generated/google/apis/replicapoolupdater_v1beta1.rb +44 -0
  313. data/generated/google/apis/reseller_v1/classes.rb +520 -0
  314. data/generated/google/apis/reseller_v1/representations.rb +200 -0
  315. data/generated/google/apis/reseller_v1/service.rb +623 -0
  316. data/generated/google/apis/reseller_v1.rb +37 -0
  317. data/generated/google/apis/resourceviews_v1beta2/classes.rb +660 -0
  318. data/generated/google/apis/resourceviews_v1beta2/representations.rb +269 -0
  319. data/generated/google/apis/resourceviews_v1beta2/service.rb +563 -0
  320. data/generated/google/apis/resourceviews_v1beta2.rb +50 -0
  321. data/generated/google/apis/script_v1/classes.rb +259 -0
  322. data/generated/google/apis/script_v1/representations.rb +106 -0
  323. data/generated/google/apis/script_v1/service.rb +98 -0
  324. data/generated/google/apis/script_v1.rb +61 -0
  325. data/generated/google/apis/site_verification_v1/classes.rb +185 -0
  326. data/generated/google/apis/site_verification_v1/representations.rb +101 -0
  327. data/generated/google/apis/site_verification_v1/service.rb +315 -0
  328. data/generated/google/apis/site_verification_v1.rb +37 -0
  329. data/generated/google/apis/sqladmin_v1beta4/classes.rb +2001 -0
  330. data/generated/google/apis/sqladmin_v1beta4/representations.rb +758 -0
  331. data/generated/google/apis/sqladmin_v1beta4/service.rb +1625 -0
  332. data/generated/google/apis/sqladmin_v1beta4.rb +37 -0
  333. data/generated/google/apis/storage_v1/classes.rb +1222 -0
  334. data/generated/google/apis/storage_v1/representations.rb +445 -0
  335. data/generated/google/apis/storage_v1/service.rb +1903 -0
  336. data/generated/google/apis/storage_v1.rb +46 -0
  337. data/generated/google/apis/storagetransfer_v1/classes.rb +1046 -0
  338. data/generated/google/apis/storagetransfer_v1/representations.rb +370 -0
  339. data/generated/google/apis/storagetransfer_v1/service.rb +473 -0
  340. data/generated/google/apis/storagetransfer_v1.rb +35 -0
  341. data/generated/google/apis/tagmanager_v1/classes.rb +1384 -0
  342. data/generated/google/apis/tagmanager_v1/representations.rb +515 -0
  343. data/generated/google/apis/tagmanager_v1/service.rb +1817 -0
  344. data/generated/google/apis/tagmanager_v1.rb +52 -0
  345. data/generated/google/apis/taskqueue_v1beta2/classes.rb +254 -0
  346. data/generated/google/apis/taskqueue_v1beta2/representations.rb +114 -0
  347. data/generated/google/apis/taskqueue_v1beta2/service.rb +408 -0
  348. data/generated/google/apis/taskqueue_v1beta2.rb +37 -0
  349. data/generated/google/apis/tasks_v1/classes.rb +296 -0
  350. data/generated/google/apis/tasks_v1/representations.rb +115 -0
  351. data/generated/google/apis/tasks_v1/service.rb +643 -0
  352. data/generated/google/apis/tasks_v1.rb +37 -0
  353. data/generated/google/apis/translate_v2/classes.rb +168 -0
  354. data/generated/google/apis/translate_v2/representations.rb +109 -0
  355. data/generated/google/apis/translate_v2/service.rb +182 -0
  356. data/generated/google/apis/translate_v2.rb +31 -0
  357. data/generated/google/apis/urlshortener_v1/classes.rb +246 -0
  358. data/generated/google/apis/urlshortener_v1/representations.rb +111 -0
  359. data/generated/google/apis/urlshortener_v1/service.rb +176 -0
  360. data/generated/google/apis/urlshortener_v1.rb +34 -0
  361. data/generated/google/apis/webmasters_v3/classes.rb +563 -0
  362. data/generated/google/apis/webmasters_v3/representations.rb +250 -0
  363. data/generated/google/apis/webmasters_v3/service.rb +573 -0
  364. data/generated/google/apis/webmasters_v3.rb +37 -0
  365. data/generated/google/apis/youtube_analytics_v1/classes.rb +546 -0
  366. data/generated/google/apis/youtube_analytics_v1/representations.rb +243 -0
  367. data/generated/google/apis/youtube_analytics_v1/service.rb +562 -0
  368. data/generated/google/apis/youtube_analytics_v1.rb +46 -0
  369. data/generated/google/apis/youtube_v3/classes.rb +8136 -0
  370. data/generated/google/apis/youtube_v3/representations.rb +2838 -0
  371. data/generated/google/apis/youtube_v3/service.rb +4403 -0
  372. data/generated/google/apis/youtube_v3.rb +49 -0
  373. data/generated/google/apis/youtubereporting_v1/classes.rb +258 -0
  374. data/generated/google/apis/youtubereporting_v1/representations.rb +128 -0
  375. data/generated/google/apis/youtubereporting_v1/service.rb +364 -0
  376. data/generated/google/apis/youtubereporting_v1.rb +38 -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 +12 -11
  380. data/lib/google/api_client/auth/storage.rb +5 -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/core/api_command.rb +135 -0
  385. data/lib/google/apis/core/base_service.rb +317 -0
  386. data/lib/google/apis/core/batch.rb +239 -0
  387. data/lib/google/apis/core/download.rb +94 -0
  388. data/lib/google/apis/core/hashable.rb +44 -0
  389. data/lib/google/apis/core/http_client_adapter.rb +82 -0
  390. data/lib/google/apis/core/http_command.rb +312 -0
  391. data/lib/google/apis/core/json_representation.rb +127 -0
  392. data/lib/google/{api_client/version.rb → apis/core/logging.rb} +12 -8
  393. data/lib/google/apis/core/multipart.rb +187 -0
  394. data/lib/google/apis/core/upload.rb +288 -0
  395. data/lib/google/{api_client → apis}/errors.rb +39 -28
  396. data/lib/google/apis/generator/annotator.rb +295 -0
  397. data/lib/google/apis/generator/helpers.rb +74 -0
  398. data/lib/google/apis/generator/model.rb +143 -0
  399. data/lib/google/apis/generator/template.rb +124 -0
  400. data/lib/google/apis/generator/templates/_class.tmpl +40 -0
  401. data/lib/google/apis/generator/templates/_method.tmpl +92 -0
  402. data/lib/google/apis/generator/templates/_representation.tmpl +51 -0
  403. data/lib/google/apis/generator/templates/_representation_stub.tmpl +15 -0
  404. data/lib/google/apis/generator/templates/_representation_type.tmpl +10 -0
  405. data/lib/google/{api_client/reference.rb → apis/generator/templates/classes.rb.tmpl} +11 -9
  406. data/lib/google/apis/generator/templates/module.rb.tmpl +40 -0
  407. data/lib/google/apis/generator/templates/representations.rb.tmpl +32 -0
  408. data/lib/google/apis/generator/templates/service.rb.tmpl +60 -0
  409. data/lib/google/apis/generator.rb +70 -0
  410. data/lib/google/apis/options.rb +85 -0
  411. data/lib/google/apis/version.rb +39 -0
  412. data/lib/google/apis.rb +48 -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/load_path_spec.rb +33 -0
  460. data/spec/spec_helper.rb +131 -44
  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/auth/file_storage.rb +0 -59
  465. data/lib/google/api_client/auth/jwt_asserter.rb +0 -126
  466. data/lib/google/api_client/auth/pkcs12.rb +0 -41
  467. data/lib/google/api_client/batch.rb +0 -325
  468. data/lib/google/api_client/charset.rb +0 -33
  469. data/lib/google/api_client/discovery/api.rb +0 -300
  470. data/lib/google/api_client/discovery/media.rb +0 -77
  471. data/lib/google/api_client/discovery/method.rb +0 -363
  472. data/lib/google/api_client/discovery/resource.rb +0 -156
  473. data/lib/google/api_client/discovery/schema.rb +0 -119
  474. data/lib/google/api_client/environment.rb +0 -42
  475. data/lib/google/api_client/gzip.rb +0 -28
  476. data/lib/google/api_client/logging.rb +0 -32
  477. data/lib/google/api_client/media.rb +0 -259
  478. data/lib/google/api_client/railtie.rb +0 -18
  479. data/lib/google/api_client/request.rb +0 -350
  480. data/lib/google/api_client/result.rb +0 -255
  481. data/lib/google/api_client/service/batch.rb +0 -110
  482. data/lib/google/api_client/service/request.rb +0 -144
  483. data/lib/google/api_client/service/resource.rb +0 -40
  484. data/lib/google/api_client/service/result.rb +0 -162
  485. data/lib/google/api_client/service/simple_file_store.rb +0 -151
  486. data/lib/google/api_client/service/stub_generator.rb +0 -61
  487. data/lib/google/api_client/service.rb +0 -233
  488. data/lib/google/api_client.rb +0 -750
  489. data/spec/google/api_client/batch_spec.rb +0 -248
  490. data/spec/google/api_client/discovery_spec.rb +0 -662
  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,2290 @@
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 GamesV1
23
+ # Google Play Game Services API
24
+ #
25
+ # The API for Google Play Game Services.
26
+ #
27
+ # @example
28
+ # require 'google/apis/games_v1'
29
+ #
30
+ # Games = Google::Apis::GamesV1 # Alias the module
31
+ # service = Games::GamesService.new
32
+ #
33
+ # @see https://developers.google.com/games/services/
34
+ class GamesService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ # Overrides userIp if both are provided.
44
+ attr_accessor :quota_user
45
+
46
+ # @return [String]
47
+ # IP address of the site where the request originates. Use this if you want to
48
+ # enforce per-user limits.
49
+ attr_accessor :user_ip
50
+
51
+ def initialize
52
+ super('https://www.googleapis.com/', 'games/v1/')
53
+ end
54
+
55
+ # Lists all the achievement definitions for your application.
56
+ # @param [String] language
57
+ # The preferred language to use for strings returned by this method.
58
+ # @param [Fixnum] max_results
59
+ # The maximum number of achievement resources to return in the response, used
60
+ # for paging. For any response, the actual number of achievement resources
61
+ # returned may be less than the specified maxResults.
62
+ # @param [String] page_token
63
+ # The token returned by the previous request.
64
+ # @param [String] fields
65
+ # Selector specifying which fields to include in a partial response.
66
+ # @param [String] quota_user
67
+ # Available to use for quota purposes for server-side applications. Can be any
68
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
69
+ # Overrides userIp if both are provided.
70
+ # @param [String] user_ip
71
+ # IP address of the site where the request originates. Use this if you want to
72
+ # enforce per-user limits.
73
+ # @param [Google::Apis::RequestOptions] options
74
+ # Request-specific options
75
+ #
76
+ # @yield [result, err] Result & error if block supplied
77
+ # @yieldparam result [Google::Apis::GamesV1::ListAchievementDefinitionsResponse] parsed result object
78
+ # @yieldparam err [StandardError] error object if request failed
79
+ #
80
+ # @return [Google::Apis::GamesV1::ListAchievementDefinitionsResponse]
81
+ #
82
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
83
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
84
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
85
+ def list_achievement_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
86
+ command = make_simple_command(:get, 'achievements', options)
87
+ command.response_representation = Google::Apis::GamesV1::ListAchievementDefinitionsResponse::Representation
88
+ command.response_class = Google::Apis::GamesV1::ListAchievementDefinitionsResponse
89
+ command.query['language'] = language unless language.nil?
90
+ command.query['maxResults'] = max_results unless max_results.nil?
91
+ command.query['pageToken'] = page_token unless page_token.nil?
92
+ command.query['fields'] = fields unless fields.nil?
93
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
94
+ command.query['userIp'] = user_ip unless user_ip.nil?
95
+ execute_or_queue_command(command, &block)
96
+ end
97
+
98
+ # Increments the steps of the achievement with the given ID for the currently
99
+ # authenticated player.
100
+ # @param [String] achievement_id
101
+ # The ID of the achievement used by this method.
102
+ # @param [Fixnum] steps_to_increment
103
+ # The number of steps to increment.
104
+ # @param [String] request_id
105
+ # A randomly generated numeric ID for each request specified by the caller. This
106
+ # number is used at the server to ensure that the request is handled correctly
107
+ # across retries.
108
+ # @param [String] fields
109
+ # Selector specifying which fields to include in a partial response.
110
+ # @param [String] quota_user
111
+ # Available to use for quota purposes for server-side applications. Can be any
112
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
113
+ # Overrides userIp if both are provided.
114
+ # @param [String] user_ip
115
+ # IP address of the site where the request originates. Use this if you want to
116
+ # enforce per-user limits.
117
+ # @param [Google::Apis::RequestOptions] options
118
+ # Request-specific options
119
+ #
120
+ # @yield [result, err] Result & error if block supplied
121
+ # @yieldparam result [Google::Apis::GamesV1::AchievementIncrementResponse] parsed result object
122
+ # @yieldparam err [StandardError] error object if request failed
123
+ #
124
+ # @return [Google::Apis::GamesV1::AchievementIncrementResponse]
125
+ #
126
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
127
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
128
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
129
+ def increment_achievement(achievement_id, steps_to_increment, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
130
+ command = make_simple_command(:post, 'achievements/{achievementId}/increment', options)
131
+ command.response_representation = Google::Apis::GamesV1::AchievementIncrementResponse::Representation
132
+ command.response_class = Google::Apis::GamesV1::AchievementIncrementResponse
133
+ command.params['achievementId'] = achievement_id unless achievement_id.nil?
134
+ command.query['requestId'] = request_id unless request_id.nil?
135
+ command.query['stepsToIncrement'] = steps_to_increment unless steps_to_increment.nil?
136
+ command.query['fields'] = fields unless fields.nil?
137
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
138
+ command.query['userIp'] = user_ip unless user_ip.nil?
139
+ execute_or_queue_command(command, &block)
140
+ end
141
+
142
+ # Lists the progress for all your application's achievements for the currently
143
+ # authenticated player.
144
+ # @param [String] player_id
145
+ # A player ID. A value of me may be used in place of the authenticated player's
146
+ # ID.
147
+ # @param [String] language
148
+ # The preferred language to use for strings returned by this method.
149
+ # @param [Fixnum] max_results
150
+ # The maximum number of achievement resources to return in the response, used
151
+ # for paging. For any response, the actual number of achievement resources
152
+ # returned may be less than the specified maxResults.
153
+ # @param [String] page_token
154
+ # The token returned by the previous request.
155
+ # @param [String] state
156
+ # Tells the server to return only achievements with the specified state. If this
157
+ # parameter isn't specified, all achievements are returned.
158
+ # @param [String] fields
159
+ # Selector specifying which fields to include in a partial response.
160
+ # @param [String] quota_user
161
+ # Available to use for quota purposes for server-side applications. Can be any
162
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
163
+ # Overrides userIp if both are provided.
164
+ # @param [String] user_ip
165
+ # IP address of the site where the request originates. Use this if you want to
166
+ # enforce per-user limits.
167
+ # @param [Google::Apis::RequestOptions] options
168
+ # Request-specific options
169
+ #
170
+ # @yield [result, err] Result & error if block supplied
171
+ # @yieldparam result [Google::Apis::GamesV1::ListPlayerAchievementResponse] parsed result object
172
+ # @yieldparam err [StandardError] error object if request failed
173
+ #
174
+ # @return [Google::Apis::GamesV1::ListPlayerAchievementResponse]
175
+ #
176
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
177
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
178
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
179
+ def list_achievements(player_id, language: nil, max_results: nil, page_token: nil, state: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
180
+ command = make_simple_command(:get, 'players/{playerId}/achievements', options)
181
+ command.response_representation = Google::Apis::GamesV1::ListPlayerAchievementResponse::Representation
182
+ command.response_class = Google::Apis::GamesV1::ListPlayerAchievementResponse
183
+ command.params['playerId'] = player_id unless player_id.nil?
184
+ command.query['language'] = language unless language.nil?
185
+ command.query['maxResults'] = max_results unless max_results.nil?
186
+ command.query['pageToken'] = page_token unless page_token.nil?
187
+ command.query['state'] = state unless state.nil?
188
+ command.query['fields'] = fields unless fields.nil?
189
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
190
+ command.query['userIp'] = user_ip unless user_ip.nil?
191
+ execute_or_queue_command(command, &block)
192
+ end
193
+
194
+ # Sets the state of the achievement with the given ID to REVEALED for the
195
+ # currently authenticated player.
196
+ # @param [String] achievement_id
197
+ # The ID of the achievement used by this method.
198
+ # @param [String] fields
199
+ # Selector specifying which fields to include in a partial response.
200
+ # @param [String] quota_user
201
+ # Available to use for quota purposes for server-side applications. Can be any
202
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
203
+ # Overrides userIp if both are provided.
204
+ # @param [String] user_ip
205
+ # IP address of the site where the request originates. Use this if you want to
206
+ # enforce per-user limits.
207
+ # @param [Google::Apis::RequestOptions] options
208
+ # Request-specific options
209
+ #
210
+ # @yield [result, err] Result & error if block supplied
211
+ # @yieldparam result [Google::Apis::GamesV1::AchievementRevealResponse] parsed result object
212
+ # @yieldparam err [StandardError] error object if request failed
213
+ #
214
+ # @return [Google::Apis::GamesV1::AchievementRevealResponse]
215
+ #
216
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
217
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
218
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
219
+ def reveal_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
220
+ command = make_simple_command(:post, 'achievements/{achievementId}/reveal', options)
221
+ command.response_representation = Google::Apis::GamesV1::AchievementRevealResponse::Representation
222
+ command.response_class = Google::Apis::GamesV1::AchievementRevealResponse
223
+ command.params['achievementId'] = achievement_id unless achievement_id.nil?
224
+ command.query['fields'] = fields unless fields.nil?
225
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
226
+ command.query['userIp'] = user_ip unless user_ip.nil?
227
+ execute_or_queue_command(command, &block)
228
+ end
229
+
230
+ # Sets the steps for the currently authenticated player towards unlocking an
231
+ # achievement. If the steps parameter is less than the current number of steps
232
+ # that the player already gained for the achievement, the achievement is not
233
+ # modified.
234
+ # @param [String] achievement_id
235
+ # The ID of the achievement used by this method.
236
+ # @param [Fixnum] steps
237
+ # The minimum value to set the steps to.
238
+ # @param [String] fields
239
+ # Selector specifying which fields to include in a partial response.
240
+ # @param [String] quota_user
241
+ # Available to use for quota purposes for server-side applications. Can be any
242
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
243
+ # Overrides userIp if both are provided.
244
+ # @param [String] user_ip
245
+ # IP address of the site where the request originates. Use this if you want to
246
+ # enforce per-user limits.
247
+ # @param [Google::Apis::RequestOptions] options
248
+ # Request-specific options
249
+ #
250
+ # @yield [result, err] Result & error if block supplied
251
+ # @yieldparam result [Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse] parsed result object
252
+ # @yieldparam err [StandardError] error object if request failed
253
+ #
254
+ # @return [Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse]
255
+ #
256
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
257
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
258
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
259
+ def set_achievement_steps_at_least(achievement_id, steps, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
260
+ command = make_simple_command(:post, 'achievements/{achievementId}/setStepsAtLeast', options)
261
+ command.response_representation = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse::Representation
262
+ command.response_class = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse
263
+ command.params['achievementId'] = achievement_id unless achievement_id.nil?
264
+ command.query['steps'] = steps unless steps.nil?
265
+ command.query['fields'] = fields unless fields.nil?
266
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
267
+ command.query['userIp'] = user_ip unless user_ip.nil?
268
+ execute_or_queue_command(command, &block)
269
+ end
270
+
271
+ # Unlocks this achievement for the currently authenticated player.
272
+ # @param [String] achievement_id
273
+ # The ID of the achievement used by this method.
274
+ # @param [String] fields
275
+ # Selector specifying which fields to include in a partial response.
276
+ # @param [String] quota_user
277
+ # Available to use for quota purposes for server-side applications. Can be any
278
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
279
+ # Overrides userIp if both are provided.
280
+ # @param [String] user_ip
281
+ # IP address of the site where the request originates. Use this if you want to
282
+ # enforce per-user limits.
283
+ # @param [Google::Apis::RequestOptions] options
284
+ # Request-specific options
285
+ #
286
+ # @yield [result, err] Result & error if block supplied
287
+ # @yieldparam result [Google::Apis::GamesV1::AchievementUnlockResponse] parsed result object
288
+ # @yieldparam err [StandardError] error object if request failed
289
+ #
290
+ # @return [Google::Apis::GamesV1::AchievementUnlockResponse]
291
+ #
292
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
293
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
294
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
295
+ def unlock_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
296
+ command = make_simple_command(:post, 'achievements/{achievementId}/unlock', options)
297
+ command.response_representation = Google::Apis::GamesV1::AchievementUnlockResponse::Representation
298
+ command.response_class = Google::Apis::GamesV1::AchievementUnlockResponse
299
+ command.params['achievementId'] = achievement_id unless achievement_id.nil?
300
+ command.query['fields'] = fields unless fields.nil?
301
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
302
+ command.query['userIp'] = user_ip unless user_ip.nil?
303
+ execute_or_queue_command(command, &block)
304
+ end
305
+
306
+ # Updates multiple achievements for the currently authenticated player.
307
+ # @param [Google::Apis::GamesV1::AchievementUpdateMultipleRequest] achievement_update_multiple_request_object
308
+ # @param [String] fields
309
+ # Selector specifying which fields to include in a partial response.
310
+ # @param [String] quota_user
311
+ # Available to use for quota purposes for server-side applications. Can be any
312
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
313
+ # Overrides userIp if both are provided.
314
+ # @param [String] user_ip
315
+ # IP address of the site where the request originates. Use this if you want to
316
+ # enforce per-user limits.
317
+ # @param [Google::Apis::RequestOptions] options
318
+ # Request-specific options
319
+ #
320
+ # @yield [result, err] Result & error if block supplied
321
+ # @yieldparam result [Google::Apis::GamesV1::AchievementUpdateMultipleResponse] parsed result object
322
+ # @yieldparam err [StandardError] error object if request failed
323
+ #
324
+ # @return [Google::Apis::GamesV1::AchievementUpdateMultipleResponse]
325
+ #
326
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
327
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
328
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
329
+ def update_multiple_achievements(achievement_update_multiple_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
330
+ command = make_simple_command(:post, 'achievements/updateMultiple', options)
331
+ command.request_representation = Google::Apis::GamesV1::AchievementUpdateMultipleRequest::Representation
332
+ command.request_object = achievement_update_multiple_request_object
333
+ command.response_representation = Google::Apis::GamesV1::AchievementUpdateMultipleResponse::Representation
334
+ command.response_class = Google::Apis::GamesV1::AchievementUpdateMultipleResponse
335
+ command.query['fields'] = fields unless fields.nil?
336
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
337
+ command.query['userIp'] = user_ip unless user_ip.nil?
338
+ execute_or_queue_command(command, &block)
339
+ end
340
+
341
+ # Retrieves the metadata of the application with the given ID. If the requested
342
+ # application is not available for the specified platformType, the returned
343
+ # response will not include any instance data.
344
+ # @param [String] application_id
345
+ # The application ID from the Google Play developer console.
346
+ # @param [String] language
347
+ # The preferred language to use for strings returned by this method.
348
+ # @param [String] platform_type
349
+ # Restrict application details returned to the specific platform.
350
+ # @param [String] fields
351
+ # Selector specifying which fields to include in a partial response.
352
+ # @param [String] quota_user
353
+ # Available to use for quota purposes for server-side applications. Can be any
354
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
355
+ # Overrides userIp if both are provided.
356
+ # @param [String] user_ip
357
+ # IP address of the site where the request originates. Use this if you want to
358
+ # enforce per-user limits.
359
+ # @param [Google::Apis::RequestOptions] options
360
+ # Request-specific options
361
+ #
362
+ # @yield [result, err] Result & error if block supplied
363
+ # @yieldparam result [Google::Apis::GamesV1::Application] parsed result object
364
+ # @yieldparam err [StandardError] error object if request failed
365
+ #
366
+ # @return [Google::Apis::GamesV1::Application]
367
+ #
368
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
369
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
370
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
371
+ def get_application(application_id, language: nil, platform_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
372
+ command = make_simple_command(:get, 'applications/{applicationId}', options)
373
+ command.response_representation = Google::Apis::GamesV1::Application::Representation
374
+ command.response_class = Google::Apis::GamesV1::Application
375
+ command.params['applicationId'] = application_id unless application_id.nil?
376
+ command.query['language'] = language unless language.nil?
377
+ command.query['platformType'] = platform_type unless platform_type.nil?
378
+ command.query['fields'] = fields unless fields.nil?
379
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
380
+ command.query['userIp'] = user_ip unless user_ip.nil?
381
+ execute_or_queue_command(command, &block)
382
+ end
383
+
384
+ # Indicate that the the currently authenticated user is playing your application.
385
+ # @param [String] fields
386
+ # Selector specifying which fields to include in a partial response.
387
+ # @param [String] quota_user
388
+ # Available to use for quota purposes for server-side applications. Can be any
389
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
390
+ # Overrides userIp if both are provided.
391
+ # @param [String] user_ip
392
+ # IP address of the site where the request originates. Use this if you want to
393
+ # enforce per-user limits.
394
+ # @param [Google::Apis::RequestOptions] options
395
+ # Request-specific options
396
+ #
397
+ # @yield [result, err] Result & error if block supplied
398
+ # @yieldparam result [NilClass] No result returned for this method
399
+ # @yieldparam err [StandardError] error object if request failed
400
+ #
401
+ # @return [void]
402
+ #
403
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
404
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
405
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
406
+ def played_application(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
407
+ command = make_simple_command(:post, 'applications/played', options)
408
+ command.query['fields'] = fields unless fields.nil?
409
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
410
+ command.query['userIp'] = user_ip unless user_ip.nil?
411
+ execute_or_queue_command(command, &block)
412
+ end
413
+
414
+ # Verifies the auth token provided with this request is for the application with
415
+ # the specified ID, and returns the ID of the player it was granted for.
416
+ # @param [String] application_id
417
+ # The application ID from the Google Play developer console.
418
+ # @param [String] fields
419
+ # Selector specifying which fields to include in a partial response.
420
+ # @param [String] quota_user
421
+ # Available to use for quota purposes for server-side applications. Can be any
422
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
423
+ # Overrides userIp if both are provided.
424
+ # @param [String] user_ip
425
+ # IP address of the site where the request originates. Use this if you want to
426
+ # enforce per-user limits.
427
+ # @param [Google::Apis::RequestOptions] options
428
+ # Request-specific options
429
+ #
430
+ # @yield [result, err] Result & error if block supplied
431
+ # @yieldparam result [Google::Apis::GamesV1::ApplicationVerifyResponse] parsed result object
432
+ # @yieldparam err [StandardError] error object if request failed
433
+ #
434
+ # @return [Google::Apis::GamesV1::ApplicationVerifyResponse]
435
+ #
436
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
437
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
438
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
439
+ def verify_application(application_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
440
+ command = make_simple_command(:get, 'applications/{applicationId}/verify', options)
441
+ command.response_representation = Google::Apis::GamesV1::ApplicationVerifyResponse::Representation
442
+ command.response_class = Google::Apis::GamesV1::ApplicationVerifyResponse
443
+ command.params['applicationId'] = application_id unless application_id.nil?
444
+ command.query['fields'] = fields unless fields.nil?
445
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
446
+ command.query['userIp'] = user_ip unless user_ip.nil?
447
+ execute_or_queue_command(command, &block)
448
+ end
449
+
450
+ # Returns a list showing the current progress on events in this application for
451
+ # the currently authenticated user.
452
+ # @param [String] language
453
+ # The preferred language to use for strings returned by this method.
454
+ # @param [Fixnum] max_results
455
+ # The maximum number of events to return in the response, used for paging. For
456
+ # any response, the actual number of events to return may be less than the
457
+ # specified maxResults.
458
+ # @param [String] page_token
459
+ # The token returned by the previous request.
460
+ # @param [String] fields
461
+ # Selector specifying which fields to include in a partial response.
462
+ # @param [String] quota_user
463
+ # Available to use for quota purposes for server-side applications. Can be any
464
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
465
+ # Overrides userIp if both are provided.
466
+ # @param [String] user_ip
467
+ # IP address of the site where the request originates. Use this if you want to
468
+ # enforce per-user limits.
469
+ # @param [Google::Apis::RequestOptions] options
470
+ # Request-specific options
471
+ #
472
+ # @yield [result, err] Result & error if block supplied
473
+ # @yieldparam result [Google::Apis::GamesV1::ListPlayerEventResponse] parsed result object
474
+ # @yieldparam err [StandardError] error object if request failed
475
+ #
476
+ # @return [Google::Apis::GamesV1::ListPlayerEventResponse]
477
+ #
478
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
479
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
480
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
481
+ def list_event_by_player(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
482
+ command = make_simple_command(:get, 'events', options)
483
+ command.response_representation = Google::Apis::GamesV1::ListPlayerEventResponse::Representation
484
+ command.response_class = Google::Apis::GamesV1::ListPlayerEventResponse
485
+ command.query['language'] = language unless language.nil?
486
+ command.query['maxResults'] = max_results unless max_results.nil?
487
+ command.query['pageToken'] = page_token unless page_token.nil?
488
+ command.query['fields'] = fields unless fields.nil?
489
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
490
+ command.query['userIp'] = user_ip unless user_ip.nil?
491
+ execute_or_queue_command(command, &block)
492
+ end
493
+
494
+ # Returns a list of the event definitions in this application.
495
+ # @param [String] language
496
+ # The preferred language to use for strings returned by this method.
497
+ # @param [Fixnum] max_results
498
+ # The maximum number of event definitions to return in the response, used for
499
+ # paging. For any response, the actual number of event definitions to return may
500
+ # be less than the specified maxResults.
501
+ # @param [String] page_token
502
+ # The token returned by the previous request.
503
+ # @param [String] fields
504
+ # Selector specifying which fields to include in a partial response.
505
+ # @param [String] quota_user
506
+ # Available to use for quota purposes for server-side applications. Can be any
507
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
508
+ # Overrides userIp if both are provided.
509
+ # @param [String] user_ip
510
+ # IP address of the site where the request originates. Use this if you want to
511
+ # enforce per-user limits.
512
+ # @param [Google::Apis::RequestOptions] options
513
+ # Request-specific options
514
+ #
515
+ # @yield [result, err] Result & error if block supplied
516
+ # @yieldparam result [Google::Apis::GamesV1::ListEventDefinitionResponse] parsed result object
517
+ # @yieldparam err [StandardError] error object if request failed
518
+ #
519
+ # @return [Google::Apis::GamesV1::ListEventDefinitionResponse]
520
+ #
521
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
522
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
523
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
524
+ def list_event_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
525
+ command = make_simple_command(:get, 'eventDefinitions', options)
526
+ command.response_representation = Google::Apis::GamesV1::ListEventDefinitionResponse::Representation
527
+ command.response_class = Google::Apis::GamesV1::ListEventDefinitionResponse
528
+ command.query['language'] = language unless language.nil?
529
+ command.query['maxResults'] = max_results unless max_results.nil?
530
+ command.query['pageToken'] = page_token unless page_token.nil?
531
+ command.query['fields'] = fields unless fields.nil?
532
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
533
+ command.query['userIp'] = user_ip unless user_ip.nil?
534
+ execute_or_queue_command(command, &block)
535
+ end
536
+
537
+ # Records a batch of changes to the number of times events have occurred for the
538
+ # currently authenticated user of this application.
539
+ # @param [Google::Apis::GamesV1::EventRecordRequest] event_record_request_object
540
+ # @param [String] language
541
+ # The preferred language to use for strings returned by this method.
542
+ # @param [String] fields
543
+ # Selector specifying which fields to include in a partial response.
544
+ # @param [String] quota_user
545
+ # Available to use for quota purposes for server-side applications. Can be any
546
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
547
+ # Overrides userIp if both are provided.
548
+ # @param [String] user_ip
549
+ # IP address of the site where the request originates. Use this if you want to
550
+ # enforce per-user limits.
551
+ # @param [Google::Apis::RequestOptions] options
552
+ # Request-specific options
553
+ #
554
+ # @yield [result, err] Result & error if block supplied
555
+ # @yieldparam result [Google::Apis::GamesV1::UpdateEventResponse] parsed result object
556
+ # @yieldparam err [StandardError] error object if request failed
557
+ #
558
+ # @return [Google::Apis::GamesV1::UpdateEventResponse]
559
+ #
560
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
561
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
562
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
563
+ def record_event(event_record_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
564
+ command = make_simple_command(:post, 'events', options)
565
+ command.request_representation = Google::Apis::GamesV1::EventRecordRequest::Representation
566
+ command.request_object = event_record_request_object
567
+ command.response_representation = Google::Apis::GamesV1::UpdateEventResponse::Representation
568
+ command.response_class = Google::Apis::GamesV1::UpdateEventResponse
569
+ command.query['language'] = language unless language.nil?
570
+ command.query['fields'] = fields unless fields.nil?
571
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
572
+ command.query['userIp'] = user_ip unless user_ip.nil?
573
+ execute_or_queue_command(command, &block)
574
+ end
575
+
576
+ # Retrieves the metadata of the leaderboard with the given ID.
577
+ # @param [String] leaderboard_id
578
+ # The ID of the leaderboard.
579
+ # @param [String] language
580
+ # The preferred language to use for strings returned by this method.
581
+ # @param [String] fields
582
+ # Selector specifying which fields to include in a partial response.
583
+ # @param [String] quota_user
584
+ # Available to use for quota purposes for server-side applications. Can be any
585
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
586
+ # Overrides userIp if both are provided.
587
+ # @param [String] user_ip
588
+ # IP address of the site where the request originates. Use this if you want to
589
+ # enforce per-user limits.
590
+ # @param [Google::Apis::RequestOptions] options
591
+ # Request-specific options
592
+ #
593
+ # @yield [result, err] Result & error if block supplied
594
+ # @yieldparam result [Google::Apis::GamesV1::Leaderboard] parsed result object
595
+ # @yieldparam err [StandardError] error object if request failed
596
+ #
597
+ # @return [Google::Apis::GamesV1::Leaderboard]
598
+ #
599
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
600
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
601
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
602
+ def get_leaderboard(leaderboard_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
603
+ command = make_simple_command(:get, 'leaderboards/{leaderboardId}', options)
604
+ command.response_representation = Google::Apis::GamesV1::Leaderboard::Representation
605
+ command.response_class = Google::Apis::GamesV1::Leaderboard
606
+ command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
607
+ command.query['language'] = language unless language.nil?
608
+ command.query['fields'] = fields unless fields.nil?
609
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
610
+ command.query['userIp'] = user_ip unless user_ip.nil?
611
+ execute_or_queue_command(command, &block)
612
+ end
613
+
614
+ # Lists all the leaderboard metadata for your application.
615
+ # @param [String] language
616
+ # The preferred language to use for strings returned by this method.
617
+ # @param [Fixnum] max_results
618
+ # The maximum number of leaderboards to return in the response. For any response,
619
+ # the actual number of leaderboards returned may be less than the specified
620
+ # maxResults.
621
+ # @param [String] page_token
622
+ # The token returned by the previous request.
623
+ # @param [String] fields
624
+ # Selector specifying which fields to include in a partial response.
625
+ # @param [String] quota_user
626
+ # Available to use for quota purposes for server-side applications. Can be any
627
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
628
+ # Overrides userIp if both are provided.
629
+ # @param [String] user_ip
630
+ # IP address of the site where the request originates. Use this if you want to
631
+ # enforce per-user limits.
632
+ # @param [Google::Apis::RequestOptions] options
633
+ # Request-specific options
634
+ #
635
+ # @yield [result, err] Result & error if block supplied
636
+ # @yieldparam result [Google::Apis::GamesV1::ListLeaderboardResponse] parsed result object
637
+ # @yieldparam err [StandardError] error object if request failed
638
+ #
639
+ # @return [Google::Apis::GamesV1::ListLeaderboardResponse]
640
+ #
641
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
642
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
643
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
644
+ def list_leaderboards(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
645
+ command = make_simple_command(:get, 'leaderboards', options)
646
+ command.response_representation = Google::Apis::GamesV1::ListLeaderboardResponse::Representation
647
+ command.response_class = Google::Apis::GamesV1::ListLeaderboardResponse
648
+ command.query['language'] = language unless language.nil?
649
+ command.query['maxResults'] = max_results unless max_results.nil?
650
+ command.query['pageToken'] = page_token unless page_token.nil?
651
+ command.query['fields'] = fields unless fields.nil?
652
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
653
+ command.query['userIp'] = user_ip unless user_ip.nil?
654
+ execute_or_queue_command(command, &block)
655
+ end
656
+
657
+ # Return the metagame configuration data for the calling application.
658
+ # @param [String] fields
659
+ # Selector specifying which fields to include in a partial response.
660
+ # @param [String] quota_user
661
+ # Available to use for quota purposes for server-side applications. Can be any
662
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
663
+ # Overrides userIp if both are provided.
664
+ # @param [String] user_ip
665
+ # IP address of the site where the request originates. Use this if you want to
666
+ # enforce per-user limits.
667
+ # @param [Google::Apis::RequestOptions] options
668
+ # Request-specific options
669
+ #
670
+ # @yield [result, err] Result & error if block supplied
671
+ # @yieldparam result [Google::Apis::GamesV1::MetagameConfig] parsed result object
672
+ # @yieldparam err [StandardError] error object if request failed
673
+ #
674
+ # @return [Google::Apis::GamesV1::MetagameConfig]
675
+ #
676
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
677
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
678
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
679
+ def get_metagame_config(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
680
+ command = make_simple_command(:get, 'metagameConfig', options)
681
+ command.response_representation = Google::Apis::GamesV1::MetagameConfig::Representation
682
+ command.response_class = Google::Apis::GamesV1::MetagameConfig
683
+ command.query['fields'] = fields unless fields.nil?
684
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
685
+ command.query['userIp'] = user_ip unless user_ip.nil?
686
+ execute_or_queue_command(command, &block)
687
+ end
688
+
689
+ # List play data aggregated per category for the player corresponding to
690
+ # playerId.
691
+ # @param [String] player_id
692
+ # A player ID. A value of me may be used in place of the authenticated player's
693
+ # ID.
694
+ # @param [String] collection
695
+ # The collection of categories for which data will be returned.
696
+ # @param [String] language
697
+ # The preferred language to use for strings returned by this method.
698
+ # @param [Fixnum] max_results
699
+ # The maximum number of category resources to return in the response, used for
700
+ # paging. For any response, the actual number of category resources returned may
701
+ # be less than the specified maxResults.
702
+ # @param [String] page_token
703
+ # The token returned by the previous request.
704
+ # @param [String] fields
705
+ # Selector specifying which fields to include in a partial response.
706
+ # @param [String] quota_user
707
+ # Available to use for quota purposes for server-side applications. Can be any
708
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
709
+ # Overrides userIp if both are provided.
710
+ # @param [String] user_ip
711
+ # IP address of the site where the request originates. Use this if you want to
712
+ # enforce per-user limits.
713
+ # @param [Google::Apis::RequestOptions] options
714
+ # Request-specific options
715
+ #
716
+ # @yield [result, err] Result & error if block supplied
717
+ # @yieldparam result [Google::Apis::GamesV1::ListCategoryResponse] parsed result object
718
+ # @yieldparam err [StandardError] error object if request failed
719
+ #
720
+ # @return [Google::Apis::GamesV1::ListCategoryResponse]
721
+ #
722
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
723
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
724
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
725
+ def list_metagame_categories_by_player(player_id, collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
726
+ command = make_simple_command(:get, 'players/{playerId}/categories/{collection}', options)
727
+ command.response_representation = Google::Apis::GamesV1::ListCategoryResponse::Representation
728
+ command.response_class = Google::Apis::GamesV1::ListCategoryResponse
729
+ command.params['playerId'] = player_id unless player_id.nil?
730
+ command.params['collection'] = collection unless collection.nil?
731
+ command.query['language'] = language unless language.nil?
732
+ command.query['maxResults'] = max_results unless max_results.nil?
733
+ command.query['pageToken'] = page_token unless page_token.nil?
734
+ command.query['fields'] = fields unless fields.nil?
735
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
736
+ command.query['userIp'] = user_ip unless user_ip.nil?
737
+ execute_or_queue_command(command, &block)
738
+ end
739
+
740
+ # Retrieves the Player resource with the given ID. To retrieve the player for
741
+ # the currently authenticated user, set playerId to me.
742
+ # @param [String] player_id
743
+ # A player ID. A value of me may be used in place of the authenticated player's
744
+ # ID.
745
+ # @param [String] language
746
+ # The preferred language to use for strings returned by this method.
747
+ # @param [String] fields
748
+ # Selector specifying which fields to include in a partial response.
749
+ # @param [String] quota_user
750
+ # Available to use for quota purposes for server-side applications. Can be any
751
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
752
+ # Overrides userIp if both are provided.
753
+ # @param [String] user_ip
754
+ # IP address of the site where the request originates. Use this if you want to
755
+ # enforce per-user limits.
756
+ # @param [Google::Apis::RequestOptions] options
757
+ # Request-specific options
758
+ #
759
+ # @yield [result, err] Result & error if block supplied
760
+ # @yieldparam result [Google::Apis::GamesV1::Player] parsed result object
761
+ # @yieldparam err [StandardError] error object if request failed
762
+ #
763
+ # @return [Google::Apis::GamesV1::Player]
764
+ #
765
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
766
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
767
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
768
+ def get_player(player_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
769
+ command = make_simple_command(:get, 'players/{playerId}', options)
770
+ command.response_representation = Google::Apis::GamesV1::Player::Representation
771
+ command.response_class = Google::Apis::GamesV1::Player
772
+ command.params['playerId'] = player_id unless player_id.nil?
773
+ command.query['language'] = language unless language.nil?
774
+ command.query['fields'] = fields unless fields.nil?
775
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
776
+ command.query['userIp'] = user_ip unless user_ip.nil?
777
+ execute_or_queue_command(command, &block)
778
+ end
779
+
780
+ # Get the collection of players for the currently authenticated user.
781
+ # @param [String] collection
782
+ # Collection of players being retrieved
783
+ # @param [String] language
784
+ # The preferred language to use for strings returned by this method.
785
+ # @param [Fixnum] max_results
786
+ # The maximum number of player resources to return in the response, used for
787
+ # paging. For any response, the actual number of player resources returned may
788
+ # be less than the specified maxResults.
789
+ # @param [String] page_token
790
+ # The token returned by the previous request.
791
+ # @param [String] fields
792
+ # Selector specifying which fields to include in a partial response.
793
+ # @param [String] quota_user
794
+ # Available to use for quota purposes for server-side applications. Can be any
795
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
796
+ # Overrides userIp if both are provided.
797
+ # @param [String] user_ip
798
+ # IP address of the site where the request originates. Use this if you want to
799
+ # enforce per-user limits.
800
+ # @param [Google::Apis::RequestOptions] options
801
+ # Request-specific options
802
+ #
803
+ # @yield [result, err] Result & error if block supplied
804
+ # @yieldparam result [Google::Apis::GamesV1::ListPlayerResponse] parsed result object
805
+ # @yieldparam err [StandardError] error object if request failed
806
+ #
807
+ # @return [Google::Apis::GamesV1::ListPlayerResponse]
808
+ #
809
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
810
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
811
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
812
+ def list_players(collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
813
+ command = make_simple_command(:get, 'players/me/players/{collection}', options)
814
+ command.response_representation = Google::Apis::GamesV1::ListPlayerResponse::Representation
815
+ command.response_class = Google::Apis::GamesV1::ListPlayerResponse
816
+ command.params['collection'] = collection unless collection.nil?
817
+ command.query['language'] = language unless language.nil?
818
+ command.query['maxResults'] = max_results unless max_results.nil?
819
+ command.query['pageToken'] = page_token unless page_token.nil?
820
+ command.query['fields'] = fields unless fields.nil?
821
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
822
+ command.query['userIp'] = user_ip unless user_ip.nil?
823
+ execute_or_queue_command(command, &block)
824
+ end
825
+
826
+ # Removes a push token for the current user and application. Removing a non-
827
+ # existent push token will report success.
828
+ # @param [Google::Apis::GamesV1::PushTokenId] push_token_id_object
829
+ # @param [String] fields
830
+ # Selector specifying which fields to include in a partial response.
831
+ # @param [String] quota_user
832
+ # Available to use for quota purposes for server-side applications. Can be any
833
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
834
+ # Overrides userIp if both are provided.
835
+ # @param [String] user_ip
836
+ # IP address of the site where the request originates. Use this if you want to
837
+ # enforce per-user limits.
838
+ # @param [Google::Apis::RequestOptions] options
839
+ # Request-specific options
840
+ #
841
+ # @yield [result, err] Result & error if block supplied
842
+ # @yieldparam result [NilClass] No result returned for this method
843
+ # @yieldparam err [StandardError] error object if request failed
844
+ #
845
+ # @return [void]
846
+ #
847
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
848
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
849
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
850
+ def remove_pushtoken(push_token_id_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
851
+ command = make_simple_command(:post, 'pushtokens/remove', options)
852
+ command.request_representation = Google::Apis::GamesV1::PushTokenId::Representation
853
+ command.request_object = push_token_id_object
854
+ command.query['fields'] = fields unless fields.nil?
855
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
856
+ command.query['userIp'] = user_ip unless user_ip.nil?
857
+ execute_or_queue_command(command, &block)
858
+ end
859
+
860
+ # Registers a push token for the current user and application.
861
+ # @param [Google::Apis::GamesV1::PushToken] push_token_object
862
+ # @param [String] fields
863
+ # Selector specifying which fields to include in a partial response.
864
+ # @param [String] quota_user
865
+ # Available to use for quota purposes for server-side applications. Can be any
866
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
867
+ # Overrides userIp if both are provided.
868
+ # @param [String] user_ip
869
+ # IP address of the site where the request originates. Use this if you want to
870
+ # enforce per-user limits.
871
+ # @param [Google::Apis::RequestOptions] options
872
+ # Request-specific options
873
+ #
874
+ # @yield [result, err] Result & error if block supplied
875
+ # @yieldparam result [NilClass] No result returned for this method
876
+ # @yieldparam err [StandardError] error object if request failed
877
+ #
878
+ # @return [void]
879
+ #
880
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
881
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
882
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
883
+ def update_pushtoken(push_token_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
884
+ command = make_simple_command(:put, 'pushtokens', options)
885
+ command.request_representation = Google::Apis::GamesV1::PushToken::Representation
886
+ command.request_object = push_token_object
887
+ command.query['fields'] = fields unless fields.nil?
888
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
889
+ command.query['userIp'] = user_ip unless user_ip.nil?
890
+ execute_or_queue_command(command, &block)
891
+ end
892
+
893
+ # Report that a reward for the milestone corresponding to milestoneId for the
894
+ # quest corresponding to questId has been claimed by the currently authorized
895
+ # user.
896
+ # @param [String] quest_id
897
+ # The ID of the quest.
898
+ # @param [String] milestone_id
899
+ # The ID of the milestone.
900
+ # @param [String] request_id
901
+ # A numeric ID to ensure that the request is handled correctly across retries.
902
+ # Your client application must generate this ID randomly.
903
+ # @param [String] fields
904
+ # Selector specifying which fields to include in a partial response.
905
+ # @param [String] quota_user
906
+ # Available to use for quota purposes for server-side applications. Can be any
907
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
908
+ # Overrides userIp if both are provided.
909
+ # @param [String] user_ip
910
+ # IP address of the site where the request originates. Use this if you want to
911
+ # enforce per-user limits.
912
+ # @param [Google::Apis::RequestOptions] options
913
+ # Request-specific options
914
+ #
915
+ # @yield [result, err] Result & error if block supplied
916
+ # @yieldparam result [NilClass] No result returned for this method
917
+ # @yieldparam err [StandardError] error object if request failed
918
+ #
919
+ # @return [void]
920
+ #
921
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
922
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
923
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
924
+ def claim_quest_milestone(quest_id, milestone_id, request_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
925
+ command = make_simple_command(:put, 'quests/{questId}/milestones/{milestoneId}/claim', options)
926
+ command.params['questId'] = quest_id unless quest_id.nil?
927
+ command.params['milestoneId'] = milestone_id unless milestone_id.nil?
928
+ command.query['requestId'] = request_id unless request_id.nil?
929
+ command.query['fields'] = fields unless fields.nil?
930
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
931
+ command.query['userIp'] = user_ip unless user_ip.nil?
932
+ execute_or_queue_command(command, &block)
933
+ end
934
+
935
+ # Indicates that the currently authorized user will participate in the quest.
936
+ # @param [String] quest_id
937
+ # The ID of the quest.
938
+ # @param [String] language
939
+ # The preferred language to use for strings returned by this method.
940
+ # @param [String] fields
941
+ # Selector specifying which fields to include in a partial response.
942
+ # @param [String] quota_user
943
+ # Available to use for quota purposes for server-side applications. Can be any
944
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
945
+ # Overrides userIp if both are provided.
946
+ # @param [String] user_ip
947
+ # IP address of the site where the request originates. Use this if you want to
948
+ # enforce per-user limits.
949
+ # @param [Google::Apis::RequestOptions] options
950
+ # Request-specific options
951
+ #
952
+ # @yield [result, err] Result & error if block supplied
953
+ # @yieldparam result [Google::Apis::GamesV1::Quest] parsed result object
954
+ # @yieldparam err [StandardError] error object if request failed
955
+ #
956
+ # @return [Google::Apis::GamesV1::Quest]
957
+ #
958
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
959
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
960
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
961
+ def accept_quest(quest_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
962
+ command = make_simple_command(:post, 'quests/{questId}/accept', options)
963
+ command.response_representation = Google::Apis::GamesV1::Quest::Representation
964
+ command.response_class = Google::Apis::GamesV1::Quest
965
+ command.params['questId'] = quest_id unless quest_id.nil?
966
+ command.query['language'] = language unless language.nil?
967
+ command.query['fields'] = fields unless fields.nil?
968
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
969
+ command.query['userIp'] = user_ip unless user_ip.nil?
970
+ execute_or_queue_command(command, &block)
971
+ end
972
+
973
+ # Get a list of quests for your application and the currently authenticated
974
+ # player.
975
+ # @param [String] player_id
976
+ # A player ID. A value of me may be used in place of the authenticated player's
977
+ # ID.
978
+ # @param [String] language
979
+ # The preferred language to use for strings returned by this method.
980
+ # @param [Fixnum] max_results
981
+ # The maximum number of quest resources to return in the response, used for
982
+ # paging. For any response, the actual number of quest resources returned may be
983
+ # less than the specified maxResults. Acceptable values are 1 to 50, inclusive. (
984
+ # Default: 50).
985
+ # @param [String] page_token
986
+ # The token returned by the previous request.
987
+ # @param [String] fields
988
+ # Selector specifying which fields to include in a partial response.
989
+ # @param [String] quota_user
990
+ # Available to use for quota purposes for server-side applications. Can be any
991
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
992
+ # Overrides userIp if both are provided.
993
+ # @param [String] user_ip
994
+ # IP address of the site where the request originates. Use this if you want to
995
+ # enforce per-user limits.
996
+ # @param [Google::Apis::RequestOptions] options
997
+ # Request-specific options
998
+ #
999
+ # @yield [result, err] Result & error if block supplied
1000
+ # @yieldparam result [Google::Apis::GamesV1::ListQuestResponse] parsed result object
1001
+ # @yieldparam err [StandardError] error object if request failed
1002
+ #
1003
+ # @return [Google::Apis::GamesV1::ListQuestResponse]
1004
+ #
1005
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1006
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1007
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1008
+ def list_quests(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1009
+ command = make_simple_command(:get, 'players/{playerId}/quests', options)
1010
+ command.response_representation = Google::Apis::GamesV1::ListQuestResponse::Representation
1011
+ command.response_class = Google::Apis::GamesV1::ListQuestResponse
1012
+ command.params['playerId'] = player_id unless player_id.nil?
1013
+ command.query['language'] = language unless language.nil?
1014
+ command.query['maxResults'] = max_results unless max_results.nil?
1015
+ command.query['pageToken'] = page_token unless page_token.nil?
1016
+ command.query['fields'] = fields unless fields.nil?
1017
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1018
+ command.query['userIp'] = user_ip unless user_ip.nil?
1019
+ execute_or_queue_command(command, &block)
1020
+ end
1021
+
1022
+ # Checks whether the games client is out of date.
1023
+ # @param [String] client_revision
1024
+ # The revision of the client SDK used by your application. Format:
1025
+ # [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are:
1026
+ #
1027
+ # - "ANDROID" - Client is running the Android SDK.
1028
+ # - "IOS" - Client is running the iOS SDK.
1029
+ # - "WEB_APP" - Client is running as a Web App.
1030
+ # @param [String] fields
1031
+ # Selector specifying which fields to include in a partial response.
1032
+ # @param [String] quota_user
1033
+ # Available to use for quota purposes for server-side applications. Can be any
1034
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1035
+ # Overrides userIp if both are provided.
1036
+ # @param [String] user_ip
1037
+ # IP address of the site where the request originates. Use this if you want to
1038
+ # enforce per-user limits.
1039
+ # @param [Google::Apis::RequestOptions] options
1040
+ # Request-specific options
1041
+ #
1042
+ # @yield [result, err] Result & error if block supplied
1043
+ # @yieldparam result [Google::Apis::GamesV1::CheckRevisionResponse] parsed result object
1044
+ # @yieldparam err [StandardError] error object if request failed
1045
+ #
1046
+ # @return [Google::Apis::GamesV1::CheckRevisionResponse]
1047
+ #
1048
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1049
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1050
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1051
+ def check_revision(client_revision, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1052
+ command = make_simple_command(:get, 'revisions/check', options)
1053
+ command.response_representation = Google::Apis::GamesV1::CheckRevisionResponse::Representation
1054
+ command.response_class = Google::Apis::GamesV1::CheckRevisionResponse
1055
+ command.query['clientRevision'] = client_revision unless client_revision.nil?
1056
+ command.query['fields'] = fields unless fields.nil?
1057
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1058
+ command.query['userIp'] = user_ip unless user_ip.nil?
1059
+ execute_or_queue_command(command, &block)
1060
+ end
1061
+
1062
+ # Create a room. For internal use by the Games SDK only. Calling this method
1063
+ # directly is unsupported.
1064
+ # @param [Google::Apis::GamesV1::CreateRoomRequest] create_room_request_object
1065
+ # @param [String] language
1066
+ # The preferred language to use for strings returned by this method.
1067
+ # @param [String] fields
1068
+ # Selector specifying which fields to include in a partial response.
1069
+ # @param [String] quota_user
1070
+ # Available to use for quota purposes for server-side applications. Can be any
1071
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1072
+ # Overrides userIp if both are provided.
1073
+ # @param [String] user_ip
1074
+ # IP address of the site where the request originates. Use this if you want to
1075
+ # enforce per-user limits.
1076
+ # @param [Google::Apis::RequestOptions] options
1077
+ # Request-specific options
1078
+ #
1079
+ # @yield [result, err] Result & error if block supplied
1080
+ # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object
1081
+ # @yieldparam err [StandardError] error object if request failed
1082
+ #
1083
+ # @return [Google::Apis::GamesV1::Room]
1084
+ #
1085
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1086
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1087
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1088
+ def create_room(create_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1089
+ command = make_simple_command(:post, 'rooms/create', options)
1090
+ command.request_representation = Google::Apis::GamesV1::CreateRoomRequest::Representation
1091
+ command.request_object = create_room_request_object
1092
+ command.response_representation = Google::Apis::GamesV1::Room::Representation
1093
+ command.response_class = Google::Apis::GamesV1::Room
1094
+ command.query['language'] = language unless language.nil?
1095
+ command.query['fields'] = fields unless fields.nil?
1096
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1097
+ command.query['userIp'] = user_ip unless user_ip.nil?
1098
+ execute_or_queue_command(command, &block)
1099
+ end
1100
+
1101
+ # Decline an invitation to join a room. For internal use by the Games SDK only.
1102
+ # Calling this method directly is unsupported.
1103
+ # @param [String] room_id
1104
+ # The ID of the room.
1105
+ # @param [String] language
1106
+ # The preferred language to use for strings returned by this method.
1107
+ # @param [String] fields
1108
+ # Selector specifying which fields to include in a partial response.
1109
+ # @param [String] quota_user
1110
+ # Available to use for quota purposes for server-side applications. Can be any
1111
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1112
+ # Overrides userIp if both are provided.
1113
+ # @param [String] user_ip
1114
+ # IP address of the site where the request originates. Use this if you want to
1115
+ # enforce per-user limits.
1116
+ # @param [Google::Apis::RequestOptions] options
1117
+ # Request-specific options
1118
+ #
1119
+ # @yield [result, err] Result & error if block supplied
1120
+ # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object
1121
+ # @yieldparam err [StandardError] error object if request failed
1122
+ #
1123
+ # @return [Google::Apis::GamesV1::Room]
1124
+ #
1125
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1126
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1127
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1128
+ def decline_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1129
+ command = make_simple_command(:post, 'rooms/{roomId}/decline', options)
1130
+ command.response_representation = Google::Apis::GamesV1::Room::Representation
1131
+ command.response_class = Google::Apis::GamesV1::Room
1132
+ command.params['roomId'] = room_id unless room_id.nil?
1133
+ command.query['language'] = language unless language.nil?
1134
+ command.query['fields'] = fields unless fields.nil?
1135
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1136
+ command.query['userIp'] = user_ip unless user_ip.nil?
1137
+ execute_or_queue_command(command, &block)
1138
+ end
1139
+
1140
+ # Dismiss an invitation to join a room. For internal use by the Games SDK only.
1141
+ # Calling this method directly is unsupported.
1142
+ # @param [String] room_id
1143
+ # The ID of the room.
1144
+ # @param [String] fields
1145
+ # Selector specifying which fields to include in a partial response.
1146
+ # @param [String] quota_user
1147
+ # Available to use for quota purposes for server-side applications. Can be any
1148
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1149
+ # Overrides userIp if both are provided.
1150
+ # @param [String] user_ip
1151
+ # IP address of the site where the request originates. Use this if you want to
1152
+ # enforce per-user limits.
1153
+ # @param [Google::Apis::RequestOptions] options
1154
+ # Request-specific options
1155
+ #
1156
+ # @yield [result, err] Result & error if block supplied
1157
+ # @yieldparam result [NilClass] No result returned for this method
1158
+ # @yieldparam err [StandardError] error object if request failed
1159
+ #
1160
+ # @return [void]
1161
+ #
1162
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1163
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1164
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1165
+ def dismiss_room(room_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1166
+ command = make_simple_command(:post, 'rooms/{roomId}/dismiss', options)
1167
+ command.params['roomId'] = room_id unless room_id.nil?
1168
+ command.query['fields'] = fields unless fields.nil?
1169
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1170
+ command.query['userIp'] = user_ip unless user_ip.nil?
1171
+ execute_or_queue_command(command, &block)
1172
+ end
1173
+
1174
+ # Get the data for a room.
1175
+ # @param [String] room_id
1176
+ # The ID of the room.
1177
+ # @param [String] language
1178
+ # The preferred language to use for strings returned by this method.
1179
+ # @param [String] fields
1180
+ # Selector specifying which fields to include in a partial response.
1181
+ # @param [String] quota_user
1182
+ # Available to use for quota purposes for server-side applications. Can be any
1183
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1184
+ # Overrides userIp if both are provided.
1185
+ # @param [String] user_ip
1186
+ # IP address of the site where the request originates. Use this if you want to
1187
+ # enforce per-user limits.
1188
+ # @param [Google::Apis::RequestOptions] options
1189
+ # Request-specific options
1190
+ #
1191
+ # @yield [result, err] Result & error if block supplied
1192
+ # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object
1193
+ # @yieldparam err [StandardError] error object if request failed
1194
+ #
1195
+ # @return [Google::Apis::GamesV1::Room]
1196
+ #
1197
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1198
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1199
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1200
+ def get_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1201
+ command = make_simple_command(:get, 'rooms/{roomId}', options)
1202
+ command.response_representation = Google::Apis::GamesV1::Room::Representation
1203
+ command.response_class = Google::Apis::GamesV1::Room
1204
+ command.params['roomId'] = room_id unless room_id.nil?
1205
+ command.query['language'] = language unless language.nil?
1206
+ command.query['fields'] = fields unless fields.nil?
1207
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1208
+ command.query['userIp'] = user_ip unless user_ip.nil?
1209
+ execute_or_queue_command(command, &block)
1210
+ end
1211
+
1212
+ # Join a room. For internal use by the Games SDK only. Calling this method
1213
+ # directly is unsupported.
1214
+ # @param [String] room_id
1215
+ # The ID of the room.
1216
+ # @param [Google::Apis::GamesV1::JoinRoomRequest] join_room_request_object
1217
+ # @param [String] language
1218
+ # The preferred language to use for strings returned by this method.
1219
+ # @param [String] fields
1220
+ # Selector specifying which fields to include in a partial response.
1221
+ # @param [String] quota_user
1222
+ # Available to use for quota purposes for server-side applications. Can be any
1223
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1224
+ # Overrides userIp if both are provided.
1225
+ # @param [String] user_ip
1226
+ # IP address of the site where the request originates. Use this if you want to
1227
+ # enforce per-user limits.
1228
+ # @param [Google::Apis::RequestOptions] options
1229
+ # Request-specific options
1230
+ #
1231
+ # @yield [result, err] Result & error if block supplied
1232
+ # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object
1233
+ # @yieldparam err [StandardError] error object if request failed
1234
+ #
1235
+ # @return [Google::Apis::GamesV1::Room]
1236
+ #
1237
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1238
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1239
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1240
+ def join_room(room_id, join_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1241
+ command = make_simple_command(:post, 'rooms/{roomId}/join', options)
1242
+ command.request_representation = Google::Apis::GamesV1::JoinRoomRequest::Representation
1243
+ command.request_object = join_room_request_object
1244
+ command.response_representation = Google::Apis::GamesV1::Room::Representation
1245
+ command.response_class = Google::Apis::GamesV1::Room
1246
+ command.params['roomId'] = room_id unless room_id.nil?
1247
+ command.query['language'] = language unless language.nil?
1248
+ command.query['fields'] = fields unless fields.nil?
1249
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1250
+ command.query['userIp'] = user_ip unless user_ip.nil?
1251
+ execute_or_queue_command(command, &block)
1252
+ end
1253
+
1254
+ # Leave a room. For internal use by the Games SDK only. Calling this method
1255
+ # directly is unsupported.
1256
+ # @param [String] room_id
1257
+ # The ID of the room.
1258
+ # @param [Google::Apis::GamesV1::LeaveRoomRequest] leave_room_request_object
1259
+ # @param [String] language
1260
+ # The preferred language to use for strings returned by this method.
1261
+ # @param [String] fields
1262
+ # Selector specifying which fields to include in a partial response.
1263
+ # @param [String] quota_user
1264
+ # Available to use for quota purposes for server-side applications. Can be any
1265
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1266
+ # Overrides userIp if both are provided.
1267
+ # @param [String] user_ip
1268
+ # IP address of the site where the request originates. Use this if you want to
1269
+ # enforce per-user limits.
1270
+ # @param [Google::Apis::RequestOptions] options
1271
+ # Request-specific options
1272
+ #
1273
+ # @yield [result, err] Result & error if block supplied
1274
+ # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object
1275
+ # @yieldparam err [StandardError] error object if request failed
1276
+ #
1277
+ # @return [Google::Apis::GamesV1::Room]
1278
+ #
1279
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1280
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1281
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1282
+ def leave_room(room_id, leave_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1283
+ command = make_simple_command(:post, 'rooms/{roomId}/leave', options)
1284
+ command.request_representation = Google::Apis::GamesV1::LeaveRoomRequest::Representation
1285
+ command.request_object = leave_room_request_object
1286
+ command.response_representation = Google::Apis::GamesV1::Room::Representation
1287
+ command.response_class = Google::Apis::GamesV1::Room
1288
+ command.params['roomId'] = room_id unless room_id.nil?
1289
+ command.query['language'] = language unless language.nil?
1290
+ command.query['fields'] = fields unless fields.nil?
1291
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1292
+ command.query['userIp'] = user_ip unless user_ip.nil?
1293
+ execute_or_queue_command(command, &block)
1294
+ end
1295
+
1296
+ # Returns invitations to join rooms.
1297
+ # @param [String] language
1298
+ # The preferred language to use for strings returned by this method.
1299
+ # @param [Fixnum] max_results
1300
+ # The maximum number of rooms to return in the response, used for paging. For
1301
+ # any response, the actual number of rooms to return may be less than the
1302
+ # specified maxResults.
1303
+ # @param [String] page_token
1304
+ # The token returned by the previous request.
1305
+ # @param [String] fields
1306
+ # Selector specifying which fields to include in a partial response.
1307
+ # @param [String] quota_user
1308
+ # Available to use for quota purposes for server-side applications. Can be any
1309
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1310
+ # Overrides userIp if both are provided.
1311
+ # @param [String] user_ip
1312
+ # IP address of the site where the request originates. Use this if you want to
1313
+ # enforce per-user limits.
1314
+ # @param [Google::Apis::RequestOptions] options
1315
+ # Request-specific options
1316
+ #
1317
+ # @yield [result, err] Result & error if block supplied
1318
+ # @yieldparam result [Google::Apis::GamesV1::RoomList] parsed result object
1319
+ # @yieldparam err [StandardError] error object if request failed
1320
+ #
1321
+ # @return [Google::Apis::GamesV1::RoomList]
1322
+ #
1323
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1324
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1325
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1326
+ def list_rooms(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1327
+ command = make_simple_command(:get, 'rooms', options)
1328
+ command.response_representation = Google::Apis::GamesV1::RoomList::Representation
1329
+ command.response_class = Google::Apis::GamesV1::RoomList
1330
+ command.query['language'] = language unless language.nil?
1331
+ command.query['maxResults'] = max_results unless max_results.nil?
1332
+ command.query['pageToken'] = page_token unless page_token.nil?
1333
+ command.query['fields'] = fields unless fields.nil?
1334
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1335
+ command.query['userIp'] = user_ip unless user_ip.nil?
1336
+ execute_or_queue_command(command, &block)
1337
+ end
1338
+
1339
+ # Updates sent by a client reporting the status of peers in a room. For internal
1340
+ # use by the Games SDK only. Calling this method directly is unsupported.
1341
+ # @param [String] room_id
1342
+ # The ID of the room.
1343
+ # @param [Google::Apis::GamesV1::RoomP2PStatuses] room_p2_p_statuses_object
1344
+ # @param [String] language
1345
+ # The preferred language to use for strings returned by this method.
1346
+ # @param [String] fields
1347
+ # Selector specifying which fields to include in a partial response.
1348
+ # @param [String] quota_user
1349
+ # Available to use for quota purposes for server-side applications. Can be any
1350
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1351
+ # Overrides userIp if both are provided.
1352
+ # @param [String] user_ip
1353
+ # IP address of the site where the request originates. Use this if you want to
1354
+ # enforce per-user limits.
1355
+ # @param [Google::Apis::RequestOptions] options
1356
+ # Request-specific options
1357
+ #
1358
+ # @yield [result, err] Result & error if block supplied
1359
+ # @yieldparam result [Google::Apis::GamesV1::RoomStatus] parsed result object
1360
+ # @yieldparam err [StandardError] error object if request failed
1361
+ #
1362
+ # @return [Google::Apis::GamesV1::RoomStatus]
1363
+ #
1364
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1365
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1366
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1367
+ def report_room_status(room_id, room_p2_p_statuses_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1368
+ command = make_simple_command(:post, 'rooms/{roomId}/reportstatus', options)
1369
+ command.request_representation = Google::Apis::GamesV1::RoomP2PStatuses::Representation
1370
+ command.request_object = room_p2_p_statuses_object
1371
+ command.response_representation = Google::Apis::GamesV1::RoomStatus::Representation
1372
+ command.response_class = Google::Apis::GamesV1::RoomStatus
1373
+ command.params['roomId'] = room_id unless room_id.nil?
1374
+ command.query['language'] = language unless language.nil?
1375
+ command.query['fields'] = fields unless fields.nil?
1376
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1377
+ command.query['userIp'] = user_ip unless user_ip.nil?
1378
+ execute_or_queue_command(command, &block)
1379
+ end
1380
+
1381
+ # Get high scores, and optionally ranks, in leaderboards for the currently
1382
+ # authenticated player. For a specific time span, leaderboardId can be set to
1383
+ # ALL to retrieve data for all leaderboards in a given time span.
1384
+ # NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same
1385
+ # request; only one parameter may be set to 'ALL'.
1386
+ # @param [String] player_id
1387
+ # A player ID. A value of me may be used in place of the authenticated player's
1388
+ # ID.
1389
+ # @param [String] leaderboard_id
1390
+ # The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all
1391
+ # leaderboards for this application.
1392
+ # @param [String] time_span
1393
+ # The time span for the scores and ranks you're requesting.
1394
+ # @param [String] include_rank_type
1395
+ # The types of ranks to return. If the parameter is omitted, no ranks will be
1396
+ # returned.
1397
+ # @param [String] language
1398
+ # The preferred language to use for strings returned by this method.
1399
+ # @param [Fixnum] max_results
1400
+ # The maximum number of leaderboard scores to return in the response. For any
1401
+ # response, the actual number of leaderboard scores returned may be less than
1402
+ # the specified maxResults.
1403
+ # @param [String] page_token
1404
+ # The token returned by the previous request.
1405
+ # @param [String] fields
1406
+ # Selector specifying which fields to include in a partial response.
1407
+ # @param [String] quota_user
1408
+ # Available to use for quota purposes for server-side applications. Can be any
1409
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1410
+ # Overrides userIp if both are provided.
1411
+ # @param [String] user_ip
1412
+ # IP address of the site where the request originates. Use this if you want to
1413
+ # enforce per-user limits.
1414
+ # @param [Google::Apis::RequestOptions] options
1415
+ # Request-specific options
1416
+ #
1417
+ # @yield [result, err] Result & error if block supplied
1418
+ # @yieldparam result [Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse] parsed result object
1419
+ # @yieldparam err [StandardError] error object if request failed
1420
+ #
1421
+ # @return [Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse]
1422
+ #
1423
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1424
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1425
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1426
+ def get_score(player_id, leaderboard_id, time_span, include_rank_type: nil, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1427
+ command = make_simple_command(:get, 'players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}', options)
1428
+ command.response_representation = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse::Representation
1429
+ command.response_class = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse
1430
+ command.params['playerId'] = player_id unless player_id.nil?
1431
+ command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
1432
+ command.params['timeSpan'] = time_span unless time_span.nil?
1433
+ command.query['includeRankType'] = include_rank_type unless include_rank_type.nil?
1434
+ command.query['language'] = language unless language.nil?
1435
+ command.query['maxResults'] = max_results unless max_results.nil?
1436
+ command.query['pageToken'] = page_token unless page_token.nil?
1437
+ command.query['fields'] = fields unless fields.nil?
1438
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1439
+ command.query['userIp'] = user_ip unless user_ip.nil?
1440
+ execute_or_queue_command(command, &block)
1441
+ end
1442
+
1443
+ # Lists the scores in a leaderboard, starting from the top.
1444
+ # @param [String] leaderboard_id
1445
+ # The ID of the leaderboard.
1446
+ # @param [String] collection
1447
+ # The collection of scores you're requesting.
1448
+ # @param [String] time_span
1449
+ # The time span for the scores and ranks you're requesting.
1450
+ # @param [String] language
1451
+ # The preferred language to use for strings returned by this method.
1452
+ # @param [Fixnum] max_results
1453
+ # The maximum number of leaderboard scores to return in the response. For any
1454
+ # response, the actual number of leaderboard scores returned may be less than
1455
+ # the specified maxResults.
1456
+ # @param [String] page_token
1457
+ # The token returned by the previous request.
1458
+ # @param [String] fields
1459
+ # Selector specifying which fields to include in a partial response.
1460
+ # @param [String] quota_user
1461
+ # Available to use for quota purposes for server-side applications. Can be any
1462
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1463
+ # Overrides userIp if both are provided.
1464
+ # @param [String] user_ip
1465
+ # IP address of the site where the request originates. Use this if you want to
1466
+ # enforce per-user limits.
1467
+ # @param [Google::Apis::RequestOptions] options
1468
+ # Request-specific options
1469
+ #
1470
+ # @yield [result, err] Result & error if block supplied
1471
+ # @yieldparam result [Google::Apis::GamesV1::LeaderboardScores] parsed result object
1472
+ # @yieldparam err [StandardError] error object if request failed
1473
+ #
1474
+ # @return [Google::Apis::GamesV1::LeaderboardScores]
1475
+ #
1476
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1477
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1478
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1479
+ def list_scores(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1480
+ command = make_simple_command(:get, 'leaderboards/{leaderboardId}/scores/{collection}', options)
1481
+ command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation
1482
+ command.response_class = Google::Apis::GamesV1::LeaderboardScores
1483
+ command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
1484
+ command.params['collection'] = collection unless collection.nil?
1485
+ command.query['language'] = language unless language.nil?
1486
+ command.query['maxResults'] = max_results unless max_results.nil?
1487
+ command.query['pageToken'] = page_token unless page_token.nil?
1488
+ command.query['timeSpan'] = time_span unless time_span.nil?
1489
+ command.query['fields'] = fields unless fields.nil?
1490
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1491
+ command.query['userIp'] = user_ip unless user_ip.nil?
1492
+ execute_or_queue_command(command, &block)
1493
+ end
1494
+
1495
+ # Lists the scores in a leaderboard around (and including) a player's score.
1496
+ # @param [String] leaderboard_id
1497
+ # The ID of the leaderboard.
1498
+ # @param [String] collection
1499
+ # The collection of scores you're requesting.
1500
+ # @param [String] time_span
1501
+ # The time span for the scores and ranks you're requesting.
1502
+ # @param [String] language
1503
+ # The preferred language to use for strings returned by this method.
1504
+ # @param [Fixnum] max_results
1505
+ # The maximum number of leaderboard scores to return in the response. For any
1506
+ # response, the actual number of leaderboard scores returned may be less than
1507
+ # the specified maxResults.
1508
+ # @param [String] page_token
1509
+ # The token returned by the previous request.
1510
+ # @param [Fixnum] results_above
1511
+ # The preferred number of scores to return above the player's score. More scores
1512
+ # may be returned if the player is at the bottom of the leaderboard; fewer may
1513
+ # be returned if the player is at the top. Must be less than or equal to
1514
+ # maxResults.
1515
+ # @param [Boolean] return_top_if_absent
1516
+ # True if the top scores should be returned when the player is not in the
1517
+ # leaderboard. Defaults to true.
1518
+ # @param [String] fields
1519
+ # Selector specifying which fields to include in a partial response.
1520
+ # @param [String] quota_user
1521
+ # Available to use for quota purposes for server-side applications. Can be any
1522
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1523
+ # Overrides userIp if both are provided.
1524
+ # @param [String] user_ip
1525
+ # IP address of the site where the request originates. Use this if you want to
1526
+ # enforce per-user limits.
1527
+ # @param [Google::Apis::RequestOptions] options
1528
+ # Request-specific options
1529
+ #
1530
+ # @yield [result, err] Result & error if block supplied
1531
+ # @yieldparam result [Google::Apis::GamesV1::LeaderboardScores] parsed result object
1532
+ # @yieldparam err [StandardError] error object if request failed
1533
+ #
1534
+ # @return [Google::Apis::GamesV1::LeaderboardScores]
1535
+ #
1536
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1537
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1538
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1539
+ def list_score_window(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, results_above: nil, return_top_if_absent: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1540
+ command = make_simple_command(:get, 'leaderboards/{leaderboardId}/window/{collection}', options)
1541
+ command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation
1542
+ command.response_class = Google::Apis::GamesV1::LeaderboardScores
1543
+ command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
1544
+ command.params['collection'] = collection unless collection.nil?
1545
+ command.query['language'] = language unless language.nil?
1546
+ command.query['maxResults'] = max_results unless max_results.nil?
1547
+ command.query['pageToken'] = page_token unless page_token.nil?
1548
+ command.query['resultsAbove'] = results_above unless results_above.nil?
1549
+ command.query['returnTopIfAbsent'] = return_top_if_absent unless return_top_if_absent.nil?
1550
+ command.query['timeSpan'] = time_span unless time_span.nil?
1551
+ command.query['fields'] = fields unless fields.nil?
1552
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1553
+ command.query['userIp'] = user_ip unless user_ip.nil?
1554
+ execute_or_queue_command(command, &block)
1555
+ end
1556
+
1557
+ # Submits a score to the specified leaderboard.
1558
+ # @param [String] leaderboard_id
1559
+ # The ID of the leaderboard.
1560
+ # @param [String] score
1561
+ # The score you're submitting. The submitted score is ignored if it is worse
1562
+ # than a previously submitted score, where worse depends on the leaderboard sort
1563
+ # order. The meaning of the score value depends on the leaderboard format type.
1564
+ # For fixed-point, the score represents the raw value. For time, the score
1565
+ # represents elapsed time in milliseconds. For currency, the score represents a
1566
+ # value in micro units.
1567
+ # @param [String] language
1568
+ # The preferred language to use for strings returned by this method.
1569
+ # @param [String] score_tag
1570
+ # Additional information about the score you're submitting. Values must contain
1571
+ # no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
1572
+ # @param [String] fields
1573
+ # Selector specifying which fields to include in a partial response.
1574
+ # @param [String] quota_user
1575
+ # Available to use for quota purposes for server-side applications. Can be any
1576
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1577
+ # Overrides userIp if both are provided.
1578
+ # @param [String] user_ip
1579
+ # IP address of the site where the request originates. Use this if you want to
1580
+ # enforce per-user limits.
1581
+ # @param [Google::Apis::RequestOptions] options
1582
+ # Request-specific options
1583
+ #
1584
+ # @yield [result, err] Result & error if block supplied
1585
+ # @yieldparam result [Google::Apis::GamesV1::PlayerScoreResponse] parsed result object
1586
+ # @yieldparam err [StandardError] error object if request failed
1587
+ #
1588
+ # @return [Google::Apis::GamesV1::PlayerScoreResponse]
1589
+ #
1590
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1591
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1592
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1593
+ def submit_score(leaderboard_id, score, language: nil, score_tag: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1594
+ command = make_simple_command(:post, 'leaderboards/{leaderboardId}/scores', options)
1595
+ command.response_representation = Google::Apis::GamesV1::PlayerScoreResponse::Representation
1596
+ command.response_class = Google::Apis::GamesV1::PlayerScoreResponse
1597
+ command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
1598
+ command.query['language'] = language unless language.nil?
1599
+ command.query['score'] = score unless score.nil?
1600
+ command.query['scoreTag'] = score_tag unless score_tag.nil?
1601
+ command.query['fields'] = fields unless fields.nil?
1602
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1603
+ command.query['userIp'] = user_ip unless user_ip.nil?
1604
+ execute_or_queue_command(command, &block)
1605
+ end
1606
+
1607
+ # Submits multiple scores to leaderboards.
1608
+ # @param [Google::Apis::GamesV1::PlayerScoreSubmissionList] player_score_submission_list_object
1609
+ # @param [String] language
1610
+ # The preferred language to use for strings returned by this method.
1611
+ # @param [String] fields
1612
+ # Selector specifying which fields to include in a partial response.
1613
+ # @param [String] quota_user
1614
+ # Available to use for quota purposes for server-side applications. Can be any
1615
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1616
+ # Overrides userIp if both are provided.
1617
+ # @param [String] user_ip
1618
+ # IP address of the site where the request originates. Use this if you want to
1619
+ # enforce per-user limits.
1620
+ # @param [Google::Apis::RequestOptions] options
1621
+ # Request-specific options
1622
+ #
1623
+ # @yield [result, err] Result & error if block supplied
1624
+ # @yieldparam result [Google::Apis::GamesV1::ListPlayerScoreResponse] parsed result object
1625
+ # @yieldparam err [StandardError] error object if request failed
1626
+ #
1627
+ # @return [Google::Apis::GamesV1::ListPlayerScoreResponse]
1628
+ #
1629
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1630
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1631
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1632
+ def submit_score_multiple(player_score_submission_list_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1633
+ command = make_simple_command(:post, 'leaderboards/scores', options)
1634
+ command.request_representation = Google::Apis::GamesV1::PlayerScoreSubmissionList::Representation
1635
+ command.request_object = player_score_submission_list_object
1636
+ command.response_representation = Google::Apis::GamesV1::ListPlayerScoreResponse::Representation
1637
+ command.response_class = Google::Apis::GamesV1::ListPlayerScoreResponse
1638
+ command.query['language'] = language unless language.nil?
1639
+ command.query['fields'] = fields unless fields.nil?
1640
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1641
+ command.query['userIp'] = user_ip unless user_ip.nil?
1642
+ execute_or_queue_command(command, &block)
1643
+ end
1644
+
1645
+ # Retrieves the metadata for a given snapshot ID.
1646
+ # @param [String] snapshot_id
1647
+ # The ID of the snapshot.
1648
+ # @param [String] language
1649
+ # The preferred language to use for strings returned by this method.
1650
+ # @param [String] fields
1651
+ # Selector specifying which fields to include in a partial response.
1652
+ # @param [String] quota_user
1653
+ # Available to use for quota purposes for server-side applications. Can be any
1654
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1655
+ # Overrides userIp if both are provided.
1656
+ # @param [String] user_ip
1657
+ # IP address of the site where the request originates. Use this if you want to
1658
+ # enforce per-user limits.
1659
+ # @param [Google::Apis::RequestOptions] options
1660
+ # Request-specific options
1661
+ #
1662
+ # @yield [result, err] Result & error if block supplied
1663
+ # @yieldparam result [Google::Apis::GamesV1::Snapshot] parsed result object
1664
+ # @yieldparam err [StandardError] error object if request failed
1665
+ #
1666
+ # @return [Google::Apis::GamesV1::Snapshot]
1667
+ #
1668
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1669
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1670
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1671
+ def get_snapshot(snapshot_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1672
+ command = make_simple_command(:get, 'snapshots/{snapshotId}', options)
1673
+ command.response_representation = Google::Apis::GamesV1::Snapshot::Representation
1674
+ command.response_class = Google::Apis::GamesV1::Snapshot
1675
+ command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
1676
+ command.query['language'] = language unless language.nil?
1677
+ command.query['fields'] = fields unless fields.nil?
1678
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1679
+ command.query['userIp'] = user_ip unless user_ip.nil?
1680
+ execute_or_queue_command(command, &block)
1681
+ end
1682
+
1683
+ # Retrieves a list of snapshots created by your application for the player
1684
+ # corresponding to the player ID.
1685
+ # @param [String] player_id
1686
+ # A player ID. A value of me may be used in place of the authenticated player's
1687
+ # ID.
1688
+ # @param [String] language
1689
+ # The preferred language to use for strings returned by this method.
1690
+ # @param [Fixnum] max_results
1691
+ # The maximum number of snapshot resources to return in the response, used for
1692
+ # paging. For any response, the actual number of snapshot resources returned may
1693
+ # be less than the specified maxResults.
1694
+ # @param [String] page_token
1695
+ # The token returned by the previous request.
1696
+ # @param [String] fields
1697
+ # Selector specifying which fields to include in a partial response.
1698
+ # @param [String] quota_user
1699
+ # Available to use for quota purposes for server-side applications. Can be any
1700
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1701
+ # Overrides userIp if both are provided.
1702
+ # @param [String] user_ip
1703
+ # IP address of the site where the request originates. Use this if you want to
1704
+ # enforce per-user limits.
1705
+ # @param [Google::Apis::RequestOptions] options
1706
+ # Request-specific options
1707
+ #
1708
+ # @yield [result, err] Result & error if block supplied
1709
+ # @yieldparam result [Google::Apis::GamesV1::ListSnapshotResponse] parsed result object
1710
+ # @yieldparam err [StandardError] error object if request failed
1711
+ #
1712
+ # @return [Google::Apis::GamesV1::ListSnapshotResponse]
1713
+ #
1714
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1715
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1716
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1717
+ def list_snapshots(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1718
+ command = make_simple_command(:get, 'players/{playerId}/snapshots', options)
1719
+ command.response_representation = Google::Apis::GamesV1::ListSnapshotResponse::Representation
1720
+ command.response_class = Google::Apis::GamesV1::ListSnapshotResponse
1721
+ command.params['playerId'] = player_id unless player_id.nil?
1722
+ command.query['language'] = language unless language.nil?
1723
+ command.query['maxResults'] = max_results unless max_results.nil?
1724
+ command.query['pageToken'] = page_token unless page_token.nil?
1725
+ command.query['fields'] = fields unless fields.nil?
1726
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1727
+ command.query['userIp'] = user_ip unless user_ip.nil?
1728
+ execute_or_queue_command(command, &block)
1729
+ end
1730
+
1731
+ # Cancel a turn-based match.
1732
+ # @param [String] match_id
1733
+ # The ID of the match.
1734
+ # @param [String] fields
1735
+ # Selector specifying which fields to include in a partial response.
1736
+ # @param [String] quota_user
1737
+ # Available to use for quota purposes for server-side applications. Can be any
1738
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1739
+ # Overrides userIp if both are provided.
1740
+ # @param [String] user_ip
1741
+ # IP address of the site where the request originates. Use this if you want to
1742
+ # enforce per-user limits.
1743
+ # @param [Google::Apis::RequestOptions] options
1744
+ # Request-specific options
1745
+ #
1746
+ # @yield [result, err] Result & error if block supplied
1747
+ # @yieldparam result [NilClass] No result returned for this method
1748
+ # @yieldparam err [StandardError] error object if request failed
1749
+ #
1750
+ # @return [void]
1751
+ #
1752
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1753
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1754
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1755
+ def cancel_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1756
+ command = make_simple_command(:put, 'turnbasedmatches/{matchId}/cancel', options)
1757
+ command.params['matchId'] = match_id unless match_id.nil?
1758
+ command.query['fields'] = fields unless fields.nil?
1759
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1760
+ command.query['userIp'] = user_ip unless user_ip.nil?
1761
+ execute_or_queue_command(command, &block)
1762
+ end
1763
+
1764
+ # Create a turn-based match.
1765
+ # @param [Google::Apis::GamesV1::CreateTurnBasedMatchRequest] create_turn_based_match_request_object
1766
+ # @param [String] language
1767
+ # The preferred language to use for strings returned by this method.
1768
+ # @param [String] fields
1769
+ # Selector specifying which fields to include in a partial response.
1770
+ # @param [String] quota_user
1771
+ # Available to use for quota purposes for server-side applications. Can be any
1772
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1773
+ # Overrides userIp if both are provided.
1774
+ # @param [String] user_ip
1775
+ # IP address of the site where the request originates. Use this if you want to
1776
+ # enforce per-user limits.
1777
+ # @param [Google::Apis::RequestOptions] options
1778
+ # Request-specific options
1779
+ #
1780
+ # @yield [result, err] Result & error if block supplied
1781
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object
1782
+ # @yieldparam err [StandardError] error object if request failed
1783
+ #
1784
+ # @return [Google::Apis::GamesV1::TurnBasedMatch]
1785
+ #
1786
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1787
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1788
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1789
+ def create_turn_based_match(create_turn_based_match_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1790
+ command = make_simple_command(:post, 'turnbasedmatches/create', options)
1791
+ command.request_representation = Google::Apis::GamesV1::CreateTurnBasedMatchRequest::Representation
1792
+ command.request_object = create_turn_based_match_request_object
1793
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
1794
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatch
1795
+ command.query['language'] = language unless language.nil?
1796
+ command.query['fields'] = fields unless fields.nil?
1797
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1798
+ command.query['userIp'] = user_ip unless user_ip.nil?
1799
+ execute_or_queue_command(command, &block)
1800
+ end
1801
+
1802
+ # Decline an invitation to play a turn-based match.
1803
+ # @param [String] match_id
1804
+ # The ID of the match.
1805
+ # @param [String] language
1806
+ # The preferred language to use for strings returned by this method.
1807
+ # @param [String] fields
1808
+ # Selector specifying which fields to include in a partial response.
1809
+ # @param [String] quota_user
1810
+ # Available to use for quota purposes for server-side applications. Can be any
1811
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1812
+ # Overrides userIp if both are provided.
1813
+ # @param [String] user_ip
1814
+ # IP address of the site where the request originates. Use this if you want to
1815
+ # enforce per-user limits.
1816
+ # @param [Google::Apis::RequestOptions] options
1817
+ # Request-specific options
1818
+ #
1819
+ # @yield [result, err] Result & error if block supplied
1820
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object
1821
+ # @yieldparam err [StandardError] error object if request failed
1822
+ #
1823
+ # @return [Google::Apis::GamesV1::TurnBasedMatch]
1824
+ #
1825
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1826
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1827
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1828
+ def decline_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1829
+ command = make_simple_command(:put, 'turnbasedmatches/{matchId}/decline', options)
1830
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
1831
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatch
1832
+ command.params['matchId'] = match_id unless match_id.nil?
1833
+ command.query['language'] = language unless language.nil?
1834
+ command.query['fields'] = fields unless fields.nil?
1835
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1836
+ command.query['userIp'] = user_ip unless user_ip.nil?
1837
+ execute_or_queue_command(command, &block)
1838
+ end
1839
+
1840
+ # Dismiss a turn-based match from the match list. The match will no longer show
1841
+ # up in the list and will not generate notifications.
1842
+ # @param [String] match_id
1843
+ # The ID of the match.
1844
+ # @param [String] fields
1845
+ # Selector specifying which fields to include in a partial response.
1846
+ # @param [String] quota_user
1847
+ # Available to use for quota purposes for server-side applications. Can be any
1848
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1849
+ # Overrides userIp if both are provided.
1850
+ # @param [String] user_ip
1851
+ # IP address of the site where the request originates. Use this if you want to
1852
+ # enforce per-user limits.
1853
+ # @param [Google::Apis::RequestOptions] options
1854
+ # Request-specific options
1855
+ #
1856
+ # @yield [result, err] Result & error if block supplied
1857
+ # @yieldparam result [NilClass] No result returned for this method
1858
+ # @yieldparam err [StandardError] error object if request failed
1859
+ #
1860
+ # @return [void]
1861
+ #
1862
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1863
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1864
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1865
+ def dismiss_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1866
+ command = make_simple_command(:put, 'turnbasedmatches/{matchId}/dismiss', options)
1867
+ command.params['matchId'] = match_id unless match_id.nil?
1868
+ command.query['fields'] = fields unless fields.nil?
1869
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1870
+ command.query['userIp'] = user_ip unless user_ip.nil?
1871
+ execute_or_queue_command(command, &block)
1872
+ end
1873
+
1874
+ # Finish a turn-based match. Each player should make this call once, after all
1875
+ # results are in. Only the player whose turn it is may make the first call to
1876
+ # Finish, and can pass in the final match state.
1877
+ # @param [String] match_id
1878
+ # The ID of the match.
1879
+ # @param [Google::Apis::GamesV1::TurnBasedMatchResults] turn_based_match_results_object
1880
+ # @param [String] language
1881
+ # The preferred language to use for strings returned by this method.
1882
+ # @param [String] fields
1883
+ # Selector specifying which fields to include in a partial response.
1884
+ # @param [String] quota_user
1885
+ # Available to use for quota purposes for server-side applications. Can be any
1886
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1887
+ # Overrides userIp if both are provided.
1888
+ # @param [String] user_ip
1889
+ # IP address of the site where the request originates. Use this if you want to
1890
+ # enforce per-user limits.
1891
+ # @param [Google::Apis::RequestOptions] options
1892
+ # Request-specific options
1893
+ #
1894
+ # @yield [result, err] Result & error if block supplied
1895
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object
1896
+ # @yieldparam err [StandardError] error object if request failed
1897
+ #
1898
+ # @return [Google::Apis::GamesV1::TurnBasedMatch]
1899
+ #
1900
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1901
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1902
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1903
+ def finish_turn_based_match(match_id, turn_based_match_results_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1904
+ command = make_simple_command(:put, 'turnbasedmatches/{matchId}/finish', options)
1905
+ command.request_representation = Google::Apis::GamesV1::TurnBasedMatchResults::Representation
1906
+ command.request_object = turn_based_match_results_object
1907
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
1908
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatch
1909
+ command.params['matchId'] = match_id unless match_id.nil?
1910
+ command.query['language'] = language unless language.nil?
1911
+ command.query['fields'] = fields unless fields.nil?
1912
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1913
+ command.query['userIp'] = user_ip unless user_ip.nil?
1914
+ execute_or_queue_command(command, &block)
1915
+ end
1916
+
1917
+ # Get the data for a turn-based match.
1918
+ # @param [String] match_id
1919
+ # The ID of the match.
1920
+ # @param [Boolean] include_match_data
1921
+ # Get match data along with metadata.
1922
+ # @param [String] language
1923
+ # The preferred language to use for strings returned by this method.
1924
+ # @param [String] fields
1925
+ # Selector specifying which fields to include in a partial response.
1926
+ # @param [String] quota_user
1927
+ # Available to use for quota purposes for server-side applications. Can be any
1928
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1929
+ # Overrides userIp if both are provided.
1930
+ # @param [String] user_ip
1931
+ # IP address of the site where the request originates. Use this if you want to
1932
+ # enforce per-user limits.
1933
+ # @param [Google::Apis::RequestOptions] options
1934
+ # Request-specific options
1935
+ #
1936
+ # @yield [result, err] Result & error if block supplied
1937
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object
1938
+ # @yieldparam err [StandardError] error object if request failed
1939
+ #
1940
+ # @return [Google::Apis::GamesV1::TurnBasedMatch]
1941
+ #
1942
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1943
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1944
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1945
+ def get_turn_based_match(match_id, include_match_data: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1946
+ command = make_simple_command(:get, 'turnbasedmatches/{matchId}', options)
1947
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
1948
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatch
1949
+ command.params['matchId'] = match_id unless match_id.nil?
1950
+ command.query['includeMatchData'] = include_match_data unless include_match_data.nil?
1951
+ command.query['language'] = language unless language.nil?
1952
+ command.query['fields'] = fields unless fields.nil?
1953
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1954
+ command.query['userIp'] = user_ip unless user_ip.nil?
1955
+ execute_or_queue_command(command, &block)
1956
+ end
1957
+
1958
+ # Join a turn-based match.
1959
+ # @param [String] match_id
1960
+ # The ID of the match.
1961
+ # @param [String] language
1962
+ # The preferred language to use for strings returned by this method.
1963
+ # @param [String] fields
1964
+ # Selector specifying which fields to include in a partial response.
1965
+ # @param [String] quota_user
1966
+ # Available to use for quota purposes for server-side applications. Can be any
1967
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1968
+ # Overrides userIp if both are provided.
1969
+ # @param [String] user_ip
1970
+ # IP address of the site where the request originates. Use this if you want to
1971
+ # enforce per-user limits.
1972
+ # @param [Google::Apis::RequestOptions] options
1973
+ # Request-specific options
1974
+ #
1975
+ # @yield [result, err] Result & error if block supplied
1976
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object
1977
+ # @yieldparam err [StandardError] error object if request failed
1978
+ #
1979
+ # @return [Google::Apis::GamesV1::TurnBasedMatch]
1980
+ #
1981
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1982
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1983
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1984
+ def join_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1985
+ command = make_simple_command(:put, 'turnbasedmatches/{matchId}/join', options)
1986
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
1987
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatch
1988
+ command.params['matchId'] = match_id unless match_id.nil?
1989
+ command.query['language'] = language unless language.nil?
1990
+ command.query['fields'] = fields unless fields.nil?
1991
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1992
+ command.query['userIp'] = user_ip unless user_ip.nil?
1993
+ execute_or_queue_command(command, &block)
1994
+ end
1995
+
1996
+ # Leave a turn-based match when it is not the current player's turn, without
1997
+ # canceling the match.
1998
+ # @param [String] match_id
1999
+ # The ID of the match.
2000
+ # @param [String] language
2001
+ # The preferred language to use for strings returned by this method.
2002
+ # @param [String] fields
2003
+ # Selector specifying which fields to include in a partial response.
2004
+ # @param [String] quota_user
2005
+ # Available to use for quota purposes for server-side applications. Can be any
2006
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2007
+ # Overrides userIp if both are provided.
2008
+ # @param [String] user_ip
2009
+ # IP address of the site where the request originates. Use this if you want to
2010
+ # enforce per-user limits.
2011
+ # @param [Google::Apis::RequestOptions] options
2012
+ # Request-specific options
2013
+ #
2014
+ # @yield [result, err] Result & error if block supplied
2015
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object
2016
+ # @yieldparam err [StandardError] error object if request failed
2017
+ #
2018
+ # @return [Google::Apis::GamesV1::TurnBasedMatch]
2019
+ #
2020
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2021
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2022
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2023
+ def leave_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2024
+ command = make_simple_command(:put, 'turnbasedmatches/{matchId}/leave', options)
2025
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
2026
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatch
2027
+ command.params['matchId'] = match_id unless match_id.nil?
2028
+ command.query['language'] = language unless language.nil?
2029
+ command.query['fields'] = fields unless fields.nil?
2030
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2031
+ command.query['userIp'] = user_ip unless user_ip.nil?
2032
+ execute_or_queue_command(command, &block)
2033
+ end
2034
+
2035
+ # Leave a turn-based match during the current player's turn, without canceling
2036
+ # the match.
2037
+ # @param [String] match_id
2038
+ # The ID of the match.
2039
+ # @param [Fixnum] match_version
2040
+ # The version of the match being updated.
2041
+ # @param [String] language
2042
+ # The preferred language to use for strings returned by this method.
2043
+ # @param [String] pending_participant_id
2044
+ # The ID of another participant who should take their turn next. If not set, the
2045
+ # match will wait for other player(s) to join via automatching; this is only
2046
+ # valid if automatch criteria is set on the match with remaining slots for
2047
+ # automatched players.
2048
+ # @param [String] fields
2049
+ # Selector specifying which fields to include in a partial response.
2050
+ # @param [String] quota_user
2051
+ # Available to use for quota purposes for server-side applications. Can be any
2052
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2053
+ # Overrides userIp if both are provided.
2054
+ # @param [String] user_ip
2055
+ # IP address of the site where the request originates. Use this if you want to
2056
+ # enforce per-user limits.
2057
+ # @param [Google::Apis::RequestOptions] options
2058
+ # Request-specific options
2059
+ #
2060
+ # @yield [result, err] Result & error if block supplied
2061
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object
2062
+ # @yieldparam err [StandardError] error object if request failed
2063
+ #
2064
+ # @return [Google::Apis::GamesV1::TurnBasedMatch]
2065
+ #
2066
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2067
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2068
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2069
+ def leave_turn(match_id, match_version, language: nil, pending_participant_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2070
+ command = make_simple_command(:put, 'turnbasedmatches/{matchId}/leaveTurn', options)
2071
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
2072
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatch
2073
+ command.params['matchId'] = match_id unless match_id.nil?
2074
+ command.query['language'] = language unless language.nil?
2075
+ command.query['matchVersion'] = match_version unless match_version.nil?
2076
+ command.query['pendingParticipantId'] = pending_participant_id unless pending_participant_id.nil?
2077
+ command.query['fields'] = fields unless fields.nil?
2078
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2079
+ command.query['userIp'] = user_ip unless user_ip.nil?
2080
+ execute_or_queue_command(command, &block)
2081
+ end
2082
+
2083
+ # Returns turn-based matches the player is or was involved in.
2084
+ # @param [Boolean] include_match_data
2085
+ # True if match data should be returned in the response. Note that not all data
2086
+ # will necessarily be returned if include_match_data is true; the server may
2087
+ # decide to only return data for some of the matches to limit download size for
2088
+ # the client. The remainder of the data for these matches will be retrievable on
2089
+ # request.
2090
+ # @param [String] language
2091
+ # The preferred language to use for strings returned by this method.
2092
+ # @param [Fixnum] max_completed_matches
2093
+ # The maximum number of completed or canceled matches to return in the response.
2094
+ # If not set, all matches returned could be completed or canceled.
2095
+ # @param [Fixnum] max_results
2096
+ # The maximum number of matches to return in the response, used for paging. For
2097
+ # any response, the actual number of matches to return may be less than the
2098
+ # specified maxResults.
2099
+ # @param [String] page_token
2100
+ # The token returned by the previous request.
2101
+ # @param [String] fields
2102
+ # Selector specifying which fields to include in a partial response.
2103
+ # @param [String] quota_user
2104
+ # Available to use for quota purposes for server-side applications. Can be any
2105
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2106
+ # Overrides userIp if both are provided.
2107
+ # @param [String] user_ip
2108
+ # IP address of the site where the request originates. Use this if you want to
2109
+ # enforce per-user limits.
2110
+ # @param [Google::Apis::RequestOptions] options
2111
+ # Request-specific options
2112
+ #
2113
+ # @yield [result, err] Result & error if block supplied
2114
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatchList] parsed result object
2115
+ # @yieldparam err [StandardError] error object if request failed
2116
+ #
2117
+ # @return [Google::Apis::GamesV1::TurnBasedMatchList]
2118
+ #
2119
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2120
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2121
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2122
+ def list_turn_based_matches(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2123
+ command = make_simple_command(:get, 'turnbasedmatches', options)
2124
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatchList::Representation
2125
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatchList
2126
+ command.query['includeMatchData'] = include_match_data unless include_match_data.nil?
2127
+ command.query['language'] = language unless language.nil?
2128
+ command.query['maxCompletedMatches'] = max_completed_matches unless max_completed_matches.nil?
2129
+ command.query['maxResults'] = max_results unless max_results.nil?
2130
+ command.query['pageToken'] = page_token unless page_token.nil?
2131
+ command.query['fields'] = fields unless fields.nil?
2132
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2133
+ command.query['userIp'] = user_ip unless user_ip.nil?
2134
+ execute_or_queue_command(command, &block)
2135
+ end
2136
+
2137
+ # Create a rematch of a match that was previously completed, with the same
2138
+ # participants. This can be called by only one player on a match still in their
2139
+ # list; the player must have called Finish first. Returns the newly created
2140
+ # match; it will be the caller's turn.
2141
+ # @param [String] match_id
2142
+ # The ID of the match.
2143
+ # @param [String] language
2144
+ # The preferred language to use for strings returned by this method.
2145
+ # @param [String] request_id
2146
+ # A randomly generated numeric ID for each request specified by the caller. This
2147
+ # number is used at the server to ensure that the request is handled correctly
2148
+ # across retries.
2149
+ # @param [String] fields
2150
+ # Selector specifying which fields to include in a partial response.
2151
+ # @param [String] quota_user
2152
+ # Available to use for quota purposes for server-side applications. Can be any
2153
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2154
+ # Overrides userIp if both are provided.
2155
+ # @param [String] user_ip
2156
+ # IP address of the site where the request originates. Use this if you want to
2157
+ # enforce per-user limits.
2158
+ # @param [Google::Apis::RequestOptions] options
2159
+ # Request-specific options
2160
+ #
2161
+ # @yield [result, err] Result & error if block supplied
2162
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatchRematch] parsed result object
2163
+ # @yieldparam err [StandardError] error object if request failed
2164
+ #
2165
+ # @return [Google::Apis::GamesV1::TurnBasedMatchRematch]
2166
+ #
2167
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2168
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2169
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2170
+ def rematch_turn_based_match(match_id, language: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2171
+ command = make_simple_command(:post, 'turnbasedmatches/{matchId}/rematch', options)
2172
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatchRematch::Representation
2173
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatchRematch
2174
+ command.params['matchId'] = match_id unless match_id.nil?
2175
+ command.query['language'] = language unless language.nil?
2176
+ command.query['requestId'] = request_id unless request_id.nil?
2177
+ command.query['fields'] = fields unless fields.nil?
2178
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2179
+ command.query['userIp'] = user_ip unless user_ip.nil?
2180
+ execute_or_queue_command(command, &block)
2181
+ end
2182
+
2183
+ # Returns turn-based matches the player is or was involved in that changed since
2184
+ # the last sync call, with the least recent changes coming first. Matches that
2185
+ # should be removed from the local cache will have a status of MATCH_DELETED.
2186
+ # @param [Boolean] include_match_data
2187
+ # True if match data should be returned in the response. Note that not all data
2188
+ # will necessarily be returned if include_match_data is true; the server may
2189
+ # decide to only return data for some of the matches to limit download size for
2190
+ # the client. The remainder of the data for these matches will be retrievable on
2191
+ # request.
2192
+ # @param [String] language
2193
+ # The preferred language to use for strings returned by this method.
2194
+ # @param [Fixnum] max_completed_matches
2195
+ # The maximum number of completed or canceled matches to return in the response.
2196
+ # If not set, all matches returned could be completed or canceled.
2197
+ # @param [Fixnum] max_results
2198
+ # The maximum number of matches to return in the response, used for paging. For
2199
+ # any response, the actual number of matches to return may be less than the
2200
+ # specified maxResults.
2201
+ # @param [String] page_token
2202
+ # The token returned by the previous request.
2203
+ # @param [String] fields
2204
+ # Selector specifying which fields to include in a partial response.
2205
+ # @param [String] quota_user
2206
+ # Available to use for quota purposes for server-side applications. Can be any
2207
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2208
+ # Overrides userIp if both are provided.
2209
+ # @param [String] user_ip
2210
+ # IP address of the site where the request originates. Use this if you want to
2211
+ # enforce per-user limits.
2212
+ # @param [Google::Apis::RequestOptions] options
2213
+ # Request-specific options
2214
+ #
2215
+ # @yield [result, err] Result & error if block supplied
2216
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatchSync] parsed result object
2217
+ # @yieldparam err [StandardError] error object if request failed
2218
+ #
2219
+ # @return [Google::Apis::GamesV1::TurnBasedMatchSync]
2220
+ #
2221
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2222
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2223
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2224
+ def sync_turn_based_match(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2225
+ command = make_simple_command(:get, 'turnbasedmatches/sync', options)
2226
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatchSync::Representation
2227
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatchSync
2228
+ command.query['includeMatchData'] = include_match_data unless include_match_data.nil?
2229
+ command.query['language'] = language unless language.nil?
2230
+ command.query['maxCompletedMatches'] = max_completed_matches unless max_completed_matches.nil?
2231
+ command.query['maxResults'] = max_results unless max_results.nil?
2232
+ command.query['pageToken'] = page_token unless page_token.nil?
2233
+ command.query['fields'] = fields unless fields.nil?
2234
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2235
+ command.query['userIp'] = user_ip unless user_ip.nil?
2236
+ execute_or_queue_command(command, &block)
2237
+ end
2238
+
2239
+ # Commit the results of a player turn.
2240
+ # @param [String] match_id
2241
+ # The ID of the match.
2242
+ # @param [Google::Apis::GamesV1::TurnBasedMatchTurn] turn_based_match_turn_object
2243
+ # @param [String] language
2244
+ # The preferred language to use for strings returned by this method.
2245
+ # @param [String] fields
2246
+ # Selector specifying which fields to include in a partial response.
2247
+ # @param [String] quota_user
2248
+ # Available to use for quota purposes for server-side applications. Can be any
2249
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2250
+ # Overrides userIp if both are provided.
2251
+ # @param [String] user_ip
2252
+ # IP address of the site where the request originates. Use this if you want to
2253
+ # enforce per-user limits.
2254
+ # @param [Google::Apis::RequestOptions] options
2255
+ # Request-specific options
2256
+ #
2257
+ # @yield [result, err] Result & error if block supplied
2258
+ # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object
2259
+ # @yieldparam err [StandardError] error object if request failed
2260
+ #
2261
+ # @return [Google::Apis::GamesV1::TurnBasedMatch]
2262
+ #
2263
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2264
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2265
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2266
+ def take_turn(match_id, turn_based_match_turn_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2267
+ command = make_simple_command(:put, 'turnbasedmatches/{matchId}/turn', options)
2268
+ command.request_representation = Google::Apis::GamesV1::TurnBasedMatchTurn::Representation
2269
+ command.request_object = turn_based_match_turn_object
2270
+ command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
2271
+ command.response_class = Google::Apis::GamesV1::TurnBasedMatch
2272
+ command.params['matchId'] = match_id unless match_id.nil?
2273
+ command.query['language'] = language unless language.nil?
2274
+ command.query['fields'] = fields unless fields.nil?
2275
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2276
+ command.query['userIp'] = user_ip unless user_ip.nil?
2277
+ execute_or_queue_command(command, &block)
2278
+ end
2279
+
2280
+ protected
2281
+
2282
+ def apply_command_defaults(command)
2283
+ command.query['key'] = key unless key.nil?
2284
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2285
+ command.query['userIp'] = user_ip unless user_ip.nil?
2286
+ end
2287
+ end
2288
+ end
2289
+ end
2290
+ end