رؤوس 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 Playground لتجربة بيانات اعتماد التطبيق و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 يتضمّن Authorization لكل طلب بيانات من واجهة برمجة التطبيقات لواجهة برمجة التطبيقات Search Ads 360 Reporting API:

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

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

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

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