위치 근처의 장소를 검색합니다.
HTTP 요청
POST https://places.googleapis.com/v1/places:searchNearby
URL은 gRPC 트랜스코딩 구문을 사용합니다.
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
| JSON 표현 |
|---|
{ "languageCode": string, "regionCode": string, "includedTypes": [ string ], "excludedTypes": [ string ], "includedPrimaryTypes": [ string ], "excludedPrimaryTypes": [ string ], "maxResultCount": integer, "locationRestriction": { object ( |
| 필드 | |
|---|---|
languageCode |
사용 가능한 경우 장소 세부정보가 선호하는 언어로 표시됩니다. 언어 코드가 지정되지 않거나 인식되지 않는 경우 장소 세부정보가 있는 경우 영어로 우선하여 모든 언어의 장소 세부정보가 반환될 수 있습니다. 지원되는 언어의 현재 목록: https://developers.google.com/maps/faq#languagesupport. |
regionCode |
요청이 전송되는 위치의 Unicode 국가/지역 코드 (CLDR)입니다. 이 매개변수는 지역별 장소 이름과 같은 장소 세부정보를 표시하는 데 사용됩니다(사용 가능한 경우). 이 매개변수는 관련 법률에 따라 결과에 영향을 줄 수 있습니다. 자세한 내용은 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html을 참고하세요. 현재 3자리 지역 코드는 지원되지 않습니다. |
includedTypes[] |
https://developers.google.com/maps/documentation/places/web-service/place-types의 포함된 장소 유형 (예: 'restaurant' 또는 'gas_station')입니다. 표 A에서 최대 50개의 유형을 지정할 수 있습니다. 충돌하는 유형(즉, 포함된 유형과 제외된 유형 모두에 유형이 표시됨)이 있으면 INVALID_ARGUMENT 오류가 반환됩니다. 장소 유형이 여러 유형 제한사항과 함께 지정되면 모든 제한사항을 충족하는 장소만 반환됩니다. 예를 들어 {includedTypes = ['restaurant'], excludedPrimaryTypes = ['restaurant']}가 있는 경우 반환된 장소는 'restaurant' 관련 서비스를 제공하지만 주로 'restaurants'로 운영되지는 않습니다. |
excludedTypes[] |
https://developers.google.com/maps/documentation/places/web-service/place-types의 제외된 장소 유형 (예: 'restaurant' 또는 'gas_station')입니다. 표 A에서 최대 50개의 유형을 지정할 수 있습니다. 클라이언트가 포함된 유형 (예: 레스토랑)과 제외된 유형 (예: 카페)을 모두 제공하는 경우 응답에는 레스토랑이지만 카페는 아닌 장소가 포함되어야 합니다. 응답에는 포함된 유형 중 하나 이상과 일치하고 제외된 유형과 일치하지 않는 장소가 포함됩니다. 충돌하는 유형(즉, 포함된 유형과 제외된 유형 모두에 유형이 표시됨)이 있으면 INVALID_ARGUMENT 오류가 반환됩니다. 장소 유형이 여러 유형 제한사항과 함께 지정되면 모든 제한사항을 충족하는 장소만 반환됩니다. 예를 들어 {includedTypes = ['restaurant'], excludedPrimaryTypes = ['restaurant']}가 있는 경우 반환된 장소는 'restaurant' 관련 서비스를 제공하지만 주로 'restaurants'로 운영되지는 않습니다. |
includedPrimaryTypes[] |
https://developers.google.com/maps/documentation/places/web-service/place-types의 포함된 기본 장소 유형 (예: "restaurant" 또는 "gas_station")입니다. 장소에는 지원되는 유형 표의 기본 유형이 하나만 연결될 수 있습니다. 표 A에서 최대 50개의 유형을 지정할 수 있습니다. 충돌하는 기본 유형(즉, 포함된 기본 유형과 제외된 기본 유형 모두에 유형이 표시됨)이 있으면 INVALID_ARGUMENT 오류가 반환됩니다. 장소 유형이 여러 유형 제한사항과 함께 지정되면 모든 제한사항을 충족하는 장소만 반환됩니다. 예를 들어 {includedTypes = ['restaurant'], excludedPrimaryTypes = ['restaurant']}가 있는 경우 반환된 장소는 'restaurant' 관련 서비스를 제공하지만 주로 'restaurants'로 운영되지는 않습니다. |
excludedPrimaryTypes[] |
https://developers.google.com/maps/documentation/places/web-service/place-types의 제외된 기본 장소 유형 (예: "restaurant" 또는 "gas_station")입니다. 표 A에서 최대 50개의 유형을 지정할 수 있습니다. 충돌하는 기본 유형(즉, 포함된 기본 유형과 제외된 기본 유형 모두에 유형이 표시됨)이 있으면 INVALID_ARGUMENT 오류가 반환됩니다. 장소 유형이 여러 유형 제한사항과 함께 지정되면 모든 제한사항을 충족하는 장소만 반환됩니다. 예를 들어 {includedTypes = ['restaurant'], excludedPrimaryTypes = ['restaurant']}가 있는 경우 반환된 장소는 'restaurant' 관련 서비스를 제공하지만 주로 'restaurants'로 운영되지는 않습니다. |
maxResultCount |
반환할 결과의 최대 수입니다. 1~20(기본값) 사이의 값이어야 합니다(포함). 숫자가 설정되지 않으면 상한으로 대체됩니다. 숫자가 음수로 설정되거나 상한을 초과하면 INVALID_ARGUMENT 오류가 반환됩니다. |
locationRestriction |
필수 항목입니다. 검색할 지역입니다. |
rankPreference |
응답에서 결과의 순위가 지정되는 방식입니다. |
routingParameters |
선택사항입니다. 검색 결과로의 라우팅에 영향을 미치는 매개변수입니다. |
includeFutureOpeningBusinesses |
선택사항입니다. true인 경우 아직 영업 중이 아니지만 향후 영업을 시작할 비즈니스를 포함합니다. |
응답 본문
주변 검색의 응답 프로토콜입니다.
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
| JSON 표현 |
|---|
{ "places": [ { object ( |
| 필드 | |
|---|---|
places[] |
장소 유형, 장소 수, 특정 위치 제한사항과 같은 사용자 요구사항을 충족하는 장소 목록입니다. |
routingSummaries[] |
각 항목이 |
승인 범위
다음 OAuth 범위 중 하나가 필요합니다.
https://www.googleapis.com/auth/maps-platform.places.nearbysearchhttps://www.googleapis.com/auth/maps-platform.placeshttps://www.googleapis.com/auth/cloud-platform
LocationRestriction
검색할 지역입니다.
| JSON 표현 |
|---|
{ // Union field |
| 필드 | |
|---|---|
통합 필드
|
|
circle |
중심점과 반경으로 정의된 원입니다. |
RankPreference
응답에서 결과의 순위가 지정되는 방식입니다.
| 열거형 | |
|---|---|
RANK_PREFERENCE_UNSPECIFIED |
RankPreference 값이 설정되지 않았습니다. 기본적으로 인기도별 순위가 사용됩니다. |
DISTANCE |
거리를 기준으로 결과의 순위를 지정합니다. |
POPULARITY |
인기도를 기준으로 결과의 순위를 지정합니다. |