Preenchimento automático (novo)

Selecione a plataforma: Android iOS JavaScript Serviço da Web

O Autocomplete (novo) retorna previsões de lugares em resposta a uma solicitação que inclui uma string de pesquisa de texto e limites geográficos que controlam a área de pesquisa. O preenchimento automático pode fazer a correspondência de palavras completas e substrings da entrada, resolvendo nomes, endereços e Plus Codes de lugares. Conforme o usuário digita, seu aplicativo pode enviar consultas para fornecer previsões de locais e consultas instantaneamente.

Por exemplo, você chama o Autocomplete usando como entrada uma string que contém uma entrada parcial do usuário, "Sicilian piz", com a área de pesquisa limitada a São Francisco, CA. A resposta contém uma lista de previsões de lugar que correspondem à string de pesquisa e à área de pesquisa, como o restaurante chamado "Sicilian Pizza Kitchen".

As previsões de lugar retornadas são apresentadas ao usuário com o objetivo de ajudar na escolha do lugar desejado. Você pode fazer uma solicitação de Place Details (novo) para receber mais informações sobre qualquer uma das previsões de lugar retornadas.

Solicitações de Autocomplete (novo)

Seu app pode receber uma lista de nomes e/ou endereços de lugares previstos pela API de preenchimento automático chamando PlacesClient.findAutocompletePredictions(), transmitindo um objeto FindAutocompletePredictionsRequest. O exemplo abaixo mostra uma chamada completa para PlacesClient.findAutocompletePredictions().

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();
LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);
final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Sicilian piz")
            .setRegionCode("ES")
            .setLocationRestriction(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Respostas de Autocomplete (novo)

A API retorna um FindAutocompletePredictionsResponse em uma Task. O FindAutocompletePredictionsResponse contém uma lista de até cinco objetos AutocompletePrediction que representam os lugares previstos. A lista pode ficar vazia se não houver um local conhecido correspondente à consulta e aos critérios de filtro.

Para cada local previsto, é possível chamar os seguintes métodos para recuperar os detalhes:

  • getFullText(CharacterStyle) retorna o texto completo da descrição de um lugar. Essa é uma combinação dos textos primário e secundário. Por exemplo: Torre Eiffel, Avenue Anatole France, Paris, França. Além disso, esse método permite destacar as seções da descrição que correspondem à pesquisa com um estilo de sua escolha, usando CharacterStyle. O parâmetro CharacterStyle é opcional. Defina-o como nulo se não precisar de destaques.
  • getPrimaryText(CharacterStyle) retorna o texto principal que descreve um lugar. Geralmente é o nome do lugar. Exemplos: "Torre Eiffel" e "123 Pitt Street".
  • getSecondaryText(CharacterStyle) retorna o texto complementar de uma descrição de lugar. Isso é útil, por exemplo, como uma segunda linha ao mostrar previsões de preenchimento automático. Exemplos: "Avenue Anatole France, Paris, France" e "Sydney, Nova Gales do Sul".
  • getPlaceId() retorna o ID do lugar previsto. Um ID de lugar é um identificador textual que determina um local de forma exclusiva, que você pode usar para recuperar o objeto Place novamente mais tarde. Para mais informações sobre IDs de lugar no Autocomplete, consulte Place Details (novo). Para informações gerais sobre IDs de lugar, consulte a visão geral de IDs de lugar.
  • getTypes() retorna a lista de tipos de lugar associados a esse lugar.
  • getDistanceMeters() retorna a distância em linha reta em metros entre esse lugar e a origem especificada na solicitação.

Parâmetros obrigatórios

  • Consulta

    A string de texto na qual pesquisar. Especifique palavras completas e substrings, nomes de lugares, endereços e Plus Codes. O serviço Autocomplete (novo) retorna correspondências possíveis de acordo com essa string e ordena os resultados com base na relevância percebida.

    Para definir o parâmetro de consulta, chame o método setQuery() ao criar o objeto FindAutocompletePredictionsRequest.

Parâmetros opcionais

  • Tipos principais

    Uma lista de até cinco valores de tipo dos tipos Tabela A ou Tabela B usadas para filtrar os locais retornados na resposta. Um local precisa corresponder a um dos valores de tipo primário especificados para ser incluído na resposta.

    Um lugar só pode ter um único tipo principal dos tipos Tabela A ou Tabela B associados a ele. Por exemplo, o tipo principal pode ser "mexican_restaurant" ou "steak_house".

    A solicitação será rejeitada com um erro INVALID_REQUEST se:

    • Mais de cinco tipos foram especificados.
    • Todos os tipos não reconhecidos foram especificados.

    Para definir o parâmetro de tipos principais, chame o método setTypesFilter() ao criar o objeto FindAutocompletePredictionsRequest.

  • Países

    Inclua somente os resultados da lista de países especificados, como uma lista de até 15 valores de dois caracteres de ccTLD ("domínio de nível superior"). Se omitido, nenhuma restrição será aplicada à resposta. Por exemplo, para limitar as regiões à Alemanha e à França:

    Se você especificar locationRestriction e includedRegionCodes, os resultados serão localizados na área de interseção das duas configurações.

    Para definir o parâmetro de países, chame o método setCountries() ao criar o objeto FindAutocompletePredictionsRequest.

  • Deslocamento de entrada

    O deslocamento de caracteres Unicode baseado em zero que indica a posição do cursor na consulta. A posição do cursor pode influenciar quais previsões são retornadas. Se estiver vazio, o padrão será o comprimento da consulta.

    Para definir o parâmetro de deslocamento de entrada, chame o método setInputOffset() ao criar o objeto FindAutocompletePredictionsRequest.

  • Viés de local ou restrição de local

    Para definir a área de pesquisa, especifique um direcionamento ou restrição de local, mas não ambos. Pense na restrição de local como a especificação da região em que os resultados precisam estar, e no viés de local como a especificação da região a que os resultados precisam estar próximos. A principal diferença é que, com a polarização de local, resultados fora da região especificada ainda podem ser retornados.

    • Viés de local

      Especifica uma área a ser pesquisada. Esse local serve como um viés, não uma restrição, então resultados fora da área especificada ainda podem ser retornados.

      Para definir o parâmetro de direcionamento de local, chame o método setLocationBias() ao criar o objeto FindAutocompletePredictionsRequest.

    • Restrição de local

      Especifica uma área a ser pesquisada. Os resultados fora da área especificada não são retornados.

      Para definir o parâmetro de restrição de local, chame o método setLocationRestriction() ao criar o objeto FindAutocompletePredictionsRequest.

    Especifique a polarização de local ou a região de restrição de local como uma janela de visualização retangular ou como um círculo.

    • Um círculo é definido pelo ponto central e pelo raio em metros. O raio precisa estar entre 0,0 e 50.000,0. O valor padrão é 0,0. Para restrição de local, você precisa definir o raio como um valor maior que 0,0. Caso contrário, a solicitação não retornará resultados.

    • Um retângulo é uma janela de visualização de latitude e longitude, representada como dois pontos diagonalmente opostos low e high. Uma janela de visualização é considerada uma região fechada, o que significa que ela inclui seus limites. Os limites de latitude precisam variar entre -90 e 90 graus, e os limites de longitude precisam variar entre -180 e 180 graus:

      • Se low = high, a janela de visualização consistirá nesse único ponto.
      • Se low.longitude > high.longitude, o intervalo de longitude é invertido (a janela de visualização cruza a linha de 180 graus de longitude).
      • Se low.longitude = -180 graus e high.longitude = 180 graus, a janela de visualização incluirá todas as longitudes.
      • Se low.longitude = 180 graus e high.longitude = -180 graus, o intervalo de longitude está vazio.

      low e high precisam ser preenchidos, e a caixa representada não pode ficar vazia. Uma janela de visualização vazia resulta em erro.

  • Origem

    O ponto de origem a partir do qual calcular a distância em linha reta até o destino (acessado usando getDistanceMeters()). Se esse valor for omitido, a distância em linha reta não será retornada. Precisa ser especificado como coordenadas de latitude e longitude:

    Para definir o parâmetro de origem, chame o método setOrigin() ao criar o objeto FindAutocompletePredictionsRequest.

  • Código de região

    O código da região usado para formatar a resposta, incluindo a formatação de endereços, especificado como um valor de ccTLD ("domínio de nível superior") de dois caracteres. A maioria dos códigos ccTLD é idêntica aos códigos ISO 3166-1, com algumas exceções notáveis. Por exemplo, o ccTLD do Reino Unido é "uk" (.co.uk), enquanto o código ISO 3166-1 é "gb" (tecnicamente para a entidade "Reino Unido da Grã-Bretanha e Irlanda do Norte").

    Se você especificar um código de região inválido, a API retornará um erro INVALID_ARGUMENT. O parâmetro pode afetar os resultados com base na legislação aplicável.

    Para definir o parâmetro do código da região, chame o método setRegionCode() ao criar o objeto FindAutocompletePredictionsRequest.

  • Token da sessão

    Tokens de sessão são strings geradas pelo usuário que rastreiam chamadas de preenchimento automático (novo) como "sessões". O Autocomplete usa tokens de sessão para agrupar as fases de consulta e seleção de uma pesquisa de preenchimento automático do usuário em uma sessão discreta para fins de faturamento. A sessão começa quando o usuário começa a digitar uma consulta e termina quando seleciona um lugar. Cada sessão pode ter várias consultas, seguidas por uma seleção de lugar. Após a conclusão de uma sessão, o token perde a validade. Seu app precisa gerar um novo token para cada sessão. Recomendamos o uso de tokens de sessão para todas as sessões programáticas de preenchimento automático. Quando você incorpora um fragmento ou inicia o preenchimento automático usando uma intent, a API faz isso automaticamente.

    O preenchimento automático usa um AutocompleteSessionToken para identificar cada sessão. Seu app precisa transmitir um novo token de sessão ao iniciar cada nova sessão e, em seguida, transmitir esse mesmo token com um ID de lugar na chamada seguinte para fetchPlace() para recuperar detalhes do lugar selecionado pelo usuário.

    Para definir o parâmetro do token de sessão, chame o método setSessionToken() ao criar o objeto FindAutocompletePredictionsRequest.

    Para mais informações, consulte Tokens de sessão.

Exemplos de preenchimento automático (novo)

Usar restrição de local e viés de local

O Autocomplete (novo) usa a polarização de IP por padrão para controlar a área de pesquisa. Com a polarização de IP, a API usa o endereço IP do dispositivo para direcionar os resultados. Também é possível usar restrição de local ou viés de local, mas não ambos, para especificar uma área a ser pesquisada.

A restrição de local especifica a área a ser pesquisada. Os resultados fora da área especificada não são retornados. O exemplo a seguir usa restrição de local para limitar a solicitação a uma restrição de local circular com um raio de 5.000 metros centrado em São Francisco:

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();

LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);

final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Amoeba")
            .setLocationRestriction(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Com a polarização de local, a localização atua como uma polarização, ou seja, os resultados ao redor do local especificado podem ser retornados, incluindo resultados fora da área especificada. O próximo exemplo muda a solicitação anterior para usar a polarização de local:

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();

LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);

final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Amoeba")
            .setLocationBias(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Usar tipos principais

Use o parâmetro de tipos principais para restringir os resultados de uma solicitação a um determinado tipo, conforme listado nas tabelas A e B. É possível especificar uma matriz de até cinco valores. Se omitido, todos os tipos são retornados.

O exemplo a seguir especifica uma string de consulta de "Futebol" e usa o parâmetro de tipos primários para restringir os resultados a estabelecimentos do tipo "sporting_goods_store":

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();

final List<Place.Field> primaryTypes = Arrays.asList("sporting_goods_store");

LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);

final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Soccer")
            .setIncludedPrimaryTypes(primaryTypes)
            .setLocationBias(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Se você omitir o parâmetro de tipos principais, os resultados poderão incluir estabelecimentos de um tipo que talvez você não queira, como "athletic_field".

Usar origem

Quando você inclui o parâmetro origin na solicitação, especificado como coordenadas de latitude e longitude, a API inclui a distância em linha reta da origem ao destino na resposta (acessada usando getDistanceMeters()). Este exemplo define a origem como o centro de São Francisco:

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();

LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);

final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Amoeba")
            .setOrigin(center)
            .setLocationRestriction(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Atribuições

Você pode usar o Autocomplete (novo), mesmo sem um mapa. Se você mostrar um mapa, ele terá que ser do Google. Quando você mostra previsões do serviço de preenchimento automático (novo) sem um mapa, é necessário incluir o logotipo do Google in-line com o campo de pesquisa/resultados. Para mais informações, consulte Como mostrar o logotipo e as atribuições do Google.