gs2-ruby-sdk-matchmaking 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.buildpath +5 -0
- data/.gitignore +10 -0
- data/.project +17 -0
- data/Gemfile +5 -0
- data/README.md +2 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/gs2-ruby-sdk-matchmaking.gemspec +26 -0
- data/lib/gs2/matchmaking/Client.rb +998 -0
- data/lib/gs2/matchmaking/version.rb +5 -0
- data/lib/gs2-matchmaking.rb +1 -0
- metadata +112 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 2e9b2503ddf19fb9d54c3ba60076737c4cdc4ab4
|
4
|
+
data.tar.gz: 202992fffeecb63f027ca0b641beda5095571d80
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7e4ad05ac0324287efa050ed2070fd93d6443ce593e925691b2cc869887cd6082995f402cf91834b735835268883c454622a7a85fe67e9f861d5cca7d746db88
|
7
|
+
data.tar.gz: dc08a40a55dc8b11c538fb1ccf6e442d1f504eaeec97f62d389fbf26866fb7e8f6f8f9f46553283bfc932a35fcfcd10aafac7f3d72798d343fdd3c605e678a55
|
data/.buildpath
ADDED
data/.gitignore
ADDED
data/.project
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<projectDescription>
|
3
|
+
<name>gs2-ruby-sdk-matchmaking</name>
|
4
|
+
<comment></comment>
|
5
|
+
<projects>
|
6
|
+
</projects>
|
7
|
+
<buildSpec>
|
8
|
+
<buildCommand>
|
9
|
+
<name>org.eclipse.dltk.core.scriptbuilder</name>
|
10
|
+
<arguments>
|
11
|
+
</arguments>
|
12
|
+
</buildCommand>
|
13
|
+
</buildSpec>
|
14
|
+
<natures>
|
15
|
+
<nature>org.eclipse.dltk.ruby.core.nature</nature>
|
16
|
+
</natures>
|
17
|
+
</projectDescription>
|
data/Gemfile
ADDED
data/README.md
ADDED
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "gs2/sdk/for/ruby/matchmaking"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'gs2/matchmaking/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "gs2-ruby-sdk-matchmaking"
|
8
|
+
spec.version = Gs2::Matchmaking::VERSION
|
9
|
+
spec.authors = ["Game Server Services, Inc."]
|
10
|
+
spec.email = ["contact@gs2.io"]
|
11
|
+
spec.licenses = "Apache-2.0"
|
12
|
+
|
13
|
+
spec.summary = %q{Game Server Services GS2-Matchmaking Client Library}
|
14
|
+
spec.homepage = "https://gs2.io/"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
17
|
+
spec.bindir = "exe"
|
18
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency "gs2-ruby-sdk-core", "~> 0.0.1"
|
22
|
+
spec.add_dependency "gs2-ruby-sdk-auth", "~> 0.0.1"
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.12"
|
25
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
26
|
+
end
|
@@ -0,0 +1,998 @@
|
|
1
|
+
require 'gs2/core/AbstractClient.rb'
|
2
|
+
|
3
|
+
module Gs2 module Matchmaking
|
4
|
+
|
5
|
+
# GS2-Matchmaking クライアント
|
6
|
+
#
|
7
|
+
# @author Game Server Services, Inc.
|
8
|
+
class Client < Gs2::Core::AbstractClient
|
9
|
+
|
10
|
+
@@ENDPOINT = 'matchmaking'
|
11
|
+
|
12
|
+
# コンストラクタ
|
13
|
+
#
|
14
|
+
# @param region [String] リージョン名
|
15
|
+
# @param gs2_client_id [String] GSIクライアントID
|
16
|
+
# @param gs2_client_secret [String] GSIクライアントシークレット
|
17
|
+
def initialize(region, gs2_client_id, gs2_client_secret)
|
18
|
+
super(region, gs2_client_id, gs2_client_secret)
|
19
|
+
end
|
20
|
+
|
21
|
+
# デバッグ用。通常利用する必要はありません。
|
22
|
+
def self.ENDPOINT(v = nil)
|
23
|
+
if v
|
24
|
+
@@ENDPOINT = v
|
25
|
+
else
|
26
|
+
return @@ENDPOINT
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
# マッチメイキングリストを取得
|
31
|
+
#
|
32
|
+
# @param pageToken [String] ページトークン
|
33
|
+
# @param limit [Integer] 取得件数
|
34
|
+
# @return [Array]
|
35
|
+
# * items
|
36
|
+
# [Array]
|
37
|
+
# * matchmakingId => マッチメイキングID
|
38
|
+
# * ownerId => オーナーID
|
39
|
+
# * name => マッチメイキング名
|
40
|
+
# * description => 説明文
|
41
|
+
# * type => 種類
|
42
|
+
# * maxPlayer => 最大プレイヤー数
|
43
|
+
# * serviceClass => サービスクラス
|
44
|
+
# * callback => コールバックURL
|
45
|
+
# * createAt => 作成日時
|
46
|
+
# * updateAt => 更新日時
|
47
|
+
# * nextPageToken => 次ページトークン
|
48
|
+
def describe_matchmaking(pageToken = nil, limit = nil)
|
49
|
+
query = {}
|
50
|
+
if pageToken; query['pageToken'] = pageToken; end
|
51
|
+
if limit; query['limit'] = limit; end
|
52
|
+
return get(
|
53
|
+
'Gs2Matchmaking',
|
54
|
+
'DescribeMatchmaking',
|
55
|
+
@@ENDPOINT,
|
56
|
+
'/matchmaking',
|
57
|
+
query);
|
58
|
+
end
|
59
|
+
|
60
|
+
# サービスクラスリストを取得
|
61
|
+
#
|
62
|
+
# @return [Array] サービスクラス
|
63
|
+
def describe_service_class()
|
64
|
+
query = {}
|
65
|
+
result = get(
|
66
|
+
'Gs2Matchmaking',
|
67
|
+
'DescribeServiceClass',
|
68
|
+
@@ENDPOINT,
|
69
|
+
'/matchmaking/serviceClass',
|
70
|
+
query);
|
71
|
+
return result['items'];
|
72
|
+
end
|
73
|
+
|
74
|
+
# マッチメイキングを作成<br>
|
75
|
+
# <br>
|
76
|
+
# GS2-Matchmaking を利用するためにまず作成するデータモデルです。<br>
|
77
|
+
# マッチメイキングの設定項目として、マッチメイキングの方式や最大プレイヤー数を設定します。<br>
|
78
|
+
#
|
79
|
+
# @param request [Array]
|
80
|
+
# * name => マッチメイキング名
|
81
|
+
# * description => 説明文
|
82
|
+
# * serviceClass => サービスクラス
|
83
|
+
# * type => 種類
|
84
|
+
# * maxPlayer => 最大プレイヤー数
|
85
|
+
# * callback => コールバックURL
|
86
|
+
# @return [Array]
|
87
|
+
# * item
|
88
|
+
# * matchmakingId => マッチメイキングID
|
89
|
+
# * ownerId => オーナーID
|
90
|
+
# * name => マッチメイキング名
|
91
|
+
# * description => 説明文
|
92
|
+
# * type => 種類
|
93
|
+
# * maxPlayer => 最大プレイヤー数
|
94
|
+
# * serviceClass => サービスクラス
|
95
|
+
# * callback => コールバックURL
|
96
|
+
# * createAt => 作成日時
|
97
|
+
# * updateAt => 更新日時
|
98
|
+
def create_matchmaking(request)
|
99
|
+
if not request; raise ArgumentError.new(); end
|
100
|
+
body = {}
|
101
|
+
if request.has_key?('name'); body['name'] = request['name']; end
|
102
|
+
if request.has_key?('description'); body['description'] = request['description']; end
|
103
|
+
if request.has_key?('serviceClass'); body['serviceClass'] = request['serviceClass']; end
|
104
|
+
if request.has_key?('type'); body['type'] = request['type']; end
|
105
|
+
if request.has_key?('maxPlayer'); body['maxPlayer'] = request['maxPlayer']; end
|
106
|
+
if request.has_key?('callback'); body['callback'] = request['callback']; end
|
107
|
+
query = {}
|
108
|
+
return post(
|
109
|
+
'Gs2Matchmaking',
|
110
|
+
'CreateMatchmaking',
|
111
|
+
@@ENDPOINT,
|
112
|
+
'/matchmaking',
|
113
|
+
body,
|
114
|
+
query);
|
115
|
+
end
|
116
|
+
|
117
|
+
# マッチメイキングを取得
|
118
|
+
#
|
119
|
+
# @param request [Array]
|
120
|
+
# * matchmakingName => マッチメイキング名
|
121
|
+
# @return [Array]
|
122
|
+
# * item
|
123
|
+
# * matchmakingId => マッチメイキングID
|
124
|
+
# * ownerId => オーナーID
|
125
|
+
# * name => マッチメイキング名
|
126
|
+
# * description => 説明文
|
127
|
+
# * type => 種類
|
128
|
+
# * maxPlayer => 最大プレイヤー数
|
129
|
+
# * serviceClass => サービスクラス
|
130
|
+
# * callback => コールバックURL
|
131
|
+
# * createAt => 作成日時
|
132
|
+
# * updateAt => 更新日時
|
133
|
+
def get_matchmaking(request)
|
134
|
+
if not request; raise ArgumentError.new(); end
|
135
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
136
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
137
|
+
query = {}
|
138
|
+
return get(
|
139
|
+
'Gs2Matchmaking',
|
140
|
+
'GetMatchmaking',
|
141
|
+
@@ENDPOINT,
|
142
|
+
'/matchmaking/' + request['matchmakingName'],
|
143
|
+
query);
|
144
|
+
end
|
145
|
+
|
146
|
+
# マッチメイキングの状態を取得
|
147
|
+
#
|
148
|
+
# @param request [Array]
|
149
|
+
# * matchmakingName => マッチメイキング名
|
150
|
+
# @return [Array]
|
151
|
+
# * status => 状態
|
152
|
+
def get_matchmaking_status(request)
|
153
|
+
if not request; raise ArgumentError.new(); end
|
154
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
155
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
156
|
+
query = {}
|
157
|
+
return get(
|
158
|
+
'Gs2Matchmaking',
|
159
|
+
'GetMatchmakingStatus',
|
160
|
+
@@ENDPOINT,
|
161
|
+
'/matchmaking/' + request['matchmakingName'] + '/status',
|
162
|
+
query);
|
163
|
+
end
|
164
|
+
|
165
|
+
# マッチメイキングを更新
|
166
|
+
#
|
167
|
+
# @param request [Array]
|
168
|
+
# * matchmakingName => マッチメイキング名
|
169
|
+
# * description => 説明文
|
170
|
+
# * serviceClass => サービスクラス
|
171
|
+
# * callback => コールバックURL
|
172
|
+
# @return [Array]
|
173
|
+
# * item
|
174
|
+
# * matchmakingId => マッチメイキングID
|
175
|
+
# * ownerId => オーナーID
|
176
|
+
# * name => マッチメイキング名
|
177
|
+
# * description => 説明文
|
178
|
+
# * type => 種類
|
179
|
+
# * maxPlayer => 最大プレイヤー数
|
180
|
+
# * serviceClass => サービスクラス
|
181
|
+
# * callback => コールバックURL
|
182
|
+
# * createAt => 作成日時
|
183
|
+
# * updateAt => 更新日時
|
184
|
+
def update_matchmaking(request)
|
185
|
+
if not request; raise ArgumentError.new(); end
|
186
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
187
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
188
|
+
body = {}
|
189
|
+
if request.has_key?('description'); body['description'] = request['description']; end
|
190
|
+
if request.has_key?('serviceClass'); body['serviceClass'] = request['serviceClass']; end
|
191
|
+
if request.has_key?('callback'); body['callback'] = request['callback']; end
|
192
|
+
query = {}
|
193
|
+
return put(
|
194
|
+
'Gs2Matchmaking',
|
195
|
+
'UpdateMatchmaking',
|
196
|
+
@@ENDPOINT,
|
197
|
+
'/matchmaking/' + request['matchmakingName'],
|
198
|
+
body,
|
199
|
+
query);
|
200
|
+
end
|
201
|
+
|
202
|
+
# マッチメイキングを削除
|
203
|
+
#
|
204
|
+
# @param request [Array]
|
205
|
+
# * matchmakingName => マッチメイキング名
|
206
|
+
def delete_matchmaking(request)
|
207
|
+
if not request; raise ArgumentError.new(); end
|
208
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
209
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
210
|
+
query = {}
|
211
|
+
return delete(
|
212
|
+
'Gs2Matchmaking',
|
213
|
+
'DeleteMatchmaking',
|
214
|
+
@@ENDPOINT,
|
215
|
+
'/matchmaking/' + request['matchmakingName'],
|
216
|
+
query);
|
217
|
+
end
|
218
|
+
|
219
|
+
# Anybodyマッチメイキング - マッチメイキングを実行<br>
|
220
|
+
# <br>
|
221
|
+
# Anybodyマッチメイキングのマッチメイキングプロセスは、このAPIを呼び出すことで完結します。<br>
|
222
|
+
# このAPIを呼び出した段階で参加者を待っているギャザリングが存在すれば参加し、<br>
|
223
|
+
# 参加者を待っているギャザリングが存在しなければ、新しくギャザリングに作成して、そのギャザリングに参加します。<br>
|
224
|
+
# <br>
|
225
|
+
# 戻り値にはギャザリングに参加している人数が含まれますので、自分がギャザリングを作成したのかはそこで確認することができます。<br>
|
226
|
+
# <br>
|
227
|
+
# マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。<br>
|
228
|
+
# マッチメイキングの進捗を確認したい場合は {#anybody_describe_joined_user} を呼び出すことで、<br>
|
229
|
+
# ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。<br>
|
230
|
+
# <br>
|
231
|
+
# ユーザ操作などにより、マッチメイキングを中断する場合は {#anybody_leave_gathering} を呼び出すことで中断できます。<br>
|
232
|
+
# GS2-Matchmaking にはホストという明確な役割は存在しないため、ギャザリングを作成したユーザがマッチメイキングを中断したとしてもマッチメイキングは継続されます。<br>
|
233
|
+
# <br>
|
234
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
235
|
+
#
|
236
|
+
# @param request [Array]
|
237
|
+
# * matchmakingName => マッチメイキング名
|
238
|
+
# * accessToken => アクセストークン
|
239
|
+
# @return [Array]
|
240
|
+
# * item
|
241
|
+
# * gatheringId => ギャザリングID
|
242
|
+
# * joinPlayer => 参加プレイヤー数
|
243
|
+
# * updateAt => 更新日時
|
244
|
+
def anybody_do_matchmaking(request)
|
245
|
+
if not request; raise ArgumentError.new(); end
|
246
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
247
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
248
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
249
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
250
|
+
body = {}
|
251
|
+
query = {}
|
252
|
+
header = {
|
253
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
254
|
+
}
|
255
|
+
return post(
|
256
|
+
'Gs2Matchmaking',
|
257
|
+
'DoMatchmaking',
|
258
|
+
@@ENDPOINT,
|
259
|
+
'/matchmaking/' + request['matchmakingName'] + "/anybody",
|
260
|
+
body,
|
261
|
+
query,
|
262
|
+
header);
|
263
|
+
end
|
264
|
+
|
265
|
+
# Anybodyマッチメイキング - ギャザリングに参加しているユーザID一覧取得を実行<br>
|
266
|
+
# <br>
|
267
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
268
|
+
#
|
269
|
+
# @param request [Array]
|
270
|
+
# * matchmakingName => マッチメイキング名
|
271
|
+
# * gatheringId => ギャザリングID
|
272
|
+
# * accessToken => アクセストークン
|
273
|
+
# @return [Array]
|
274
|
+
# * items => 参加ユーザID一覧
|
275
|
+
def anybody_describe_joined_user(request)
|
276
|
+
if not request; raise ArgumentError.new(); end
|
277
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
278
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
279
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
280
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
281
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
282
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
283
|
+
query = {}
|
284
|
+
header = {
|
285
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
286
|
+
}
|
287
|
+
return get(
|
288
|
+
'Gs2Matchmaking',
|
289
|
+
'DescribeJoinedUser',
|
290
|
+
@@ENDPOINT,
|
291
|
+
'/matchmaking/' + request['matchmakingName'] + "/anybody/" + request['gatheringId'] + "/player",
|
292
|
+
query,
|
293
|
+
header);
|
294
|
+
end
|
295
|
+
|
296
|
+
# Anybodyマッチメイキング - ギャザリングからの離脱を実行<br>
|
297
|
+
# <br>
|
298
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
299
|
+
#
|
300
|
+
# @param request [Array]
|
301
|
+
# * matchmakingName => マッチメイキング名
|
302
|
+
# * gatheringId => ギャザリングID
|
303
|
+
# * accessToken => アクセストークン
|
304
|
+
def anybody_leave_gathering(request)
|
305
|
+
if not request; raise ArgumentError.new(); end
|
306
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
307
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
308
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
309
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
310
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
311
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
312
|
+
query = {}
|
313
|
+
header = {
|
314
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
315
|
+
}
|
316
|
+
delete(
|
317
|
+
'Gs2Matchmaking',
|
318
|
+
'LeaveGathering',
|
319
|
+
@@ENDPOINT,
|
320
|
+
'/matchmaking/' + request['matchmakingName'] + "/anybody/" + request['gatheringId'] + "/player",
|
321
|
+
query,
|
322
|
+
header);
|
323
|
+
end
|
324
|
+
|
325
|
+
# CustomAutoマッチメイキング - <br>
|
326
|
+
# <br>
|
327
|
+
# CustomAutoマッチメイキングを実行する場合は、基本的にはこのAPIを呼び出すことで完結します。<br>
|
328
|
+
# CustomAutoマッチメイキングのリクエストパラメータには、参加対象となるギャザリングの属性値の範囲を指定して行われます。<br>
|
329
|
+
# 属性値は最大5個指定することができ、属性値毎に検索する最小値・最大値を指定できます。<br>
|
330
|
+
# すべての属性値が希望する範囲内に収まっているギャザリングを見つけた場合はそのギャザリングに参加します。<br>
|
331
|
+
# <br>
|
332
|
+
# 一定時間内にすべてのギャザリングの検索を終えることができなかった場合は、searchContext というパラメータを応答します。<br>
|
333
|
+
# この場合、searchContext を指定して このAPIを再度呼び出すことで、検索を再開することができます。<br>
|
334
|
+
# この際に指定する検索条件は以前の searchContext と同じ条件にするようにしてください。<br>
|
335
|
+
# 条件が変更されたうえで、searchContext を利用した場合の動作は保証できません。<br>
|
336
|
+
# <br>
|
337
|
+
# すべてのギャザリングを検索した結果、対象となるギャザリングが存在しなかった場合は、新しくギャザリングを作成し、そのギャザリングに参加します。<br>
|
338
|
+
# <br>
|
339
|
+
# 戻り値にはギャザリングに参加している人数が含まれますので、自分がギャザリングを作成したのかはそこで確認することができます。<br>
|
340
|
+
# <br>
|
341
|
+
# マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。<br>
|
342
|
+
# マッチメイキングの進捗を確認したい場合は {#custom_auto_describe_joined_user} を呼び出すことで、<br>
|
343
|
+
# ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。<br>
|
344
|
+
# <br>
|
345
|
+
# ユーザ操作などにより、マッチメイキングを中断する場合は {#custom_auto_leave_gathering} を呼び出すことで中断できます。<br>
|
346
|
+
# GS2-Matchmaking にはホストという明確な役割は存在しないため、ギャザリングを作成したユーザがマッチメイキングを中断したとしてもマッチメイキングは継続されます。<br>
|
347
|
+
# <br>
|
348
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
349
|
+
#
|
350
|
+
# @param request [Array]
|
351
|
+
# * matchmakingName => マッチメイキング名
|
352
|
+
# * attribute1 => ギャザリング新規作成時の属性1
|
353
|
+
# * attribute2 => ギャザリング新規作成時の属性2
|
354
|
+
# * attribute3 => ギャザリング新規作成時の属性3
|
355
|
+
# * attribute4 => ギャザリング新規作成時の属性4
|
356
|
+
# * attribute5 => ギャザリング新規作成時の属性5
|
357
|
+
# * searchAttribute1Min => 検索対象ギャザリング属性1の下限
|
358
|
+
# * searchAttribute1Max => 検索対象ギャザリング属性1の上限
|
359
|
+
# * searchAttribute2Min => 検索対象ギャザリング属性2の下限
|
360
|
+
# * searchAttribute2Max => 検索対象ギャザリング属性2の上限
|
361
|
+
# * searchAttribute3Min => 検索対象ギャザリング属性3の下限
|
362
|
+
# * searchAttribute3Max => 検索対象ギャザリング属性3の上限
|
363
|
+
# * searchAttribute4Min => 検索対象ギャザリング属性4の下限
|
364
|
+
# * searchAttribute4Max => 検索対象ギャザリング属性4の上限
|
365
|
+
# * searchAttribute5Min => 検索対象ギャザリング属性5の下限
|
366
|
+
# * searchAttribute5Max => 検索対象ギャザリング属性5の上限
|
367
|
+
# * searchContext => 検索コンテキスト
|
368
|
+
# * accessToken => アクセストークン
|
369
|
+
# @return [Array]
|
370
|
+
# * done => 検索が完了したか
|
371
|
+
# * item
|
372
|
+
# * gatheringId => ギャザリングID
|
373
|
+
# * joinPlayer => 参加プレイヤー数
|
374
|
+
# * updateAt => 更新日時
|
375
|
+
# * searchContext => 検索コンテキスト
|
376
|
+
def custom_auto_do_matchmaking(request)
|
377
|
+
if not request; raise ArgumentError.new(); end
|
378
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
379
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
380
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
381
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
382
|
+
body = {}
|
383
|
+
if request.has_key?('attribute1'); body['attribute1'] = request['attribute1']; end
|
384
|
+
if request.has_key?('attribute2'); body['attribute2'] = request['attribute2']; end
|
385
|
+
if request.has_key?('attribute3'); body['attribute3'] = request['attribute3']; end
|
386
|
+
if request.has_key?('attribute4'); body['attribute4'] = request['attribute4']; end
|
387
|
+
if request.has_key?('attribute5'); body['attribute5'] = request['attribute5']; end
|
388
|
+
if request.has_key?('searchAttribute1Min'); body['searchAttribute1Min'] = request['searchAttribute1Min']; end
|
389
|
+
if request.has_key?('searchAttribute2Min'); body['searchAttribute2Min'] = request['searchAttribute2Min']; end
|
390
|
+
if request.has_key?('searchAttribute3Min'); body['searchAttribute3Min'] = request['searchAttribute3Min']; end
|
391
|
+
if request.has_key?('searchAttribute4Min'); body['searchAttribute4Min'] = request['searchAttribute4Min']; end
|
392
|
+
if request.has_key?('searchAttribute5Min'); body['searchAttribute5Min'] = request['searchAttribute5Min']; end
|
393
|
+
if request.has_key?('searchAttribute1Max'); body['searchAttribute1Max'] = request['searchAttribute1Max']; end
|
394
|
+
if request.has_key?('searchAttribute2Max'); body['searchAttribute2Max'] = request['searchAttribute2Max']; end
|
395
|
+
if request.has_key?('searchAttribute3Max'); body['searchAttribute3Max'] = request['searchAttribute3Max']; end
|
396
|
+
if request.has_key?('searchAttribute4Max'); body['searchAttribute4Max'] = request['searchAttribute4Max']; end
|
397
|
+
if request.has_key?('searchAttribute5Max'); body['searchAttribute5Max'] = request['searchAttribute5Max']; end
|
398
|
+
if request.has_key?('searchContext'); body['searchContext'] = request['searchContext']; end
|
399
|
+
query = {}
|
400
|
+
header = {
|
401
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
402
|
+
}
|
403
|
+
return post(
|
404
|
+
'Gs2Matchmaking',
|
405
|
+
'DoMatchmaking',
|
406
|
+
@@ENDPOINT,
|
407
|
+
'/matchmaking/' + request['matchmakingName'] + "/customauto",
|
408
|
+
body,
|
409
|
+
query,
|
410
|
+
header);
|
411
|
+
end
|
412
|
+
|
413
|
+
# CustomAutoマッチメイキング - ギャザリングに参加しているユーザID一覧取得を実行<br>
|
414
|
+
# <br>
|
415
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
416
|
+
#
|
417
|
+
# @param request [Array]
|
418
|
+
# * matchmakingName => マッチメイキング名
|
419
|
+
# * gatheringId => ギャザリングID
|
420
|
+
# * accessToken => アクセストークン
|
421
|
+
# @return [Array]
|
422
|
+
# * items => 参加ユーザID一覧
|
423
|
+
def custom_auto_describe_joined_user(request)
|
424
|
+
if not request; raise ArgumentError.new(); end
|
425
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
426
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
427
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
428
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
429
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
430
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
431
|
+
query = {}
|
432
|
+
header = {
|
433
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
434
|
+
}
|
435
|
+
return get(
|
436
|
+
'Gs2Matchmaking',
|
437
|
+
'DescribeJoinedUser',
|
438
|
+
@@ENDPOINT,
|
439
|
+
'/matchmaking/' + request['matchmakingName'] + "/customauto/" + request['gatheringId'] + "/player",
|
440
|
+
query,
|
441
|
+
header);
|
442
|
+
end
|
443
|
+
|
444
|
+
# CustomAutoマッチメイキング - ギャザリングからの離脱を実行<br>
|
445
|
+
# <br>
|
446
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
447
|
+
#
|
448
|
+
# @param request [Array]
|
449
|
+
# * matchmakingName => マッチメイキング名
|
450
|
+
# * gatheringId => ギャザリングID
|
451
|
+
# * accessToken => アクセストークン
|
452
|
+
def custom_auto_leave_gathering(request)
|
453
|
+
if not request; raise ArgumentError.new(); end
|
454
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
455
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
456
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
457
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
458
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
459
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
460
|
+
query = {}
|
461
|
+
header = {
|
462
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
463
|
+
}
|
464
|
+
return delete(
|
465
|
+
'Gs2Matchmaking',
|
466
|
+
'LeaveGathering',
|
467
|
+
@@ENDPOINT,
|
468
|
+
'/matchmaking/' + request['matchmakingName'] + "/customauto/" + request['gatheringId'] + "/player",
|
469
|
+
query,
|
470
|
+
header);
|
471
|
+
end
|
472
|
+
|
473
|
+
# Passcodeマッチメイキング - ギャザリングを作成<br>
|
474
|
+
# <br>
|
475
|
+
# Passcodeマッチメイキングの開始手段は2つに別れます。<br>
|
476
|
+
# ひとつ目は既存のギャザリングに参加すること。もう一つはこのAPIで実行できる、新しくギャザリングを作成する。という手段です。<br>
|
477
|
+
# <br>
|
478
|
+
# ギャザリングを新しく作成するにあたって必要なパラメータなどはありません。<br>
|
479
|
+
# このAPIを呼び出すことでギャザリングが新しく作られ、ギャザリングには固有のパスコード(8ケタ数字)が割り当てられます。<br>
|
480
|
+
# 割り当てられたパスコードは戻り値に含まれています。<br>
|
481
|
+
# <br>
|
482
|
+
# パスコードの上位は乱数、下位はミリ秒単位のタイムスタンプで構成されています。<br>
|
483
|
+
# そのため、非常に短い間隔でリクエストを出した時に、乱数もあるため可能性は低くいですがパスコードが衝突する可能性があります。<br>
|
484
|
+
# その場合はパスコードを入力した時に同一パスコードを持つギャザリングのうちどのギャザリングに参加するかは不定です。<br>
|
485
|
+
# <br>
|
486
|
+
# 万全を期するには、ミリ秒単位でルームの作成が多数衝突する頻度でギャザリングを作成する必要がある場合は、<br>
|
487
|
+
# Anybody や CustomAuto といった方法のマッチメイキングも併用していただき、友達同士と遊びたい場合にのみ Passcode 方式を利用するよう誘導いただくのが得策です。<br>
|
488
|
+
# <br>
|
489
|
+
# ギャザリング作成後は、マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。<br>
|
490
|
+
# マッチメイキングの進捗を確認したい場合は {#passcode_describe_joined_user} を呼び出すことで、<br>
|
491
|
+
# ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。<br>
|
492
|
+
# <br>
|
493
|
+
# ユーザ操作などにより、マッチメイキングを中断する場合は {#passcode_leave_gathering} を呼び出すことで中断できます。<br>
|
494
|
+
# GS2-Matchmaking にはホストという明確な役割は存在しないため、ギャザリングを作成したユーザがマッチメイキングを中断したとしてもマッチメイキングは継続されます。<br>
|
495
|
+
# <br>
|
496
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
497
|
+
#
|
498
|
+
# @param request [Array]
|
499
|
+
# * matchmakingName => マッチメイキング名
|
500
|
+
# * accessToken => アクセストークン
|
501
|
+
# @return [Array]
|
502
|
+
# * item
|
503
|
+
# * gatheringId => ギャザリングID
|
504
|
+
# * joinPlayer => 参加プレイヤー数
|
505
|
+
# * passcode => ギャザリング参加用パスコード
|
506
|
+
# * updateAt => 更新日時
|
507
|
+
def passcode_create_gathering(request)
|
508
|
+
if not request; raise ArgumentError.new(); end
|
509
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
510
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
511
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
512
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
513
|
+
body = {}
|
514
|
+
query = {}
|
515
|
+
header = {
|
516
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
517
|
+
}
|
518
|
+
return post(
|
519
|
+
'Gs2Matchmaking',
|
520
|
+
'CreateGathering',
|
521
|
+
@@ENDPOINT,
|
522
|
+
'/matchmaking/' + request['matchmakingName'] + "/passcode",
|
523
|
+
body,
|
524
|
+
query,
|
525
|
+
header);
|
526
|
+
end
|
527
|
+
|
528
|
+
# Passcodeマッチメイキング - ギャザリングに参加<br>
|
529
|
+
# <br>
|
530
|
+
# Passcodeマッチメイキングの開始手段は2つに別れます。<br>
|
531
|
+
# ひとつ目は新しくギャザリングを作成すること。もう一つはこのAPIで実行できる、既存のギャザリングに参加する。という手段です。<br>
|
532
|
+
# <br>
|
533
|
+
# パスコードの交換方法は GS2 では提供しません。<br>
|
534
|
+
# ソーシャル連携などの手段は各ゲームで実装頂く必要があります。<br>
|
535
|
+
# <br>
|
536
|
+
# 何らかの手段で得たパスコードを指定してこのAPIを呼び出すことで、既存のギャザリングに参加することができます。<br>
|
537
|
+
# <br>
|
538
|
+
# ギャザリング参加後は、マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。<br>
|
539
|
+
# マッチメイキングの進捗を確認したい場合は {#passcode_describe_joined_user} を呼び出すことで、<br>
|
540
|
+
# ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。<br>
|
541
|
+
# <br>
|
542
|
+
# ユーザ操作などにより、マッチメイキングを中断する場合は {#passcode_leave_gathering} を呼び出すことで中断できます。<br>
|
543
|
+
# <br>
|
544
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
545
|
+
#
|
546
|
+
# @param request [Array]
|
547
|
+
# * matchmakingName => マッチメイキング名
|
548
|
+
# * passcode => ギャザリング参加用パスコード
|
549
|
+
# * accessToken => アクセストークン
|
550
|
+
# @return [Array]
|
551
|
+
# * item
|
552
|
+
# * gatheringId => ギャザリングID
|
553
|
+
# * joinPlayer => 参加プレイヤー数
|
554
|
+
# * passcode => ギャザリング参加用パスコード
|
555
|
+
# * updateAt => 更新日時
|
556
|
+
def passcode_join_gathering(request)
|
557
|
+
if not request; raise ArgumentError.new(); end
|
558
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
559
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
560
|
+
if not request.has_key?('passcode'); raise ArgumentError.new(); end
|
561
|
+
if not request['passcode']; raise ArgumentError.new(); end
|
562
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
563
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
564
|
+
body = {}
|
565
|
+
query = {}
|
566
|
+
header = {
|
567
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
568
|
+
}
|
569
|
+
return post(
|
570
|
+
'Gs2Matchmaking',
|
571
|
+
'JoinGathering',
|
572
|
+
@@ENDPOINT,
|
573
|
+
'/matchmaking/' + request['matchmakingName'] + "/passcode/join/" + request['passcode'],
|
574
|
+
body,
|
575
|
+
query,
|
576
|
+
header);
|
577
|
+
end
|
578
|
+
|
579
|
+
# Passcodeマッチメイキング - ギャザリングに参加しているユーザID一覧取得を実行<br>
|
580
|
+
# <br>
|
581
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
582
|
+
#
|
583
|
+
# @param request [Array]
|
584
|
+
# * matchmakingName => マッチメイキング名
|
585
|
+
# * gatheringId => ギャザリングID
|
586
|
+
# * accessToken => アクセストークン
|
587
|
+
# @return [Array]
|
588
|
+
# * items => 参加ユーザID一覧
|
589
|
+
def passcode_describe_joined_user(request)
|
590
|
+
if not request; raise ArgumentError.new(); end
|
591
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
592
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
593
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
594
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
595
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
596
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
597
|
+
query = {}
|
598
|
+
header = {
|
599
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
600
|
+
}
|
601
|
+
return get(
|
602
|
+
'Gs2Matchmaking',
|
603
|
+
'DescribeJoinedUser',
|
604
|
+
@@ENDPOINT,
|
605
|
+
'/matchmaking/' + request['matchmakingName'] + "/passcode/" + request['gatheringId'] + "/player",
|
606
|
+
query,
|
607
|
+
header);
|
608
|
+
end
|
609
|
+
|
610
|
+
# Passcodeマッチメイキング - ギャザリングからの離脱を実行<br>
|
611
|
+
# <br>
|
612
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
613
|
+
#
|
614
|
+
# @param request [Array]
|
615
|
+
# * matchmakingName => マッチメイキング名
|
616
|
+
# * gatheringId => ギャザリングID
|
617
|
+
# * accessToken => アクセストークン
|
618
|
+
def passcode_leave_gathering(request)
|
619
|
+
if not request; raise ArgumentError.new(); end
|
620
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
621
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
622
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
623
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
624
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
625
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
626
|
+
query = {}
|
627
|
+
header = {
|
628
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
629
|
+
}
|
630
|
+
return delete(
|
631
|
+
'Gs2Matchmaking',
|
632
|
+
'LeaveGathering',
|
633
|
+
@@ENDPOINT,
|
634
|
+
'/matchmaking/' + request['matchmakingName'] + "/passcode/" + request['gatheringId'] + "/player",
|
635
|
+
query,
|
636
|
+
header);
|
637
|
+
end
|
638
|
+
|
639
|
+
# Passcodeマッチメイキング - ギャザリングの解散を実行。<br>
|
640
|
+
# <br>
|
641
|
+
# ギャザリングへのプレイヤー募集を中止し、解散します。<br>
|
642
|
+
# 解散によって完了コールバックが返ることはありません。<br>
|
643
|
+
# この操作はギャザリングの作成主のユーザのみ行うことができます。<br>
|
644
|
+
# <br>
|
645
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
646
|
+
#
|
647
|
+
# @param request [Array]
|
648
|
+
# * matchmakingName => マッチメイキング名
|
649
|
+
# * gatheringId => ギャザリングID
|
650
|
+
# * accessToken => アクセストークン
|
651
|
+
def passcode_breakup_gathering(request)
|
652
|
+
if not request; raise ArgumentError.new(); end
|
653
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
654
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
655
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
656
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
657
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
658
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
659
|
+
query = {}
|
660
|
+
header = {
|
661
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
662
|
+
}
|
663
|
+
return delete(
|
664
|
+
'Gs2Matchmaking',
|
665
|
+
'BreakupGathering',
|
666
|
+
@@ENDPOINT,
|
667
|
+
'/matchmaking/' + request['matchmakingName'] + "/passcode/" + request['gatheringId'],
|
668
|
+
query,
|
669
|
+
header);
|
670
|
+
end
|
671
|
+
|
672
|
+
# Passcodeマッチメイキング - ギャザリングの早期終了を実行。<br>
|
673
|
+
# <br>
|
674
|
+
# ギャザリングへのプレイヤー募集を早期終了します。<br>
|
675
|
+
# Matchmaking で定義した規定人数に満ていない場合もマッチメイキング完了コールバックが返ります。<br>
|
676
|
+
# この操作はギャザリングの作成主のユーザのみ行うことができます。<br>
|
677
|
+
# <br>
|
678
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
679
|
+
#
|
680
|
+
# @param request [Array]
|
681
|
+
# * matchmakingName => マッチメイキング名
|
682
|
+
# * gatheringId => ギャザリングID
|
683
|
+
# * accessToken => アクセストークン
|
684
|
+
def passcode_early_complete_gathering(request)
|
685
|
+
if not request; raise ArgumentError.new(); end
|
686
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
687
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
688
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
689
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
690
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
691
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
692
|
+
body = {}
|
693
|
+
query = {}
|
694
|
+
header = {
|
695
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
696
|
+
}
|
697
|
+
return post(
|
698
|
+
'Gs2Matchmaking',
|
699
|
+
'EarlyCompleteGathering',
|
700
|
+
@@ENDPOINT,
|
701
|
+
'/matchmaking/' + request['matchmakingName'] + "/passcode/" + request['gatheringId'] + "/complete",
|
702
|
+
body,
|
703
|
+
query,
|
704
|
+
header);
|
705
|
+
end
|
706
|
+
|
707
|
+
# Roomマッチメイキング - ギャザリングを作成<br>
|
708
|
+
# <br>
|
709
|
+
# Room 方式のマッチメイキングは以下のプロセスで成立します。<br>
|
710
|
+
#
|
711
|
+
# 1. {#room_create_gathering} でギャザリングを作成
|
712
|
+
# 2. {#room_describe_gathering} でギャザリング一覧を取得
|
713
|
+
# 3. 気に入ったルームが見つかったら {#room_join_gathering} でギャザリングに参加
|
714
|
+
#
|
715
|
+
# このAPIでは1番目のプロセスのギャザリングの作成が行えます。<br>
|
716
|
+
# <br>
|
717
|
+
# ギャザリングの作成リクエストには、128バイト以下と非常に小さいですが、ギャザリングのメタ情報を付加することができます。<br>
|
718
|
+
# ここにはホストが遊びたいと思っているゲームモードなどの情報を付与し、ギャザリング一覧での表示に利用できます。<br>
|
719
|
+
# 129バイト以上のデータを利用したい場合はメタデータのURLを格納するなどして対処してください。<br>
|
720
|
+
# <br>
|
721
|
+
# ギャザリング作成後、マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。<br>
|
722
|
+
# マッチメイキングの進捗を確認したい場合は {#room_describe_joined_user} を呼び出すことで、<br>
|
723
|
+
# ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。<br>
|
724
|
+
# <br>
|
725
|
+
# ユーザ操作などにより、マッチメイキングを中断する場合は {#room_leave_gathering} を呼び出すことで中断できます。<br>
|
726
|
+
# GS2-Matchmaking にはホストという明確な役割は存在しないため、ギャザリングを作成したユーザがマッチメイキングを中断したとしてもマッチメイキングは継続されます。<br>
|
727
|
+
# <br>
|
728
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
729
|
+
#
|
730
|
+
# @param request [Array]
|
731
|
+
# * matchmakingName => マッチメイキング名
|
732
|
+
# * meta => メタデータ(Optional)
|
733
|
+
# * accessToken => アクセストークン
|
734
|
+
# @return [Array]
|
735
|
+
# * item
|
736
|
+
# * gatheringId => ギャザリングID
|
737
|
+
# * joinPlayer => 参加プレイヤー数
|
738
|
+
# * meta => メタデータ
|
739
|
+
# * updateAt => 更新日時
|
740
|
+
def room_create_gathering(request)
|
741
|
+
if not request; raise ArgumentError.new(); end
|
742
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
743
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
744
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
745
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
746
|
+
body = {}
|
747
|
+
if request.has_key?('meta'); body['meta'] = request['meta']; end
|
748
|
+
query = {}
|
749
|
+
header = {
|
750
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
751
|
+
}
|
752
|
+
return post(
|
753
|
+
'Gs2Matchmaking',
|
754
|
+
'CreateGathering',
|
755
|
+
@@ENDPOINT,
|
756
|
+
'/matchmaking/' + request['matchmakingName'] + "/room",
|
757
|
+
body,
|
758
|
+
query,
|
759
|
+
header);
|
760
|
+
end
|
761
|
+
|
762
|
+
# Roomマッチメイキング - ギャザリングに参加<br>
|
763
|
+
# <br>
|
764
|
+
# Room 方式のマッチメイキングは以下のプロセスで成立します。<br>
|
765
|
+
#
|
766
|
+
# 1. {#room_create_gathering} でギャザリングを作成
|
767
|
+
# 2. {#room_describe_gathering} でギャザリング一覧を取得
|
768
|
+
# 3. 気に入ったルームが見つかったら {#room_join_gathering} でギャザリングに参加
|
769
|
+
#
|
770
|
+
# <br>
|
771
|
+
# このAPIでは3番目のプロセスのギャザリングへの参加が行えます。<br>
|
772
|
+
# ギャザリングの一覧取得からギャザリングへの参加がアトミックに行われるわけではないので、<br>
|
773
|
+
# このAPIを呼び出した段階では、ギャザリングが解散していたり、すでに満員になっている可能性があります。<br>
|
774
|
+
# そのような場合は、このAPIはエラー応答として、Gs2::Core::BadRequestException 例外をスローします。<br>
|
775
|
+
# <br>
|
776
|
+
# ギャザリング参加後、マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。<br>
|
777
|
+
# マッチメイキングの進捗を確認したい場合は {#room_describe_joined_user} を呼び出すことで、<br>
|
778
|
+
# ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。<br>
|
779
|
+
# <br>
|
780
|
+
# ユーザ操作などにより、マッチメイキングを中断する場合は {#room_leave_gathering} を呼び出すことで中断できます。<br>
|
781
|
+
# <br>
|
782
|
+
# ゲーム利用者にとって、最もニーズに合ったギャザリングに参加できるのが Room 方式のマッチメイキングの特徴ではありますが、<br>
|
783
|
+
# プレイヤー数が多いゲームにおいては、このアトミックに操作が行われないという点がUXにマイナスの影響をおよぼす可能性があります。<br>
|
784
|
+
# どうしても Room 方式でなければならない理由がないのであれば、他のマッチメイキング方式を採用することをおすすめします。<br>
|
785
|
+
# <br>
|
786
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
787
|
+
#
|
788
|
+
# @param request [Array]
|
789
|
+
# * matchmakingName => マッチメイキング名
|
790
|
+
# * gatheringId => ギャザリングID
|
791
|
+
# * accessToken => アクセストークン
|
792
|
+
# @return [Array]
|
793
|
+
# * item
|
794
|
+
# * gatheringId => ギャザリングID
|
795
|
+
# * joinPlayer => 参加プレイヤー数
|
796
|
+
# * meta => メタデータ
|
797
|
+
# * updateAt => 更新日時
|
798
|
+
def room_join_gathering(request)
|
799
|
+
if not request; raise ArgumentError.new(); end
|
800
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
801
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
802
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
803
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
804
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
805
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
806
|
+
body = {}
|
807
|
+
query = {}
|
808
|
+
header = {
|
809
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
810
|
+
}
|
811
|
+
return post(
|
812
|
+
'Gs2Matchmaking',
|
813
|
+
'JoinGathering',
|
814
|
+
@@ENDPOINT,
|
815
|
+
'/matchmaking/' + request['matchmakingName'] + "/room/" + request['gatheringId'],
|
816
|
+
body,
|
817
|
+
query,
|
818
|
+
header);
|
819
|
+
end
|
820
|
+
|
821
|
+
# Roomマッチメイキング - ギャザリング一覧を取得<br>
|
822
|
+
# <br>
|
823
|
+
# Room 方式のマッチメイキングは以下のプロセスで成立します。<br>
|
824
|
+
#
|
825
|
+
# 1. {#room_create_gathering} でギャザリングを作成
|
826
|
+
# 2. {#room_describe_gathering} でギャザリング一覧を取得
|
827
|
+
# 3. 気に入ったルームが見つかったら {#room_join_gathering} でギャザリングに参加
|
828
|
+
#
|
829
|
+
# <br>
|
830
|
+
# このAPIでは2番目のプロセスのギャザリング一覧の取得が行えます。<br>
|
831
|
+
# <br>
|
832
|
+
# ギャザリングの一覧をユーザに提供し、気に入ったギャザリングがあれば次のプロセスへ<br>
|
833
|
+
# 見つからなければ、先頭から取り直すか戻り値に含まれる nextPageToken を利用して次のページを案内できます。<br>
|
834
|
+
#
|
835
|
+
# @param request [Array]
|
836
|
+
# * matchmakingName => マッチメイキング名
|
837
|
+
# * accessToken => アクセストークン
|
838
|
+
# @param pageToken [String] ページトークン
|
839
|
+
# @param limit [Integer] 取得件数
|
840
|
+
# @return [Array]
|
841
|
+
# * items
|
842
|
+
# [Array]
|
843
|
+
# * gatheringId => ギャザリングID
|
844
|
+
# * joinPlayer => 参加プレイヤー数
|
845
|
+
# * meta => メタデータ
|
846
|
+
# * updateAt => 更新日時
|
847
|
+
# * nextPageToken => 次ページトークン
|
848
|
+
def room_describe_gathering(request, pageToken = nil, limit = nil)
|
849
|
+
if not request; raise ArgumentError.new(); end
|
850
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
851
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
852
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
853
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
854
|
+
query = {}
|
855
|
+
if pageToken; query['pageToken'] = pageToken; end
|
856
|
+
if limit; query['limit'] = limit; end
|
857
|
+
header = {
|
858
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
859
|
+
}
|
860
|
+
return get(
|
861
|
+
'Gs2Matchmaking',
|
862
|
+
'DescribeGathering',
|
863
|
+
@@ENDPOINT,
|
864
|
+
'/matchmaking/' + request['matchmakingName'] + "/room/",
|
865
|
+
query,
|
866
|
+
header);
|
867
|
+
end
|
868
|
+
|
869
|
+
# Roomマッチメイキング - ギャザリングに参加しているユーザID一覧取得を実行<br>
|
870
|
+
# <br>
|
871
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
872
|
+
#
|
873
|
+
# @param request [Array]
|
874
|
+
# * matchmakingName => マッチメイキング名
|
875
|
+
# * gatheringId => ギャザリングID
|
876
|
+
# * accessToken => アクセストークン
|
877
|
+
# @return [Array]
|
878
|
+
# * items => 参加ユーザID一覧
|
879
|
+
def room_describe_joined_user(request)
|
880
|
+
if not request; raise ArgumentError.new(); end
|
881
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
882
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
883
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
884
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
885
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
886
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
887
|
+
query = {}
|
888
|
+
header = {
|
889
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
890
|
+
}
|
891
|
+
return get(
|
892
|
+
'Gs2Matchmaking',
|
893
|
+
'DescribeJoinedUser',
|
894
|
+
@@ENDPOINT,
|
895
|
+
'/matchmaking/' + request['matchmakingName'] + "/room/" + request['gatheringId'] + "/player",
|
896
|
+
query,
|
897
|
+
header);
|
898
|
+
end
|
899
|
+
|
900
|
+
# Roomマッチメイキング - ギャザリングからの離脱を実行<br>
|
901
|
+
# <br>
|
902
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
903
|
+
#
|
904
|
+
# @param request [Array]
|
905
|
+
# * matchmakingName => マッチメイキング名
|
906
|
+
# * gatheringId => ギャザリングID
|
907
|
+
# * accessToken => アクセストークン
|
908
|
+
def room_leave_gathering(request)
|
909
|
+
if not request; raise ArgumentError.new(); end
|
910
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
911
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
912
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
913
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
914
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
915
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
916
|
+
query = {}
|
917
|
+
header = {
|
918
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
919
|
+
}
|
920
|
+
return delete(
|
921
|
+
'Gs2Matchmaking',
|
922
|
+
'LeaveGathering',
|
923
|
+
@@ENDPOINT,
|
924
|
+
'/matchmaking/' + request['matchmakingName'] + "/room/" + request['gatheringId'] + "/player",
|
925
|
+
query,
|
926
|
+
header);
|
927
|
+
end
|
928
|
+
|
929
|
+
# Roomマッチメイキング - ギャザリングの解散を実行。<br>
|
930
|
+
# <br>
|
931
|
+
# ギャザリングへのプレイヤー募集を中止し、解散します。<br>
|
932
|
+
# 解散によって完了コールバックが返ることはありません。<br>
|
933
|
+
# この操作はギャザリングの作成主のユーザのみ行うことができます。<br>
|
934
|
+
# <br>
|
935
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
936
|
+
#
|
937
|
+
# @param request [Array]
|
938
|
+
# * matchmakingName => マッチメイキング名
|
939
|
+
# * gatheringId => ギャザリングID
|
940
|
+
# * accessToken => アクセストークン
|
941
|
+
def room_breakup_gathering(request)
|
942
|
+
if not request; raise ArgumentError.new(); end
|
943
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
944
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
945
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
946
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
947
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
948
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
949
|
+
query = {}
|
950
|
+
header = {
|
951
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
952
|
+
}
|
953
|
+
return delete(
|
954
|
+
'Gs2Matchmaking',
|
955
|
+
'BreakupGathering',
|
956
|
+
@@ENDPOINT,
|
957
|
+
'/matchmaking/' + request['matchmakingName'] + "/room/" + request['gatheringId'],
|
958
|
+
query,
|
959
|
+
header);
|
960
|
+
end
|
961
|
+
|
962
|
+
# Roomマッチメイキング - ギャザリングの早期終了を実行。<br>
|
963
|
+
# <br>
|
964
|
+
# ギャザリングへのプレイヤー募集を早期終了します。<br>
|
965
|
+
# Matchmaking で定義した規定人数に満ていない場合もマッチメイキング完了コールバックが返ります。<br>
|
966
|
+
# この操作はギャザリングの作成主のユーザのみ行うことができます。<br>
|
967
|
+
# <br>
|
968
|
+
# accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
|
969
|
+
#
|
970
|
+
# @param request [Array]
|
971
|
+
# * matchmakingName => マッチメイキング名
|
972
|
+
# * gatheringId => ギャザリングID
|
973
|
+
# * accessToken => アクセストークン
|
974
|
+
def room_early_complete_gathering(request)
|
975
|
+
if not request; raise ArgumentError.new(); end
|
976
|
+
if not request.has_key?('matchmakingName'); raise ArgumentError.new(); end
|
977
|
+
if not request['matchmakingName']; raise ArgumentError.new(); end
|
978
|
+
if not request.has_key?('gatheringId'); raise ArgumentError.new(); end
|
979
|
+
if not request['gatheringId']; raise ArgumentError.new(); end
|
980
|
+
if not request.has_key?('accessToken'); raise ArgumentError.new(); end
|
981
|
+
if not request['accessToken']; raise ArgumentError.new(); end
|
982
|
+
body = {}
|
983
|
+
query = {}
|
984
|
+
header = {
|
985
|
+
'X-GS2-ACCESS-TOKEN' => request['accessToken']
|
986
|
+
}
|
987
|
+
return post(
|
988
|
+
'Gs2Matchmaking',
|
989
|
+
'EarlyCompleteGathering',
|
990
|
+
@@ENDPOINT,
|
991
|
+
'/matchmaking/' + request['matchmakingName'] + "/room/" + request['gatheringId'] + "/complete",
|
992
|
+
body,
|
993
|
+
query,
|
994
|
+
header);
|
995
|
+
end
|
996
|
+
|
997
|
+
end
|
998
|
+
end end
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'gs2/matchmaking/Client.rb'
|
metadata
ADDED
@@ -0,0 +1,112 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: gs2-ruby-sdk-matchmaking
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Game Server Services, Inc.
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-10-06 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: gs2-ruby-sdk-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.0.1
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.0.1
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: gs2-ruby-sdk-auth
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 0.0.1
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 0.0.1
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.12'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.12'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '10.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '10.0'
|
69
|
+
description:
|
70
|
+
email:
|
71
|
+
- contact@gs2.io
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".buildpath"
|
77
|
+
- ".gitignore"
|
78
|
+
- ".project"
|
79
|
+
- Gemfile
|
80
|
+
- README.md
|
81
|
+
- Rakefile
|
82
|
+
- bin/console
|
83
|
+
- bin/setup
|
84
|
+
- gs2-ruby-sdk-matchmaking.gemspec
|
85
|
+
- lib/gs2-matchmaking.rb
|
86
|
+
- lib/gs2/matchmaking/Client.rb
|
87
|
+
- lib/gs2/matchmaking/version.rb
|
88
|
+
homepage: https://gs2.io/
|
89
|
+
licenses:
|
90
|
+
- Apache-2.0
|
91
|
+
metadata: {}
|
92
|
+
post_install_message:
|
93
|
+
rdoc_options: []
|
94
|
+
require_paths:
|
95
|
+
- lib
|
96
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
97
|
+
requirements:
|
98
|
+
- - ">="
|
99
|
+
- !ruby/object:Gem::Version
|
100
|
+
version: '0'
|
101
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
102
|
+
requirements:
|
103
|
+
- - ">="
|
104
|
+
- !ruby/object:Gem::Version
|
105
|
+
version: '0'
|
106
|
+
requirements: []
|
107
|
+
rubyforge_project:
|
108
|
+
rubygems_version: 2.5.1
|
109
|
+
signing_key:
|
110
|
+
specification_version: 4
|
111
|
+
summary: Game Server Services GS2-Matchmaking Client Library
|
112
|
+
test_files: []
|