Best Practices für die Verwendung von Directions API (Legacy)-Webdiensten

Die Google Maps Platform-Webdienste sind eine Sammlung von HTTP-Schnittstellen zu Google-Diensten, die geografische Daten für Ihre Kartenanwendungen bereitstellen.

In dieser Anleitung werden einige gängige Verfahren beschrieben, die beim Einrichten von Webdienst-Anfragen und beim Verarbeiten von Dienstantworten hilfreich sind. Die vollständige Dokumentation der Directions API (Legacy) finden Sie im Entwicklerleitfaden.

Was ist ein Webdienst?

Google Maps Platform-Webdienste sind eine Schnittstelle zum Anfordern von Maps API-Daten von externen Diensten und zum Verwenden der Daten in Ihren Maps-Anwendungen. Diese Dienste sind gemäß den Lizenzbeschränkungen in den Nutzungsbedingungen für die Google Maps Platform für die Verwendung in Verbindung mit einer Karte vorgesehen.

Die Webdienste der Maps APIs verwenden HTTP(S)-Anfragen an bestimmte URLs und übergeben URL-Parameter und/oder POST-Daten im JSON-Format als Argumente an die Dienste. Im Allgemeinen geben diese Dienste Daten im Antwortbody entweder als JSON oder XML zurück, damit sie von Ihrer Anwendung geparst und/oder verarbeitet werden können.

Eine typische Anfrage an die Directions API (Legacy) hat in der Regel das folgende Format:

https://maps.googleapis.com/maps/api/directions/output?parameters

Dabei steht output für das Antwortformat (in der Regel json oder xml).

Hinweis: Für alle Directions API (Legacy)-Anwendungen ist eine Authentifizierung erforderlich. Weitere Informationen zu Anmeldedaten für die Authentifizierung

SSL/TLS-Zugriff

HTTPS ist für alle Google Maps Platform-Anfragen erforderlich, die API-Schlüssel verwenden oder Nutzerdaten enthalten. Anfragen, die über HTTP gesendet werden und sensible Daten enthalten, werden möglicherweise abgelehnt.

Gültige URL erstellen

Es mag den Anschein haben, dass „gültige“ URLs eine Selbstverständlichkeit sind. Das ist jedoch nicht der Fall. So kann beispielsweise eine URL, die in die Adresszeile eines Browsers eingegeben wird, Sonderzeichen wie "上海+中國" enthalten. Der Browser muss diese Zeichen vor der Übertragung intern in eine andere Codierung umwandeln. Ebenso ist es möglich, dass Code, der UTF-8-Eingaben erzeugt oder akzeptiert, URLs mit UTF-8-Zeichen als „gültig“ behandelt; diese Zeichen müssten jedoch vor dem Senden an einen Webbrowser ebenfalls umgewandelt werden. Dieser Vorgang wird als URL-Codierung oder Prozentcodierung bezeichnet.

Sonderzeichen

Sonderzeichen müssen umgewandelt werden, da alle URLs der Syntax entsprechen müssen, die in der Spezifikation Uniform Resource Identifier (URI) angegeben ist. Das bedeutet, dass URLs nur einen Teil der ASCII-Zeichen enthalten dürfen: die bekannten alphanumerischen Symbole und einige reservierte Zeichen, die in den URLs als Steuerzeichen dienen. Hier eine Übersicht:

Beachten Sie bei der Generierung einer gültigen URL, dass diese nur die in der Tabelle aufgeführten Zeichen enthalten darf. Die Anpassung der URL an diesen Zeichensatz führt in der Regel zu zwei Problemen, nämlich dass Zeichen weggelassen oder ersetzt werden müssen:

• Die Zeichen, die Sie verarbeiten möchten, sind nicht im obigen Zeichensatz enthalten. So müssen beispielsweise Zeichen ausländischer Sprachen, wie 上海+中國, mithilfe der oben angegebenen Zeichen codiert werden. Auch werden Leerzeichen, die innerhalb von URLs nicht zulässig sind, entsprechend den geltenden Konventionen oftmals durch das Zeichen '+' dargestellt.
• Die Zeichen sind im obigen Zeichensatz als reservierte Zeichen enthalten, müssen aber im ursprünglichen Sinn des Zeichens verwendet werden. So wird beispielsweise ? in URLs für den Beginn eines Abfragestrings verwendet. Möchten Sie es stattdessen für den Text „? and the Mysterions“ verwenden, müssen Sie das Zeichen '?' codieren.

Alle Zeichen, die als URL codiert werden sollen, werden mithilfe des Zeichens '%' und eines Hexadezimalwerts aus zwei Zeichen codiert, der ihrem UTF-8-Zeichen entspricht. So würde zum Beispiel der UTF-8-String 上海+中國 durch die URL-Codierung in %E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B umgewandelt. Und aus ? and the Mysterians würde %3F+and+the+Mysterians oder %3F%20and%20the%20Mysterians werden.

Häufig vorkommende Zeichen, die codiert werden müssen

Folgende häufig vorkommende Zeichen müssen codiert werden:

Die Konvertierung von URLs, die aus Nutzereingaben empfangen werden, kann manchmal Probleme mit sich bringen. Beispielsweise kann ein Nutzer eine Adresse als „5th&Main St.“ eingeben. Im Allgemeinen sollten Sie die URL aus ihren Teilen erstellen und jede Nutzereingabe wortwörtlich betrachten.

Außerdem sind URLs für alle Google Maps Platform-Webdienste und statischen Web APIs auf 16.384 Zeichen beschränkt. Bei den meisten Diensten wird diese Begrenzung selten erreicht. Beachten Sie jedoch, dass bestimmte Dienste einige Parameter haben, die zu langen URLs führen können.

Respektvolle Nutzung der Google APIs

Schlecht konzipierte API-Clients können sowohl das Internet als auch die Server von Google unnötig belasten. Dieser Abschnitt enthält einige bewährte Methoden für Kunden der APIs. Wenn Sie diese Best Practices befolgen, können Sie verhindern, dass Ihre Anwendung aufgrund unbeabsichtigten Missbrauchs der APIs blockiert wird.

Exponential Backoff

In seltenen Fällen kann es zu Problemen bei der Bearbeitung Ihrer Anfrage kommen. Sie erhalten dann möglicherweise einen 4XX- oder 5XX-HTTP-Antwortcode oder die TCP-Verbindung schlägt irgendwo zwischen Ihrem Client und dem Server von Google fehl. Oft lohnt es sich, die Anfrage noch einmal zu versuchen, da die Folgeanfrage möglicherweise erfolgreich ist, wenn die ursprüngliche Anfrage fehlgeschlagen ist. Es ist jedoch wichtig, nicht einfach wiederholt Anfragen an die Server von Google zu senden. Dieses Verhalten kann das Netzwerk zwischen Ihrem Client und Google überlasten und Probleme für viele Beteiligte verursachen.

Ein besserer Ansatz ist es, wiederholte Versuche in immer größeren Abständen durchzuführen. Normalerweise wird die Verzögerung bei jedem Versuch um einen multiplikativen Faktor erhöht. Dieses Verfahren wird als exponentieller Backoff bezeichnet.

Angenommen, eine Anwendung möchte die folgende Anfrage an die Time Zone API senden:

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

Im folgenden Beispiel mit Python wird gezeigt, wie die Anforderung mit exponentiellem Backoff durchgeführt wird:

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}")

Achten Sie außerdem darauf, dass sich in der Aufrufkette der Anwendung kein Wiederholungscode befindet, der zu wiederholten Anfragen in schneller Folge führt.

Synchronisierte Anforderungen

Eine große Anzahl synchronisierter Anfragen an die APIs von Google kann wie ein DDoS-Angriff (Distributed Denial of Service) auf die Infrastruktur von Google aussehen und wird entsprechend behandelt. Um dies zu vermeiden, sollten Sie darauf achten, dass API-Anfragen nicht zwischen Clients synchronisiert werden.

Angenommen, eine Anwendung zeigt die Zeit in der aktuellen Zeitzone an. Diese Anwendung legt wahrscheinlich einen Wecker im Clientbetriebssystem fest, der das Gerät zu Beginn der Minute aktiviert, damit die angezeigte Zeit aktualisiert werden kann. Die Anwendung sollte im Rahmen der Verarbeitung, die mit diesem Alarm verbunden ist, keine API-Aufrufe ausführen.

API-Aufrufe als Reaktion auf einen festen Alarm sind nicht empfehlenswert, da sie dazu führen, dass die API-Aufrufe auf den Beginn der Minute synchronisiert werden, auch zwischen verschiedenen Geräten, anstatt gleichmäßig über die Zeit verteilt zu werden. Eine schlecht konzipierte Anwendung, die dies tut, erzeugt zu Beginn jeder Minute einen Traffic-Spike, der sechzig Mal so hoch ist wie normal.

Stattdessen wird bei einer guten Lösung ein zweiter Alarm für eine zufällig gewählte Zeit festgelegt. Wenn dieser zweite Alarm ausgelöst wird, ruft die Anwendung alle erforderlichen APIs auf und speichert die Ergebnisse. Wenn die Anwendung ihre Anzeige zu Beginn der Minute aktualisieren möchte, verwendet sie zuvor gespeicherte Ergebnisse, anstatt die API noch einmal aufzurufen. Bei diesem Ansatz werden API-Aufrufe gleichmäßig über die Zeit verteilt. Außerdem verzögern die API-Aufrufe das Rendern nicht, wenn die Anzeige aktualisiert wird.

Neben dem Beginn der Minute sollten Sie auch den Beginn einer Stunde und den Beginn eines Tages um Mitternacht nicht als Synchronisationszeiten verwenden.

Verarbeiten von Antworten

In diesem Abschnitt wird erklärt, wie Sie diese Werte dynamisch aus den Webdienstantworten extrahieren.

Die Google Maps-Webdienste liefern Antworten, die leicht zu verstehen, aber nicht gerade nutzerfreundlich sind. Wenn Sie eine Abfrage ausführen, möchten Sie wahrscheinlich nicht nur eine Reihe von Daten anzeigen lassen, sondern einige bestimmte Werte extrahieren. Im Allgemeinen möchten Sie Antworten vom Webdienst parsen und nur die Werte extrahieren, die für Sie von Interesse sind.

Das verwendete Parsing-Schema hängt davon ab, ob Sie die Ausgabe in XML oder JSON zurückgeben. JSON-Antworten, die bereits in Form von JavaScript-Objekten vorliegen, können direkt im JavaScript auf dem Client verarbeitet werden. XML-Antworten sollten mit einem XML-Prozessor und einer XML-Abfragesprache verarbeitet werden, um Elemente im XML-Format zu adressieren. In den folgenden Beispielen verwenden wir XPath, da es in XML-Verarbeitungsbibliotheken häufig unterstützt wird.

Verarbeiten von XML mit XPath

XML ist ein relativ ausgereiftes Format für strukturierte Informationen, das für den Datenaustausch verwendet wird. XML ist zwar nicht so schlank wie JSON, bietet aber mehr Sprachunterstützung und robustere Tools. Code für die Verarbeitung von XML in Java ist beispielsweise in die javax.xml-Pakete integriert.

Bei der Verarbeitung von XML-Antworten sollten Sie eine geeignete Abfragesprache zum Auswählen von Knoten im XML-Dokument verwenden, anstatt davon auszugehen, dass sich die Elemente an absoluten Positionen in der XML-Auszeichnung befinden. XPath ist eine Sprachsyntax zum eindeutigen Beschreiben von Knoten und Elementen in einem XML-Dokument. Mit XPath-Ausdrücken können Sie bestimmte Inhalte im XML-Antwortdokument identifizieren.

XPath-Ausdrücke

Wenn Sie sich mit XPath auskennen, können Sie ein robustes Parsing-Schema entwickeln. In diesem Abschnitt wird erläutert, wie Elemente in einem XML-Dokument mit XPath adressiert werden. So können Sie mehrere Elemente adressieren und komplexe Abfragen erstellen.

XPath verwendet Ausdrücke, um Elemente in einem XML-Dokument auszuwählen. Die Syntax ähnelt der für Verzeichnispfade. Mit diesen Ausdrücken werden Elemente in einem XML-Dokumentbaum identifiziert, der einem DOM ähnelt. XPath-Ausdrücke sind in der Regel „unersättlich“. Das bedeutet, dass sie mit allen Knoten übereinstimmen, die den angegebenen Kriterien entsprechen.

Wir verwenden das folgende abstrakte XML, um unsere Beispiele zu veranschaulichen:

<WebServiceResponse>
 <status>OK</status>
 <result>
  <type>sample</type>
  <name>Sample XML</name>
  <location>
   <lat>37.4217550</lat>
   <lng>-122.0846330</lng>
  </location>
 </result>
 <result>
  <message>The secret message</message>
 </result>
</WebServiceResponse>

Auswahl von Knoten in Ausdrücken

Mit XPath-Auswahlen werden Knoten ausgewählt. Der Stammknoten umfasst das gesamte Dokument. Sie wählen diesen Knoten mit dem speziellen Ausdruck „/“ aus. Der Stammknoten ist nicht der Knoten der obersten Ebene Ihres XML-Dokuments, sondern befindet sich eine Ebene darüber und umfasst ihn.

Elementknoten stellen die verschiedenen Elemente im XML-Dokumentbaum dar. Ein <WebServiceResponse>-Element stellt beispielsweise das Element der obersten Ebene dar, das in unserem Beispieldienst oben zurückgegeben wird. Sie wählen einzelne Knoten entweder über absolute oder relative Pfade aus. Das wird durch das Vorhandensein oder Fehlen des führenden Zeichens „/“ angegeben.

• Absoluter Pfad: Mit dem Ausdruck „/WebServiceResponse/result“ werden alle <result>-Knoten ausgewählt, die untergeordnete Knoten des <WebServiceResponse>-Knotens sind. Beide Elemente sind unter dem Stammknoten „/“ zu finden.
• Relativer Pfad vom aktuellen Kontext: Der Ausdruck „result“ würde alle <result>-Elemente im aktuellen Kontext abgleichen. Im Allgemeinen müssen Sie sich keine Gedanken über den Kontext machen, da Sie Webdienst-Ergebnisse in der Regel über einen einzelnen Ausdruck verarbeiten.

Jeder dieser Ausdrücke kann durch Hinzufügen eines Platzhalterpfads, der durch einen Doppelslash („//“) angegeben wird, erweitert werden. Dieser Platzhalter gibt an, dass null oder mehr Elemente im dazwischenliegenden Pfad übereinstimmen können. Der XPath-Ausdruck „//formatted_address“ entspricht beispielsweise allen Knoten mit diesem Namen im aktuellen Dokument. Der Ausdruck //viewport//lat würde mit allen <lat>-Elementen übereinstimmen, die <viewport> als übergeordnetes Element haben.

Standardmäßig werden durch XPath-Ausdrücke alle übereinstimmenden Elemente ausgewählt. Sie können den Ausdruck so einschränken, dass er nur mit einem bestimmten Element übereinstimmt, indem Sie ein Prädikat angeben, das in eckigen Klammern ([]) eingeschlossen ist. Der XPath-Ausdruck „/GeocodeResponse/result[2]“ gibt beispielsweise immer das zweite Ergebnis zurück.

    <WebServiceResponse>
     <status>OK</status>
     <result>
      <type>sample</type>
      <name>Sample XML</name>
      <location>
       <lat>37.4217550</lat>
       <lng>-122.0846330</lng>
      </location>
     </result>
     <result>
      <message>The secret message</message>
     </result>
    </WebServiceResponse>
    

    <result>
     <type>sample</type>
     <name>Sample XML</name>
     <location>
      <lat>37.4217550</lat>
      <lng>-122.0846330</lng>
     </location>
    </result>
    <result>
     <message>The secret message</message>
    </result>
    

    <location>
     <lat>37.4217550</lat>
     <lng>-122.0846330</lng>
    </location>
    

    <message>The secret message</message>
    

     <type>sample</type>
     <name>Sample XML</name>
     <location>
      <lat>37.4217550</lat>
      <lng>-122.0846330</lng>
     </location>
    

    Sample XML
    

Wenn Sie Elemente auswählen, wählen Sie Knoten aus, nicht nur den Text in diesen Objekten. In der Regel möchten Sie alle übereinstimmenden Knoten durchlaufen und den Text extrahieren. Sie können auch Textknoten direkt abgleichen. Weitere Informationen finden Sie unten unter Textknoten .

XPath unterstützt auch Attributknoten. Da jedoch alle Google Maps-Webdienste Elemente ohne Attribute bereitstellen, ist kein Attributabgleich erforderlich.

Auswahl von Text in Ausdrücken

Text in einem XML-Dokument wird in XPath-Ausdrücken über einen Textknoten-Operator angegeben. Dieser Operator „text()“ gibt an, dass Text aus dem angegebenen Knoten extrahiert wird. Der XPath-Ausdruck „//formatted_address/text()“ gibt beispielsweise den gesamten Text in <formatted_address>-Elementen zurück.

    sample
    Sample XML

    37.4217550
    -122.0846330
    The secret message
    

    The secret message
    

    Sample XML
    

Alternativ können Sie einen Ausdruck auswerten und eine Gruppe von Knoten zurückgeben. Anschließend können Sie diese Knotengruppe durchlaufen und den Text aus jedem Knoten extrahieren. Dieser Ansatz wird im Beispiel unten verwendet.

Weitere Informationen zu XPath finden Sie in der XPath-Spezifikation des W3C.

XPath in Java auswerten

Java bietet umfassende Unterstützung für das Parsen von XML und die Verwendung von XPath-Ausdrücken im javax.xml.xpath.*-Paket. Aus diesem Grund wird im Beispielcode in diesem Abschnitt Java verwendet, um zu veranschaulichen, wie XML verarbeitet und Daten aus XML-Dienstantworten geparst werden.

Wenn Sie XPath in Ihrem Java-Code verwenden möchten, müssen Sie zuerst eine Instanz von XPathFactory instanziieren und newXPath() für diese Factory aufrufen, um ein XPath -Objekt zu erstellen. Dieses Objekt kann dann übergebene XML- und XPath-Ausdrücke mit der Methode evaluate() verarbeiten.

Achten Sie bei der Auswertung von XPath-Ausdrücken darauf, dass Sie alle möglichen „Knotensätze“ durchlaufen, die zurückgegeben werden können. Da diese Ergebnisse als DOM-Knoten im Java-Code zurückgegeben werden, sollten Sie solche Mehrfachwerte in einem NodeList-Objekt erfassen und dieses Objekt durchlaufen, um Text oder Werte aus diesen Knoten zu extrahieren.

Der folgende Code zeigt, wie Sie ein XPath-Objekt erstellen, ihm XML und einen XPath-Ausdruck zuweisen und den Ausdruck auswerten, um den relevanten Inhalt auszugeben.

import org.xml.sax.InputSource;
import org.w3c.dom.*;
import javax.xml.xpath.*;
import java.io.*;

public class SimpleParser {

  public static void main(String[] args) throws IOException {

	XPathFactory factory = XPathFactory.newInstance();

    XPath xpath = factory.newXPath();

    try {
      System.out.print("Web Service Parser 1.0\n");

      // In practice, you'd retrieve your XML via an HTTP request.
      // Here we simply access an existing file.
      File xmlFile = new File("XML_FILE");

      // The xpath evaluator requires the XML be in the format of an InputSource
	  InputSource inputXml = new InputSource(new FileInputStream(xmlFile));

      // Because the evaluator may return multiple entries, we specify that the expression
      // return a NODESET and place the result in a NodeList.
      NodeList nodes = (NodeList) xpath.evaluate("XPATH_EXPRESSION", inputXml, XPathConstants.NODESET);

      // We can then iterate over the NodeList and extract the content via getTextContent().
      // NOTE: this will only return text for element nodes at the returned context.
      for (int i = 0, n = nodes.getLength(); i < n; i++) {
        String nodeString = nodes.item(i).getTextContent();
        System.out.print(nodeString);
        System.out.print("\n");
      }
    } catch (XPathExpressionException ex) {
	  System.out.print("XPath Error");
    } catch (FileNotFoundException ex) {
      System.out.print("File Error");
    }
  }
}