Package places is an auto-generated package for the Places API (New).
The Places API allows developers to access a variety of search and retrieval endpoints for a Place.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/maps/places/apiv1@latest ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := places . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req := & placespb . AutocompletePlacesRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/maps/places/apiv1/placespb#AutocompletePlacesRequest. } resp , err := c . AutocompletePlaces ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type
CallOptions
struct
{
SearchNearby
[]
gax
.
CallOption
SearchText
[]
gax
.
CallOption
GetPhotoMedia
[]
gax
.
CallOption
GetPlace
[]
gax
.
CallOption
AutocompletePlaces
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// The call options for this service.
CallOptions
*
CallOptions
// contains filtered or unexported fields
}
Client is a client for interacting with Places API (New). Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Service definition for the Places API. Note: every request (except for Autocomplete requests) requires a field mask set outside of the request proto (all/*, is not assumed). The field mask can be set via the HTTP header X-Goog-FieldMask. See: https://developers.google.com/maps/documentation/places/web-service/choose-fields (at https://developers.google.com/maps/documentation/places/web-service/choose-fields )
func NewClient
NewClient creates a new places client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Service definition for the Places API. Note: every request (except for Autocomplete requests) requires a field mask set outside of the request proto (all/*, is not assumed). The field mask can be set via the HTTP header X-Goog-FieldMask. See: https://developers.google.com/maps/documentation/places/web-service/choose-fields (at https://developers.google.com/maps/documentation/places/web-service/choose-fields )
Example
package
main
import
(
"context"
places
"cloud.google.com/go/maps/places/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
places
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new places rest client.
Service definition for the Places API. Note: every request (except for Autocomplete requests) requires a field mask set outside of the request proto (all/*, is not assumed). The field mask can be set via the HTTP header X-Goog-FieldMask. See: https://developers.google.com/maps/documentation/places/web-service/choose-fields (at https://developers.google.com/maps/documentation/places/web-service/choose-fields )
Example
package
main
import
(
"context"
places
"cloud.google.com/go/maps/places/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
places
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) AutocompletePlaces
func
(
c
*
Client
)
AutocompletePlaces
(
ctx
context
.
Context
,
req
*
placespb
.
AutocompletePlacesRequest
,
opts
...
gax
.
CallOption
)
(
*
placespb
.
AutocompletePlacesResponse
,
error
)
AutocompletePlaces returns predictions for the given input.
Example
package
main
import
(
"context"
places
"cloud.google.com/go/maps/places/apiv1"
placespb
"cloud.google.com/go/maps/places/apiv1/placespb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
places
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& placespb
.
AutocompletePlacesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/maps/places/apiv1/placespb#AutocompletePlacesRequest.
}
resp
,
err
:=
c
.
AutocompletePlaces
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection (deprecated)
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) GetPhotoMedia
func
(
c
*
Client
)
GetPhotoMedia
(
ctx
context
.
Context
,
req
*
placespb
.
GetPhotoMediaRequest
,
opts
...
gax
.
CallOption
)
(
*
placespb
.
PhotoMedia
,
error
)
GetPhotoMedia get a photo media with a photo reference string.
Example
package
main
import
(
"context"
places
"cloud.google.com/go/maps/places/apiv1"
placespb
"cloud.google.com/go/maps/places/apiv1/placespb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
places
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& placespb
.
GetPhotoMediaRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/maps/places/apiv1/placespb#GetPhotoMediaRequest.
}
resp
,
err
:=
c
.
GetPhotoMedia
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetPlace
func
(
c
*
Client
)
GetPlace
(
ctx
context
.
Context
,
req
*
placespb
.
GetPlaceRequest
,
opts
...
gax
.
CallOption
)
(
*
placespb
.
Place
,
error
)
GetPlace get the details of a place based on its resource name, which is a string in the places/{place_id} format.
Example
package
main
import
(
"context"
places
"cloud.google.com/go/maps/places/apiv1"
placespb
"cloud.google.com/go/maps/places/apiv1/placespb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
places
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& placespb
.
GetPlaceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/maps/places/apiv1/placespb#GetPlaceRequest.
}
resp
,
err
:=
c
.
GetPlace
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) SearchNearby
func
(
c
*
Client
)
SearchNearby
(
ctx
context
.
Context
,
req
*
placespb
.
SearchNearbyRequest
,
opts
...
gax
.
CallOption
)
(
*
placespb
.
SearchNearbyResponse
,
error
)
SearchNearby search for places near locations.
Example
package
main
import
(
"context"
places
"cloud.google.com/go/maps/places/apiv1"
placespb
"cloud.google.com/go/maps/places/apiv1/placespb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
places
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& placespb
.
SearchNearbyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/maps/places/apiv1/placespb#SearchNearbyRequest.
}
resp
,
err
:=
c
.
SearchNearby
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) SearchText
func
(
c
*
Client
)
SearchText
(
ctx
context
.
Context
,
req
*
placespb
.
SearchTextRequest
,
opts
...
gax
.
CallOption
)
(
*
placespb
.
SearchTextResponse
,
error
)
SearchText text query based place search.
Example
package
main
import
(
"context"
places
"cloud.google.com/go/maps/places/apiv1"
placespb
"cloud.google.com/go/maps/places/apiv1/placespb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
places
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& placespb
.
SearchTextRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/maps/places/apiv1/placespb#SearchTextRequest.
}
resp
,
err
:=
c
.
SearchText
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
