- HTTP リクエスト
- リクエスト本文
- レスポンス本文
- AreaFilter
- PointExclusion
- Criterion
- Filter
- SpacingOptions
- PointType
- ContentRating
- AccessType
- ProximityOptions
- Mode
- Ranking
- Busyness
- BusynessModifier
- Capacity
- CapacityModifier
- Dwellability
- DwellabilityModifier
- ArtisticallyInteresting
- ArtisticallyInterestingModifier
指定した領域内にあり、かつ任意のフィルタ条件を満たすプレイアブル ロケーションのセットを返します。
注: 世界の状態は時間の経過とともに変化するため、同じ v3.searchPlayableLocations
リクエストで異なる結果が返されることがあります。
HTTP リクエスト
POST https://playablelocations.googleapis.com/v3:searchPlayableLocations
この URL では gRPC Transcoding 構文を使用します。
リクエスト本文
リクエストの本文には次の構造のデータが含まれます。
JSON 表現 | |
---|---|
{ "areaFilter": { object ( |
フィールド | |
---|---|
areaFilter |
必須。プレイアブル ロケーションを検索する領域を指定します。 |
criteria[] |
必須。返されたプレイアブル ロケーションをフィルタしてランク付けする 1 つ以上(最大 100 個)の条件を指定します。 |
レスポンス本文
成功すると、レスポンス本文に次の構造のデータが含まれます。
v3.searchPlayableLocations
メソッドに対するレスポンス。
JSON 表現 | |
---|---|
{
"locationsPerGameObjectType": {
string: {
object( |
フィールド | |
---|---|
locationsPerGameObjectType |
各 PlayableLocation オブジェクトは、リクエストで指定された gameObjectType に対応しています。
|
ttl |
必須。プレイアブル ロケーションのセットの「有効期間」を指定します。この値を使用して、プレイアブル ロケーションのセットをキャッシュに保存する期間を決定できます。この期間を過ぎた後は、バックエンド ゲーム サーバーで新しい 小数点以下 9 桁まで、「 |
AreaFilter
プレイアブル ロケーションを検索する領域を指定します。
JSON 表現 | |
---|---|
{
"s2CellId": string,
"pointExclusions": [
{
object ( |
フィールド | |
---|---|
s2CellId |
必須。目的の領域の S2 セル ID。セルのレベルを 11~16 の範囲で指定する必要があります。 S2 セルは、Earth での領域を識別する 64 ビットの整数です。これらは階層構造になっているため、空間インデックスに使用できます。 S2 ジオメトリ ライブラリは、次の複数の言語で使用できます。 |
pointExclusions[] |
プレイアブル ロケーションを検索する際に除外するプレイアブル ロケーションを指定します。たとえば、ゲームですでに使用されているロケーションを、ユーザーが作成した「基地」や「補給庫」に基づいて除外することができます。 |
PointExclusion
返されたプレイアブル ロケーションのセットから特定のプレイアブル ロケーションを除外する方法を指定します。
JSON 表現 | |
---|---|
{ "point": string, "minSpacingMeters": number } |
フィールド | |
---|---|
point |
必須。検索結果から除外するリーフ S2 セルの ID。このフィールドを使用して、ご自身のコンテンツとプレイアブル ロケーションが重ならないようにすることができます。 |
minSpacingMeters |
除外する S2 セルの周囲の最小間隔。 プレイアブル ロケーションはこの半径の範囲内に配置されなくなります。 |
Criterion
プレイアブル ロケーションのセットの検索に使用するフィルタ条件をカプセル化します。
JSON 表現 | |
---|---|
{ "gameObjectType": integer, "filter": { object ( |
フィールド | |
---|---|
gameObjectType |
必須。プレイアブル ロケーションが使用されるゲーム オブジェクトのタイプについてデベロッパーが定義する任意の識別子。このフィールドを使用して、プレイアブル ロケーションを検索する際の条件をゲーム オブジェクト タイプごとに指定できます。 タイプが異なるゲーム オブジェクトは、プレーヤーが操作する方法も異なるため、このフィールドによって目的のデータ分析で使用するインプレッション データを分離することができます。 異なるタイプのゲーム オブジェクトを表すには、すべての レスポンスには map<gameObjectType, Response> が含まれます。 |
filter |
フィルタ オプションと検索結果のセットに含める要素を指定します。 |
ranking |
プレイアブル ロケーションをランク付けする方法を指定します。 |
fieldsToReturn |
どの
次のフィールドは、ここで指定しない限り省略されます。
注: 含めるフィールドが多くなるほど、データや関連するレイテンシによってクエリにかかる費用は高くなります。 完全修飾されたフィールド名のカンマ区切りリスト(例: |
Filter
プレイアブル ロケーションの検索に使用するフィルタを指定します。
JSON 表現 | |
---|---|
{ "maxLocationCount": integer, "spacing": { object ( |
フィールド | |
---|---|
maxLocationCount |
返されるプレイアブル ロケーションの最大数を指定します。この値は 1,000 以内で指定する必要があります。デフォルト値は 100 です。 ランク付けが上位のプレイアブル ロケーションのみが返されます。 |
spacing |
プレイアブル ロケーションの間隔を調整するオプションのセット。 |
includedTypes[] |
プレイアブル ロケーションのセットを目的のタイプのみに限定します。 |
excludedTypes[] |
不要なプレイアブル ロケーションのタイプを除外します。 このフィールドは、 |
contentRating |
年齢制限のある場所(バー、カジノ、ナイトクラブなど)に関連するプレイアブル ロケーションを含めるオプションを指定します。 デフォルト値は、プレイアブル ロケーションがすべての年齢層に適していることを意味する |
accessTypes[] |
場所に関連付けられたアクセスタイプを指定する値。 このフィールドを使用して、 |
biomeTypes[] |
プレイアブル ロケーションのセットを特定の生物群系タイプのみに限定します。 |
proximityOptions[] |
付近の場所タイプに関する情報をリクエストする、または付近の場所タイプまでの距離を指定する際に使用できるオプションのセット(最大 10 個)。 |
SpacingOptions
プレイアブル ロケーションの間隔を指定するオプションのセット。
JSON 表現 | |
---|---|
{
"minSpacingMeters": number,
"pointType": enum ( |
フィールド | |
---|---|
minSpacingMeters |
必須。2 つのプレイアブル ロケーションの最小間隔(メートル単位)。最小値は 10、最大値は 1000 です。 プレイアブル ロケーションが密集しないようにするには、このフィールドを設定します。 注: 間隔の計算では貪欲アルゴリズムが使用されます。このアルゴリズムでは、最大限に多くのロケーションを選択するのではなく、まず最もランク付けが高いロケーションを選定するよう最適化が行われます。次のシナリオを考えてみます。
間隔が 25 の場合は、[A] や [C] ではなく、最もランク付けの高い場所である [B] が選定されます。 注: 間隔は、ゲーム オブジェクト タイプ自体と、その前のゲーム オブジェクト タイプに適用されます。たとえば、3 つのゲーム オブジェクト タイプで、それぞれ以下の間隔が指定されているとします。
これらのロケーションの間の距離関係は次のようになります。
|
pointType |
プレイアブル ロケーションの中心点またはスナップ ポイントに最小間隔の制限を適用するかどうかを指定します。デフォルト値は プレイアブル ロケーションのスナップ ポイントを使用できない場合は、中心点が代用されます。 ゲームで使用されるポイントの種類に設定します。この設定は、 |
PointType
プレイアブル ロケーションの地理座標(緯度と経度)を、中心点または最も近い道路の歩道にスナップされている場所に対応させるかどうかを指定します。
列挙型 | |
---|---|
POINT_TYPE_UNSPECIFIED |
ポイントの種類の指定なし。この値は使用しないでください。 |
CENTER_POINT |
場所の中心点に対応する地理座標。 |
SNAPPED_POINT |
(近くに道路がある場合)最も近い道路の歩道にスナップされている場所に対応する地理座標。 |
ContentRating
プレイアブル ロケーションに適したユーザーの年齢層を指定する値のセット。
Playable Locations API は、あらゆる年齢層のプレーヤーの使用に適しているプレイアブル ロケーションをデフォルトで提供しますが、ゲームが成人のプレーヤーのみを対象としている場合は、年齢制限のある場所(バー、カジノ、ナイトクラブなど)に関連するプレイアブル ロケーションを含めることができます。
列挙型 | |
---|---|
CONTENT_RATING_UNSPECIFIED |
指定なし。不使用。 |
EVERYONE |
子供と 21 歳未満の若年層の使用に適しているプレイアブル ロケーションのセット(成人向けのコンテンツを含まないプレイアブル ロケーションなど)。 |
ADULTS_ONLY |
21 歳以上のユーザーの使用に適しているプレイアブル ロケーションのセット。このセットには EVERYONE が含まれます。 |
AccessType
場所で提供されるアクセスの種類を指定する値のセット。
列挙型 | |
---|---|
ACCESS_TYPE_UNSPECIFIED |
アクセスの種類の指定なし。使用しないでください。 |
FREE |
一般ユーザーが制限なくアクセスできます(例: 公園、遊び場、広場)。 |
PAID |
有料ユーザーと会員に制限されます(例: ゴルフコース、遊園地、動物園)。 有料のロケーションに配置されたゲーム オブジェクトは、プレーヤーが半径 100 メートル以内にいるときに表示されるようにすることをおすすめします。 |
ProximityOptions
付近の場所タイプに関する情報をリクエストする、または付近の場所タイプまでの距離を指定する際に使用できるオプションのセット。
JSON 表現 | |
---|---|
{
"types": [
string
],
"maxDistanceMeters": number,
"mode": enum ( |
フィールド | |
---|---|
types[] |
必須。プレイアブル ロケーションの |
maxDistanceMeters |
必須。このプレイアブル ロケーションの半径(メートル単位)の範囲内で、指定されたプレイスタイプを検索します。値は 10~1,000 メートルの範囲で指定する必要があります。 リクエストされた S2 セルの近隣セルのみが検索されます。遠距離を設定した場合は、検索の対象が実質的にそれらのセルの範囲に制限されます。 |
mode |
近隣オプションを情報提供のために使用するか、それともプレイアブル ロケーションをフィルタするために使用するかを指定します。デフォルト値は |
Mode
近隣オプションを情報提供のために使用するか、それともプレイアブル ロケーションの結果をフィルタするために使用するかを指定する値のセット。
列挙型 | |
---|---|
MODE_UNSPECIFIED |
指定なし。使用しないでください。 |
INFORMATION |
プレイアブル ロケーションで近隣に関する追加情報が必要です。指定されたプレイスタイプごとに、プレイアブル ロケーションから maxDistanceMeters の範囲にある最も近い場所までの距離が NearbyType として返されます。 |
FILTERING |
指定されたいずれかのプレイスタイプから maxDistanceMeters の範囲にあるプレイアブル ロケーションのみが含まれます。 |
Ranking
返されたプレイアブル ロケーションのランク付けに使用する重み付け要素を定義します。
プレイアブル ロケーションのスコアとランク付けには次の要素が反映されます。
- 知名度。Google のインデックスにおける場所のランク付けや、世界的な人気度などの要素によって決まります。
- (省略可)各種の知名度に基づく調整比。より望ましい(または望ましくない)種類を指定します。
- (省略可)混雑状況。より混雑している(または混雑していない)ロケーションを選択します。
- (省略可)芸術的関心。より芸術的関心が寄せられているとみなされる場所を指定します。
JSON 表現 | |
---|---|
{ "typesProminenceModifier": { string: integer, ... }, "busyness": { object ( |
フィールド | |
---|---|
typesProminenceModifier |
プレイアブル ロケーションの特定の種類の重み付けを調整できます。望ましい種類の重み付けを増やすには正の値を使用し、そうでない種類の重み付けを減らすには負の値を指定します。 たとえば、「{park: 2, cinema: 3, bank: -1}」のように指定できます。この場合、公園の重み付けは 2、映画館については 3 増え、銀行の重み付けは 1 減ります。値は -10~+10 の範囲で指定できます。 複数のマッチング タイプに該当するプレイアブル ロケーションのスコア調整には、指定された中で最も大きい値が使用されます。
|
busyness |
プレイアブル ロケーションの混雑度を指定します。 |
capacity |
大規模な場所の収容人数を指定します。 このランク付けの調整比は現在サポートされていませんが、フィードバックをお寄せくださいますようお願いいたします。 |
dwellability |
場所の平均滞在時間を指定します。 このランク付けの調整比は現在サポートされていませんが、フィードバックをお寄せくださいますようお願いいたします。 |
artisticallyInteresting |
場所に対して芸術的関心がどの程度寄せられているかを指定します。 |
Busyness
場所の利用頻度の高さに基づくランク付けの調整比を指定します。
JSON 表現 | |
---|---|
{
"busyness": enum ( |
フィールド | |
---|---|
busyness |
アクティビティ レベルに基づくランク付けの調整比を、
|
BusynessModifier
優先される混雑度を指定する値のセット。つまり、場所を定期的に利用するユーザーが多いほうがいいか、少ないほうがいいかを指定します。
列挙型 | |
---|---|
MODIFIER_UNSPECIFIED |
指定なし。 |
MORE_BUSY_BETTER |
より混雑している場所のランク付けを高くします。 |
LESS_BUSY_BETTER |
より混雑していない場所のランク付けを高くします。 |
Capacity
場所の収容人数に基づくランク付けの調整比を指定します。
このランク付けの調整比は現在サポートされていませんが、フィードバックをお寄せくださいますようお願いいたします。
JSON 表現 | |
---|---|
{
"capacity": enum ( |
フィールド | |
---|---|
capacity |
収容人数に基づくランク付けの調整比を、
|
CapacityModifier
優先される収容人数を指定する値のセット。つまり、その場所が大規模な人数を収容できるかどうかを指定します。
列挙型 | |
---|---|
MODIFIER_UNSPECIFIED |
指定なし。 |
LARGE |
場所の規模が大きいほどランク付けが高くなります。 |
Dwellability
ユーザーが場所に滞在する可能性がどの程度高いかに基づくランク付けの調整比を指定します。
このランク付けの調整比は現在サポートされていませんが、フィードバックをお寄せくださいますようお願いいたします。
JSON 表現 | |
---|---|
{
"dwellability": enum ( |
フィールド | |
---|---|
dwellability |
滞在時間の長さに基づくランク付け調整比を、
|
DwellabilityModifier
優先される滞在時間の長さを指定する値のセット。つまり、場所を訪れたユーザーが滞在する可能性が高い時間を指定します。
列挙型 | |
---|---|
MODIFIER_UNSPECIFIED |
指定なし。使用しないでください。 |
LONG |
ユーザーは比較的長時間にわたってその場所に滞在する傾向があります。 滞在時間の長い場所ほどランク付けが高くなります。たとえば、公園はガソリン スタンドよりも滞在時間が長くなります。 |
ArtisticallyInteresting
場所に対して芸術的関心がどの程度寄せられているかに基づくランク付けの調整比を指定します。
JSON 表現 | |
---|---|
{
"artisticallyInteresting": enum ( |
フィールド | |
---|---|
artisticallyInteresting |
|
ArtisticallyInterestingModifier
場所に対して芸術的関心がどの程度寄せられているかを指定する値のセット。
列挙型 | |
---|---|
MODIFIER_UNSPECIFIED |
指定なし。使用しないでください。 |
INTERESTING |
ユーザーはこの場所に芸術的関心を寄せる傾向があります。 芸術的関心が寄せられている場所ほどランク付けが高くなります(博物館や劇場など)。 |