مرجع فئة GMSPlacesClient


نظرة عامة

الواجهة الرئيسية لحزمة تطوير البرامج للأماكن.

تُستخدَم للبحث والحصول على تفاصيل حول الأماكن. يجب الوصول إلى هذه الفئة من خلال طريقة [GMSPlacesClient SharedClient].

يجب استدعاء طرق GMSPlacesClient من سلسلة التعليمات الرئيسية فقط. سيؤدي استدعاء هذه الطرق من سلسلة محادثات أخرى إلى حدوث استثناء أو سلوك غير معروف. سيتم استدعاء جميع عمليات الاستدعاء في سلسلة التعليمات الرئيسية، ما لم يتم تحديد خلاف ذلك.

وظائف الأعضاء العامة

(void) - lookUpPlaceID:callback:
 الحصول على تفاصيل عن مكان
(void) - lookUpPhotosForPlaceID:callback:
 يمكنك الحصول على البيانات الوصفية لما يصل إلى 10 صور مرتبطة بالمكان.
(void) - loadPlaceImage:callback:
 لتحميل الصورة لصورة معيّنة بالحد الأقصى للحجم.
(void) - loadPlacePhoto:constrainedToSize:scale:callback:
 لتحميل الصورة لصورة محددة، يتم قياسها لتناسب الحد الأقصى للأبعاد المحددة.
(void) - currentPlaceWithCallback:
 لعرض تقدير للمكان المعروف حاليًا بموقع الجهاز فيه.
(void) - findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 يمكنك العثور على توقعات الإكمال التلقائي من طلب البحث النصي.
(void) - fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 يمكنك استرجاع تفاصيل مكان معيّن.
(void) - findPlaceLikeliITYsFromCurrentLocationWithPlaceFields:callbacks:
 البحث عن احتمالية الأماكن باستخدام الموقع الجغرافي الحالي للمستخدم
(void) - isOpenWithPlaceID:callback:
 الحصول على تفاصيل حول مكان، بما في ذلك جميع الحقول اللازمة لتحديد GMSPlaceOpenStatus في الوقت الحالي
(void) - isOpenWithPlaceID:date:callback:
 للحصول على تفاصيل عن مكان، بما في ذلك جميع الحقول اللازمة لتحديد GMSPlaceOpenStatus في NSDate المحدَّد
(void) - isOpenWithPlace:callback:
 الحصول على تفاصيل حول مكان، بما في ذلك جميع الحقول اللازمة لتحديد GMSPlaceOpenStatus في الوقت الحالي
(void) - isOpenWithPlace:date:callback:
 للحصول على تفاصيل عن مكان، بما في ذلك جميع الحقول اللازمة لتحديد GMSPlaceOpenStatus في NSDate المحدَّد
(void) - searchByTextWithRequest:callback:
 البحث عن الأماكن حسب النص والقيود

دوال الأعضاء العامة الثابتة

(instancetype)+ sharedClient
 يوفر مثيلاً مشتركًا من GMSPlacesClient لحزمة SDK لأماكن Google لنظام التشغيل iOS، بحيث يتم إنشاؤه إذا لزم الأمر.
(BOOL) + توفير مفتاح واجهة برمجة التطبيقات:
 توفّر مفتاح واجهة برمجة التطبيقات لحزمة تطوير برامج أماكن Google لنظام التشغيل iOS.
(NSString *)+ openSourceLicenseInfo
 تعرض معلومات ترخيص البرنامج مفتوح المصدر لحزمة تطوير برامج أماكن Google لنظام التشغيل iOS.
(NSString *)+ SDKVersion
 لعرض إصدار هذا الإصدار من حزمة تطوير البرامج (SDK) لأماكن Google لنظام التشغيل iOS.
(NSString *)+ SDKLongVersion
 عرض النسخة الطويلة لهذا الإصدار من حزمة تطوير البرامج (SDK) لأماكن Google لنظام التشغيل iOS.

(يُرجى العلم أنّ هذه الدوال ليست أعضاء.)

typedef false(^ GMSPlaceResultCallback )(GMSPlace *_Nullable result, NSError *_Nullable error)
 نوع معاودة الاتصال لتلقّي عمليات البحث عن تفاصيل المكان.
typedef false(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_NullableposeList, NSError *_Nullable error)
 نوع معاودة الاتصال لتلقّي قوائم احتمالية الأماكن.
typedef false(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable المحتملs, NSError *_Nullable error)
 نوع معاودة الاتصال لاستلام مصفوفة من GMSPlaceLikelihoods.
typedef false(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable error)
 نوع معاودة الاتصال لتلقّي نتائج الإكمال التلقائي.
typedef false(^ GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
 نوع معاودة الاتصال لتلقي نتائج صور الأماكن.
typedef false(^ GMSPlacePhotoImageResultCallback )(UIImage *_Nullable photo, NSError *_Nullable error)
 نوع معاودة الاتصال لاستلام عناصر UIImage من عنصر GMSPlacePhotoMetadata
typedef false(^ GMSPlaceOpenStatusCallback )(نتيجة GMSPlaceOpenStatus، NSError *_Nullable error)
 نوع معاودة الاتصال لتلقي حالة ساعات العمل للمكان.
typedef false(^ GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
 نوع معاودة الاتصال لتلقّي البحث حسب النتائج النصية.

وثائق وظائف الأعضاء

+ (instancetype) sharedClient

يوفر مثيلاً مشتركًا من GMSPlacesClient لحزمة SDK لأماكن Google لنظام التشغيل iOS، بحيث يتم إنشاؤه إذا لزم الأمر.

إذا كان تطبيقك يستخدم غالبًا طُرق GMSPlacesClient، قد يريد الاحتفاظ بهذا الكائن مباشرةً، وإلا قد تتم إعادة بدء اتصالك بـ Google بشكل منتظم.

+ (BOOL) provideAPIKey: (NSString *) مفتاح

توفّر مفتاح واجهة برمجة التطبيقات لحزمة تطوير برامج أماكن Google لنظام التشغيل iOS.

يتم إنشاء هذا المفتاح لتطبيقك من خلال وحدة تحكّم Google Cloud Platform، ويتم إقرانه بمعرّف حزمة تطبيقك لتحديده. يجب أن يطلب تطبيقك هذا الأمر قبل استخدام GMSPlacesClient (على سبيل المثال، في app:didFinishLaunchingWithOptions:).

المرتجعات:
نعم إذا تم تقديم مفتاح واجهة برمجة التطبيقات بنجاح.
+ (NSString *) openSourceLicenseInfo

تعرض معلومات ترخيص البرنامج مفتوح المصدر لحزمة تطوير برامج أماكن Google لنظام التشغيل iOS.

ويجب إتاحة هذه المعلومات داخل طلبك.

+ (NSString *) SDKVersion

لعرض إصدار هذا الإصدار من حزمة تطوير البرامج (SDK) لأماكن Google لنظام التشغيل iOS.

. على سبيل المثال، "1.0.0".

+ (NSString *) SDKLongVersion

عرض النسخة الطويلة لهذا الإصدار من حزمة تطوير البرامج (SDK) لأماكن Google لنظام التشغيل iOS.

. على سبيل المثال، "1.0.0 (102.1)".

- (ملء) lookUpPlaceID: (NSString *) placeID
معاودة الاتصال: (GMSPlaceResultCallback) معاودة الاتصال

الحصول على تفاصيل عن مكان

لا تؤدي هذه الطريقة إلى الحظر.

المَعلمات:
placeIDرقم تعريف المكان المطلوب البحث عنه.
معاودة الاتصالمعاودة الاتصال المطلوب استدعائها بنتيجة البحث.
- (ملء) lookUpPhotosForPlaceID: (NSString *) placeID
معاودة الاتصال: (GMSPlacePhotoMetadataResultCallback) معاودة الاتصال

يمكنك الحصول على البيانات الوصفية لما يصل إلى 10 صور مرتبطة بالمكان.

يتم الحصول على الصور من مجموعة متنوعة من المواقع، بما في ذلك مالكي الأنشطة التجارية والصور التي يساهم بها مستخدمو +Google. في معظم الحالات، يمكن استخدام هذه الصور بدون ذِكرها، أو سيتم تضمين الإسناد المطلوب كجزء من الصورة. مع ذلك، عليك استخدام السمة attributions كاستجابة لاسترداد أي إحالات إضافية مطلوبة، وعرض هذه الإحالات في تطبيقك أينما عرضت الصورة. يتم عرض 10 صور كحدّ أقصى.

من المحتمل أن تؤدي الطلبات المتعددة باستخدام هذه الطريقة إلى عرض الصور نفسها في كل مرة. ومع ذلك، لا يمكننا ضمان ذلك لأنّه من المحتمل أن تكون البيانات الأساسية قد تغيّرت.

تُجري هذه الطريقة بحثًا في الشبكة.

المَعلمات:
placeIDرقم تعريف المكان المطلوب البحث عن الصور له.
معاودة الاتصالمعاودة الاتصال المطلوب استدعائها بنتيجة البحث.
- (الفراغ)loadPlaceImage: (GMSPlacePhotoMetadata *) photoMetadata
معاودة الاتصال: (GMSPlacePhotoImageResultCallback) معاودة الاتصال

لتحميل الصورة لصورة معيّنة بالحد الأقصى للحجم.

وقد يتم تخزين بيانات الصور مؤقتًا باستخدام حزمة تطوير البرامج (SDK). إذا لم تتوفر الصورة المطلوبة في ذاكرة التخزين المؤقت، سيتم إجراء بحث عن الشبكة.

المَعلمات:
photoMetadataGMSPlacePhotoMetadata الذي سيتم تحميل UIImage له.
معاودة الاتصالمعاودة الاتصال المطلوب استدعاءها مع UIImage التي تم تحميلها.
- (الفراغ)loadPlaceImage: (GMSPlacePhotoMetadata *) photoMetadata
RestrictedToSize: (CGSize) maxSize
المقياس: (CGFloat) مقياس
معاودة الاتصال: (GMSPlacePhotoImageResultCallback) معاودة الاتصال

لتحميل الصورة لصورة محددة، يتم قياسها لتناسب الحد الأقصى للأبعاد المحددة.

سيتم تغيير حجم الصورة لتلائم الأبعاد المحددة مع الحفاظ على نسبة العرض إلى الارتفاع للصورة الأصلية. يتم إجراء هذا التحجيم من جهة الخادم.

إذا لم تكن مَعلمة المقياس 1.0 maxSize، سيتم ضرب هذه القيمة في هذه القيمة، وسيتم ضبط قيمة UIImage المعروضة على المقياس المحدّد. يجب ضبط هذه المَعلمة على مقياس الشاشة إذا كنت تُحمِّل صورًا لعرضها على الشاشة.

وقد يتم تخزين بيانات الصور مؤقتًا باستخدام حزمة تطوير البرامج (SDK). إذا لم تتوفر الصورة المطلوبة في ذاكرة التخزين المؤقت، سيتم إجراء بحث عن الشبكة.

ملاحظة:
بعد تطبيق عامل المقياس، سيتم تقريب الأبعاد إلى maxSize إلى أقرب عدد صحيح قبل الاستخدام. في حال طلب صورة أكبر من الحد الأقصى للحجم المتاح، قد يتم عرض صورة أصغر.
المَعلمات:
photoMetadataGMSPlacePhotoMetadata الذي سيتم تحميل UIImage له.
maxSizeالحد الأقصى لحجم الصورة.
المقياسالمقياس المطلوب تحميل الصورة عليه.
معاودة الاتصالمعاودة الاتصال المطلوب استدعاءها مع UIImage التي تم تحميلها.
- (إبطال) currentPlaceWithCallback: (GMSPlaceLikelihoodListCallback) معاودة الاتصال

لعرض تقدير للمكان المعروف حاليًا بموقع الجهاز فيه.

إنشاء قائمة احتمالية الأماكن استنادًا إلى آخر موقع جغرافي مقدَّر للجهاز سيتم استدعاء معاودة الاتصال المقدمة مع قائمة الاحتمالات هذه عند النجاح وعرض NSError عند حدوث خطأ.

ملاحظة:
تتطلب هذه الطريقة أن يكون لدى تطبيقك إذن بالوصول إلى موقع الجهاز الحالي. قبل استدعاء هذه الرسالة، تأكَّد من طلب الوصول إلى الموقع الجغرافي للمستخدمين باستخدام [CLLocationManager requestWhenInUseCONTACT] أو [CLLocationManager request AlwaysAuthorize]. فإذا استدعيت هذه الطريقة ولم يكن تطبيقك يحتوي على حالة التفويض الصحيحة، سيتم استدعاء رد الاتصال مع وجود خطأ.
المَعلمات:
معاودة الاتصالمعاودة الاتصال المطلوب استدعاؤها بقائمة احتمالية الأماكن.
- (ملء) findAutocompleteForecastionsFromQuery: (NSString *) طلب البحث
الفلتر المستخدم: (GMSAutocompleteFilter *) فلتر
sessionToken: (GMSAutocompleteSessionToken *) قابل لقيمة فارغة sessionToken
معاودة الاتصال: (GMSAutocompletePredictionsCallback) معاودة الاتصال

يمكنك العثور على توقعات الإكمال التلقائي من طلب البحث النصي.

قد تكون النتائج منحازة بشكل اختياري نحو موقع جغرافي معيّن أو حصرها بمنطقة ما. لا تؤدي هذه الطريقة إلى الحظر.

سيتم استدعاء معاودة الاتصال المقدمة مع مجموعة من توقعات الإكمال التلقائي عند النجاح و NSError عند حدوث خطأ.

المَعلمات:
queryالنص الجزئي المطلوب إكماله تلقائيًا.
filterالفلتر المطلوب تطبيقه على النتائج. قد تكون هذه المعلمة صفر.
sessionTokenGMSAutocompleteSessionToken المطلوب ربطه بجلسة فوترة.
معاودة الاتصالمعاودة الاتصال للاستدعاء مع التوقعات.
- (إبطال) renamePlaceFromPlaceID: (NSString *) placeID
مجالات الأماكن: (GMSPlaceField) placeFields
sessionToken: (GMSAutocompleteSessionToken *) قابل لقيمة فارغة sessionToken
معاودة الاتصال: (GMSPlaceResultCallback) معاودة الاتصال

يمكنك استرجاع تفاصيل مكان معيّن.

لا تؤدي هذه الطريقة إلى الحظر.

المَعلمات:
placeIDرقم تعريف المكان المطلوب البحث عنه.
placeFieldsحقول الأماكن الفردية المطلوبة لعناصر الأماكن في القائمة.
sessionTokenGMSAutocompleteSessionToken المطلوب ربطه بجلسة فوترة.
معاودة الاتصالمعاودة الاتصال المطلوب استدعائها بنتيجة البحث.
- (إبطال) findPlaceLikeliITYsFromCurrentLocationWithPlaceFields: (GMSPlaceField) placeFields
معاودة الاتصال: (GMSPlaceLikelihoodsCallback) معاودة الاتصال

البحث عن احتمالية الأماكن باستخدام الموقع الجغرافي الحالي للمستخدم

لا تؤدي هذه الطريقة إلى الحظر.

سيتم استدعاء معاودة الاتصال المقدمة مع مجموعة من الأماكن التي لها درجات احتمالية عند النجاح وNSError عند حدوث خطأ.

المَعلمات:
placeFieldsحقول الأماكن الفردية المطلوبة لعناصر الأماكن في القائمة.
معاودة الاتصالمعاودة الاتصال للاستدعاء مع احتمالات المكان.
- (خالية) isOpenWithPlaceID: (NSString *) placeID
معاودة الاتصال: (GMSPlaceOpenStatusCallback) معاودة الاتصال

الحصول على تفاصيل حول مكان، بما في ذلك جميع الحقول اللازمة لتحديد GMSPlaceOpenStatus في الوقت الحالي

لا تؤدي هذه الطريقة إلى الحظر.

المَعلمات:
placeIDرقم تعريف المكان المطلوب البحث عنه.
معاودة الاتصالمعاودة الاتصال للاستدعاء بنتيجة المكان.
- (خالية) isOpenWithPlaceID: (NSString *) placeID
التاريخ: (NSDate *) التاريخ
معاودة الاتصال: (GMSPlaceOpenStatusCallback) معاودة الاتصال

للحصول على تفاصيل عن مكان، بما في ذلك جميع الحقول اللازمة لتحديد GMSPlaceOpenStatus في NSDate المحدَّد

لا تؤدي هذه الطريقة إلى الحظر.

المَعلمات:
placeIDرقم تعريف المكان المطلوب البحث عنه.
التاريختعرض هذه السمة NSDate لتحديد حالة الفتح.
معاودة الاتصالمعاودة الاتصال للاستدعاء بنتيجة المكان.
- (خالية) isOpenWithPlace: (GMSPlace *) مكان
معاودة الاتصال: (GMSPlaceOpenStatusCallback) معاودة الاتصال

الحصول على تفاصيل حول مكان، بما في ذلك جميع الحقول اللازمة لتحديد GMSPlaceOpenStatus في الوقت الحالي

لا تطلب الحقول الإضافية إلا إذا كان الحقل "GMSPlace" لا يحتوي على جميع الحقول اللازمة، وإلّا سيتم عرض GMSPlaceOpenStatus في معاودة الاتصال على الفور. لا تؤدي هذه الطريقة إلى الحظر.

المَعلمات:
مكانGMSPlace المطلوب البحث عنها.
معاودة الاتصالمعاودة الاتصال للاستدعاء بنتيجة المكان.
- (خالية) isOpenWithPlace: (GMSPlace *) مكان
التاريخ: (NSDate *) التاريخ
معاودة الاتصال: (GMSPlaceOpenStatusCallback) معاودة الاتصال

للحصول على تفاصيل عن مكان، بما في ذلك جميع الحقول اللازمة لتحديد GMSPlaceOpenStatus في NSDate المحدَّد

لا تطلب الحقول الإضافية إلا إذا كان الحقل "GMSPlace" لا يحتوي على جميع الحقول اللازمة، وإلّا سيتم عرض GMSPlaceOpenStatus في معاودة الاتصال على الفور. لا تؤدي هذه الطريقة إلى الحظر.

المَعلمات:
مكانGMSPlace المطلوب البحث عنها.
التاريختعرض هذه السمة NSDate لتحديد حالة الفتح.
معاودة الاتصالمعاودة الاتصال للاستدعاء بنتيجة المكان.
- (ملء) searchByTextWithRequest: (GMSPlaceSearchByTextRequest *) textSearchRequest
معاودة الاتصال: (GMSPlaceSearchByTextResultCallback) معاودة الاتصال

البحث عن الأماكن حسب النص والقيود

لا تؤدي هذه الطريقة إلى الحظر.

المَعلمات:
textSearchRequestGMSPlaceSearchByTextRequest تمثّل هذه السمة الطلب النصي الذي سيتم استخدامه لطلب البحث.
معاودة الاتصالمعاودة الاتصال المطلوب استدعائها بنتيجة البحث.

- (typedef الأحدث(^ GMSPlaceResultCallback)(GMSPlace *_Nullable result, NSError *_Nullable error)) [related]

نوع معاودة الاتصال لتلقّي عمليات البحث عن تفاصيل المكان.

إذا حدث خطأ، فسيكون result فارغًا وسيحتوي error على معلومات حول الخطأ.

المَعلمات:
نتيجةتمثّل هذه السمة GMSPlace التي تم إرجاعها.
خطأالخطأ الذي حدث، إن وجد.
- (typedef الأحدث(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_NullableposeList, NSError *_Nullable error)) [related]

نوع معاودة الاتصال لتلقّي قوائم احتمالية الأماكن.

إذا حدث خطأ، فسيكون likelihoodList فارغًا وسيحتوي error على معلومات حول الخطأ.

المَعلمات:
likelihoodListتمثّل هذه السمة قائمة باحتمالات الأماكن.
خطأالخطأ الذي حدث، إن وجد.
- (typedef false(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable رغبةs, NSError *_Nullable error)) [related]

نوع معاودة الاتصال لاستلام مصفوفة من GMSPlaceLikelihoods.

وإذا حدث خطأ، ستكون الصفيفة فارغة وستتضمّن السمة error معلومات حول الخطأ.

- (typedef vit(^ GMSAutocompletePredictionsCallback)(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable error)) [related]

نوع معاودة الاتصال لتلقّي نتائج الإكمال التلقائي.

results هي مصفوفة من GMSAutocompleteForecastions التي تمثل إكمالات مرشحة لطلب البحث.

المَعلمات:
النتائجمصفوفة من GMSAutocompletePrediction.
خطأالخطأ الذي حدث، إن وجد.
- (typedef mut(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

نوع معاودة الاتصال لتلقي نتائج صور الأماكن.

إذا حدث خطأ، فسيكون photos فارغًا وسيحتوي error على معلومات حول الخطأ.

المَعلمات:
صورتتضمن النتيجة عنصرَين (GMSPlacePhotoMetadata).
خطأالخطأ الذي حدث، إن وجد.
- (typedef mut(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photos, NSError *_Nullable error)) [related]

نوع معاودة الاتصال لاستلام عناصر UIImage من عنصر GMSPlacePhotoMetadata

إذا حدث خطأ، فسيكون photo فارغًا وسيحتوي error على معلومات حول الخطأ.

المَعلمات:
صورةUIImage الذي تم تحميله.
خطأالخطأ الذي حدث، إن وجد.
- (typedef الأحدث(^ GMSPlaceOpenStatusCallback)(نتيجة GMSPlaceOpenStatus, NSError *_Nullable error)) [related]

نوع معاودة الاتصال لتلقي حالة ساعات العمل للمكان.

في حال حدوث خطأ، ستكون حالة result GMSPlaceOpenStatusUnknown (والمكانة المفتوحة هنا: error) وستحتوي على معلومات حول الخطأ.

المَعلمات:
نتيجةتمثّل هذه السمة GMSPlaceOpenStatus التي تم إرجاعها.
خطأالخطأ الذي حدث، إن وجد.
- (typedef mut(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

نوع معاودة الاتصال لتلقّي البحث حسب النتائج النصية.

results هو مصفوفة من GMSPlace تمثل نتائج فردية تطابق طلب البحث.

المَعلمات:
النتائجمصفوفة من GMSPlace.
خطأالخطأ الذي حدث، إن وجد.