@azure-rest/maps-search package

عنوان النتيجة

GeoJSON GeocodingFeature العنصر الذي يصف حدود منطقة جغرافية. يتم وصف هندسة الميزة مع GeoJSON GeometryCollection.

يرجى ملاحظة أن الخدمة عادة ما ترجع GeometryCollection مع أنواع فرعية مضلع أو متعددPolygon.

خصائص عنصر الحدود.

خطأ إدارة الموارد معلومات إضافية.

تفاصيل الخطأ.

استجابة الخطأ الشائعة لجميع واجهات برمجة تطبيقات Azure Resource Manager لإرجاع تفاصيل الخطأ للعمليات الفاشلة. (يتبع هذا أيضا تنسيق استجابة خطأ OData.).

نوع كائن GeoJSON FeatureCollection صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

نوع كائن GeoJSON Feature صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

نوع كائن GeoJSON GeometryCollection صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

عنصر هندسي GeoJSON صالح. يجب أن يكون النوع أحد أنواع هندسة GeoJSON السبعة الصالحة - Point و MultiPoint و LineString و MultiLineString و Polygon و MultiPolygon و GeometryCollection. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

نوع هندسي GeoJSON LineString صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

نوع هندسي GeoJSON MultiLineString صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

البيانات التي يحتوي عليها GeoJson MultiPoint.

نوع هندسي GeoJSON MultiPoint صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

نوع كائن GeoJSON MultiPolygon صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

كائن GeoJSON صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

البيانات التي يحتوي عليها GeoJson Point.

نوع هندسي GeoJSON Point صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

نوع هندسي GeoJSON Polygon صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

قائمة استعلامات/طلبات الترميز الجغرافي للعنوان لمعالجتها. يمكن أن تحتوي القائمة على 100 استعلام كحد أقصى ويجب أن تحتوي على استعلام 1 على الأقل.

كائن استعلام الدفعة

يتم إرجاع هذا الكائن من استدعاء خدمة Geocoding Batch ناجح.

ملخص لطلب الدفعة

يتم إرجاع هذا الكائن من مكالمة ترميز جغرافي ناجحة

معلومات حقوق النشر لهندسة عنصر حدي.

عنوان النتيجة.

المعلمات الاختيارية للعميل

قائمة استعلامات/طلبات الترميز الجغرافي العكسي لمعالجتها. يمكن أن تحتوي القائمة على 100 استعلام كحد أقصى ويجب أن تحتوي على استعلام 1 على الأقل.

كائن استعلام الدفعة

Get Geocoding API هو طلب GET HTTP يرجع إحداثيات خط الطول وخط العرض للموقع الذي يتم البحث فيه.

في كثير من الحالات، قد تكون خدمة البحث الكاملة أكثر من اللازم، على سبيل المثال إذا كنت مهتما فقط بالترميز الجغرافي التقليدي. يمكن أيضا الوصول إلى البحث للبحث عن العنوان حصريا. يتم تنفيذ الترميز الجغرافي عن طريق الوصول إلى نقطة نهاية الترميز الجغرافي بالعنوان أو العنوان الجزئي المعني فقط. سيتم الاستعلام عن فهرس البحث عن الترميز الجغرافي عن كل شيء فوق بيانات مستوى الشارع. لن يتم إرجاع أي نقطة اهتمام (POIs). لاحظ أن أداة الترميز الجغرافي متسامحة جدا مع الأخطاء الكتابية والعناوين غير المكتملة. كما سيتعامل مع كل شيء من عناوين الشوارع أو الشوارع أو التقاطعات الدقيقة بالإضافة إلى المناطق الجغرافية ذات المستوى الأعلى مثل مراكز المدن والمقاطعات والولايات. تقوم الاستجابة أيضا بإرجاع خصائص العنوان التفصيلية مثل الشارع والرمز البريدي والبلدية ومعلومات البلد/المنطقة.

واجهة برمجة تطبيقات Get Geocoding Batch هي طلب POST HTTP يرسل دفعات تصل إلى 100 استعلامات إلى Geocoding API في طلب واحد.

إرسال طلب دفعي متزامن

يوصى باستخدام واجهة برمجة التطبيقات المتزامنة لطلبات الدفعات الخفيفة. عندما تتلقى الخدمة طلبا، سوف تستجيب بمجرد حساب عناصر الدفعة ولن تكون هناك إمكانية لاسترداد النتائج لاحقا. سترجع واجهة برمجة التطبيقات المتزامنة خطأ مهلة (استجابة 408) إذا استغرق الطلب أكثر من 60 ثانية. يقتصر عدد عناصر الدفعات على 100 لواجهة برمجة التطبيقات هذه.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

نص POST لطلب الدفعة

لإرسال استعلامات الترميز الجغرافي ستستخدم طلب حيث سيحتوي نص الطلب على صفيف بتنسيق وسيتم تعيين عنوان إلى . فيما يلي نموذج نص طلب يحتوي على استعلامات ترميز جغرافي :

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

يمكن أن يقبل كائن الترميز الجغرافي batchItem أيا من معلمات URIالترميز الجغرافي المدعومة.

يجب أن تحتوي الدفعة على استعلام على الأقل.

نموذج استجابة الدفعة

تحتوي استجابة الدفعة على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequests أي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. كل عنصر من أحد الأنواع التالية:

• GeocodingResponse - إذا اكتمل الاستعلام بنجاح.

• Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

واجهة برمجة تطبيقات Get Geocoding Batch هي طلب POST HTTP يرسل دفعات تصل إلى 100 استعلامات إلى Geocoding API في طلب واحد.

إرسال طلب دفعي متزامن

يوصى باستخدام واجهة برمجة التطبيقات المتزامنة لطلبات الدفعات الخفيفة. عندما تتلقى الخدمة طلبا، سوف تستجيب بمجرد حساب عناصر الدفعة ولن تكون هناك إمكانية لاسترداد النتائج لاحقا. سترجع واجهة برمجة التطبيقات المتزامنة خطأ مهلة (استجابة 408) إذا استغرق الطلب أكثر من 60 ثانية. يقتصر عدد عناصر الدفعات على 100 لواجهة برمجة التطبيقات هذه.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

نص POST لطلب الدفعة

لإرسال استعلامات الترميز الجغرافي ستستخدم طلب حيث سيحتوي نص الطلب على صفيف بتنسيق وسيتم تعيين عنوان إلى . فيما يلي نموذج نص طلب يحتوي على استعلامات ترميز جغرافي :

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

يمكن أن يقبل كائن الترميز الجغرافي batchItem أيا من معلمات URIالترميز الجغرافي المدعومة.

يجب أن تحتوي الدفعة على استعلام على الأقل.

نموذج استجابة الدفعة

تحتوي استجابة الدفعة على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequests أي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. كل عنصر من أحد الأنواع التالية:

• GeocodingResponse - إذا اكتمل الاستعلام بنجاح.

• Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

Get Geocoding API هو طلب GET HTTP يرجع إحداثيات خط الطول وخط العرض للموقع الذي يتم البحث فيه.

في كثير من الحالات، قد تكون خدمة البحث الكاملة أكثر من اللازم، على سبيل المثال إذا كنت مهتما فقط بالترميز الجغرافي التقليدي. يمكن أيضا الوصول إلى البحث للبحث عن العنوان حصريا. يتم تنفيذ الترميز الجغرافي عن طريق الوصول إلى نقطة نهاية الترميز الجغرافي بالعنوان أو العنوان الجزئي المعني فقط. سيتم الاستعلام عن فهرس البحث عن الترميز الجغرافي عن كل شيء فوق بيانات مستوى الشارع. لن يتم إرجاع أي نقطة اهتمام (POIs). لاحظ أن أداة الترميز الجغرافي متسامحة جدا مع الأخطاء الكتابية والعناوين غير المكتملة. كما سيتعامل مع كل شيء من عناوين الشوارع أو الشوارع أو التقاطعات الدقيقة بالإضافة إلى المناطق الجغرافية ذات المستوى الأعلى مثل مراكز المدن والمقاطعات والولايات. تقوم الاستجابة أيضا بإرجاع خصائص العنوان التفصيلية مثل الشارع والرمز البريدي والبلدية ومعلومات البلد/المنطقة.

واجهة برمجة تطبيقات Get Polygon عبارة عن طلب GET HTTP يوفر بيانات مضلعة لمخطط منطقة جغرافية مثل مدينة أو منطقة بلد.

واجهة برمجة تطبيقات Get Polygon عبارة عن طلب GET HTTP يوفر بيانات مضلعة لمخطط منطقة جغرافية مثل مدينة أو منطقة بلد.

Get Reverse Geocoding API هو طلب GET HTTP يستخدم لترجمة إحداثيات (مثال: 37.786505، -122.3862) إلى عنوان شارع يمكن فهمه من قبل الإنسان. مفيدة في تتبع التطبيقات حيث تتلقى موجز GPS من الجهاز أو الأصل وترغب في معرفة العنوان المرتبط الإحداثيات. سترجع نقطة النهاية هذه معلومات العنوان لإحداثيات معينة.

واجهة برمجة تطبيقات Get Reverse Geocoding Batch هي طلب POST HTTP يرسل دفعات تصل إلى 100 استعلامات إلى عكس الترميز الجغرافي API باستخدام طلب واحد.

إرسال طلب دفعي متزامن

يوصى باستخدام واجهة برمجة التطبيقات المتزامنة لطلبات الدفعات الخفيفة. عندما تتلقى الخدمة طلبا، سوف تستجيب بمجرد حساب عناصر الدفعة ولن تكون هناك إمكانية لاسترداد النتائج لاحقا. سترجع واجهة برمجة التطبيقات المتزامنة خطأ مهلة (استجابة 408) إذا استغرق الطلب أكثر من 60 ثانية. يقتصر عدد عناصر الدفعات على 100 لواجهة برمجة التطبيقات هذه.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

نص POST لطلب الدفعة

لإرسال استعلامات الترميز الجغرافي العكسي ستستخدم طلب حيث سيحتوي نص الطلب على صفيف بتنسيق وسيتم تعيين عنوان إلى . فيما يلي نموذج نص طلب يحتوي على استعلامات ترميز جغرافي عكسي :

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

يمكن لعنصر الترميز الجغرافي العكسي batchItem قبول أي من معلمات الترميز الجغرافي العكسي المدعومةURI.

يجب أن تحتوي الدفعة على استعلام على الأقل.

نموذج استجابة الدفعة

تحتوي استجابة الدفعة على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequests أي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. كل عنصر من أحد الأنواع التالية:

• GeocodingResponse - إذا اكتمل الاستعلام بنجاح.

• Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

واجهة برمجة تطبيقات Get Reverse Geocoding Batch هي طلب POST HTTP يرسل دفعات تصل إلى 100 استعلامات إلى عكس الترميز الجغرافي API باستخدام طلب واحد.

إرسال طلب دفعي متزامن

يوصى باستخدام واجهة برمجة التطبيقات المتزامنة لطلبات الدفعات الخفيفة. عندما تتلقى الخدمة طلبا، سوف تستجيب بمجرد حساب عناصر الدفعة ولن تكون هناك إمكانية لاسترداد النتائج لاحقا. سترجع واجهة برمجة التطبيقات المتزامنة خطأ مهلة (استجابة 408) إذا استغرق الطلب أكثر من 60 ثانية. يقتصر عدد عناصر الدفعات على 100 لواجهة برمجة التطبيقات هذه.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

نص POST لطلب الدفعة

لإرسال استعلامات الترميز الجغرافي العكسي ستستخدم طلب حيث سيحتوي نص الطلب على صفيف بتنسيق وسيتم تعيين عنوان إلى . فيما يلي نموذج نص طلب يحتوي على استعلامات ترميز جغرافي عكسي :

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

يمكن لعنصر الترميز الجغرافي العكسي batchItem قبول أي من معلمات الترميز الجغرافي العكسي المدعومةURI.

يجب أن تحتوي الدفعة على استعلام على الأقل.

نموذج استجابة الدفعة

تحتوي استجابة الدفعة على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequests أي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. كل عنصر من أحد الأنواع التالية:

• GeocodingResponse - إذا اكتمل الاستعلام بنجاح.

• Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

Get Reverse Geocoding API هو طلب GET HTTP يستخدم لترجمة إحداثيات (مثال: 37.786505، -122.3862) إلى عنوان شارع يمكن فهمه من قبل الإنسان. مفيدة في تتبع التطبيقات حيث تتلقى موجز GPS من الجهاز أو الأصل وترغب في معرفة العنوان المرتبط الإحداثيات. سترجع نقطة النهاية هذه معلومات العنوان لإحداثيات معينة.

نوع كائن GeoJSON Feature صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

عنصر هندسي GeoJSON صالح. يجب أن يكون النوع أحد أنواع هندسة GeoJSON السبعة الصالحة - Point و MultiPoint و LineString و MultiLineString و Polygon و MultiPolygon و GeometryCollection. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

كائن GeoJSON صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.

إنشاء مثيل MapsSearchClient من مفتاح اشتراك.

مثال

import { AzureKeyCredential } from "@azure/core-auth";
import MapsSearch from "@azure-rest/maps-search";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);

إنشاء مثيل MapsSearch من Azure Identity TokenCredential.

مثال

import { DefaultAzureCredential } from "@azure/identity";
import MapsSearch from "@azure-rest/maps-search";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");

إنشاء مثيل MapsSearch من Azure Identity AzureSASCredential.

مثال

import { AzureSASCredential } from "@azure/core-auth";
import MapsSearch from "@azure-rest/maps-search";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);