رؤوس HTTP والتفويض

تحتاج إلى بيانات اعتماد تطبيق OAuth 2.0 عند الاتصال بواجهة برمجة التطبيقات Search Ads 360 Reporting API. إذا كنت بصدد إجراء طلبات بيانات من واجهة برمجة التطبيقات بصفته حسابًا إداريًا على "إعلانات شبكة البحث 360"، عليك أيضًا تحديد عنوان login-customer-id مع كل طلب. توضّح هذه الصفحة كيفية ضبط هذه القيم وتوثّق العديد من رؤوس HTTP الإضافية الخاصة بواجهة برمجة التطبيقات والتي يتم إرسالها واستلامها عند استخدام واجهة برمجة التطبيقات REST.

بيانات اعتماد OAuth 2.0

تستخدِم Search Ads 360 Reporting API بيانات اعتماد التطبيق لتحديد طلبات واجهة برمجة التطبيقات وتفويضها. يمكن ضبط عملاء OAuth 2.0. يجب أن يتمّ تفويض جميع طلبات Search Ads 360 Reporting API من خلال بروتوكول OAuth2. يتيح OAuth2 لتطبيق عميل Search Ads 360 Reporting API الوصول إلى حساب مستخدم على "إعلانات شبكة البحث 360" بدون الحاجة إلى التعامل مع معلومات تسجيل دخول المستخدم أو تخزينها.

إذا كنت مبتدئًا في استخدام Google APIs، يمكنك استخدام oauth2l أو مساحة OAuth 2.0 التجريبية للتجرّب مع بيانات اعتماد التطبيق وSearch Ads 360 Reporting API قبل كتابة الرمز البرمجي لتطبيقك. يمكنك أيضًا إنشاء رمز مميّز لإعادة التحميل في OAuth من خلال تشغيل النص البرمجي لإنشاء بيانات اعتماد المستخدم المقدَّمة.

إنشاء رموز وصول جديدة

بعد الحصول على معرّف العميل ومفتاح سر العميل والرمز المميّز لإعادة التحميل، يمكنك إنشاء رمز دخول جديد لاستخدامه في طلبات بيانات واجهة برمجة التطبيقات باستخدام أداة سطر الأوامر curl:

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

بعد ذلك، استخدِم رمز الوصول الذي يعرضه طلب curl في عنوان HTTP لكلّ طلب واجهة برمجة تطبيقات موجّه إلى Search Ads 360 Reporting API:Authorization

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

عناوين الطلبات

رقم تعريف العميل لتسجيل الدخول

بالنسبة إلى طلبات Search Ads 360 Reporting API التي يُجريها مدير إلى حساب عميل (أي عند تسجيل الدخول بصفتك مديرًا لإجراء طلبات واجهة برمجة التطبيقات إلى أحد حسابات العملاء)، عليك أيضًا تقديم login-customer-id عنوان HTTP. تمثّل هذه القيمة رقم تعريف العميل في "إعلانات شبكة البحث 360" للمدير الذي يُجري طلب البيانات من واجهة برمجة التطبيقات.

ويؤدي تضمين هذا العنوان إلى اختيار حساب في واجهة مستخدم "إعلانات شبكة البحث 360" بعد تسجيل الدخول أو النقر على صورة ملفك الشخصي في أعلى يسار الصفحة. عند تحديد الرقم التعريفي للعميل، احرص على إزالة أيّ شرطات (—)، على سبيل المثال: 1234567890 وليس 123-456-7890.

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

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

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

معرّف الطلب

request-id هي سلسلة تحدِّد طلب واجهة برمجة التطبيقات بشكل فريد. عند تحديد أخطاء طلبات البيانات من واجهة برمجة التطبيقات أو تحديد المشاكل وحلّها، يُعدّ request-id معرّفًا مهمًا يجب استخدامه عند التواصل مع فريق دعم المطوّرين في Google.

request-id: 2a5Cj89VV7CNhya1DZjjrC