Best practice per l'utilizzo dei servizi web dell'API Places Insights

I servizi web di Google Maps Platform sono una raccolta di interfacce HTTP ai servizi Google che forniscono dati geografici per le tue applicazioni di mappe.

Questa guida descrive alcune pratiche comuni utili per configurare le richieste del servizio web e per elaborare le risposte del servizio. Consulta la guida per gli sviluppatori. per la documentazione completa dell'API Places Insights.

Che cos'è un servizio web?

I servizi web di Google Maps Platform sono un'interfaccia per richiedere i dati dell'API di Google Maps da da servizi esterni e utilizzare i dati all'interno delle applicazioni Maps. Questi servizi progettata per essere utilizzata insieme a una mappa, come Limitazioni di licenza nei Termini di servizio di Google Maps Platform.

I servizi web delle API di Google Maps utilizzano richieste HTTP(S) a URL specifici, trasmettendo parametri URL e/o Dati POST in formato JSON come argomenti per i servizi. In genere, questi servizi restituiscono i dati corpo della risposta come JSON per l'analisi e/o all'elaborazione da parte dell'utente.

L'esempio seguente mostra l'URL di un Richiesta REST GET:

AN ACTUAL API CALL INCLUDING THE API_KEY&key=API_KEY

Nota: tutte le applicazioni dell'API Places Insights richiedono l'autenticazione. Leggi ulteriori informazioni sulle credenziali di autenticazione.

Accesso SSL/TLS

HTTPS è obbligatorio per tutte le richieste di Google Maps Platform che utilizzano chiavi API o contengono dati degli utenti. Le richieste effettuate tramite HTTP che contengono dati sensibili potrebbero essere rifiutate.

Creazione di un URL valido

Potresti pensare che un URL "valido" sia evidente, ma non è così. Un URL inserito in una barra degli indirizzi in un browser, ad esempio, può contenere caratteri speciali (come "上海+中國"); il browser deve tradurre internamente quei caratteri in una codifica diversa prima della trasmissione. Per lo stesso token, qualsiasi codice che generi o accetta input UTF-8 potrebbe considerare "validi" gli URL con caratteri UTF-8, ma richiederebbe anche per tradurre quei caratteri prima di inviarli a un server web. Questa procedura è denominata Codifica degli URL o codifica percentuale.

Attenzione: i browser e/o i servizi potrebbero automaticamente Codifica l'URL di un URI della richiesta prima dell'invio. Nelle API che utilizzano la firma delle richieste crittografiche, potrebbe invalidare la firma, se la codifica dell'URL altera la richiesta dopo la firma. Da evitare questo problema, esegui sempre la codifica URL della stringa di query prima di firmare richiesta.

Caratteri speciali

Dobbiamo tradurre i caratteri speciali tutti gli URL devono essere conformi alla sintassi specificata dal Uniforme URI (Resource Identifier). In pratica, questo significa che gli URL devono contenere solo un sottoinsieme speciale di caratteri ASCII: i familiari simboli alfanumerici e alcuni caratteri riservati per l'utilizzo come caratteri di controllo all'interno degli URL. Questa tabella riassume questi caratteri:

Configura	caratteri	Utilizzo dell'URL
Alfanumerico	a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9	Stringhe di testo, utilizzo dello schema (http), porta (8080) e così via.
Non prenotato	- _ ~	Stringhe di testo
Prenotato	! * ' ( ) : @ e = + $ , / ? % # [ ]	Caratteri di controllo e/o stringhe di testo

Quando crei un URL valido, devi assicurarti che contenga solo i caratteri mostrati nella tabella. Conformità di un URL all'utilizzo generale di questo insieme di caratteri causa due problemi, uno di omissione e uno di sostituzione:

• I caratteri che vuoi gestire esistono al di fuori sopra l'insieme. Ad esempio, caratteri in lingue straniere come 上海+中國, devono essere codificati utilizzando sopra i caratteri. Per convenzione popolare, gli spazi (che sono non consentite negli URL) sono spesso rappresentate con il '+' carattere.
• I caratteri all'interno di questo intervallo sono impostati come riservati, ma che devono essere usati letteralmente. Ad esempio, ? viene utilizzato negli URL per indicare l'inizio della stringa di query; se vuoi utilizzare stringa "? and the Mysterions" dovresti codificare il modello '?' carattere.

Tutti i caratteri da codificare nell'URL sono codificati utilizzando un carattere '%' e un esadecimale a due caratteri corrispondente al carattere UTF-8. Ad esempio,上海+中國 in UTF-8 viene codificato per l'URL come%E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B. La la stringa ? and the Mysterians verrebbe codificata come URL %3F+and+the+Mysterians o %3F%20and%20the%20Mysterians.

Caratteri comuni che richiedono la codifica

Alcuni caratteri comuni che devono essere codificati sono:

Carattere non sicuro	Valore codificato
Spazio	%20
"	%22
<	%3C
>	%3E
#	%23
%	%25
|	%7C

A volte la conversione di un URL ricevuto dall'input dell'utente può essere difficile. Ad esempio, un utente potrebbe inserire un indirizzo come "5th&Main St." In genere, devi generare l'URL partendo dalle sue parti, tenendo presente che qualsiasi input utente come caratteri letterali.

Inoltre, gli URL sono limitati a 16.384 caratteri per tutti i servizi web di Google Maps Platform e le API web statiche. Per la maggior parte dei servizi, questo limite di caratteri viene raramente raggiunto. Tuttavia, tieni presente che alcuni servizi hanno diversi parametri che possono generare URL lunghi.

Utilizzo discreto delle API di Google

I client API progettati in modo scorretto possono applicare più carico del necessario sia su Internet sia nei server di Google. Questa sezione contiene alcune best practice per i client delle API. Persone che seguo queste best practice possono aiutarti a evitare che la tua applicazione venga bloccata per comportamenti illeciti involontari le API.

Backoff esponenziale

In rari casi, si potrebbe verificare un problema nella gestione della tua richiesta. potresti ricevere un HTTP 4XX o 5XX del codice di risposta o semplicemente la connessione TCP non riesce in qualche punto tra il client server web. Spesso vale la pena ritentare la richiesta la richiesta di follow-up potrebbe avere esito positivo se l'originale non è andato a buon fine. Tuttavia, è importante non eseguire semplicemente un loop di richieste ripetute ai server di Google. Questo comportamento di loop può sovraccaricare tra il tuo client e Google, causando problemi a molte parti.

Un approccio migliore è riprovare con un ritardo maggiore tra un tentativo e l'altro. Di solito il ritardo viene aumentato di un fattore moltiplicativo a ogni tentativo, un approccio noto Backoff esponenziale.

Ad esempio, consideriamo un'applicazione che vuole effettuare questa richiesta l'API Time Zone:

https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810,-119.6822510&timestamp=1331161200&key=YOUR_API_KEY

Il seguente esempio Python mostra come effettuare la richiesta con backoff esponenziale:

import json
import time
import urllib.error
import urllib.parse
import urllib.request

# The maps_key defined below isn't a valid Google Maps API key.
# You need to get your own API key.
# See https://developers.google.com/maps/documentation/timezone/get-api-key
API_KEY = "YOUR_KEY_HERE"
TIMEZONE_BASE_URL = "https://maps.googleapis.com/maps/api/timezone/json"


def timezone(lat, lng, timestamp):

    # Join the parts of the URL together into one string.
    params = urllib.parse.urlencode(
        {"location": f"{lat},{lng}", "timestamp": timestamp, "key": API_KEY,}
    )
    url = f"{TIMEZONE_BASE_URL}?{params}"

    current_delay = 0.1  # Set the initial retry delay to 100ms.
    max_delay = 5  # Set the maximum retry delay to 5 seconds.

    while True:
        try:
            # Get the API response.
            response = urllib.request.urlopen(url)
        except urllib.error.URLError:
            pass  # Fall through to the retry loop.
        else:
            # If we didn't get an IOError then parse the result.
            result = json.load(response)

            if result["status"] == "OK":
                return result["timeZoneId"]
            elif result["status"] != "UNKNOWN_ERROR":
                # Many API errors cannot be fixed by a retry, e.g. INVALID_REQUEST or
                # ZERO_RESULTS. There is no point retrying these requests.
                raise Exception(result["error_message"])

        if current_delay > max_delay:
            raise Exception("Too many retry attempts.")

        print("Waiting", current_delay, "seconds before retrying.")

        time.sleep(current_delay)
        current_delay *= 2  # Increase the delay each time we retry.


if __name__ == "__main__":
    tz = timezone(39.6034810, -119.6822510, 1331161200)
    print(f"Timezone: {tz}")

Devi inoltre fare attenzione che la chiamata all'applicazione non includa un nuovo codice per un nuovo tentativo che porta a richieste ripetute in rapida successione.

Richieste sincronizzate

Un numero elevato di richieste sincronizzate alle API di Google può apparire come Attacco DoS (Denial of Service) all'infrastruttura di Google e da trattare di conseguenza. Per evitarlo, devi assicurarti che le richieste dell'API non siano sincronizzate tra i client.

Ad esempio, considera un'applicazione che mostra l'ora nel fuso orario attuale. Questa applicazione probabilmente imposterà un allarme nel sistema operativo client per riattivarlo alle l'inizio del minuto in modo che l'ora visualizzata possa essere aggiornata. L'applicazione non deve effettuare chiamate API nell'ambito dell'elaborazione associata all'allarme.

Effettuare chiamate API in risposta a un allarme fisso è un'azione negativa perché le chiamate API vengono sincronizzati all'inizio, anche tra dispositivi diversi, invece di essere distribuiti in modo uniforme nel tempo. Un'applicazione progettata in modo scorretto produrrà un picco di il traffico a livelli sessanta volte normali all'inizio di ogni minuto.

Un'ottima soluzione potrebbe essere quella di impostare una seconda sveglia su un orario selezionato in modo casuale. Quando questo secondo allarme si attiva, l'applicazione chiama tutte le API di cui ha bisogno e memorizza che consentono di analizzare i dati e visualizzare i risultati. Quando l'applicazione vuole aggiornare la visualizzazione all'inizio del minuto, utilizza i risultati memorizzati in precedenza anziché richiamare di nuovo l'API. Con questo approccio, le chiamate API sono distribuiti in modo uniforme nel tempo. Inoltre, le chiamate API non ritardano il rendering quando il display viene in fase di aggiornamento.

Oltre all'inizio del minuto, altri orari di sincronizzazione comuni devono essere non scelti come target sono all'inizio di un'ora e all'inizio di ogni giorno a mezzanotte.

Elaborazione delle risposte

Nota: come formato esatto delle singole risposte con un richiesta di servizio web non è garantita (alcuni elementi potrebbero essere mancanti o in più posizioni), non si deve mai dare per scontato che il formato restituito per una determinata risposta sia lo stesso per diverse query. Devi invece elaborare la risposta e selezionare i valori appropriati tramite espressioni.

Questa sezione spiega come estrarre questi valori in modo dinamico dalle risposte del servizio web.

I servizi web di Google Maps forniscono risposte facili da capire, ma non proprio facile da usare. Quando esegui una query, piuttosto che visualizzare un set di dati, probabilmente vorrai estrarre alcuni e i relativi valori. In genere, è consigliabile analizzare le risposte provenienti dal web servizio ed estrarre solo i valori che ti interessano.

Lo schema di analisi utilizzato dipende dal fatto che tu stia restituendo l'output in JSON. Risposte JSON, che sono già sotto forma di Oggetti JavaScript, possono essere elaborati all'interno di JavaScript sul cliente.