자동 완성 (신규)

플랫폼 선택: Android iOS JavaScript 웹 서비스

자동 완성 (신규) 서비스는 HTTP 요청에 대한 응답으로 장소 예상 검색어 및 예상 검색어를 반환하는 웹 서비스입니다. 요청에서 텍스트 검색 문자열과 검색 영역을 제어하는 지리적 경계를 지정합니다.

자동 완성 (신규) 서비스는 입력의 전체 단어 및 하위 문자열을 일치시켜 장소 이름, 주소, 플러스 코드를 결정할 수 있습니다. 따라서 사용자가 입력할 때 애플리케이션에서 쿼리를 전송하여 즉시 장소 및 예상 검색어를 제공할 수 있습니다.

Autocomplete (New) API의 응답에는 두 가지 유형의 예상 검색어가 포함될 수 있습니다.

  • 장소 예상 검색어: 지정된 입력 텍스트 문자열과 검색 영역을 기반으로 한 비즈니스, 주소, 관심 장소 등의 장소입니다. 장소 예상 검색어는 기본적으로 반환됩니다.
  • 검색어 예상 검색어: 입력 텍스트 문자열 및 검색 영역과 일치하는 검색어 문자열입니다. 쿼리 예측은 기본적으로 반환되지 않습니다. includeQueryPredictions 요청 매개변수를 사용하여 응답에 쿼리 예측을 추가합니다.

예를 들어, 사용자 입력 부분이 'Sicilian piz'이고 검색 영역이 캘리포니아 샌프란시스코로 제한된 문자열을 입력으로 사용하여 API를 호출합니다. 응답에는 장소에 대한 세부정보와 함께 검색 문자열 및 검색 영역(예: 'Sicilian Pizza Kitchen'이라는 레스토랑)과 일치하는 장소 예상 검색어 목록이 포함됩니다.

반환된 장소 예상 검색어는 사용자에게 표시되어 원하는 장소를 선택하는 데 도움을 줄 수 있습니다. 장소 세부정보 (신규) 요청을 통해 반환된 장소 예상 검색어에 대한 추가 정보를 가져올 수 있습니다.

응답에는 'Sicilian Pizza & Pasta'와 같이 검색 문자열 및 검색 영역과 일치하는 쿼리 예상 검색어 목록도 포함될 수 있습니다. 응답의 각 쿼리 예상 검색어에는 추천 텍스트 검색 문자열이 포함된 text 필드가 포함됩니다. 이 문자열을 텍스트 검색 (신규)에 대한 입력으로 사용하여 더 자세한 검색을 수행합니다.

API 탐색기를 사용하면 실시간 요청을 수행하여 API 및 API 옵션을 익힐 수 있습니다.

실습

자동 완성 (신규) 요청

자동 완성 (신규) 요청은 다음과 같은 형식의 URL에 대한 HTTP POST 요청입니다.

https://places.googleapis.com/v1/places:autocomplete

JSON 요청 본문 또는 헤더에 모든 매개변수를 POST 요청의 일부로 전달합니다. 예를 들면 다음과 같습니다.

curl -X POST -d '{
  "input": "pizza",
  "locationBias": {
    "circle": {
      "center": {
        "latitude": 37.7937,
        "longitude": -122.3965
      },
      "radius": 500.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

답변 정보

자동 완성 (신규)은 JSON 객체를 응답으로 반환합니다. 응답에서 각 항목의 의미는 다음과 같습니다.

  • suggestions 배열에는 감지된 관련성을 기준으로 모든 예상 장소와 검색어가 순서대로 포함됩니다. 각 장소는 placePrediction 필드로, 각 쿼리는 queryPrediction 필드로 표시됩니다.
  • placePrediction 필드에는 장소 ID, 텍스트 설명 등 단일 장소 예상 검색어에 대한 자세한 정보가 포함됩니다.
  • queryPrediction 필드에는 단일 쿼리 예상 검색어에 대한 자세한 정보가 포함됩니다.

전체 JSON 객체는 다음과 같은 형식입니다.

{
  "suggestions": [
    {
      "placePrediction": {
        "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "text": {
          "text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }]
        },
      ...
    },
    {
      "queryPrediction": {
        "text": {
          "text": "Amoeba Music",
          "matches": [
            {
              "endOffset": 6
            }]
        },
        ...
    }
  ...]
}

필수 매개변수

  • 입력

    검색할 텍스트 문자열입니다. 전체 단어 및 하위 문자열, 장소 이름, 주소, 플러스 코드를 지정합니다. Autocomplete (신규) 서비스는 이 문자열을 기준으로 일치 가능성이 있는 항목을 반환하고 감지된 관련성을 기준으로 검색 결과의 순서를 지정합니다.

선택적 매개변수

  • includedPrimaryTypes

    한 장소에는 테이블 A 또는 테이블 B에 나열된 유형의 단일 기본 유형만 있을 수 있습니다. 예를 들어 기본 유형은 "mexican_restaurant" 또는 "steak_house"일 수 있습니다.

    기본적으로 API는 장소와 연결된 기본 유형 값과 관계없이 input 매개변수를 기반으로 모든 장소를 반환합니다. includedPrimaryTypes 매개변수를 전달하여 결과를 특정 기본 유형 또는 기본 유형으로 제한합니다.

    이 매개변수를 사용하여 표 A 또는 표 B에서 최대 5개의 유형 값을 지정합니다. 장소는 응답에 포함할 지정된 기본 유형 값 중 하나와 일치해야 합니다.

    이 매개변수는 대신 (regions) 또는 (cities) 중 하나를 포함할 수도 있습니다. (regions) 유형 컬렉션은 인근 지역이나 우편번호와 같은 지역 또는 구역을 필터링합니다. (cities) 유형 컬렉션은 Google에서 도시로 식별한 장소를 필터링합니다.

    다음과 같은 경우 INVALID_REQUEST 오류와 함께 요청이 거부됩니다.

    • 5개 이상의 유형이 지정되었습니다.
    • 모든 유형은 (cities) 또는 (regions) 외에 추가로 지정됩니다.
    • 인식할 수 없는 유형이 모두 지정되었습니다.
  • includeQueryPredictions

    true이면 응답에 장소 및 예상 검색어가 모두 포함됩니다. 기본값은 false이며, 이 경우 응답에 장소 예상 검색어만 포함됩니다.

  • includedRegionCodes

    최대 15개의 ccTLD ('최상위 도메인') 2자 값의 배열로 지정된 지정된 지역 목록의 결과만 포함합니다. 생략할 경우 응답에 제한이 적용되지 않습니다. 예를 들어 리전을 독일과 프랑스로 제한하는 방법은 다음과 같습니다.

        "includedRegionCodes": ["de", "fr"]

    locationRestrictionincludedRegionCodes를 모두 지정하면 두 설정이 교차하는 영역에 결과가 표시됩니다.

  • inputOffset

    input에서 커서 위치를 나타내는 0 기준 유니코드 문자 오프셋입니다. 커서 위치는 반환되는 예상 검색어에 영향을 줄 수 있습니다. 비어 있으면 기본값은 input의 길이입니다.

  • languageCode

    결과를 반환할 때 사용할 기본 언어입니다. input에 사용된 언어가 languageCode로 지정된 값과 다르거나 반환된 장소에 현지 언어에서 languageCode로의 번역이 없는 경우 결과가 혼합된 언어일 수 있습니다.

    • IETF BCP-47 언어 코드를 사용하여 기본 언어를 지정해야 합니다.
    • languageCode가 제공되지 않으면 API는 Accept-Language 헤더에 지정된 값을 사용합니다. 둘 다 지정되지 않으면 기본값은 en입니다. 잘못된 언어 코드를 지정하면 API에서 INVALID_ARGUMENT 오류를 반환합니다.
    • 선호 언어는 API가 반환하기로 선택한 결과 집합과 반환 순서에 약간의 영향을 미칩니다. 이는 API의 맞춤법 오류 수정 기능에도 영향을 줍니다.
    • API는 사용자와 지역 주민이 모두 읽을 수 있는 상세 주소를 제공하려고 하면서 동시에 사용자 입력을 반영하려고 합니다. 장소 예상 검색어는 각 요청의 사용자 입력에 따라 형식이 다르게 지정됩니다.
      • input 매개변수의 일치 용어가 사용 가능한 경우 languageCode 매개변수가 나타내는 언어 환경설정에 맞춰 정렬된 이름을 사용하여 먼저 선택하고, 그렇지 않은 경우에는 사용자 입력과 가장 일치하는 이름을 사용합니다.
      • 상세 주소는 input 매개변수의 용어와 일치하도록 일치하는 용어를 선택한 후에만 가능한 경우 사용자가 읽을 수 있는 스크립트의 현지 언어로 형식이 지정됩니다.
      • input 매개변수의 검색어와 일치하는 용어가 선택된 후에 다른 모든 주소는 기본 언어로 반환됩니다. 기본 언어로 이름을 사용할 수 없는 경우 API는 가장 유사한 일치 항목을 사용합니다.
  • locationBias 또는 locationRestriction

    locationBias 또는 locationRestriction을 지정할 수 있지만 둘 다 지정할 수는 없습니다. locationRestriction은 결과가 포함되어야 하는 영역을 지정하는 것으로, locationBias은 결과가 있어야 하지만 영역 밖에 있을 수 있는 영역을 지정하는 것으로 생각하세요.

    • locationBias

      검색할 영역을 지정합니다. 이 위치는 지정된 지역 외부의 결과를 포함하여 지정된 위치 주변의 결과가 반환될 수 있음을 의미하는 바이어스 역할을 합니다.

    • locationRestriction

      검색할 영역을 지정합니다. 지정된 영역을 벗어난 결과는 반환되지 않습니다.

    locationBias 또는 locationRestriction 영역을 직사각형 표시 영역 또는 원형으로 지정합니다.

    • 원은 중심점과 반지름(미터)으로 정의됩니다. 반경은 0.0 이상, 50000.0 이하여야 합니다. 기본값은 0.0입니다. locationRestriction의 경우 반경을 0.0보다 큰 값으로 설정해야 합니다. 그렇지 않으면 요청에서 결과가 반환되지 않습니다.

      예를 들면 다음과 같습니다.

      "locationBias": {
        "circle": {
          "center": {
            "latitude": 37.7937,
            "longitude": -122.3965
          },
          "radius": 500.0
        }
      }
    • 직사각형은 위도-경도 표시 영역으로, 대각선 반대쪽에 있는 두 개의 low 및 높은 지점으로 표시됩니다. 표시 영역은 경계가 포함된 닫힌 영역으로 간주됩니다. 위도 경계는 -90도 이상 90도 이하여야 하며 경도 경계는 -180도 이상 180도 범위여야 합니다.

      • low = high인 경우 표시 영역은 단일 점으로 구성됩니다.
      • low.longitude > high.longitude인 경우 경도 범위가 반전됩니다(표시 영역이 180도 경도 선을 교차함).
      • low.longitude = -180도이고 high.longitude = 180도이면 표시 영역에 모든 경도가 포함됩니다.
      • low.longitude = 180도이고 high.longitude = -180도인 경우 경도 범위는 비어 있습니다.

      lowhigh를 모두 채워야 하며, 표시된 상자는 비워 둘 수 없습니다. 표시 영역이 비어 있으면 오류가 발생합니다.

      예를 들어 이 표시 영역은 뉴욕시를 완전히 둘러쌉니다.

      "locationBias": {
        "rectangle": {
          "low": {
            "latitude": 40.477398,
            "longitude": -74.259087
          },
          "high": {
            "latitude": 40.91618,
            "longitude": -73.70018
          }
        }
      }
  • 원산지

    목적지까지의 직선 거리를 계산할 출발지입니다 (distanceMeters로 반환됨). 이 값을 생략하면 직선 거리는 반환되지 않습니다. 위도 및 경도 좌표로 지정해야 합니다.

    "origin": {
        "latitude": 40.477398,
        "longitude": -74.259087
    }
  • regionCode

    응답 형식을 지정하는 데 사용된 지역 코드로, ccTLD ('최상위 도메인') 2자 값으로 지정됩니다. 대부분의 ccTLD 코드는 ISO 3166-1 코드와 동일하지만 일부 눈에 띄는 예외가 있습니다. 예를 들어 영국의 ccTLD는 'uk' (.co.uk)이지만 ISO 3166-1 코드는 'gb' (기술적으로 '영국 및 북아일랜드' 엔티티)입니다.

    잘못된 지역 코드를 지정하면 API에서 INVALID_ARGUMENT 오류를 반환합니다. 매개변수는 관련 법률에 따라 결과에 영향을 미칠 수 있습니다.

  • sessionToken

    세션 토큰은 Autocomplete(신규) 호출을 '세션'으로 추적하는 사용자 생성 문자열입니다. Autocomplete (신규)는 세션 토큰을 사용하여 사용자 자동 완성 검색의 쿼리 및 선택 단계를 결제 목적의 개별 세션으로 그룹화합니다. 자세한 내용은 세션 토큰을 참조하세요.

자동 완성 (신규) 예시

locationRestriction 및 locationBias 사용

API는 기본적으로 IP 상세 검색을 사용하여 검색 영역을 제어합니다. IP 상세 검색을 사용하면 API가 기기의 IP 주소를 사용하여 결과를 바이어스합니다. 선택적으로 locationRestriction 또는 locationBias를 사용할 수 있지만 둘 다 사용할 수는 없습니다. 이렇게 하면 검색할 영역을 지정할 수 있습니다.

locationRestriction는 검색할 영역을 지정합니다. 지정된 영역을 벗어난 결과는 반환되지 않습니다. 다음 예에서는 locationRestriction를 사용하여 샌프란시스코를 중심으로 한 반경 5, 000미터의 원으로 요청을 제한합니다.

curl -X POST -d '{
  "input": "Amoeba",
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 5000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

지정된 영역 내의 모든 결과는 suggestions 배열에 포함됩니다.

{
  "suggestions": [
    {
      "placePrediction": {
        "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "text": {
          "text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }
          ]
        },
        "structuredFormat": {
          "mainText": {
            "text": "Amoeba Music",
            "matches": [
              {
                "endOffset": 6
              }
            ]
          },
          "secondaryText": {
            "text": "Haight Street, San Francisco, CA, USA"
          }
        },
        "types": [
          "home_goods_store",
          "establishment",
          "store",
          "point_of_interest",
          "electronics_store"
        ]
      }
    }
  ]
}

locationBias의 경우 위치가 바이어스로 기능합니다. 즉, 지정된 지역 밖에 있는 결과를 포함하여 지정된 위치 주변의 결과가 반환될 수 있습니다. 다음 예에서는 locationBias를 사용하도록 요청을 변경합니다.

curl -X POST -d '{
  "input": "Amoeba",
  "locationBias": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 5000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

이제 결과에 5000미터 반경을 벗어난 결과를 포함하여 더 많은 항목이 포함됩니다.

{
  "suggestions": [
    {
      "placePrediction": {
        "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "text": {
          "text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }
          ]
        },
        "structuredFormat": {
          "mainText": {
            "text": "Amoeba Music",
            "matches": [
              {
                "endOffset": 6
              }
            ]
          },
          "secondaryText": {
            "text": "Haight Street, San Francisco, CA, USA"
          }
        },
        "types": [
          "electronics_store",
          "point_of_interest",
          "store",
          "establishment",
          "home_goods_store"
        ]
      }
    },
    {
      "placePrediction": {
        "place": "places/ChIJr7uwwy58hYARBY-e7-QVwqw",
        "placeId": "ChIJr7uwwy58hYARBY-e7-QVwqw",
        "text": {
          "text": "Amoeba Music, Telegraph Avenue, Berkeley, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }
          ]
        },
        "structuredFormat": {
          "mainText": {
            "text": "Amoeba Music",
            "matches": [
              {
                "endOffset": 6
              }
            ]
          },
          "secondaryText": {
            "text": "Telegraph Avenue, Berkeley, CA, USA"
          }
        },
        "types": [
          "electronics_store",
          "point_of_interest",
          "establishment",
          "home_goods_store",
          "store"
        ]
      }
    },
    ...
  ]
}

includePrimaryTypes 사용

includedPrimaryTypes 매개변수를 사용하여 표 A, 표 B에서 최대 5개의 유형 값을 지정하거나 (regions) 또는 (cities)만 지정합니다. 장소는 응답에 포함할 지정된 기본 유형 값 중 하나와 일치해야 합니다.

다음 예에서는 '축구'의 input 문자열을 지정하고 includedPrimaryTypes 매개변수를 사용하여 "sporting_goods_store" 유형의 시설로 결과를 제한합니다.

curl -X POST -d '{
  "input": "Soccer",
  "includedPrimaryTypes": ["sporting_goods_store"],
  "locationBias": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 500.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

includedPrimaryTypes 매개변수를 생략하면 결과에 원치 않는 유형의 시설(예: "athletic_field")이 포함될 수 있습니다.

쿼리 예측 요청

쿼리 예측은 기본적으로 반환되지 않습니다. includeQueryPredictions 요청 매개변수를 사용하여 응답에 쿼리 예측을 추가합니다. 예를 들면 다음과 같습니다.

curl -X POST -d '{
  "input": "Amoeba",
  "includeQueryPredictions": true,
  "locationBias": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 5000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

위의 응답 정보에 나온 것처럼 이제 suggestions 배열에 장소 예상 검색어와 쿼리 예상 검색어가 모두 포함됩니다. 각 예상 검색어에는 추천 텍스트 검색 문자열이 포함된 text 필드가 포함됩니다. 텍스트 검색 (신규) 요청을 수행하여 반환된 쿼리 예상 검색어에 대한 자세한 정보를 얻을 수 있습니다.

출처 사용

이 예에서는 요청에 origin를 위도와 경도 좌표로 포함합니다. origin를 포함하면 API는 origin에서 대상까지의 직선 거리를 포함하는 distanceMeters 필드를 응답에 포함합니다. 다음 예는 원점을 샌프란시스코의 중심으로 설정합니다.

curl -X POST -d '{
  "input": "Amoeba",
  "origin": {
    "latitude": 37.7749,
    "longitude": -122.4194
  },
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 5000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

이제 응답에 distanceMeters가 포함됩니다.

{
  "suggestions": [
    {
      "placePrediction": {
        "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "text": {
          "text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }
          ]
        },
        "structuredFormat": {
          "mainText": {
            "text": "Amoeba Music",
            "matches": [
              {
                "endOffset": 6
              }
            ]
          },
          "secondaryText": {
            "text": "Haight Street, San Francisco, CA, USA"
          }
        },
        "types": [
          "home_goods_store",
          "establishment",
          "point_of_interest",
          "store",
          "electronics_store"
        ],
        "distanceMeters": 3012
      }
    }
  ]
}

사용해 보기

API 탐색기를 사용하면 샘플 요청을 수행하여 API 및 API 옵션에 익숙해질 수 있습니다.

  1. 페이지 오른쪽에 있는 API 아이콘(API 탐색기를 펼칩니다.)을 선택합니다.
  2. 필요한 경우 표준 매개변수 표시를 펼치고 fields 매개변수필드 마스크로 설정합니다.
  3. 필요한 경우 요청 본문을 수정합니다.
  4. 실행 버튼을 선택합니다. 팝업에서 요청에 사용할 계정을 선택합니다.
  5. API 탐색기 패널에서 확장 아이콘(API 탐색기를 펼칩니다.)을 선택하여 API 탐색기 창을 펼칩니다.