1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module GamesV1
# Google Play Game Services
#
# The Google Play games service allows developers to enhance games with social
# leaderboards, achievements, game state, sign-in with Google, and more.
#
# @example
# require 'google/apis/games_v1'
#
# Games = Google::Apis::GamesV1 # Alias the module
# service = Games::GamesService.new
#
# @see https://developers.google.com/games/
class GamesService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://games.googleapis.com/', '')
@batch_path = 'batch'
end
# Lists all the achievement definitions for your application.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of achievement resources to return in the response, used
# for paging. For any response, the actual number of achievement resources
# returned may be less than the specified `maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListAchievementDefinitionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListAchievementDefinitionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_achievement_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/achievements', options)
command.response_representation = Google::Apis::GamesV1::ListAchievementDefinitionsResponse::Representation
command.response_class = Google::Apis::GamesV1::ListAchievementDefinitionsResponse
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Increments the steps of the achievement with the given ID for the currently
# authenticated player.
# @param [String] achievement_id
# The ID of the achievement used by this method.
# @param [Fixnum] steps_to_increment
# The number of steps to increment.
# @param [Fixnum] request_id
# A randomly generated numeric ID for each request specified by the caller. This
# number is used at the server to ensure that the request is handled correctly
# across retries.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::AchievementIncrementResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::AchievementIncrementResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def increment_achievement(achievement_id, steps_to_increment, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/increment', options)
command.response_representation = Google::Apis::GamesV1::AchievementIncrementResponse::Representation
command.response_class = Google::Apis::GamesV1::AchievementIncrementResponse
command.params['achievementId'] = achievement_id unless achievement_id.nil?
command.query['requestId'] = request_id unless request_id.nil?
command.query['stepsToIncrement'] = steps_to_increment unless steps_to_increment.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the progress for all your application's achievements for the currently
# authenticated player.
# @param [String] player_id
# A player ID. A value of `me` may be used in place of the authenticated player'
# s ID.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of achievement resources to return in the response, used
# for paging. For any response, the actual number of achievement resources
# returned may be less than the specified `maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] state
# Tells the server to return only achievements with the specified state. If this
# parameter isn't specified, all achievements are returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListPlayerAchievementResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListPlayerAchievementResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_achievements(player_id, language: nil, max_results: nil, page_token: nil, state: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/players/{playerId}/achievements', options)
command.response_representation = Google::Apis::GamesV1::ListPlayerAchievementResponse::Representation
command.response_class = Google::Apis::GamesV1::ListPlayerAchievementResponse
command.params['playerId'] = player_id unless player_id.nil?
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['state'] = state unless state.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the state of the achievement with the given ID to `REVEALED` for the
# currently authenticated player.
# @param [String] achievement_id
# The ID of the achievement used by this method.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::AchievementRevealResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::AchievementRevealResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def reveal_achievement(achievement_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/reveal', options)
command.response_representation = Google::Apis::GamesV1::AchievementRevealResponse::Representation
command.response_class = Google::Apis::GamesV1::AchievementRevealResponse
command.params['achievementId'] = achievement_id unless achievement_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the steps for the currently authenticated player towards unlocking an
# achievement. If the steps parameter is less than the current number of steps
# that the player already gained for the achievement, the achievement is not
# modified.
# @param [String] achievement_id
# The ID of the achievement used by this method.
# @param [Fixnum] steps
# The minimum value to set the steps to.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_achievement_steps_at_least(achievement_id, steps, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/setStepsAtLeast', options)
command.response_representation = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse::Representation
command.response_class = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse
command.params['achievementId'] = achievement_id unless achievement_id.nil?
command.query['steps'] = steps unless steps.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Unlocks this achievement for the currently authenticated player.
# @param [String] achievement_id
# The ID of the achievement used by this method.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::AchievementUnlockResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::AchievementUnlockResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def unlock_achievement(achievement_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/unlock', options)
command.response_representation = Google::Apis::GamesV1::AchievementUnlockResponse::Representation
command.response_class = Google::Apis::GamesV1::AchievementUnlockResponse
command.params['achievementId'] = achievement_id unless achievement_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates multiple achievements for the currently authenticated player.
# @param [Google::Apis::GamesV1::AchievementUpdateMultipleRequest] achievement_update_multiple_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::AchievementUpdateMultipleResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::AchievementUpdateMultipleResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_multiple_achievements(achievement_update_multiple_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/achievements/updateMultiple', options)
command.request_representation = Google::Apis::GamesV1::AchievementUpdateMultipleRequest::Representation
command.request_object = achievement_update_multiple_request_object
command.response_representation = Google::Apis::GamesV1::AchievementUpdateMultipleResponse::Representation
command.response_class = Google::Apis::GamesV1::AchievementUpdateMultipleResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the metadata of the application with the given ID. If the requested
# application is not available for the specified `platformType`, the returned
# response will not include any instance data.
# @param [String] application_id
# The application ID from the Google Play developer console.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [String] platform_type
# Restrict application details returned to the specific platform.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::Application] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::Application]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_application(application_id, language: nil, platform_type: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/applications/{applicationId}', options)
command.response_representation = Google::Apis::GamesV1::Application::Representation
command.response_class = Google::Apis::GamesV1::Application
command.params['applicationId'] = application_id unless application_id.nil?
command.query['language'] = language unless language.nil?
command.query['platformType'] = platform_type unless platform_type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a URL for the requested end point type.
# @param [String] application_id
# The application ID from the Google Play developer console.
# @param [String] end_point_type
# Type of endpoint being requested.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::EndPoint] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::EndPoint]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_application_end_point(application_id: nil, end_point_type: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/applications/getEndPoint', options)
command.response_representation = Google::Apis::GamesV1::EndPoint::Representation
command.response_class = Google::Apis::GamesV1::EndPoint
command.query['applicationId'] = application_id unless application_id.nil?
command.query['endPointType'] = end_point_type unless end_point_type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Indicate that the currently authenticated user is playing your application.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def played_application(fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/applications/played', options)
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Verifies the auth token provided with this request is for the application with
# the specified ID, and returns the ID of the player it was granted for.
# @param [String] application_id
# The application ID from the Google Play developer console.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ApplicationVerifyResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ApplicationVerifyResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def verify_application(application_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/applications/{applicationId}/verify', options)
command.response_representation = Google::Apis::GamesV1::ApplicationVerifyResponse::Representation
command.response_class = Google::Apis::GamesV1::ApplicationVerifyResponse
command.params['applicationId'] = application_id unless application_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a list showing the current progress on events in this application for
# the currently authenticated user.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of events to return in the response, used for paging. For
# any response, the actual number of events to return may be less than the
# specified maxResults.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListPlayerEventResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListPlayerEventResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_event_by_player(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/events', options)
command.response_representation = Google::Apis::GamesV1::ListPlayerEventResponse::Representation
command.response_class = Google::Apis::GamesV1::ListPlayerEventResponse
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a list of the event definitions in this application.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of event definitions to return in the response, used for
# paging. For any response, the actual number of event definitions to return may
# be less than the specified `maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListEventDefinitionResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListEventDefinitionResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_event_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/eventDefinitions', options)
command.response_representation = Google::Apis::GamesV1::ListEventDefinitionResponse::Representation
command.response_class = Google::Apis::GamesV1::ListEventDefinitionResponse
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Records a batch of changes to the number of times events have occurred for the
# currently authenticated user of this application.
# @param [Google::Apis::GamesV1::EventRecordRequest] event_record_request_object
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::UpdateEventResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::UpdateEventResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def record_event(event_record_request_object = nil, language: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/events', options)
command.request_representation = Google::Apis::GamesV1::EventRecordRequest::Representation
command.request_object = event_record_request_object
command.response_representation = Google::Apis::GamesV1::UpdateEventResponse::Representation
command.response_class = Google::Apis::GamesV1::UpdateEventResponse
command.query['language'] = language unless language.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the metadata of the leaderboard with the given ID.
# @param [String] leaderboard_id
# The ID of the leaderboard.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::Leaderboard] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::Leaderboard]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_leaderboard(leaderboard_id, language: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/leaderboards/{leaderboardId}', options)
command.response_representation = Google::Apis::GamesV1::Leaderboard::Representation
command.response_class = Google::Apis::GamesV1::Leaderboard
command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
command.query['language'] = language unless language.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all the leaderboard metadata for your application.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of leaderboards to return in the response. For any response,
# the actual number of leaderboards returned may be less than the specified `
# maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListLeaderboardResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListLeaderboardResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_leaderboards(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/leaderboards', options)
command.response_representation = Google::Apis::GamesV1::ListLeaderboardResponse::Representation
command.response_class = Google::Apis::GamesV1::ListLeaderboardResponse
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Return the metagame configuration data for the calling application.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::MetagameConfig] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::MetagameConfig]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_metagame_config(fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/metagameConfig', options)
command.response_representation = Google::Apis::GamesV1::MetagameConfig::Representation
command.response_class = Google::Apis::GamesV1::MetagameConfig
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List play data aggregated per category for the player corresponding to `
# playerId`.
# @param [String] player_id
# A player ID. A value of `me` may be used in place of the authenticated player'
# s ID.
# @param [String] collection
# The collection of categories for which data will be returned.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of category resources to return in the response, used for
# paging. For any response, the actual number of category resources returned may
# be less than the specified `maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListCategoryResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListCategoryResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_metagame_categories_by_player(player_id, collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/players/{playerId}/categories/{collection}', options)
command.response_representation = Google::Apis::GamesV1::ListCategoryResponse::Representation
command.response_class = Google::Apis::GamesV1::ListCategoryResponse
command.params['playerId'] = player_id unless player_id.nil?
command.params['collection'] = collection unless collection.nil?
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the Player resource with the given ID. To retrieve the player for
# the currently authenticated user, set `playerId` to `me`.
# @param [String] player_id
# A player ID. A value of `me` may be used in place of the authenticated player'
# s ID.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::Player] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::Player]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_player(player_id, language: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/players/{playerId}', options)
command.response_representation = Google::Apis::GamesV1::Player::Representation
command.response_class = Google::Apis::GamesV1::Player
command.params['playerId'] = player_id unless player_id.nil?
command.query['language'] = language unless language.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get the collection of players for the currently authenticated user.
# @param [String] collection
# Collection of players being retrieved
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of player resources to return in the response, used for
# paging. For any response, the actual number of player resources returned may
# be less than the specified `maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListPlayerResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListPlayerResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_players(collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/players/me/players/{collection}', options)
command.response_representation = Google::Apis::GamesV1::ListPlayerResponse::Representation
command.response_class = Google::Apis::GamesV1::ListPlayerResponse
command.params['collection'] = collection unless collection.nil?
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Checks whether the games client is out of date.
# @param [String] client_revision
# The revision of the client SDK used by your application. Format: `[
# PLATFORM_TYPE]:[VERSION_NUMBER]`. Possible values of `PLATFORM_TYPE` are: * `
# ANDROID` - Client is running the Android SDK. * `IOS` - Client is running the
# iOS SDK. * `WEB_APP` - Client is running as a Web App.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::CheckRevisionResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::CheckRevisionResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def check_revision(client_revision, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/revisions/check', options)
command.response_representation = Google::Apis::GamesV1::CheckRevisionResponse::Representation
command.response_class = Google::Apis::GamesV1::CheckRevisionResponse
command.query['clientRevision'] = client_revision unless client_revision.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get high scores, and optionally ranks, in leaderboards for the currently
# authenticated player. For a specific time span, `leaderboardId` can be set to `
# ALL` to retrieve data for all leaderboards in a given time span. `NOTE: You
# cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request;
# only one parameter may be set to 'ALL'.
# @param [String] player_id
# A player ID. A value of `me` may be used in place of the authenticated player'
# s ID.
# @param [String] leaderboard_id
# The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all
# leaderboards for this application.
# @param [String] time_span
# The time span for the scores and ranks you're requesting.
# @param [String] include_rank_type
# The types of ranks to return. If the parameter is omitted, no ranks will be
# returned.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of leaderboard scores to return in the response. For any
# response, the actual number of leaderboard scores returned may be less than
# the specified `maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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, options: nil, &block)
command = make_simple_command(:get, 'games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}', options)
command.response_representation = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse::Representation
command.response_class = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse
command.params['playerId'] = player_id unless player_id.nil?
command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
command.params['timeSpan'] = time_span unless time_span.nil?
command.query['includeRankType'] = include_rank_type unless include_rank_type.nil?
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the scores in a leaderboard, starting from the top.
# @param [String] leaderboard_id
# The ID of the leaderboard.
# @param [String] collection
# The collection of scores you're requesting.
# @param [String] time_span
# The time span for the scores and ranks you're requesting.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of leaderboard scores to return in the response. For any
# response, the actual number of leaderboard scores returned may be less than
# the specified `maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::LeaderboardScores] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::LeaderboardScores]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_scores(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/leaderboards/{leaderboardId}/scores/{collection}', options)
command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation
command.response_class = Google::Apis::GamesV1::LeaderboardScores
command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
command.params['collection'] = collection unless collection.nil?
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['timeSpan'] = time_span unless time_span.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the scores in a leaderboard around (and including) a player's score.
# @param [String] leaderboard_id
# The ID of the leaderboard.
# @param [String] collection
# The collection of scores you're requesting.
# @param [String] time_span
# The time span for the scores and ranks you're requesting.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of leaderboard scores to return in the response. For any
# response, the actual number of leaderboard scores returned may be less than
# the specified `maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [Fixnum] results_above
# The preferred number of scores to return above the player's score. More scores
# may be returned if the player is at the bottom of the leaderboard; fewer may
# be returned if the player is at the top. Must be less than or equal to
# maxResults.
# @param [Boolean] return_top_if_absent
# True if the top scores should be returned when the player is not in the
# leaderboard. Defaults to true.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::LeaderboardScores] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::LeaderboardScores]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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, options: nil, &block)
command = make_simple_command(:get, 'games/v1/leaderboards/{leaderboardId}/window/{collection}', options)
command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation
command.response_class = Google::Apis::GamesV1::LeaderboardScores
command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
command.params['collection'] = collection unless collection.nil?
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['resultsAbove'] = results_above unless results_above.nil?
command.query['returnTopIfAbsent'] = return_top_if_absent unless return_top_if_absent.nil?
command.query['timeSpan'] = time_span unless time_span.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Submits a score to the specified leaderboard.
# @param [String] leaderboard_id
# The ID of the leaderboard.
# @param [Fixnum] score
# The score you're submitting. The submitted score is ignored if it is worse
# than a previously submitted score, where worse depends on the leaderboard sort
# order. The meaning of the score value depends on the leaderboard format type.
# For fixed-point, the score represents the raw value. For time, the score
# represents elapsed time in milliseconds. For currency, the score represents a
# value in micro units.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [String] score_tag
# Additional information about the score you're submitting. Values must contain
# no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::PlayerScoreResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::PlayerScoreResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def submit_score(leaderboard_id, score, language: nil, score_tag: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/leaderboards/{leaderboardId}/scores', options)
command.response_representation = Google::Apis::GamesV1::PlayerScoreResponse::Representation
command.response_class = Google::Apis::GamesV1::PlayerScoreResponse
command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
command.query['language'] = language unless language.nil?
command.query['score'] = score unless score.nil?
command.query['scoreTag'] = score_tag unless score_tag.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Submits multiple scores to leaderboards.
# @param [Google::Apis::GamesV1::PlayerScoreSubmissionList] player_score_submission_list_object
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListPlayerScoreResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListPlayerScoreResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def submit_score_multiple(player_score_submission_list_object = nil, language: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/leaderboards/scores', options)
command.request_representation = Google::Apis::GamesV1::PlayerScoreSubmissionList::Representation
command.request_object = player_score_submission_list_object
command.response_representation = Google::Apis::GamesV1::ListPlayerScoreResponse::Representation
command.response_class = Google::Apis::GamesV1::ListPlayerScoreResponse
command.query['language'] = language unless language.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the metadata for a given snapshot ID.
# @param [String] snapshot_id
# The ID of the snapshot.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::Snapshot] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::Snapshot]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_snapshot(snapshot_id, language: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/snapshots/{snapshotId}', options)
command.response_representation = Google::Apis::GamesV1::Snapshot::Representation
command.response_class = Google::Apis::GamesV1::Snapshot
command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
command.query['language'] = language unless language.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves a list of snapshots created by your application for the player
# corresponding to the player ID.
# @param [String] player_id
# A player ID. A value of `me` may be used in place of the authenticated player'
# s ID.
# @param [String] language
# The preferred language to use for strings returned by this method.
# @param [Fixnum] max_results
# The maximum number of snapshot resources to return in the response, used for
# paging. For any response, the actual number of snapshot resources returned may
# be less than the specified `maxResults`.
# @param [String] page_token
# The token returned by the previous request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ListSnapshotResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ListSnapshotResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_snapshots(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/players/{playerId}/snapshots', options)
command.response_representation = Google::Apis::GamesV1::ListSnapshotResponse::Representation
command.response_class = Google::Apis::GamesV1::ListSnapshotResponse
command.params['playerId'] = player_id unless player_id.nil?
command.query['language'] = language unless language.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Resolves any potential conflicts according to the resolution policy specified
# in the request and returns the snapshot head after the resolution.
# @param [String] snapshot_name
# Required. Name of the snapshot.
# @param [Google::Apis::GamesV1::ResolveSnapshotHeadRequest] resolve_snapshot_head_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::ResolveSnapshotHeadResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::ResolveSnapshotHeadResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def resolve_snapshots_extended_snapshot_head(snapshot_name, resolve_snapshot_head_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'games/v1/snapshotsExtended/{snapshotName}:resolveHead', options)
command.request_representation = Google::Apis::GamesV1::ResolveSnapshotHeadRequest::Representation
command.request_object = resolve_snapshot_head_request_object
command.response_representation = Google::Apis::GamesV1::ResolveSnapshotHeadResponse::Representation
command.response_class = Google::Apis::GamesV1::ResolveSnapshotHeadResponse
command.params['snapshotName'] = snapshot_name unless snapshot_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns engagement and spend statistics in this application for the currently
# authenticated user.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GamesV1::StatsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GamesV1::StatsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_stat(fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'games/v1/stats', options)
command.response_representation = Google::Apis::GamesV1::StatsResponse::Representation
command.response_class = Google::Apis::GamesV1::StatsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|