パッケージ google.maps.playablelocations.v3

Index

PlayableLocations

Playable Locations API for v3。

GenerateTerritories

rpc GenerateTerritories(GenerateTerritoriesRequest) returns (GenerateTerritoriesResponse)

指定された S2 セルのテリトリーを生成します。このテリトリーは、S2 セルをほぼカバーするだけです。隣接するセルに対して返されるテリトリーは、重複しないよう照合されます。

LogImpressions

rpc LogImpressions(LogImpressionsRequest) returns (LogImpressionsResponse)

プレイアブル ロケーションが表示されたときと、それらのロケーションが操作されたときに、新しいイベントをログに記録します。

インプレッションの一部のみが保存されることはありません。リクエストが成功するとすべてのインプレッションが保存され、リクエストが失敗するとインプレッションは一切保存されません。

LogPlayerReports

rpc LogPlayerReports(LogPlayerReportsRequest) returns (LogPlayerReportsResponse)

プレーヤーから送信された、不適切なプレイアブル ロケーションの報告をログに記録します。

報告の一部のみが保存されることはありません。リクエストが成功するとすべての報告が保存され、リクエストが失敗すると報告は一切保存されません。

SearchPlayableLocations

rpc SearchPlayableLocations(SearchPlayableLocationsRequest) returns (SearchPlayableLocationsResponse)

指定した領域内にあり、かつ任意のフィルタ条件を満たすプレイアブル ロケーションのセットを返します。

注: 世界の状態は時間の経過とともに変化するため、同じ SearchPlayableLocations リクエストで異なる結果が返されることがあります。

AccessType

場所で提供されるアクセスの種類を指定する値のセット。

列挙型
ACCESS_TYPE_UNSPECIFIED アクセスの種類の指定なし。使用しないでください。
FREE 一般ユーザーが制限なくアクセスできます(例: 公園、遊び場、広場)。
PAID

有料ユーザーと会員に制限されます(例: ゴルフコース、遊園地、動物園)。

有料のロケーションに配置されたゲーム オブジェクトは、プレーヤーが半径 100 メートル以内にいるときに表示されるようにすることをおすすめします。

Address

プレイアブル ロケーションの住所をカプセル化します。

フィールド
language_code

string

BCP-47 形式の言語コード。住所の表記に使用する言語を示します

(「en」、「en-US」、「ja-Latn」など)。

詳しくは、Unicode ロケール識別子をご覧ください。

flags[]

LanguageFlag

住所の言語に関する追加情報(その地域の言語で記載されているかなど)を指定するフラグの集まり。

formatted[]

FormattedAddress

この言語コードで定義される形式の住所。

AreaFilter

プレイアブル ロケーションを検索する領域を指定します。

フィールド
s2_cell_id

fixed64

必須。目的の領域の S2 セル ID。セルのレベルを 11~16 の範囲で指定する必要があります。

S2 セルは、Earth での領域を識別する 64 ビットの整数です。これらは階層構造になっているため、空間インデックスに使用できます。

S2 ジオメトリ ライブラリは、次の複数の言語で使用できます。

point_exclusions[]

PointExclusion

プレイアブル ロケーションを検索する際に除外するプレイアブル ロケーションを指定します。たとえば、ゲームですでに使用されているロケーションを、ユーザーが作成した「基地」や「補給庫」に基づいて除外することができます。

ArtisticallyInteresting

場所に対して芸術的関心がどの程度寄せられているかに基づくランク付けの調整比を指定します。

フィールド
artistically_interesting

ArtisticallyInterestingModifier

artistically_interesting 値を指定しなかった場合、この調整比はプレイアブル ロケーションのランク付けに使用されなくなります。

ArtisticallyInterestingModifier

場所に対して芸術的関心がどの程度寄せられているかを指定する値のセット。

列挙型
MODIFIER_UNSPECIFIED 指定なし。使用しないでください。
INTERESTING

ユーザーはこの場所に芸術的関心を寄せる傾向があります。

芸術的関心が寄せられている場所ほどランク付けが高くなります(博物館や劇場など)。

BiomeTypeProto

生物群系をカプセル化します。

BiomeType

プレイアブル ロケーションに関連付けられた生物群系の種類。

列挙型
UNKNOWN 生物群系タイプが不明です。
FOREST 森林。主に樹木で覆われています。
SHRUBLAND 灌木地。主に多年植物で覆われています。
SAVANNA サバンナ。樹木がまばらに生えています。
GRASSLAND 草原。主に一年生草本で覆われています。
WETLAND 湿地帯。水と植生被覆で覆われた領域です。
CROPLAND 耕作地。耕作された畑地です。
URBAN 都市部。都市の市街地域です。
SNOW_ICE 降雪地または凍土。1 年のうち 10 か月以上は雪と氷に覆われています。
BARREN 荒地。植物が生えていない不毛(砂漠、岩礫、土壌)地帯です。
WATER 水域。水に関わる領域です。

Busyness

場所の利用頻度の高さに基づくランク付けの調整比を指定します。

フィールド
busyness

BusynessModifier

アクティビティ レベルに基づくランク付けの調整比を、BusynessModifier 列挙値の 1 つとして指定します。

busyness 値を指定しなかった場合、この調整比はプレイアブル ロケーションのランク付けに使用されなくなります。

BusynessModifier

優先される混雑度を指定する値のセット。つまり、場所を定期的に利用するユーザーが多いほうがいいか、少ないほうがいいかを指定します。

列挙型
MODIFIER_UNSPECIFIED 指定なし。
MORE_BUSY_BETTER より混雑している場所のランク付けを高くします。
LESS_BUSY_BETTER より混雑していない場所のランク付けを高くします。

Capacity

場所の収容人数に基づくランク付けの調整比を指定します。

このランク付けの調整比は現在サポートされていませんが、フィードバックをお寄せくださいますようお願いいたします。

フィールド
capacity

CapacityModifier

収容人数に基づくランク付けの調整比を、CapacityModifier 列挙値の 1 つとして指定します。

capacity 値を指定しなかった場合、この調整比はプレイアブル ロケーションのランク付けに使用されなくなります。

CapacityModifier

優先される収容人数を指定する値のセット。つまり、その場所が大規模な人数を収容できるかどうかを指定します。

列挙型
MODIFIER_UNSPECIFIED 指定なし。
LARGE 場所の規模が大きいほどランク付けが高くなります。

ContentRating

プレイアブル ロケーションに適したユーザーの年齢層を指定する値のセット。

Playable Locations API は、あらゆる年齢層のプレーヤーの使用に適しているプレイアブル ロケーションをデフォルトで提供しますが、ゲームが成人のプレーヤーのみを対象としている場合は、年齢制限のある場所(バー、カジノ、ナイトクラブなど)に関連するプレイアブル ロケーションを含めることができます。

列挙型
CONTENT_RATING_UNSPECIFIED 指定なし。不使用。
EVERYONE 子供と 21 歳未満の若年層の使用に適しているプレイアブル ロケーションのセット(成人向けのコンテンツを含まないプレイアブル ロケーションなど)。
ADULTS_ONLY 21 歳以上のユーザーの使用に適しているプレイアブル ロケーションのセット。このセットには EVERYONE が含まれます。

Criterion

プレイアブル ロケーションのセットの検索に使用するフィルタ条件をカプセル化します。

フィールド
game_object_type

int32

必須。プレイアブル ロケーションが使用されるゲーム オブジェクトのタイプについてデベロッパーが定義する任意の識別子。このフィールドを使用して、プレイアブル ロケーションを検索する際の条件をゲーム オブジェクト タイプごとに指定できます。

タイプが異なるゲーム オブジェクトは、プレーヤーが操作する方法も異なるため、このフィールドによって目的のデータ分析で使用するインプレッション データを分離することができます。

異なるタイプのゲーム オブジェクトを表すには、すべての request_criteria に一意の game_object_type ID を割り当てる必要があります。たとえば、「1=monster location」、「2=powerup location」のように割り当てます。

レスポンスには map<game_object_type, Response> が含まれます。

filter

Filter

フィルタ オプションと検索結果のセットに含める要素を指定します。

ranking

Ranking

プレイアブル ロケーションをランク付けする方法を指定します。

fields_to_return

FieldMask

どの PlayableLocation フィールドを返すかを指定します。

name(インプレッションの記録に使用されます)、center_pointplace_id(または plus_code)は常に返されます。

次のフィールドは、ここで指定しない限り省略されます。

  • addresses
  • biome_type
  • display_names
  • snapped_point
  • types

注: 含めるフィールドが多くなるほど、データや関連するレイテンシによってクエリにかかる費用は高くなります。

DisplayName

プレイアブル ロケーションの名前をカプセル化します。

フィールド
language_code

string

BCP-47 形式の言語コード。text で提供される自由形式の名前の言語を示します

(「en」、「en-US」、「ja-Latn」など)。

詳しくは、Unicode ロケール識別子をご覧ください。

flags[]

LanguageFlag

プレイアブル ロケーションの名前の言語に関する追加情報(その地域の言語で記載されているかなど)を示すフラグの集まり。

text

string

表示名。

Dwellability

ユーザーが場所に滞在する可能性がどの程度高いかに基づくランク付けの調整比を指定します。

このランク付けの調整比は現在サポートされていませんが、フィードバックをお寄せくださいますようお願いいたします。

フィールド
dwellability

DwellabilityModifier

滞在時間の長さに基づくランク付け調整比を、DwellabilityModifier 列挙値の 1 つとして指定します。

dwellability 値を指定しなかった場合、この調整比はプレイアブル ロケーションのランク付けに使用されなくなります。

DwellabilityModifier

優先される滞在時間の長さを指定する値のセット。つまり、場所を訪れたユーザーが滞在する可能性が高い時間を指定します。

列挙型
MODIFIER_UNSPECIFIED 指定なし。使用しないでください。
LONG

ユーザーは比較的長時間にわたってその場所に滞在する傾向があります。

滞在時間の長い場所ほどランク付けが高くなります。たとえば、公園はガソリン スタンドよりも滞在時間が長くなります。

Filter

プレイアブル ロケーションの検索に使用するフィルタを指定します。

フィールド
max_location_count

int32

返されるプレイアブル ロケーションの最大数を指定します。この値は 1,000 以内で指定する必要があります。デフォルト値は 100 です。

ランク付けが上位のプレイアブル ロケーションのみが返されます。

spacing

SpacingOptions

プレイアブル ロケーションの間隔を調整するオプションのセット。

included_types[]

string

プレイアブル ロケーションのセットを目的のタイプのみに限定します。

excluded_types[]

string

不要なプレイアブル ロケーションのタイプを除外します。

このフィールドは、included_types より優先順位が高くなります。

content_rating

ContentRating

年齢制限のある場所(バー、カジノ、ナイトクラブなど)に関連するプレイアブル ロケーションを含めるオプションを指定します。

デフォルト値は、プレイアブル ロケーションがすべての年齢層に適していることを意味する EVERYONE です。

access_types[]

AccessType

場所に関連付けられたアクセスタイプを指定する値。AccessType 列挙値の 1 つとして指定されます。

このフィールドを使用して、FREE(公園など)や PAID(遊園地など)の領域内のプレイアブル ロケーションをフィルタできます。デフォルト値は FREE です。このフィルタは生成されたロケーションにのみ適用されます。

biome_types[]

BiomeType

プレイアブル ロケーションのセットを特定の生物群系タイプのみに限定します。

proximity_options[]

ProximityOptions

付近の場所タイプに関する情報をリクエストする、または付近の場所タイプまでの距離を指定する際に使用できるオプションのセット(最大 10 個)。

FormattedAddress

プレイアブル ロケーションの住所を特定の形式でカプセル化します。

フィールド
format

FormatType

FormatType 列挙値の 1 つとして指定されている住所の形式。

lines[]

string

複数の行の住所テキスト。

FormatType

住所の形式を指定する値のセット。

列挙型
FORMAT_TYPE_UNSPECIFIED 形式の種類の指定なし。使用しないでください。
LOCALITY 住所の地域区分(例: Mountain View)。
FULL_ADDRESS 1 行で表示される完全な住所(例: 1600 Amphitheatre Pkwy, Mountain View, California 94043, USA)。

GenerateTerritoriesRequest

テリトリーの生成リクエスト。

フィールド
s2_cell_id

fixed64

テリトリーで(ほぼ)カバーされる S2 セル。

S2 セルは、Earth での領域を識別する 64 ビットの整数です。これらは階層構造になっているため、空間インデックスに使用できます。

現在、レベル 11 の S2 セルのみがサポートされています(約 20 平方キロメートル)。* S2 セルの統計情報

S2 ジオメトリ ライブラリは、次の複数の言語で使用できます。

territory_size_square_meters

double

リクエストされたテリトリーの大きさ(平方メートル単位)。

subterritory_count

int32

各テリトリーを分割する下位テリトリーの数。一部のテリトリーでは、下位テリトリーがリクエストした数よりも少なくなる場合があります。

snapshot_id

string

前の GenerateTerritories リクエストで返される任意のスナップショット ID。指定した場合、この ID はテリトリーの構成要素の過去のスナップショットをマッピングするために使用されます。指定しなかった場合は最新のスナップショットが使用され、その ID がレスポンスで返されます。

GenerateTerritoriesResponse

GenerateTerritories メソッドに対するレスポンス。

フィールド
territories[]

Territory

指定された S2 セルをほぼカバーするテリトリー。

snapshot_id

string

スナップショット ID。この ID は、このリクエストでグループ化に使用されたテリトリーの構成要素の過去のスナップショットを示します。返されるスナップショット ID を、後続の GenerateTerritories リクエストのパラメータとして指定すると、同じスナップショットから新たなテリトリーを生成できます。

Impression

インプレッション イベントの詳細情報をカプセル化します。

フィールド
location_name

string

必須。プレイアブル ロケーションの名前。

impression_type

ImpressionType

必須。インプレッション イベントのタイプ。

game_object_type

int32

ゲームで使用されるゲーム オブジェクトのタイプごとにデベロッパーが定義する任意のタイプ識別子。

タイプが異なるゲーム オブジェクトは、プレーヤーが操作する方法も異なるため、このフィールドによって分析で使用するインプレッション データをタイプ別に分離することができます。

ゲームで異なるタイプのゲーム オブジェクトを表すには、一意の game_object_type ID を割り当てる必要があります。

たとえば、「1=monster location」、「2=powerup location」のように割り当てます。

ImpressionType

インプレッション イベントのタイプ。

列挙型
IMPRESSION_TYPE_UNSPECIFIED タイプの指定なし。使用しないでください。
PRESENTED プレイアブル ロケーションがプレーヤーに表示されました。
INTERACTED プレーヤーがプレイアブル ロケーションを操作しました。

LanguageFlag

言語固有のデータに追加情報を付記します。

列挙型
LANGUAGE_FLAG_UNSPECIFIED 言語フラグの指定なし。使用しないでください。
IN_LOCAL_LANGUAGE データで関連する国の言語が使用されています。

LogImpressionsRequest

インプレッションの記録リクエスト。

フィールド
impressions[]

Impression

必須。インプレッション イベントの詳細情報。ログに一度に記録できるインプレッションの報告の最大数は 50 です。

request_id

string

必須。インプレッションの記録リクエストを一意に識別する文字列。これを使用して重複するリクエストを検出できます。この値には UUID を使用することをおすすめします。値は半角 50 文字以内で指定してください。

request_id を再利用できるのは、失敗したリクエストを再試行する場合に限られます。その場合は、失敗したものと同じリクエストを再試行する必要があります。

client_info

ClientInfo

必須。クライアント デバイスに関する情報(デバイスのモデルやオペレーティング システムなど)。

LogImpressionsResponse

LogImpressions メソッドに対するレスポンス。成功した場合、このメソッドはデータを返しません。

LogPlayerReportsRequest

プレーヤーによる不適切なロケーションに関する報告の記録リクエスト。

フィールド
player_reports[]

PlayerReport

必須。プレーヤーの報告。ログに一度に記録できるプレーヤーの報告の最大数は 50 です。

request_id

string

必須。プレーヤーによる報告の記録リクエストを一意に識別する文字列。これを使用して重複するリクエストを検出できます。この値には UUID を使用することをおすすめします。値は半角 50 文字以内で指定してください。

request_id を再利用できるのは、失敗したリクエストを再試行する場合に限られます。その場合は、失敗したものと同じリクエストを再試行する必要があります。

client_info

ClientInfo

必須。クライアント デバイスに関する情報(デバイスのモデルやオペレーティング システムなど)。

LogPlayerReportsResponse

LogPlayerReports メソッドに対するレスポンス。

成功した場合、このメソッドはデータを返しません。

NearbyType

プレイアブル ロケーション付近のプレイスタイプに関する情報をカプセル化します。

フィールド
type

string

プレイアブル ロケーションの近くの場所タイプ

distance_meters

double

プレイアブル ロケーションと場所タイプの間の距離(メートル単位)。

PlayableLocation

位置情報ベースのゲームでのゲーム オブジェクトの配置に適した地理的位置。

フィールド
name

string

必須。このプレイアブル ロケーションの名前。PlayerReports と Impressions でも使用されます。

types[]

string

このプレイアブル ロケーションのプレイアブル ロケーション タイプの集まり。集まりの最初のタイプがメインのタイプとなります。

一部のプレイアブル ロケーションではタイプに関する情報を利用できない場合があります。

center_point

LatLng

必須。プレイアブル ロケーションの中心に関連付けられた緯度と経度。

SearchPlayableLocations から返されるプレイアブル ロケーションのセットでは、中心点の座標がデフォルトで使用されます。

snapped_point

LatLng

近くに道路がある場合は、最も近い道路の歩道にスナップされたプレイアブル ロケーションの座標。キュレートされた場所でのみ使用できます。

display_names[]

DisplayName

プレイアブル ロケーションの、名前がサポートされている各言語での表示名。

プレイアブル ロケーションの現地語が最初に表示され、その他の言語がある場合はその後に続いて順不同で表示されます。

addresses[]

Address

プレイアブル ロケーションの、住所がサポートされている各言語での住所。

プレイアブル ロケーションの現地語が最初に表示され、その他の言語がある場合はその後に続いて順不同で表示されます。

biome_type[]

BiomeType

プレイアブル ロケーションの生物群系タイプ。

nearby_types[]

NearbyType

このプレイアブル ロケーションと近くの場所タイプの間の距離に関する情報。

共用体フィールド location_id。必須。個々の場所は、次のいずれかの識別子を持ちます。location_id は次のいずれかになります。
place_id

string

場所 ID

plus_code

string

plus code

PlayableLocationList

単一の条件を満たしている PlayableLocation オブジェクトのリスト。

フィールド
locations[]

PlayableLocation

このゲーム オブジェクト タイプのプレイアブル ロケーションのリスト。

PlayerReport

プレーヤーから送信された、ゲームでの使用に不適切と見なされるプレイアブル ロケーションの報告。

フィールド
location_name

string

必須。プレイアブル ロケーションの名前。

reasons[]

BadLocationReason

必須。このプレイアブル ロケーションが不適切と見なされる 1 つ以上の理由。

reason_details

string

必須。プレイアブル ロケーションが不適切と見なされる理由に関する自由形式の詳細な説明。

language_code

string

reason_details で提供される自由形式の説明の言語を示す、BCP-47 形式の言語コード(「en」、「en-US」、「ja-Latn」など)。詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。

BadLocationReason

プレイアブル ロケーションが不適切と見なされる理由。

列挙型
BAD_LOCATION_REASON_UNSPECIFIED 理由の指定なし。使用しないでください。
OTHER 理由は、この列挙型の理由に該当しません。
NOT_PEDESTRIAN_ACCESSIBLE プレイアブル ロケーションに徒歩でアクセスできません(高速道路の真ん中にある場合など)。
NOT_OPEN_TO_PUBLIC プレイアブル ロケーションは一般公開されていません(私有のオフィスビルなど)。
PERMANENTLY_CLOSED プレイアブル ロケーションは閉業しています(店舗が廃業した場合など)。
TEMPORARILY_INACCESSIBLE プレイアブル ロケーションは一時的に利用できません(店舗が改装のために休業している場合など)。

PointExclusion

返されたプレイアブル ロケーションのセットから特定のプレイアブル ロケーションを除外する方法を指定します。

フィールド
point

fixed64

必須。検索結果から除外するリーフ S2 セルの ID。このフィールドを使用して、ご自身のコンテンツとプレイアブル ロケーションが重ならないようにすることができます。

min_spacing_meters

double

除外する S2 セルの周囲の最小間隔。

プレイアブル ロケーションはこの半径の範囲内に配置されなくなります。

Polygon

外側の境界線リングとホールリングで表される、ホールを含むポリゴン。どちらの場合も、頂点を順に移動する場合は、ポリゴンの内側が左側になります。つまり頂点は、外側の境界線では反時計回り、ホールでは時計回りの順になります。

フィールド
outer_boundary

Ring

ポリゴンの外側の境界線を定義するリング。リングの頂点を順に移動する場合は、ポリゴンの内側が外側の境界線の左側になります。つまり、リングの頂点は反時計回りの順になります。

holes[]

Ring

ポリゴンのホール。それぞれのリングでは、リングの頂点を順に移動する場合はポリゴンの内側がリングの左側になります。つまり、リングの頂点は時計回りの順になります。

ProximityOptions

付近の場所タイプに関する情報をリクエストする、または付近の場所タイプまでの距離を指定する際に使用できるオプションのセット。

フィールド
types[]

string

必須。プレイアブル ロケーションの max_distance_meters 内で検索するプレイスタイプのセット。プレイアブル ロケーションの種類のリストで指定されているタイプである必要があります。

max_distance_meters

double

必須。このプレイアブル ロケーションの半径(メートル単位)の範囲内で、指定されたプレイスタイプを検索します。値は 10~1,000 メートルの範囲で指定する必要があります。

リクエストされた S2 セルの近隣セルのみが検索されます。遠距離を設定した場合は、検索の対象が実質的にそれらのセルの範囲に制限されます。

mode

Mode

近隣オプションを情報提供のために使用するか、それともプレイアブル ロケーションをフィルタするために使用するかを指定します。デフォルト値は INFORMATION です。

Mode

近隣オプションを情報提供のために使用するか、それともプレイアブル ロケーションの結果をフィルタするために使用するかを指定する値のセット。

列挙型
MODE_UNSPECIFIED 指定なし。使用しないでください。
INFORMATION プレイアブル ロケーションで近隣に関する追加情報が必要です。指定されたプレイスタイプごとに、プレイアブル ロケーションから max_distance_meters の範囲にある最も近い場所までの距離が NearbyType として返されます。
FILTERING 指定されたいずれかのプレイスタイプから max_distance_meters の範囲にあるプレイアブル ロケーションのみが含まれます。

Ranking

返されたプレイアブル ロケーションのランク付けに使用する重み付け要素を定義します。

プレイアブル ロケーションのスコアとランク付けには次の要素が反映されます。

  • 知名度。Google のインデックスにおける場所のランク付けや、世界的な人気度などの要素によって決まります。
  • (省略可)各種の知名度に基づく調整比。より望ましい(または望ましくない)種類を指定します。
  • (省略可)混雑状況。より混雑している(または混雑していない)ロケーションを選択します。
  • (省略可)芸術的関心。より芸術的関心が寄せられているとみなされる場所を指定します。
フィールド
types_prominence_modifier

map<string, int32>

プレイアブル ロケーションの特定の種類の重み付けを調整できます。望ましい種類の重み付けを増やすには正の値を使用し、そうでない種類の重み付けを減らすには負の値を指定します。

たとえば、「{park: 2, cinema: 3, bank: -1}」のように指定できます。この場合、公園の重み付けは 2、映画館については 3 増え、銀行の重み付けは 1 減ります。値は -10~+10 の範囲で指定できます。

複数のマッチング タイプに該当するプレイアブル ロケーションのスコア調整には、指定された中で最も大きい値が使用されます。

busyness

Busyness

プレイアブル ロケーションの混雑度を指定します。

capacity

Capacity

大規模な場所の収容人数を指定します。

このランク付けの調整比は現在サポートされていませんが、フィードバックをお寄せくださいますようお願いいたします。

dwellability

Dwellability

場所の平均滞在時間を指定します。

このランク付けの調整比は現在サポートされていませんが、フィードバックをお寄せくださいますようお願いいたします。

artistically_interesting

ArtisticallyInteresting

場所に対して芸術的関心がどの程度寄せられているかを指定します。

Ring

閉じたポリラインのリング。個々のリングの最後の頂点は、最初の頂点に暗黙的に結合されます。

フィールド
vertices[]

LatLng

リングの頂点。

SearchPlayableLocationsRequest

クエリのライフサイクル:

  • ゲームが新しい場所で開始されると、ゲームサーバーが SearchPlayableLocations リクエストを発行します。リクエストでは S2 セルを指定して、フィルタとランク付けの「条件」を 1 つ以上含めます。

  • 条件 0: 長期的な拠点 i ロケーションや、レベル 0 のモンスターなど

  • 条件 1: 短期的な拠点 j ロケーションや、レベル 1 のモンスターなど
  • 条件 2: ランダム オブジェクトの k ロケーション。
  • その他(最大 100 個の条件を指定できます)。

PlayableLocationList に、それぞれの条件を満たしている PlayableLocation オブジェクトを相互に除外するリストが追加されます。これは、現実世界の場所の集まりと見なして、ゲーム ステータスに関連付けることができます。

注: これらの地点は永続的なものではありません。たとえば、公園は閉鎖される可能性があり、場所は削除される可能性があります。

レスポンスでは、プレイアブル ロケーションが有効な期間を指定します。有効期間が切れたら、searchPlayableLocations API にクエリを再度送信して、現実世界の新しいビューを取得します。

フィールド
area_filter

AreaFilter

必須。プレイアブル ロケーションを検索する領域を指定します。

criteria[]

Criterion

必須。返されたプレイアブル ロケーションをフィルタしてランク付けする 1 つ以上(最大 100 個)の条件を指定します。

SearchPlayableLocationsResponse

SearchPlayableLocations メソッドに対するレスポンス。

フィールド
locations_per_game_object_type

map<int32, PlayableLocationList>

各 PlayableLocation オブジェクトは、リクエストで指定された game_object_type に対応しています。

ttl

Duration

必須。プレイアブル ロケーションのセットの「有効期間」を指定します。この値を使用して、プレイアブル ロケーションのセットをキャッシュに保存する期間を決定できます。この期間をすぎた後は、バックエンド ゲーム サーバーで新しい SearchPlayableLocations リクエストを発行して、プレイアブル ロケーションの新しいセットを取得する必要があります(これは、たとえばプレイアブル ロケーションのセットが削除されている、公園が特定の日に閉鎖されている、ビジネスが閉業しているといった可能性があるためです)。

SpacingOptions

プレイアブル ロケーションの間隔を指定するオプションのセット。

フィールド
min_spacing_meters

double

必須。2 つのプレイアブル ロケーションの最小間隔(メートル単位)。最小値は 10、最大値は 1000 です。

プレイアブル ロケーションが密集しないようにするには、このフィールドを設定します。

注:

間隔の計算では貪欲アルゴリズムが使用されます。このアルゴリズムでは、最大限に多くのロケーションを選択するのではなく、まず最もランク付けが高いロケーションを選定するよう最適化が行われます。次のシナリオを考えてみます。

  • ランク: A: 2、B: 1、C: 3。
  • 距離: A -- 20 m -- B -- 20 m -- C

間隔が 25 の場合は、[A] や [C] ではなく、最もランク付けの高い場所である [B] が選定されます。

注:

間隔は、ゲーム オブジェクト タイプ自体と、その前のゲーム オブジェクト タイプに適用されます。たとえば、3 つのゲーム オブジェクト タイプで、それぞれ以下の間隔が指定されているとします。

  • X: 100 m、Y: 未定義、Z: 50 m。
  1. X のロケーションを、各オブジェクトから 100 m の範囲内に追加します。
  2. Y のロケーションを間隔なしで追加します。
  3. 最後に、Z のロケーションも X と Y からそれぞれ 50 m の範囲内に追加します。

これらのロケーションの間の距離関係は次のようになります。

  • 起点 -> 終点
  • X -> X: 100 m
  • Y -> X、Y -> Y: 未指定。
  • Z -> X、Z -> Y、Z -> Z: 50 m。
point_type

PointType

プレイアブル ロケーションの中心点またはスナップ ポイントに最小間隔の制限を適用するかどうかを指定します。デフォルト値は CENTER_POINT です。

プレイアブル ロケーションのスナップ ポイントを使用できない場合は、中心点が代用されます。

ゲームで使用されるポイントの種類に設定します。この設定は、PointExclusionProximityOptions の距離を計算する際にも使用されます。

PointType

プレイアブル ロケーションの地理座標(緯度と経度)を、中心点または最も近い道路の歩道にスナップされている場所に対応させるかどうかを指定します。

列挙型
POINT_TYPE_UNSPECIFIED ポイントの種類の指定なし。この値は使用しないでください。
CENTER_POINT 場所の中心点に対応する地理座標。
SNAPPED_POINT (近くに道路がある場合)最も近い道路の歩道にスナップされている場所に対応する地理座標。

Territory

ゲームのテリトリー。

フィールド
polygons[]

Polygon

テリトリーのポリゴン。

subterritories[]

Territory

このテリトリーの下位テリトリー。