GMSPlacesClient-Klassenreferenz


Überblick

Hauptschnittstelle des Places SDK

Wird zum Suchen und Abrufen von Details zu Orten verwendet. Der Zugriff auf diese Klasse sollte über die [GMSPlacesClient sharedClient]-Methode erfolgen.

GMSPlacesClient-Methoden sollten nur aus dem Hauptthread aufgerufen werden. Das Aufrufen dieser Methoden aus einem anderen Thread führt zu einer Ausnahme oder einem undefinierten Verhalten. Sofern nicht anders angegeben, werden alle Callbacks im Hauptthread aufgerufen.

Öffentliche Mitgliedsfunktionen

(void) lookUpPlaceID:callback:
 Details zu einem Ort abrufen
(void) lookUpPhotosForPlaceID:callback:
 Ruft die Metadaten für bis zu zehn Fotos ab, die einem Ort zugeordnet sind.
(void) loadPlace Photo:callback:
 Lädt das Bild für ein bestimmtes Foto in seiner maximalen Größe.
(void) loadPlacePhoto:constrainedToSize:scale:callback:
 Lädt das Bild für ein bestimmtes Foto, skaliert auf die vorgegebenen maximalen Abmessungen.
(void) currentPlaceWithCallback:
 Gibt eine Schätzung des Ortes zurück, an dem sich das Gerät derzeit befindet.
(void) findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Automatische Vervollständigungen in einer Textanfrage finden.
(void) fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Details zu einem Ort abrufen
(void) findPlace LikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Wahrscheinlichkeiten von Orten anhand des aktuellen Standorts des Nutzers ermitteln
(void) isOpenWithPlaceID:callback:
 Ruft Details zu einem Ort einschließlich aller Felder ab, die zum Ermitteln von GMSPlaceOpenStatus zum aktuellen Zeitpunkt erforderlich sind.
(void) isOpenWithPlaceID:date:callback:
 Ruft Details zu einem Ort einschließlich aller Felder ab, die zum Ermitteln von GMSPlaceOpenStatus am angegebenen NSDate erforderlich sind.
(void) isOpenWithPlace:callback:
 Ruft Details zu einem Ort einschließlich aller Felder ab, die zum Ermitteln von GMSPlaceOpenStatus zum aktuellen Zeitpunkt erforderlich sind.
(void) isOpenWithPlace:date:callback:
 Ruft Details zu einem Ort einschließlich aller Felder ab, die zum Ermitteln von GMSPlaceOpenStatus am angegebenen NSDate erforderlich sind.
(void) searchByTextWithRequest:callback:
 Orte anhand von Text und Einschränkungen suchen

Statische öffentliche Mitgliederfunktionen

(Instanztyp)+ sharedClient
 Stellt die gemeinsam genutzte Instanz von GMSPlacesClient für das Google Places SDK for iOS bereit und erstellt sie bei Bedarf.
(BOOL) + provideAPIKey:
 Stellt Ihren API-Schlüssel für das Google Places SDK for iOS bereit.
(NSString *)+ openSourceLicenseInfo
 Gibt die Open-Source-Softwarelizenzinformationen für das Google Places SDK for iOS zurück.
(NSString *)+ SDKVersion
 Gibt die Version für diese Version des Google Places SDK for iOS zurück.
(NSString *)+ SDKLongVersion
 Gibt die lange Version für diese Version des Google Places SDK for iOS zurück.

(Beachten Sie, dass dies keine Elementfunktionen sind.)

typedef void(^ GMSPlaceResultCallback (GMSPlace *_Nullable-Ergebnis, NSError *_Nullable-Fehler)
 Callback-Typ für den Empfang von Lookups für Ortsdetails.
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable LikeList, NSError *_Nullable-Fehler)
 Callback-Typ für den Empfang von Ortswahrscheinlichkeitslisten.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable-Wahrscheinlichkeiten, NSError *_Nullable-Fehler)
 Callback-Typ für den Empfang eines Arrays mit GMSPlaceLikelihood-Werten.
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable-Ergebnisse, NSError *_Nullable-Fehler)
 Rückruftyp für den Empfang von Ergebnissen der automatischen Vervollständigung
typedef void(^ GMSPlacePhotoMetadataResultCallback (GMSPlacePhotoMetadataList *_Nullable Fotos, NSError *_Nullable-Fehler)
 Callback-Typ für den Empfang von Ortsfotosergebnissen.
typedef void(^ GMSPlacePhotoImageResultCallback (UIImage *_Nullable-Foto, NSError *_Nullable-Fehler)
 Callback-Typ für den Empfang von UIImage-Objekten von einem GMSPlacePhotoMetadata-Objekt.
typedef void(^ GMSPlaceOpenStatusCallback (GMSPlaceOpenStatus-Ergebnis, NSError *_Nullable-Fehler)
 Rückruftyp für den Empfang des Status der Öffnungszeiten des Orts
typedef void(^ GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable-Fehler)
 Rückruftyp für den Empfang von Textergebnissen

Dokumentation zu Mitgliederfunktionen

+ (Instanztyp) sharedClient

Stellt die gemeinsam genutzte Instanz von GMSPlacesClient für das Google Places SDK for iOS bereit und erstellt sie bei Bedarf.

Wenn Ihre Anwendung häufig Methoden von GMSPlacesClient verwendet, kann sie dieses Objekt direkt beibehalten, da die Verbindung zu Google sonst regelmäßig neu gestartet werden könnte.

+ (BOOL) provideAPIKey: (NSString *) key

Stellt Ihren API-Schlüssel für das Google Places SDK for iOS bereit.

Dieser Schlüssel wird über die Google Cloud Platform Console für Ihre Anwendung generiert und mit der Bundle-ID Ihrer Anwendung verknüpft, um sie zu identifizieren. Diese sollte von Ihrer Anwendung vor der Verwendung von GMSPlacesClient aufgerufen werden (z.B. in app:didFinishLaunchingWithOptions:).

Gibt zurück:
YES, wenn der APIKey erfolgreich angegeben wurde.
+ (NSString *) openSourceLicenseInfo

Gibt die Open-Source-Softwarelizenzinformationen für das Google Places SDK for iOS zurück.

Diese Informationen müssen in Ihrer Bewerbung zur Verfügung gestellt werden.

+ (NSString *) SDKVersion

Gibt die Version für diese Version des Google Places SDK for iOS zurück.

. Zum Beispiel: "1.0.0".

+ (NSString *) SDKLongVersion

Gibt die lange Version für diese Version des Google Places SDK for iOS zurück.

. Zum Beispiel: "1.0.0 (102.1)".

– (void) lookUpPlaceID: (NSString *) placeID
Callback: (GMSPlaceResultCallback) Rückruf

Details zu einem Ort abrufen

Diese Methode ist nicht blockierend.

Parameter:
placeIDDie Orts-ID, nach der gesucht werden soll.
callbackDer Callback, der mit dem Suchergebnis aufgerufen werden soll.
- (void) lookUpPhotosForPlaceID: (NSString *) placeID
Callback: (GMSPlacePhotoMetadataResultCallback) Rückruf

Ruft die Metadaten für bis zu zehn Fotos ab, die einem Ort zugeordnet sind.

Die Fotos stammen aus verschiedenen Quellen, z. B. von den Unternehmensinhabern oder von Google+ Nutzern. In den meisten Fällen dürfen diese Fotos ohne Quellenangabe verwendet werden oder die erforderlichen Quellenangaben sind im Bild eingebunden. Sie müssen jedoch das Attribut attributions in der Antwort verwenden, um zusätzliche erforderliche Zuordnungen abzurufen und diese Quellenangaben überall dort anzuzeigen, wo das Bild angezeigt wird. Es werden maximal 10 Fotos zurückgegeben.

Bei mehreren Aufrufen dieser Methode werden wahrscheinlich jedes Mal dieselben Fotos zurückgegeben. Dies ist jedoch nicht garantiert, da sich die zugrunde liegenden Daten geändert haben können.

Diese Methode führt einen Netzwerk-Lookup durch.

Parameter:
placeIDDie Orts-ID, für die Fotos gesucht werden sollen.
callbackDer Callback, der mit dem Suchergebnis aufgerufen werden soll.
- (void)loadPlaceFoto: (GMSPlacePhotoMetadata *) photoMetadata
Callback: (GMSPlacePhotoImageResultCallback) Rückruf

Lädt das Bild für ein bestimmtes Foto in seiner maximalen Größe.

Bilddaten können vom SDK im Cache gespeichert werden. Wenn das angeforderte Foto nicht im Cache vorhanden ist, wird eine Netzwerksuche durchgeführt.

Parameter:
photoMetadataDas GMSPlacePhotoMetadata, für das ein UIImage geladen werden soll.
callbackDer Callback, der mit dem geladenen UIImage aufgerufen werden soll.
- (void)loadPlaceFoto: (GMSPlacePhotoMetadata *) photoMetadata
restrictToSize: (CGSize) maxSize
Skalierung: (CGFloat) Skalieren
Callback: (GMSPlacePhotoImageResultCallback) Rückruf

Lädt das Bild für ein bestimmtes Foto, skaliert auf die vorgegebenen maximalen Abmessungen.

Das Bild wird so skaliert, dass es den vorgegebenen Abmessungen unter Beibehaltung des Seitenverhältnisses des Originalbildes entspricht. Diese Skalierung erfolgt serverseitig.

Wenn der Parameter "scale" nicht 1,0 ist, wird "maxSize" mit diesem Wert multipliziert und der zurückgegebene UIImage auf die angegebene Skalierung festgelegt. Dieser Parameter sollte auf die Bildschirmgröße festgelegt werden, wenn Sie Bilder zur Anzeige auf dem Bildschirm laden.

Bilddaten können vom SDK im Cache gespeichert werden. Wenn das angeforderte Foto nicht im Cache vorhanden ist, wird eine Netzwerksuche durchgeführt.

Hinweis:
Nach dem Anwenden des Skalierungsfaktors werden die Dimensionen in „maxSize“ vor der Verwendung auf die nächste Ganzzahl aufgerundet. Wenn ein Bild angefordert wird, das größer als die maximal verfügbare Größe ist, wird möglicherweise ein kleineres Bild zurückgegeben.
Parameter:
photoMetadataDas GMSPlacePhotoMetadata, für das ein UIImage geladen werden soll.
maxSizeDie maximale Bildgröße.
profitierenDie Größe, mit der das Bild geladen werden soll.
callbackDer Callback, der mit dem geladenen UIImage aufgerufen werden soll.

Gibt eine Schätzung des Ortes zurück, an dem sich das Gerät derzeit befindet.

Erstellt eine Liste mit Wahrscheinlichkeiten eines Ortes basierend auf dem letzten ungefähren Standort des Geräts. Der bereitgestellte Callback wird mit dieser Wahrscheinlichkeitsliste bei Erfolg und ein NSError bei einem Fehler aufgerufen.

Hinweis:
Für diese Methode muss deine App die Berechtigung haben, auf den aktuellen Gerätestandort zuzugreifen. Bevor Sie diese Funktion aufrufen, fordern Sie mithilfe von [CLLocationManager requestWhenInUseAuthorization] oder [CLLocationManager requestAlwaysAuthorization] Zugriff auf den Standort des Nutzers an. Wenn Sie diese Methode aufrufen und Ihre App nicht den korrekten Autorisierungsstatus hat, wird der Callback mit einem Fehler aufgerufen.
Parameter:
callbackDer Callback, der mit der Ortswahrscheinlichkeitsliste ausgelöst wird.
- (void) findAutocompletePredictionsFromQuery: (NSString *) query
Filter: (GMSAutocompleteFilter darf auf Nullwerte gesetzt werden *) Filter
sessionToken: (GMSAutocompleteSessionToken* darf Nullwerte enthalten) sessionToken
Callback: (GMSAutocompletePredictionsCallback) Rückruf

Automatische Vervollständigungen in einer Textanfrage finden.

Die Ergebnisse können optional auf einen bestimmten Standort ausgerichtet oder auf ein Gebiet beschränkt sein. Diese Methode ist nicht blockierend.

Der bereitgestellte Callback wird mit einem Array von automatischen Vervollständigungen bei Erfolg und einem NSError bei einem Fehler aufgerufen.

Parameter:
AbfrageDer Teil des Textes, der automatisch vervollständigt werden soll.
FilterDer Filter, der auf die Ergebnisse angewendet werden soll. Dieser Parameter kann „null“ sein.
sessionTokenDie GMSAutocompleteSessionToken, mit der die Anfrage einer Abrechnungssitzung zugeordnet werden soll.
callbackDer Callback, der mit den Vorhersagen aufgerufen werden soll.
- (void) fetchPlaceFromPlaceID: (NSString *) placeID
„placeFields“: (GMSPlaceField) placeFields
sessionToken: (GMSAutocompleteSessionToken* darf Nullwerte enthalten) sessionToken
Callback: (GMSPlaceResultCallback) Rückruf

Details zu einem Ort abrufen

Diese Methode ist nicht blockierend.

Parameter:
placeIDDie Orts-ID, nach der gesucht werden soll.
placeFieldsDie einzelnen Ortsfelder, die für die Ortsobjekte in der Liste angefordert werden.
sessionTokenDie GMSAutocompleteSessionToken, mit der die Anfrage einer Abrechnungssitzung zugeordnet werden soll.
callbackDer Callback, der mit dem Suchergebnis aufgerufen werden soll.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField) placeFields
Callback: (GMSPlaceLikelihoodsCallback) Rückruf

Wahrscheinlichkeiten von Orten anhand des aktuellen Standorts des Nutzers ermitteln

Diese Methode ist nicht blockierend.

Der bereitgestellte Callback wird mit einem Array von Orten mit Wahrscheinlichkeitswerten bei Erfolg und einem NSError bei einem Fehler aufgerufen.

Parameter:
placeFieldsDie einzelnen Ortsfelder, die für die Ortsobjekte in der Liste angefordert werden.
callbackDer Callback, der mit Ortswahrscheinlichkeiten aufgerufen werden soll.
- (void) isOpenWithPlaceID: (NSString *) placeID
Callback: (GMSPlaceOpenStatusCallback) Rückruf

Ruft Details zu einem Ort einschließlich aller Felder ab, die zum Ermitteln von GMSPlaceOpenStatus zum aktuellen Zeitpunkt erforderlich sind.

Diese Methode ist nicht blockierend.

Parameter:
placeIDDie Orts-ID, nach der gesucht werden soll.
callbackDer Callback, der mit dem Ortsergebnis aufgerufen werden soll.
- (void) isOpenWithPlaceID: (NSString *) placeID
Datum: (NSDate *) Datum
Callback: (GMSPlaceOpenStatusCallback) Rückruf

Ruft Details zu einem Ort einschließlich aller Felder ab, die zum Ermitteln von GMSPlaceOpenStatus am angegebenen NSDate erforderlich sind.

Diese Methode ist nicht blockierend.

Parameter:
placeIDDie Orts-ID, nach der gesucht werden soll.
dateDas NSDate, für das der Öffnungsstatus bestimmt werden soll.
callbackDer Callback, der mit dem Ortsergebnis aufgerufen werden soll.
- (void) isOpenWithPlace: (GMSPlace *) Ort
Callback: (GMSPlaceOpenStatusCallback) Rückruf

Ruft Details zu einem Ort einschließlich aller Felder ab, die zum Ermitteln von GMSPlaceOpenStatus zum aktuellen Zeitpunkt erforderlich sind.

Fordert nur dann zusätzliche Felder an, wenn GMSPlace nicht alle erforderlichen Felder enthält. Andernfalls wird GMSPlaceOpenStatus sofort im Callback zurückgegeben. Diese Methode ist nicht blockierend.

Parameter:
OrtDie zu suchende GMSPlace.
callbackDer Callback, der mit dem Ortsergebnis aufgerufen werden soll.
- (void) isOpenWithPlace: (GMSPlace *) Ort
Datum: (NSDate *) Datum
Callback: (GMSPlaceOpenStatusCallback) Rückruf

Ruft Details zu einem Ort einschließlich aller Felder ab, die zum Ermitteln von GMSPlaceOpenStatus am angegebenen NSDate erforderlich sind.

Fordert nur dann zusätzliche Felder an, wenn GMSPlace nicht alle erforderlichen Felder enthält. Andernfalls wird GMSPlaceOpenStatus sofort im Callback zurückgegeben. Diese Methode ist nicht blockierend.

Parameter:
OrtDie zu suchende GMSPlace.
dateDas NSDate, für das der Öffnungsstatus bestimmt werden soll.
callbackDer Callback, der mit dem Ortsergebnis aufgerufen werden soll.
- (void) searchByTextWithRequest: (GMSPlaceSearchByTextRequest *) textSearchRequest
Callback: (GMSPlaceSearchByTextResultCallback) Rückruf

Orte anhand von Text und Einschränkungen suchen

Diese Methode ist nicht blockierend.

Parameter:
textSearchRequestGMSPlaceSearchByTextRequest Die Textanfrage, die für die Abfrage verwendet werden soll.
callbackDer Callback, der mit dem Suchergebnis aufgerufen werden soll.

- (typedef void(^ GMSPlaceResultCallback)(GMSPlace *_Nullable-Ergebnis, NSError *_Nullable-Fehler)) [related]

Callback-Typ für den Empfang von Lookups für Ortsdetails.

Wenn ein Fehler aufgetreten ist, ist result „null“ und error enthält Informationen zum Fehler.

Parameter:
ErgebnisDie zurückgegebene GMSPlace.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_NullableGSList, NSError *_Nullable error)) [related]

Callback-Typ für den Empfang von Ortswahrscheinlichkeitslisten.

Wenn ein Fehler aufgetreten ist, ist likelihoodList „null“ und error enthält Informationen zum Fehler.

Parameter:
likelihoodListDie Liste der Wahrscheinlichkeiten von Orten.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable-Wahrscheinlichkeiten, NSError *_Nullable-Fehler)) [related]

Callback-Typ für den Empfang eines Arrays mit GMSPlaceLikelihood-Werten.

Wenn ein Fehler aufgetreten ist, ist das Array null und error enthält Informationen zum Fehler.

- (typedef void(^ GMSAutocompletePredictionsCallback)(NSArray< GMSAutocompletePrediction * > *_Nullable-Ergebnisse, NSError *_Nullable-Fehler)) [related]

Rückruftyp für den Empfang von Ergebnissen der automatischen Vervollständigung

results ist ein Array von GMSAutocompletePredictions, das die Kandidatenvervollständigungen der Abfrage darstellt.

Parameter:
ErgebnisseEin Array mit GMSAutocompletePrediction-Werten.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

Callback-Typ für den Empfang von Ortsfotosergebnissen.

Wenn ein Fehler aufgetreten ist, ist photos „null“ und error enthält Informationen zum Fehler.

Parameter:
fotosDas Ergebnis, das GMSPlacePhotoMetadata-Objekte enthält.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

Callback-Typ für den Empfang von UIImage-Objekten von einem GMSPlacePhotoMetadata-Objekt.

Wenn ein Fehler aufgetreten ist, ist photo „null“ und error enthält Informationen zum Fehler.

Parameter:
fotoDie geladene UIImage.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlaceOpenStatusCallback)(GMSPlaceOpenStatus-Ergebnis, NSError *_Nullable-Fehler)) [related]

Rückruftyp für den Empfang des Status der Öffnungszeiten des Orts

Wenn ein Fehler aufgetreten ist, lautet result „GMSPlaceOpenStatusUnknown“ und error enthält Informationen zum Fehler.

Parameter:
ErgebnisDie zurückgegebene GMSPlaceOpenStatus.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

Rückruftyp für den Empfang von Textergebnissen

results ist ein Array von GMSPlace, das einzelne Ergebnisse darstellt, die mit der Abfrage übereinstimmen.

Parameter:
ErgebnisseEin Array mit GMSPlace-Werten.
errorDer aufgetretene Fehler, falls vorhanden.