- HTTP 요청
- 요청 본문
- 응답 본문
- LocationBias
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- LocationRestriction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- 제안
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- PlacePrediction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- FormattableText
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- StringRange
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- StructuredFormat
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- QueryPrediction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
지정된 입력에 대한 예측을 반환합니다.
HTTP 요청
POST https://places.googleapis.com/v1/places:autocomplete
URL은 gRPC 트랜스코딩 구문을 사용합니다.
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{ "input": string, "locationBias": { object ( |
필드 | |
---|---|
input |
필수 항목입니다. 검색할 텍스트 문자열입니다. |
locationBias |
선택사항입니다. 결과를 지정된 위치에 편중합니다.
|
locationRestriction |
선택사항입니다. 결과를 지정된 위치로 제한합니다.
|
includedPrimaryTypes[] |
선택사항입니다. 장소 유형 (https://developers.google.com/maps/documentation/places/web-service/place-types) 또는 표 A 또는 표 B의 기본 장소 유형 (예: '음식점' 또는 'gas_station')이 포함되었거나, 전용 (지역) 또는 전용 (도시)이 포함되었습니다. 장소는 기본 유형이 이 목록에 포함된 경우에만 반환됩니다. 최대 5개의 값을 지정할 수 있습니다. 유형을 지정하지 않으면 모든 장소 유형이 반환됩니다. |
includedRegionCodes[] |
선택사항입니다. 최대 15개의 CLDR 2자리 지역 코드로 지정된 지정된 지역의 결과만 포함합니다. 빈 세트는 결과를 제한하지 않습니다. |
languageCode |
선택사항입니다. 결과를 반환할 때 사용하는 언어입니다. 기본값은 en-US입니다. |
regionCode |
선택사항입니다. CLDR 2자리 지역 코드로 지정된 지역 코드입니다. 이는 주소 형식, 결과 순위에 영향을 미치며 반환되는 결과에도 영향을 줄 수 있습니다. 이렇게 해도 지정된 지역으로 검색 결과가 제한되지는 않습니다. 결과를 특정 지역으로 제한하려면 |
origin |
선택사항입니다. 목적지까지의 최단 거리 거리를 계산할 출발지입니다 ( |
inputOffset |
선택사항입니다. 비어 있으면 기본값은 |
includeQueryPredictions |
선택사항입니다. true인 경우 응답에 장소 및 예상 검색어가 모두 포함됩니다. 그렇지 않으면 응답은 장소 예상 검색어만 반환합니다. |
sessionToken |
선택사항입니다. 결제 목적으로 자동 완성 세션을 식별하는 문자열입니다. ASCII 문자 길이가 최대 36자인 URL 및 파일 이름 안전 base64 문자열이어야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다. 세션은 사용자가 쿼리를 입력하기 시작하면 시작되고, 장소를 선택하고 장소 세부정보 또는 주소 유효성 검사가 호출되면 종료됩니다. 각 세션에는 여러 개의 쿼리가 포함될 수 있으며 하나의 장소 세부정보 또는 주소 유효성 검사 요청이 뒤따릅니다. 세션 내의 각 요청에 사용되는 사용자 인증 정보는 동일한 Google Cloud 콘솔 프로젝트에 속해야 합니다. 세션이 종료되면 토큰이 더 이상 유효하지 않습니다. 각 세션에 대해 새 토큰을 생성해야 합니다. 다음 가이드라인이 권장됩니다.
|
응답 본문
places.Autocomplete의 응답 프로토콜입니다.
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{
"suggestions": [
{
object ( |
필드 | |
---|---|
suggestions[] |
추천 목록이 관련성의 내림차순으로 정렬됩니다. |
LocationBias
검색할 리전입니다. 결과는 지정된 지역을 중심으로 편향될 수 있습니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드
|
|
rectangle |
북동쪽과 남서쪽 모서리로 정의되는 표시 영역 |
circle |
중심점과 반지름으로 정의되는 원입니다. |
LocationRestriction
검색할 리전입니다. 검색 결과가 지정된 지역으로 제한됩니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드
|
|
rectangle |
북동쪽과 남서쪽 모서리로 정의되는 표시 영역 |
circle |
중심점과 반지름으로 정의되는 원입니다. |
추천
자동 완성 추천 결과입니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드
|
|
placePrediction |
장소에 대한 예상 검색어입니다. |
queryPrediction |
쿼리에 대한 예측입니다. |
PlacePrediction
Place Autocomplete 예상 검색어의 예측 결과
JSON 표현 |
---|
{ "place": string, "placeId": string, "text": { object ( |
필드 | |
---|---|
place |
추천 장소의 리소스 이름입니다. 이 이름은 장소 이름을 허용하는 다른 API에서 사용할 수 있습니다. |
placeId |
추천 장소의 고유 식별자입니다. 이 식별자는 장소 ID를 허용하는 다른 API에서 사용할 수 있습니다. |
text |
반환된 결과에 대해 사람이 읽을 수 있는 이름이 포함됩니다. 시설 결과의 경우 이는 일반적으로 비즈니스 이름 및 주소입니다.
이 텍스트는 places.get에서 반환된
|
structuredFormat |
장소 예상 검색어를 장소의 이름을 포함하는 기본 텍스트 및 추가적인 명확한 지형지물 (예: 도시 또는 지역)이 포함된 보조 텍스트로 분류합니다.
|
types[] |
https://developers.google.com/maps/documentation/places/web-service/place-types의 표 A 또는 표 B에서 이 장소에 적용되는 유형 목록입니다. 유형은 장소의 카테고리입니다. 유형을 공유하는 장소는 유사한 특성을 공유합니다. |
distanceMeters |
|
FormattableText
장소 또는 쿼리 예상 검색어를 나타내는 텍스트입니다. 텍스트는 그대로 사용되거나 서식이 지정된 대로 사용될 수 있습니다.
JSON 표현 |
---|
{
"text": string,
"matches": [
{
object ( |
필드 | |
---|---|
text |
있는 그대로 사용되거나 |
matches[] |
이 값은 |
StringRange
지정된 텍스트 내의 하위 문자열을 식별합니다.
JSON 표현 |
---|
{ "startOffset": integer, "endOffset": integer } |
필드 | |
---|---|
startOffset |
문자열의 첫 번째 유니코드 문자에 대한 0 기준 오프셋입니다 (해당 값 포함). |
endOffset |
마지막 유니코드 문자의 0 기준 오프셋입니다 (제외). |
StructuredFormat
장소 또는 검색어 예상 검색어의 분석을 기본 텍스트와 보조 텍스트로 포함합니다.
장소 예상 검색어의 경우 기본 텍스트에는 장소의 특정 이름이 포함됩니다. 검색어 예상 검색어의 경우 기본 텍스트에 검색어가 포함됩니다.
보조 텍스트에는 장소를 더 자세히 식별하거나 쿼리를 미세 조정하기 위해 추가 명확한 지형지물 (예: 도시 또는 지역)이 포함됩니다.
JSON 표현 |
---|
{ "mainText": { object ( |
필드 | |
---|---|
mainText |
장소 또는 쿼리의 이름을 나타냅니다. |
secondaryText |
장소를 추가로 식별하거나 쿼리를 미세 조정하기 위해 추가 명확한 지형지물 (예: 도시 또는 지역)을 나타냅니다. |
QueryPrediction
검색어 자동 완성 예상 검색어의 예측 결과입니다.
JSON 표현 |
---|
{ "text": { object ( |
필드 | |
---|---|
text |
예상 텍스트입니다. 이 텍스트는 장소가 아니라 검색 엔드포인트 (예: 텍스트 검색)에서 사용할 수 있는 텍스트 쿼리를 나타냅니다.
요청 |
structuredFormat |
검색어가 포함된 기본 텍스트 및 추가적인 명확한 특징을 포함하는 보조 텍스트 (예: 도시 또는 지역)로 검색어 예상 검색어를 세분화합니다.
|