Documentation
¶
Overview ¶
Package goplaces provides a Go client for the Google Places API (New).
Index ¶
- Constants
- Variables
- type APIError
- type AuthorAttribution
- type AutocompleteRequest
- type AutocompleteResponse
- type AutocompleteSuggestion
- type Client
- func (c *Client) Autocomplete(ctx context.Context, req AutocompleteRequest) (AutocompleteResponse, error)
- func (c *Client) Details(ctx context.Context, placeID string) (PlaceDetails, error)
- func (c *Client) DetailsWithOptions(ctx context.Context, req DetailsRequest) (PlaceDetails, error)
- func (c *Client) Directions(ctx context.Context, req DirectionsRequest) (DirectionsResponse, error)
- func (c *Client) NearbySearch(ctx context.Context, req NearbySearchRequest) (NearbySearchResponse, error)
- func (c *Client) PhotoMedia(ctx context.Context, req PhotoMediaRequest) (PhotoMediaResponse, error)
- func (c *Client) Resolve(ctx context.Context, req LocationResolveRequest) (LocationResolveResponse, error)
- func (c *Client) Route(ctx context.Context, req RouteRequest) (RouteResponse, error)
- func (c *Client) Search(ctx context.Context, req SearchRequest) (SearchResponse, error)
- type DetailsRequest
- type DirectionsRequest
- type DirectionsResponse
- type DirectionsStep
- type Filters
- type LatLng
- type LocalizedText
- type LocationBias
- type LocationResolveRequest
- type LocationResolveResponse
- type NearbySearchRequest
- type NearbySearchResponse
- type Options
- type Photo
- type PhotoMediaRequest
- type PhotoMediaResponse
- type PlaceDetails
- type PlaceSummary
- type ResolvedLocation
- type Review
- type ReviewVisitDate
- type RouteRequest
- type RouteResponse
- type RouteWaypoint
- type SearchRequest
- type SearchResponse
- type ValidationError
Constants ¶
const DefaultBaseURL = places.DefaultBaseURL
DefaultBaseURL is the default endpoint for the Places API (New).
Variables ¶
var ErrMissingAPIKey = places.ErrMissingAPIKey
ErrMissingAPIKey indicates a missing API key.
Functions ¶
This section is empty.
Types ¶
type AuthorAttribution ¶
type AuthorAttribution = places.AuthorAttribution
AuthorAttribution describes a review author.
type AutocompleteRequest ¶ added in v0.2.0
type AutocompleteRequest = places.AutocompleteRequest
AutocompleteRequest defines input for autocomplete suggestions.
type AutocompleteResponse ¶ added in v0.2.0
type AutocompleteResponse = places.AutocompleteResponse
AutocompleteResponse contains suggestions from autocomplete.
type AutocompleteSuggestion ¶ added in v0.2.0
type AutocompleteSuggestion = places.AutocompleteSuggestion
AutocompleteSuggestion is a place or query prediction.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client wraps access to the Google Places API.
func (*Client) Autocomplete ¶ added in v0.2.0
func (c *Client) Autocomplete(ctx context.Context, req AutocompleteRequest) (AutocompleteResponse, error)
Autocomplete returns place and query suggestions for partial input.
func (*Client) DetailsWithOptions ¶
func (c *Client) DetailsWithOptions(ctx context.Context, req DetailsRequest) (PlaceDetails, error)
DetailsWithOptions fetches place details with optional locale and field options.
func (*Client) Directions ¶ added in v0.3.0
func (c *Client) Directions(ctx context.Context, req DirectionsRequest) (DirectionsResponse, error)
Directions fetches directions between two locations.
func (*Client) NearbySearch ¶ added in v0.2.0
func (c *Client) NearbySearch(ctx context.Context, req NearbySearchRequest) (NearbySearchResponse, error)
NearbySearch searches places near a lat/lng radius.
func (*Client) PhotoMedia ¶ added in v0.2.0
func (c *Client) PhotoMedia(ctx context.Context, req PhotoMediaRequest) (PhotoMediaResponse, error)
PhotoMedia fetches a photo media URL.
func (*Client) Resolve ¶
func (c *Client) Resolve(ctx context.Context, req LocationResolveRequest) (LocationResolveResponse, error)
Resolve resolves a free-form location into place candidates.
func (*Client) Route ¶ added in v0.2.0
func (c *Client) Route(ctx context.Context, req RouteRequest) (RouteResponse, error)
Route searches for places along a route between two locations.
func (*Client) Search ¶
func (c *Client) Search(ctx context.Context, req SearchRequest) (SearchResponse, error)
Search runs a Places text search.
type DetailsRequest ¶
type DetailsRequest = places.DetailsRequest
DetailsRequest fetches place details with optional locale hints.
type DirectionsRequest ¶ added in v0.3.0
type DirectionsRequest = places.DirectionsRequest
DirectionsRequest describes a directions query between two locations.
type DirectionsResponse ¶ added in v0.3.0
type DirectionsResponse = places.DirectionsResponse
DirectionsResponse contains a single route summary and steps.
type DirectionsStep ¶ added in v0.3.0
type DirectionsStep = places.DirectionsStep
DirectionsStep is a single navigation step.
type LocalizedText ¶
type LocalizedText = places.LocalizedText
LocalizedText is a text value with an optional language code.
type LocationBias ¶
type LocationBias = places.LocationBias
LocationBias limits search results to a circular area.
type LocationResolveRequest ¶
type LocationResolveRequest = places.LocationResolveRequest
LocationResolveRequest resolves a text location into place candidates.
type LocationResolveResponse ¶
type LocationResolveResponse = places.LocationResolveResponse
LocationResolveResponse contains resolved locations.
type NearbySearchRequest ¶ added in v0.2.0
type NearbySearchRequest = places.NearbySearchRequest
NearbySearchRequest defines a nearby search query.
type NearbySearchResponse ¶ added in v0.2.0
type NearbySearchResponse = places.NearbySearchResponse
NearbySearchResponse contains nearby search results.
type PhotoMediaRequest ¶ added in v0.2.0
type PhotoMediaRequest = places.PhotoMediaRequest
PhotoMediaRequest fetches a photo URL from a photo resource name.
type PhotoMediaResponse ¶ added in v0.2.0
type PhotoMediaResponse = places.PhotoMediaResponse
PhotoMediaResponse contains the photo URL for a photo name.
type PlaceDetails ¶
type PlaceDetails = places.PlaceDetails
PlaceDetails is a detailed view of a place.
type PlaceSummary ¶
type PlaceSummary = places.PlaceSummary
PlaceSummary is a compact view of a place.
type ResolvedLocation ¶
type ResolvedLocation = places.ResolvedLocation
ResolvedLocation is a place candidate for a location string.
type ReviewVisitDate ¶
type ReviewVisitDate = places.ReviewVisitDate
ReviewVisitDate describes the date a reviewer visited a place.
type RouteRequest ¶ added in v0.2.0
type RouteRequest = places.RouteRequest
RouteRequest describes a query to search along a route.
type RouteResponse ¶ added in v0.2.0
type RouteResponse = places.RouteResponse
RouteResponse contains sampled waypoints with search results.
type RouteWaypoint ¶ added in v0.2.0
type RouteWaypoint = places.RouteWaypoint
RouteWaypoint ties a sampled route location to search results.
type SearchRequest ¶
type SearchRequest = places.SearchRequest
SearchRequest defines a text search with optional filters.
type SearchResponse ¶
type SearchResponse = places.SearchResponse
SearchResponse contains a list of places and optional pagination token.
type ValidationError ¶
type ValidationError = places.ValidationError
ValidationError describes an invalid request payload.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
goplaces
command
Package main implements the goplaces CLI entrypoint.
|
Package main implements the goplaces CLI entrypoint. |
|
internal
|
|
|
cli
Package cli implements the goplaces command-line interface.
|
Package cli implements the goplaces command-line interface. |
|
places
Package places implements the Places and Routes API client.
|
Package places implements the Places and Routes API client. |
