Bing مرجع v7 لواجهة برمجة تطبيقات البحث عن الأعمال المحلية

مقالة
04/27/2022
قراءة خلال 16 دقائق

تحذير

في 30 أكتوبر 2020، انتقلت واجهات برمجة تطبيقات البحث Bing من الخدمات المعرفية إلى خدمات البحث Bing. يتم توفير هذه الوثائق للرجوع إليها فقط. للحصول على الوثائق المحدثة، راجع وثائق واجهة برمجة تطبيقات البحث Bing. للحصول على إرشادات حول إنشاء موارد Azure جديدة للبحث Bing، راجع إنشاء مورد بحث Bing خلال Azure Marketplace.

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

يوفر هذا القسم تفاصيل فنية حول كائنات الاستجابة ومعلمات الاستعلام والرؤوس التي تؤثر على نتائج البحث. للحصول على أمثلة توضح كيفية تقديم الطلبات، راجع البدء السريع لبحث الأعمال المحلي C#‎ أو التشغيل السريع لبحث الأعمال المحلية في Java.

للحصول على معلومات حول الرؤوس التي يجب أن تتضمنها الطلبات، راجع الرؤوس.

للحصول على معلومات حول معلمات الاستعلام التي يجب أن تتضمنها الطلبات، راجع معلمات الاستعلام.

للحصول على معلومات حول كائنات JSON التي تتضمنها الاستجابة، راجع كائنات الاستجابة.

للحصول على معلومات حول الاستخدام المسموح به للنتائج وعرضها، راجع متطلبات الاستخدام والعرض.

نقطة النهاية

لطلب نتائج الأعمال المحلية، أرسل طلب GET إلى:

https://api.cognitive.microsoft.com/bing/v7.0/localbusinesses/search

يجب أن يستخدم الطلب بروتوكول HTTPS.

ملاحظة

الحد الأقصى لطول عنوان URL هو 2048 حرفا. لضمان عدم تجاوز طول عنوان URL الحد، يجب أن يكون الحد الأقصى لطول معلمات طلب البحث أقل من 1500 حرف. إذا تجاوز عنوان URL 2048 حرفا، فسيرجع الخادم 404 لم يتم العثور عليه.

الرؤوس

فيما يلي الرؤوس التي قد يتضمنها الطلب والاستجابة.

الرأس	الوصف
قبول	رأس طلب اختياري. نوع الوسائط الافتراضي هو application/json. لتحديد أن الاستجابة تستخدم JSON-LD، قم بتعيين رأس القبول إلى التطبيق/ld+json.
قبول اللغة	رأس طلب اختياري. قائمة باللغات المحددة بفواصل لاستخدامها في سلاسل واجهة المستخدم. القائمة بترتيب تفضيلي متناقص. لمزيد من المعلومات، بما في ذلك التنسيق المتوقع، راجع RFC2616. هذا الرأس ومعلمة استعلام setLang يستبعدان بعضهما البعض - لا تحدد كليهما. إذا قمت بتعيين هذا الرأس، يجب عليك أيضا تحديد معلمة استعلام cc. لتحديد السوق لإرجاع النتائج ، يستخدم Bing اللغة المدعومة الأولى التي يجدها من القائمة ويجمعها مع قيمة المعلمة`cc`. إذا كانت القائمة لا تتضمن لغة مدعومة، Bing العثور على أقرب لغة وسوق يدعم الطلب أو يستخدم سوقا مجمعة أو افتراضية للنتائج. لتحديد السوق الذي Bing استخدامه، راجع رأس BingAPIs-Market. استخدم هذا الرأس ومعلمة الاستعلام `cc` فقط إذا قمت بتحديد لغات متعددة. وإلا، استخدم معلمات استعلام mkt و setLang . سلسلة واجهة المستخدم هي سلسلة يتم استخدامها كتسمية في واجهة المستخدم. هناك عدد قليل من سلاسل واجهة المستخدم في كائنات استجابة JSON. أي ارتباطات إلى خصائص Bing.com في كائنات الاستجابة تطبق اللغة المحددة.
BingAPIs-Market	عنوان الاستجابة. السوق المستخدم من قبل الطلب. النموذج هو <اللغةرمز>< البلد>. على سبيل المثال ، en-US.
BingAPIs-TraceId	عنوان الاستجابة. معرف إدخال السجل الذي يحتوي على تفاصيل الطلب. عند حدوث خطأ، التقط هذا المعرف. إذا لم تتمكن من تحديد المشكلة وحلها، فقم بتضمين هذا المعرف إلى جانب المعلومات الأخرى التي تقدمها لفريق الدعم.
Ocp-Apim-Subscription-Key	رأس الطلب المطلوب. مفتاح الاشتراك الذي تلقيته عند الاشتراك في هذه الخدمة في الخدمات المعرفية.
براغما	رأس طلب اختياري بشكل افتراضي، Bing بإرجاع المحتوى المخزن مؤقتا، إن وجد. لمنع Bing من إرجاع المحتوى المخزن مؤقتا، اضبط رأس Pragma على عدم وجود ذاكرة تخزين مؤقت (على سبيل المثال، Pragma: بدون ذاكرة تخزين مؤقت).
وكيل المستخدم	رأس طلب اختياري. وكيل المستخدم الذي أنشأ الطلب. يستخدم Bing وكيل المستخدم لتزويد مستخدمي الأجهزة المحمولة بتجربة محسنة. على الرغم من أنه اختياري ، إلا أنه يتم تشجيعك دائما على تحديد هذا الرأس. يجب أن يكون وكيل المستخدم هو نفس السلسلة التي يرسلها أي متصفح شائع الاستخدام. للحصول على معلومات حول وكلاء المستخدمين، راجع RFC 2616. فيما يلي أمثلة على سلاسل وكيل المستخدم. Windows Phone—موزيلا/5.0 (متوافق; MSIE 10.0; Windows Phone 8.0; ترايدنت / 6.0 ؛ IEMobile/10.0; ذراع. اللمس. نوكيا. لوميا 822) أندرويد—موزيلا/5.0 (لينكس; U; أندرويد 2.3.5; en-us; SCH-i500 Build/GINGERBREAD) AppleWebKit/533.1 (KHTML؛ مثل Gecko) الإصدار/4.0 Mobile Safari/533.1 iPhone—موزيلا/5.0 (iPhone; وحدة المعالجة المركزية iPhone OS 6_1 مثل نظام التشغيل Mac OS X) AppleWebKit/536.26 (KHTML؛ مثل Gecko) Mobile/10B142 iPhone4;1 BingWeb/3.03.1428.20120423 الكمبيوتر الشخصي - موزيلا / 5.0 (Windows NT 6.3 ؛ نجاح باهر64; ترايدنت / 7.0 ؛ اللمس. rv: 11.0) مثل أبو بريص iPad—موزيلا/5.0 (iPad; وحدة المعالجة المركزية OS 7_0 مثل نظام التشغيل Mac OS X) AppleWebKit/537.51.1 (KHTML، مثل Gecko) الإصدار/7.0 الجوال/11A465 Safari/9537.53
X-MSEdge-ClientID	رأس طلب واستجابة اختياري. يستخدم Bing هذا الرأس لتزويد المستخدمين بسلوك متسق عبر مكالمات واجهة برمجة التطبيقات Bing. غالبا ما Bing رحلات جوية إلى ميزات وتحسينات جديدة ، ويستخدم معرف العميل كمفتاح لتعيين حركة المرور على رحلات مختلفة. إذا كنت لا تستخدم نفس معرف العميل لمستخدم عبر طلبات متعددة، فقد Bing تعيين المستخدم لعدة رحلات متعارضة. يمكن أن يؤدي التعيين في رحلات متضاربة متعددة إلى تجربة مستخدم غير متناسقة. على سبيل المثال، إذا كان الطلب الثاني يحتوي على مهمة طيران مختلفة عن الأول، فقد تكون التجربة غير متوقعة. أيضا ، يمكن Bing استخدام معرف العميل لتخصيص نتائج الويب لسجل بحث معرف العميل هذا ، مما يوفر تجربة أكثر ثراء للمستخدم. يستخدم Bing أيضا هذا الرأس للمساعدة في تحسين تصنيفات النتائج من خلال تحليل النشاط الذي تم إنشاؤه بواسطة معرف العميل. تساعد تحسينات الصلة في تحسين جودة النتائج التي تقدمها واجهات برمجة التطبيقات Bing وبالتالي تتيح معدلات نقر إلى ظهور أعلى لمستهلك واجهة برمجة التطبيقات. مهم: على الرغم من أنه اختياري ، يجب أن تفكر في هذا الرأس مطلوب. يتيح استمرار معرف العميل عبر طلبات متعددة لنفس المستخدم النهائي ومجموعة الأجهزة 1) مستهلك واجهة برمجة التطبيقات من الحصول على تجربة مستخدم متسقة ، و 2) معدلات نقر إلى ظهور أعلى من خلال جودة أفضل للنتائج من واجهات برمجة التطبيقات Bing. فيما يلي قواعد الاستخدام الأساسية التي تنطبق على هذا الرأس. يجب أن يكون لكل مستخدم يستخدم تطبيقك على الجهاز معرف عميل فريد تم إنشاؤه Bing. إذا لم تقم بتضمين هذا الرأس في الطلب، Bing بإنشاء معرف وإرجاعه في رأس استجابة X-MSEdge-ClientID. المرة الوحيدة التي يجب ألا تتضمن فيها هذا الرأس في طلب هي المرة الأولى التي يستخدم فيها المستخدم تطبيقك على هذا الجهاز. استخدم معرف العميل لكل طلب واجهة برمجة تطبيقات Bing يقدمه تطبيقك لهذا المستخدم على الجهاز. اهتمام: يجب عليك التأكد من أن معرف العميل هذا غير قابل للربط بأي معلومات حساب مستخدم قابلة للتصديق. استمر معرف العميل. لاستمرار المعرف في تطبيق متصفح، استخدم ملف تعريف ارتباط HTTP دائم لضمان استخدام المعرف عبر جميع الجلسات. لا تستخدم ملف تعريف ارتباط الجلسة. بالنسبة إلى التطبيقات الأخرى مثل تطبيقات الأجهزة المحمولة، استخدم مساحة التخزين المستمرة للجهاز لاستمرار المعرف. في المرة التالية التي يستخدم فيها المستخدم تطبيقك على هذا الجهاز، احصل على معرف العميل الذي استمريت فيه. ملاحظة: قد تتضمن استجابات Bing أو لا تتضمن هذا العنوان. إذا كانت الاستجابة تتضمن هذا الرأس، فقم بالتقاط معرف العميل واستخدامه لجميع طلبات Bing اللاحقة للمستخدم على هذا الجهاز. ملاحظه: إذا قمت بتضمين X-MSEdge-ClientID، فيجب عليك عدم تضمين ملفات تعريف الارتباط في الطلب.
X-MSEdge-ClientIP	رأس طلب اختياري. عنوان IPv4 أو IPv6 للجهاز العميل. يتم استخدام عنوان IP لاكتشاف موقع المستخدم. يستخدم Bing معلومات الموقع لتحديد سلوك البحث الآمن. ملاحظه: على الرغم من أنه اختياري، إلا أنه يتم تشجيعك دائما على تحديد هذا الرأس ورأس X-Search-Location. لا تشوش العنوان (على سبيل المثال، عن طريق تغيير آخر ثماني سنوات إلى 0). يؤدي التعتيم على العنوان إلى عدم وجود الموقع في أي مكان بالقرب من الموقع الفعلي للجهاز، مما قد يؤدي إلى Bing تقديم نتائج خاطئة.
X-البحث-الموقع	رأس طلب اختياري. قائمة محددة بفاصلة منقوطة لأزواج المفاتيح/القيم التي تصف الموقع الجغرافي للعميل. يستخدم Bing معلومات الموقع لتحديد سلوك البحث الآمن وإرجاع المحتوى المحلي ذي الصلة. حدد زوج المفتاح/القيمة كمفتاح<>:<قيمة>. فيما يلي المفاتيح التي تستخدمها لتحديد موقع المستخدم. lat—خط عرض موقع العميل، بالدرجات. يجب أن يكون خط العرض أكبر من أو يساوي -90.0 وأقل من أو يساوي +90.0. تشير القيم السلبية إلى خطوط العرض الجنوبية وتشير القيم الإيجابية إلى خطوط العرض الشمالية. طويل - خط طول موقع العميل ، بالدرجات. يجب أن يكون خط الطول أكبر من أو يساوي -180.0 وأقل من أو يساوي +180.0. تشير القيم السلبية إلى خطوط الطول الغربية وتشير القيم الإيجابية إلى خطوط الطول الشرقية. re— نصف القطر، بالأمتار، والذي يحدد الدقة الأفقية للإحداثيات. مرر القيمة التي تم إرجاعها بواسطة خدمة الموقع الخاصة بالجهاز. قد تكون القيم النموذجية 22 مترا لنظام تحديد المواقع العالمي (GPS/Wi-Fi)، و380 مترا لتثليث البرج الخلوي، و18000 مترا للبحث العكسي عن عناوين IP. ts— التوقيت العالمي المنسق UNIX الطابع الزمني عندما كان العميل في الموقع. (الطابع الزمني UNIX هو عدد الثواني منذ 1 يناير 1970.) الرأس—اختياري. العنوان النسبي للعميل أو اتجاه السفر. حدد اتجاه السفر كدرجات من 0 إلى 360، مع حساب اتجاه عقارب الساعة بالنسبة إلى الشمال الحقيقي. حدد هذا المفتاح فقط إذا كان `sp` المفتاح غير صفري. sp—السرعة الأفقية (السرعة)، بالأمتار في الثانية، التي يسلكها الجهاز العميل. alt—ارتفاع الجهاز العميل، بالأمتار. هي—اختياري. نصف القطر ، بالأمتار ، الذي يحدد الدقة الرأسية للإحداثيات. نصف القطر افتراضي إلى 50 كيلومترا. حدد هذا المفتاح فقط إذا قمت بتحديد المفتاح `alt` . ملاحظه: على الرغم من أن هذه المفاتيح اختيارية، إلا أنه كلما زادت المعلومات التي تقدمها، زادت دقة نتائج الموقع. ملاحظه: نشجعك دائما على تحديد الموقع الجغرافي للمستخدم. يعد توفير الموقع مهما بشكل خاص إذا كان عنوان IP الخاص بالعميل لا يعكس بدقة الموقع الفعلي للمستخدم (على سبيل المثال ، إذا كان العميل يستخدم VPN). للحصول على أفضل النتائج، يجب تضمين هذا الرأس ورأس X-MSEdge-ClientIP، ولكن على الأقل، يجب تضمين هذا الرأس.

ملاحظة

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

معلمات الاستعلام

قد يتضمن الطلب معلمات الاستعلام التالية. راجع العمود مطلوب للاطلاع على المعلمات المطلوبة. يجب عليك ترميز URL لمعلمات الاستعلام.

الاسم	القيمة	النوع	مطلوب
عد	عدد النتائج المراد إرجاعها ، بدءا من الفهرس المحدد بواسطة المعلمة `offset` .	سلسلة	لا
محليالفئات	قائمة بالخيارات التي تحدد البحث حسب فئة النشاط التجاري. الاطلاع على البحث عن فئات الأنشطة التجارية المحلية	سلسلة	لا
مكت	السوق الذي تأتي منه النتائج. للحصول على قائمة بقيم السوق المحتملة، راجع رموز السوق. ملاحظه: تدعم واجهة برمجة تطبيقات البحث عن الأنشطة التجارية المحلية حاليا السوق واللغة الخاصة بنا فقط.	سلسلة	نعم
إزاحة	الفهرس لبدء النتائج المحددة بواسطة المعلمة `count` .	عدد صحيح	لا
q	مصطلح بحث المستخدم.	سلسلة	لا
الاستجابةتنسيق	نوع الوسائط المطلوب استخدامه للاستجابة. فيما يلي القيم المحتملة غير الحساسة لحالة الأحرف. JSON جسونلد الافتراضي هو JSON. للحصول على معلومات حول كائنات JSON التي تحتوي عليها الاستجابة، راجع كائنات الاستجابة. إذا قمت بتحديد JsonLd، فإن نص الاستجابة يتضمن كائنات JSON-LD التي تحتوي على نتائج البحث. للحصول على معلومات حول JSON-LD، راجع JSON-LD.	سلسلة	لا
البحث الآمن	فلتر يستخدم لتصفية محتوى البالغين. فيما يلي قيم عوامل التصفية المحتملة غير الحساسة لحالة الأحرف. إيقاف التشغيل—لعرض صفحات الويب التي تحتوي على نصوص أو صور أو مقاطع فيديو للبالغين. معتدل: يمكنك عرض صفحات الويب التي تحتوي على نص للبالغين، ولكن ليس الصور أو مقاطع الفيديو للبالغين. صارم: لا تعرض صفحات الويب التي تحتوي على نصوص أو صور أو مقاطع فيديو للبالغين. الافتراضي هو معتدل. ملاحظه: إذا كان الطلب يأتي من سوق تتطلب `safeSearch` سياسة البالغين الخاصة Bing تعيينه إلى صارم، Bing يتجاهل `safeSearch` القيمة ويستخدم Strict. ملاحظه: إذا كنت تستخدم عامل تشغيل الاستعلام، فهناك احتمال أن تحتوي الاستجابة على محتوى للبالغين بغض النظر عن معلمة الاستعلام `site:` التي `safeSearch` تم تعيينها إليها. استخدم `site:` فقط إذا كنت على دراية بالمحتوى الموجود على الموقع ويدعم السيناريو الخاص بك إمكانية وجود محتوى للبالغين.	سلسلة	لا
سيتلانغ	اللغة التي يجب استخدامها لسلاسل واجهة المستخدم. حدد اللغة باستخدام رمز اللغة ISO 639-1 المكون من حرفين. على سبيل المثال، رمز اللغة للغة الإنجليزية هو EN. الافتراضي هو EN (الإنجليزية). على الرغم من أنه اختياري ، يجب عليك دائما تحديد اللغة. عادة، يمكنك تعيين `setLang` إلى نفس اللغة المحددة من قبل `mkt` ما لم يرغب المستخدم في عرض سلاسل واجهة المستخدم بلغة مختلفة. هذه المعلمة ورأس لغة القبول يستبعد أحدهما الآخر - لا تحدد كليهما. سلسلة واجهة المستخدم هي سلسلة يتم استخدامها كتسمية في واجهة المستخدم. هناك عدد قليل من سلاسل واجهة المستخدم في كائنات استجابة JSON. أيضا، أي ارتباطات إلى خصائص Bing.com في كائنات الاستجابة تطبيق اللغة المحددة.	سلسلة	لا

كائنات الاستجابة

فيما يلي كائنات استجابة JSON التي قد تتضمنها الاستجابة. إذا نجح الطلب، فإن كائن المستوى الأعلى في الاستجابة هو كائن SearchResponse . في حالة فشل الطلب، يكون كائن المستوى الأعلى هو كائن ErrorResponse .

عنصر	الوصف
مكان	يحدد معلومات حول نشاط تجاري محلي مثل مطعم أو فندق.

خطأ

يحدد الخطأ الذي حدث.

العنصر	الوصف	النوع
رمز	رمز الخطأ الذي يحدد فئة الخطأ. للحصول على قائمة بالرموز المحتملة، راجع رموز الخطأ.	سلسلة
رسالة	وصف للخطأ.	سلسلة
المزيدتفاصيل	وصف يوفر معلومات إضافية حول الخطأ.	سلسلة
البارامتر	معلمة الاستعلام في الطلب الذي تسبب في الخطأ.	سلسلة
الرمز الفرعي	رمز الخطأ الذي يحدد الخطأ. على سبيل المثال، إذا كان `code` InvalidRequest، `subCode` قد يكون ParameterInvalid أو ParameterInvalidValue.	سلسلة
قيمة	قيمة معلمة الاستعلام التي لم تكن صالحة.	سلسلة

ErrorResponse

كائن المستوى الأعلى الذي تتضمنه الاستجابة عند فشل الطلب.

الاسم	القيمة	النوع
_type	اكتب تلميحا.	سلسلة
اخطاء	قائمة بالأخطاء التي تصف أسباب فشل الطلب.	خطأ[]

الترخيص

يحدد الترخيص الذي يمكن بموجبه استخدام النص أو الصورة.

الاسم	القيمة	النوع
الاسم	اسم الترخيص.	سلسلة
عنوان url	عنوان URL لموقع ويب حيث يمكن للمستخدم الحصول على مزيد من المعلومات حول الترخيص. استخدم الاسم وعنوان URL لإنشاء ارتباط تشعبي.	سلسلة

الرابط

يحدد مكونات الارتباط التشعبي.

الاسم	القيمة	النوع
_type	اكتب تلميحا.	سلسلة
نص	نص العرض.	سلسلة
عنوان url	عنوان URL. استخدم عنوان URL وعرض النص لإنشاء ارتباط تشعبي.	سلسلة

المؤسسة

تعريف الناشر.

لاحظ أن الناشر قد يقدم اسمه أو موقعه على الويب أو كليهما.

الاسم	القيمة	النوع
الاسم	اسم الناشر.	سلسلة
عنوان url	عنوان URL لموقع الناشر على الويب. لاحظ أن الناشر قد لا يوفر موقعا إلكترونيا.	سلسلة

مكان

يحدد معلومات حول نشاط تجاري محلي، مثل مطعم أو فندق.

الاسم	القيمة	النوع
_type	تلميح الكتابة، والذي يمكن تعيينه إلى أحد الإجراءات التالية: فندق الأعمال التجارية المحلية مطعم	سلسلة
العنوان	العنوان البريدي لمكان وجود الكيان.	العنوان البريدي
الكيانالعرض التقديميمعلومات	معلومات إضافية حول الكيان مثل التلميحات التي يمكنك استخدامها لتحديد نوع الكيان. على سبيل المثال ، سواء كان مطعما أو فندقا. يتم تعيين الحقل `entityScenario` إلى ListItem.	الكيانالعرض التقديميمعلومات
الاسم	اسم الكيان.	سلسلة
تلفون	رقم هاتف الجهة.	سلسلة
عنوان url	عنوان URL لموقع الكيان على الويب. استخدم عنوان URL هذا مع اسم الكيان لإنشاء ارتباط تشعبي ينقل المستخدم عند النقر فوقه إلى موقع الكيان على الويب.	سلسلة
webSearchUrl	عنوان URL لنتيجة بحث Bing لهذا المكان.	سلسلة

استعلام السياق

يحدد سياق الاستعلام الذي Bing استخدامه للطلب.

العنصر	الوصف	النوع
البالغالنية	قيمة منطقية تشير إلى ما إذا كان الاستعلام المحدد له نية للبالغين. تكون القيمة صحيحة إذا كان الاستعلام له نية للبالغين. خلاف ذلك ، خطأ.	منطقي
تغييرتجاوز الاستعلام	سلسلة الاستعلام لاستخدامها لفرض Bing على استخدام السلسلة الأصلية. على سبيل المثال، إذا كانت سلسلة الاستعلام تملح في اتجاه الريح، فستكون سلسلة استعلام التجاوز +saling في اتجاه الريح. تذكر ترميز سلسلة الاستعلام التي تؤدي إلى ٪2Bsaling + هبوط. يتم تضمين هذا الحقل فقط إذا كانت سلسلة الاستعلام الأصلية تحتوي على خطأ إملائي.	سلسلة
تغيير الاستعلام	سلسلة الاستعلام المستخدمة من قبل Bing لتنفيذ الاستعلام. يستخدم Bing سلسلة الاستعلام التي تم تغييرها إذا كانت سلسلة الاستعلام الأصلية تحتوي على أخطاء إملائية. على سبيل المثال، إذا كانت سلسلة الاستعلام هي `saling downwind`، فستكون سلسلة الاستعلام التي تم تغييرها `sailing downwind`. يتم تضمين هذا الحقل فقط إذا كانت سلسلة الاستعلام الأصلية تحتوي على خطأ إملائي.	سلسلة
askUserForLocation	قيمة منطقية تشير إلى ما إذا كان Bing يتطلب موقع المستخدم لتقديم نتائج دقيقة. إذا قمت بتحديد موقع المستخدم باستخدام رؤوس X-MSEdge-ClientIP وX-Search-Location ، فيمكنك تجاهل هذا الحقل. بالنسبة إلى الاستعلامات التي تدرك الموقع، مثل "طقس اليوم" أو "المطاعم القريبة مني" التي تحتاج إلى موقع المستخدم لتقديم نتائج دقيقة، يتم تعيين هذا الحقل إلى true. بالنسبة إلى استعلامات معرفة الموقع التي تتضمن الموقع (على سبيل المثال، "طقس سياتل")، يتم تعيين هذا الحقل إلى false. تم تعيين هذا الحقل أيضا إلى false للاستعلامات التي لا تعرف الموقع، مثل "الأكثر مبيعا".	منطقي
الأصلالاستعلام	سلسلة الاستعلام كما هو محدد في الطلب.	سلسلة

التعرف

الاسم	القيمة	النوع
المعرف	معرف مورد	سلسلة

مجموعة الترتيب

يحدد مجموعة نتائج البحث، مثل الخط الرئيسي.

الاسم	القيمة	النوع
العناصر	قائمة بنتائج البحث لعرضها في المجموعة.	الترتيبالبند

الترتيبالبند

يحدد عنصر نتيجة بحث لعرضه.

الاسم	القيمة	النوع
النتيجةفهرس	فهرس يستند إلى الصفر للعنصر في الإجابة المراد عرضها. إذا لم يتضمن العنصر هذا الحقل، فقم بعرض كافة العناصر في الإجابة. على سبيل المثال، عرض جميع المقالات الإخبارية في إجابة الأخبار.	عدد صحيح
نوع الإجابة	الإجابة التي تحتوي على العنصر المراد عرضه. على سبيل المثال ، الأخبار. استخدم النوع للعثور على الإجابة في كائن SearchResponse. النوع هو اسم حقل SearchResponse. ومع ذلك، استخدم نوع الإجابة فقط إذا كان هذا الكائن يتضمن حقل القيمة; خلاف ذلك ، تجاهله.	سلسلة
textualIndex	فهرس الإجابة في textualAnswers المراد عرضه.	عدد صحيح غير موقع
القيمة	المعرف الذي يحدد إما إجابة للعرض أو عنصرا من إجابة لعرضها. إذا حدد المعرف إجابة، فقم بعرض جميع عناصر الإجابة.	التعرف

الترتيبالاستجابة

يحدد المكان الذي يجب وضع محتوى صفحة نتائج البحث فيه وبأي ترتيب.

الاسم	القيمة
رئيسي	نتائج البحث المراد عرضها في الخط الرئيسي.
قطب	نتائج البحث التي يجب أن تمنح العلاج الأكثر وضوحا (على سبيل المثال، يتم عرضها فوق الخط الرئيسي والشريط الجانبي).
الشريط الجانبي	نتائج البحث المراد عرضها في الشريط الجانبي.

SearchResponse

يعرف كائن المستوى الأعلى الذي تتضمنه الاستجابة عند نجاح الطلب.

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

الاسم	القيمة	النوع
_type	اكتب تلميحا، الذي تم تعيينه إلى SearchResponse.	سلسلة
اماكن	قائمة بالكيانات ذات الصلة باستعلام البحث.	عنصر JSON
الاستعلامالسياق	كائن يحتوي على سلسلة الاستعلام التي Bing استخدامها للطلب. يحتوي هذا الكائن على سلسلة الاستعلام كما أدخلها المستخدم. قد يحتوي أيضا على سلسلة استعلام معدلة Bing استخدامها للاستعلام إذا كانت سلسلة الاستعلام تحتوي على خطأ إملائي.	استعلام السياق

رموز الخطأ

فيما يلي رموز حالة HTTP المحتملة التي يقوم الطلب بإرجاعها.

تعليمة برمجية للحالة	الوصف
200	نجاح
400	إحدى معلمات الاستعلام مفقودة أو غير صالحة.
401	مفتاح الاشتراك مفقود أو غير صالح.
403	تتم مصادقة المستخدم (على سبيل المثال، استخدم مفتاح اشتراك صالحا) ولكن ليس لديه إذن للمورد المطلوب. قد Bing أيضا إرجاع هذه الحالة إذا تجاوز المتصل حصة استعلاماته الشهرية.
410	استخدم الطلب HTTP بدلا من بروتوكول HTTPS. HTTPS هو البروتوكول الوحيد المدعوم.
429	تجاوز المتصل استفساراته لكل حصة ثانية.
500	خطأ غير متوقع في الخادم.

في حالة فشل الطلب، تحتوي الاستجابة على كائن ErrorResponse ، الذي يحتوي على قائمة بكائنات الخطأ التي تصف سبب الخطأ . إذا كان الخطأ مرتبطا بمعلمة، يحدد الحقل parameter المعلمة المشكلة. وإذا كان الخطأ مرتبطا بقيمة معلمة، يحدد الحقل القيمة غير الصالحة value .

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "InvalidRequest", 
      "subCode": "ParameterMissing", 
      "message": "Required parameter is missing.", 
      "parameter": "q" 
    }
  ]
}

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "InvalidAuthorization", 
      "subCode": "AuthorizationMissing", 
      "message": "Authorization is required.", 
      "moreDetails": "Subscription key is not recognized."
    }
  ]
}

فيما يلي قيم رمز الخطأ المحتمل ورمز الخطأ الفرعي.

رمز	الرمز الفرعي	الوصف
خطأ الخادم	غير متوقعخطأ ResourceError NotImplemented	رمز حالة HTTP هو 500.
غير صالحطلب	المعلمةمفقود المعلمةغير صالحالقيمة httpغير مسموح به محظورة	Bing إرجاع InvalidRequest كلما كان أي جزء من الطلب غير صالح. على سبيل المثال، معلمة مطلوبة مفقودة أو قيمة معلمة غير صالحة. إذا كان الخطأ ParameterMissing أو ParameterInvalidValue، رمز حالة HTTP هو 400. إذا كنت تستخدم بروتوكول HTTP بدلا من HTTPS، Bing إرجاع HttpNotAllowed، ورمز حالة HTTP هو 410.
تم تجاوز حد المعدل	لا توجد رموز فرعية	Bing إرجاع RateLimitExceed كلما تجاوزت حصة استفساراتك في الثانية (QPS) أو الاستعلامات شهريا (QPM). إذا تجاوزت QPS، Bing ترجع رمز حالة HTTP 429، وإذا تجاوزت QPM، Bing ترجع 403.
InvalidAuthorization	التفويضمفقود التفويضالتكرار	Bing إرجاع InvalidAuthorization عندما يتعذر Bing مصادقة المتصل. على سبيل المثال، `Ocp-Apim-Subscription-Key` الرأس مفقود أو مفتاح الاشتراك غير صالح. يحدث التكرار إذا قمت بتحديد أكثر من طريقة مصادقة واحدة. إذا كان الخطأ هو InvalidAuthorization، رمز حالة HTTP هو 401.
غير كافالإذن	التفويضمعطل التفويضمنتهي الصلاحية	Bing إرجاع InsufficientAuthorization عندما لا يكون لدى المتصل أذونات للوصول إلى المورد. يمكن أن يحدث هذا إذا تم تعطيل مفتاح الاشتراك أو انتهت صلاحيته. إذا كان الخطأ غير كافالتفويض، رمز حالة HTTP هو 403.