Skip to content

docs: [google-maps-places] clarify behavior of primary types and weekday text #14050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
parthea merged 2 commits into from
Jul 1, 2025
Merged

docs: [google-maps-places] clarify behavior of primary types and weekday text #14050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a3e0de
docs: clarify behavior of primary types and weekday text
gcf-owl-bot[bot] Jul 1, 2025
15e375c
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/google-maps-places/google/maps/places/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "0.2.1" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
2 changes: 1 addition & 1 deletion packages/google-maps-places/google/maps/places_v1/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "0.2.1" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
6 changes: 3 additions & 3 deletions packages/google-maps-places/google/maps/places_v1/services/places/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@

class PlacesAsyncClient:
"""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:
for Autocomplete and GetPhotoMedia 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
"""

Expand Down
6 changes: 3 additions & 3 deletions packages/google-maps-places/google/maps/places_v1/services/places/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,9 @@ def get_transport_class(

class PlacesClient(metaclass=PlacesClientMeta):
"""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:
for Autocomplete and GetPhotoMedia 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
"""

Expand Down
6 changes: 3 additions & 3 deletions packages/google-maps-places/google/maps/places_v1/services/places/transports/grpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ class PlacesGrpcTransport(PlacesTransport):
"""gRPC backend transport for Places.

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:
for Autocomplete and GetPhotoMedia 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

This class defines the same methods as the primary client, so the
Expand Down
6 changes: 3 additions & 3 deletions packages/google-maps-places/google/maps/places_v1/services/places/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ class PlacesGrpcAsyncIOTransport(PlacesTransport):
"""gRPC AsyncIO backend transport for Places.

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:
for Autocomplete and GetPhotoMedia 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

This class defines the same methods as the primary client, so the
Expand Down
6 changes: 3 additions & 3 deletions packages/google-maps-places/google/maps/places_v1/services/places/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,9 +372,9 @@ class PlacesRestTransport(_BasePlacesRestTransport):
"""REST backend synchronous transport for Places.

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:
for Autocomplete and GetPhotoMedia 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

This class defines the same methods as the primary client, so the
Expand Down
59 changes: 39 additions & 20 deletions packages/google-maps-places/google/maps/places_v1/types/place.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,19 +89,23 @@ class Place(proto.Message):
and Table B at
https://developers.google.com/maps/documentation/places/web-service/place-types
primary_type (str):
The primary type of the given result. This
type must one of the Places API supported types.
For example, "restaurant", "cafe", "airport",
etc. A place can only have a single primary
type. For the complete list of possible values,
see Table A and Table B at
https://developers.google.com/maps/documentation/places/web-service/place-types
The primary type of the given result. This type must be one
of the Places API supported types. For example,
"restaurant", "cafe", "airport", etc. A place can only have
a single primary type. For the complete list of possible
values, see Table A and Table B at
https://developers.google.com/maps/documentation/places/web-service/place-types.
The primary type may be missing if the place's primary type
is not a supported type. When a primary type is present, it
is always one of the types in the ``types`` field.
primary_type_display_name (google.type.localized_text_pb2.LocalizedText):
The display name of the primary type,
localized to the request language if applicable.
For the complete list of possible values, see
Table A and Table B at
https://developers.google.com/maps/documentation/places/web-service/place-types
https://developers.google.com/maps/documentation/places/web-service/place-types.
The primary type may be missing if the place's
primary type is not a supported type.
national_phone_number (str):
A human-readable phone number for the place,
in national format.
Expand Down Expand Up @@ -494,19 +498,34 @@ class OpeningHours(proto.Message):

This field is a member of `oneof`_ ``_open_now``.
periods (MutableSequence[google.maps.places_v1.types.Place.OpeningHours.Period]):
The periods that this place is open during
the week. The periods are in chronological
order, starting with Sunday in the place-local
timezone. An empty (but not absent) value
indicates a place that is never open, e.g.
because it is closed temporarily for
renovations.
The periods that this place is open during the week. The
periods are in chronological order, in the place-local
timezone. An empty (but not absent) value indicates a place
that is never open, e.g. because it is closed temporarily
for renovations.

The starting day of ``periods`` is NOT fixed and should not
be assumed to be Sunday. The API determines the start day
based on a variety of factors. For example, for a 24/7
business, the first period may begin on the day of the
request. For other businesses, it might be the first day of
the week that they are open.

NOTE: The ordering of the ``periods`` array is independent
of the ordering of the ``weekday_descriptions`` array. Do
not assume they will begin on the same day.
weekday_descriptions (MutableSequence[str]):
Localized strings describing the opening
hours of this place, one string for each day of
the week. Will be empty if the hours are
unknown or could not be converted to localized
text. Example: "Sun: 18:00–06:00".
Localized strings describing the opening hours of this
place, one string for each day of the week.

NOTE: The order of the days and the start of the week is
determined by the locale (language and region). The ordering
of the ``periods`` array is independent of the ordering of
the ``weekday_descriptions`` array. Do not assume they will
begin on the same day.

Will be empty if the hours are unknown or could not be
converted to localized text. Example: "Sun: 18:00–06:00".
secondary_hours_type (google.maps.places_v1.types.Place.OpeningHours.SecondaryHoursType):
A type string used to identify the type of
secondary hours.
Expand Down
Loading