Enum value maps for SpacingOptions_PointType.
var (
SpacingOptions_PointType_name = map[int32]string{
0: "POINT_TYPE_UNSPECIFIED",
1: "CENTER_POINT",
2: "SNAPPED_POINT",
}
SpacingOptions_PointType_value = map[string]int32{
"POINT_TYPE_UNSPECIFIED": 0,
"CENTER_POINT": 1,
"SNAPPED_POINT": 2,
}
)
var File_google_maps_playablelocations_v3_sample_resources_proto protoreflect.FileDescriptor
Specifies the area to search for playable locations.
type AreaFilter struct {
// Required. The S2 cell ID of the area you want. This must be between cell
// level 11 and 14 (inclusive).
//
// S2 cells are 64-bit integers that identify areas on the Earth. They are
// hierarchical, and can therefore be used for spatial indexing.
//
// The S2 geometry library is available in a number of languages:
//
// * [C++](https://github.com/google/s2geometry)
// * [Java](https://github.com/google/s2-geometry-library-java)
// * [Go](https://github.com/golang/geo)
// * [Python](https://github.com/google/s2geometry/tree/master/src/python)
S2CellId uint64 `protobuf:"fixed64,1,opt,name=s2_cell_id,json=s2CellId,proto3" json:"s2_cell_id,omitempty"`
// contains filtered or unexported fields
}
func (*AreaFilter) Descriptor() ([]byte, []int)
Deprecated: Use AreaFilter.ProtoReflect.Descriptor instead.
func (x *AreaFilter) GetS2CellId() uint64
func (*AreaFilter) ProtoMessage()
func (x *AreaFilter) ProtoReflect() protoreflect.Message
func (x *AreaFilter) Reset()
func (x *AreaFilter) String() string
Encapsulates a filter criterion for searching for a set of playable locations.
type Criterion struct {
// Required. An arbitrary, developer-defined identifier of the type of game
// object that the playable location is used for. This field allows you to
// specify criteria per game object type when searching for playable
// locations.
//
// You should assign a unique `game_object_type` ID across all
// `request_criteria` to represent a distinct type of game object. For
// example, 1=monster location, 2=powerup location.
//
// The response contains a map<game_object_type, Response>.
GameObjectType int32 `protobuf:"varint,1,opt,name=game_object_type,json=gameObjectType,proto3" json:"game_object_type,omitempty"`
// Specifies filtering options, and specifies what will be included in the
// result set.
Filter *Filter `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Specifies which `PlayableLocation` fields are returned.
//
// `name` (which is used for logging impressions), `center_point` and
// `place_id` (or `plus_code`) are always returned.
//
// The following fields are omitted unless you specify them here:
//
// * snapped_point
// * types
//
// Note: The more fields you include, the more expensive in terms of data and
// associated latency your query will be.
FieldsToReturn *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=fields_to_return,json=fieldsToReturn,proto3" json:"fields_to_return,omitempty"`
// contains filtered or unexported fields
}
func (*Criterion) Descriptor() ([]byte, []int)
Deprecated: Use Criterion.ProtoReflect.Descriptor instead.
func (x *Criterion) GetFieldsToReturn() *fieldmaskpb.FieldMask
func (x *Criterion) GetFilter() *Filter
func (x *Criterion) GetGameObjectType() int32
func (*Criterion) ProtoMessage()
func (x *Criterion) ProtoReflect() protoreflect.Message
func (x *Criterion) Reset()
func (x *Criterion) String() string
Specifies the filters to use when searching for playable locations.
type Filter struct {
// Specifies the maximum number of playable locations to return. This value
// must not be greater than 1000. The default value is 100.
//
// Only the top-ranking playable locations are returned.
MaxLocationCount int32 `protobuf:"varint,1,opt,name=max_location_count,json=maxLocationCount,proto3" json:"max_location_count,omitempty"`
// A set of options that control the spacing between playable locations. By
// default the minimum distance between locations is 200m.
Spacing *SpacingOptions `protobuf:"bytes,2,opt,name=spacing,proto3" json:"spacing,omitempty"`
// Restricts the set of playable locations to just the
// [types](/maps/tt/games/types) that you want.
IncludedTypes []string `protobuf:"bytes,3,rep,name=included_types,json=includedTypes,proto3" json:"included_types,omitempty"`
// contains filtered or unexported fields
}
func (*Filter) Descriptor() ([]byte, []int)
Deprecated: Use Filter.ProtoReflect.Descriptor instead.
func (x *Filter) GetIncludedTypes() []string
func (x *Filter) GetMaxLocationCount() int32
func (x *Filter) GetSpacing() *SpacingOptions
func (*Filter) ProtoMessage()
func (x *Filter) ProtoReflect() protoreflect.Message
func (x *Filter) Reset()
func (x *Filter) String() string
A geographical point suitable for placing game objects in location-based games.
type PlayableLocation struct {
// Required. The name of this playable location.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required.
// Each location has one of the following identifiers:
//
// Types that are assignable to LocationId:
// *PlayableLocation_PlaceId
// *PlayableLocation_PlusCode
LocationId isPlayableLocation_LocationId `protobuf_oneof:"location_id"`
// A collection of [Playable Location Types](/maps/tt/games/types) for this
// playable location. The first type in the collection is the primary type.
//
// Type information might not be available for all playable locations.
Types []string `protobuf:"bytes,4,rep,name=types,proto3" json:"types,omitempty"`
// Required. The latitude and longitude associated with the center of the
// playable location.
//
// By default, the set of playable locations returned from
// [SamplePlayableLocations][google.maps.playablelocations.v3.PlayableLocations.SamplePlayableLocations]
// use center-point coordinates.
CenterPoint *latlng.LatLng `protobuf:"bytes,5,opt,name=center_point,json=centerPoint,proto3" json:"center_point,omitempty"`
// The playable location's coordinates, snapped to the sidewalk of the
// nearest road, if a nearby road exists.
SnappedPoint *latlng.LatLng `protobuf:"bytes,6,opt,name=snapped_point,json=snappedPoint,proto3" json:"snapped_point,omitempty"`
// contains filtered or unexported fields
}
func (*PlayableLocation) Descriptor() ([]byte, []int)
Deprecated: Use PlayableLocation.ProtoReflect.Descriptor instead.
func (x *PlayableLocation) GetCenterPoint() *latlng.LatLng
func (m *PlayableLocation) GetLocationId() isPlayableLocation_LocationId
func (x *PlayableLocation) GetName() string
func (x *PlayableLocation) GetPlaceId() string
func (x *PlayableLocation) GetPlusCode() string
func (x *PlayableLocation) GetSnappedPoint() *latlng.LatLng
func (x *PlayableLocation) GetTypes() []string
func (*PlayableLocation) ProtoMessage()
func (x *PlayableLocation) ProtoReflect() protoreflect.Message
func (x *PlayableLocation) Reset()
func (x *PlayableLocation) String() string
A list of PlayableLocation objects that satisfies a single Criterion.
type PlayableLocationList struct {
// A list of playable locations for this game object type.
Locations []*PlayableLocation `protobuf:"bytes,1,rep,name=locations,proto3" json:"locations,omitempty"`
// contains filtered or unexported fields
}
func (*PlayableLocationList) Descriptor() ([]byte, []int)
Deprecated: Use PlayableLocationList.ProtoReflect.Descriptor instead.
func (x *PlayableLocationList) GetLocations() []*PlayableLocation
func (*PlayableLocationList) ProtoMessage()
func (x *PlayableLocationList) ProtoReflect() protoreflect.Message
func (x *PlayableLocationList) Reset()
func (x *PlayableLocationList) String() string
type PlayableLocation_PlaceId struct {
// A [place ID] (https://developers.google.com/places/place-id)
PlaceId string `protobuf:"bytes,2,opt,name=place_id,json=placeId,proto3,oneof"`
}
type PlayableLocation_PlusCode struct {
// A [plus code] (http://openlocationcode.com)
PlusCode string `protobuf:"bytes,3,opt,name=plus_code,json=plusCode,proto3,oneof"`
}
A set of options that specifies the separation between playable locations.
type SpacingOptions struct {
// Required. The minimum spacing between any two playable locations, measured
// in meters. The minimum value is 30. The maximum value is 1000.
//
// Inputs will be rounded up to the next 10 meter interval.
//
// The default value is 200m.
//
// Set this field to remove tight clusters of playable locations.
//
// Note:
//
// The spacing is a greedy algorithm. It optimizes for selecting the highest
// ranking locations first, not to maximize the number of locations selected.
// Consider the following scenario:
//
// * Rank: A: 2, B: 1, C: 3.
// * Distance: A--200m--B--200m--C
//
// If spacing=250, it will pick the highest ranked location [B], not [A, C].
//
//
// Note:
//
// Spacing works within the game object type itself, as well as the previous
// ones.
// Suppose three game object types, each with the following spacing:
//
// * X: 400m, Y: undefined, Z: 200m.
//
// 1. Add locations for X, within 400m of each other.
// 2. Add locations for Y, without any spacing.
// 3. Finally, add locations for Z within 200m of each other as well X and Y.
//
// The distance diagram between those locations end up as:
//
// * From->To.
// * X->X: 400m
// * Y->X, Y->Y: unspecified.
// * Z->X, Z->Y, Z->Z: 200m.
MinSpacingMeters float64 `protobuf:"fixed64,1,opt,name=min_spacing_meters,json=minSpacingMeters,proto3" json:"min_spacing_meters,omitempty"`
// Specifies whether the minimum spacing constraint applies to the
// center-point or to the snapped point of playable locations. The default
// value is `CENTER_POINT`.
//
// If a snapped point is not available for a playable location, its
// center-point is used instead.
//
// Set this to the point type used in your game.
PointType SpacingOptions_PointType `protobuf:"varint,2,opt,name=point_type,json=pointType,proto3,enum=google.maps.playablelocations.v3.sample.SpacingOptions_PointType" json:"point_type,omitempty"`
// contains filtered or unexported fields
}
func (*SpacingOptions) Descriptor() ([]byte, []int)
Deprecated: Use SpacingOptions.ProtoReflect.Descriptor instead.
func (x *SpacingOptions) GetMinSpacingMeters() float64
func (x *SpacingOptions) GetPointType() SpacingOptions_PointType
func (*SpacingOptions) ProtoMessage()
func (x *SpacingOptions) ProtoReflect() protoreflect.Message
func (x *SpacingOptions) Reset()
func (x *SpacingOptions) String() string
Specifies whether the playable location's geographic coordinates (latitude and longitude) correspond to its center-point, or to its location snapped to the sidewalk of the nearest road.
type SpacingOptions_PointType int32
const (
// Unspecified point type. Do not use this value.
SpacingOptions_POINT_TYPE_UNSPECIFIED SpacingOptions_PointType = 0
// The geographic coordinates correspond to the center of the location.
SpacingOptions_CENTER_POINT SpacingOptions_PointType = 1
// The geographic coordinates correspond to the location snapped to the
// sidewalk of the nearest road (when a nearby road exists).
SpacingOptions_SNAPPED_POINT SpacingOptions_PointType = 2
)
func (SpacingOptions_PointType) Descriptor() protoreflect.EnumDescriptor
func (x SpacingOptions_PointType) Enum() *SpacingOptions_PointType
func (SpacingOptions_PointType) EnumDescriptor() ([]byte, []int)
Deprecated: Use SpacingOptions_PointType.Descriptor instead.
func (x SpacingOptions_PointType) Number() protoreflect.EnumNumber
func (x SpacingOptions_PointType) String() string
func (SpacingOptions_PointType) Type() protoreflect.EnumType