Places API (New) (places:v1)

2023-10-25

3 new methods

Additions

    Methods
  • places.places.searchNearby

  • places.places.get

      Parameter Order: name

      Path: v1/{+name}

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/maps-platform.places
    • https://www.googleapis.com/auth/maps-platform.places.details
    • HTTP Method: GET

      Flat Path: v1/places/{placesId}

      Parameters:

        regionCode

          Location: query

          Description: Optional. The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law. For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported.

          Type: string

        languageCode

          Location: query

          Description: Optional. Place details will be displayed with the preferred language if available. Current list of supported languages: https://developers.google.com/maps/faq#languagesupport.

          Type: string

        name

          Description: Required. A place ID returned in a Place (with "places/" prefix), or equivalently the name in the same Place. Format: places/place_id.

          Required: Yes

          Location: path

          Pattern: ^places/[^/]+$

          Type: string

      Description: Get a Place with a place id (in a name) string.

  • places.places.photos.getMedia

      Path: v1/{+name}

      Flat Path: v1/places/{placesId}/photos/{photosId}/media

      Parameters:

        skipHttpRedirect

          Type: boolean

          Description: Optional. If set, skip the default HTTP redirect behavior and render a text format (for example, in JSON format for HTTP use case) response. If not set, an HTTP redirect will be issued to redirect the call to the image midea. This option is ignored for non-HTTP requests.

          Location: query

        maxWidthPx

          Location: query

          Description: Optional. Specifies the maximum desired width, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the max_height_px and max_width_px properties accept an integer between 1 and 4800, inclusively. If the value is not within the allowed range, an INVALID_ARGUMENT error will be returned. At least one of max_height_px or max_width_px needs to be specified. If neither max_height_px nor max_width_px is specified, an INVALID_ARGUMENT error will be returned.

          Format: int32

          Type: integer

        maxHeightPx

          Description: Optional. Specifies the maximum desired height, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the max_height_px and max_width_px properties accept an integer between 1 and 4800, inclusively. If the value is not within the allowed range, an INVALID_ARGUMENT error will be returned. At least one of max_height_px or max_width_px needs to be specified. If neither max_height_px nor max_width_px is specified, an INVALID_ARGUMENT error will be returned.

          Type: integer

          Format: int32

          Location: query

        name

          Type: string

          Required: Yes

          Location: path

          Pattern: ^places/[^/]+/photos/[^/]+/media$

          Description: Required. The resource name of a photo as returned in a Place object's photos.name field. Format: places/place_id/photos/photo_reference.

      Description: Get a photo media with a photo reference string.

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/maps-platform.places
    • HTTP Method: GET

      Parameter Order: name