يجب توفير بيانات اعتماد تطبيق 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 Authorization
لكل طلب من طلبات البيانات من واجهة Search Ads 360 Reporting API:
GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
عناوين الطلبات
معرّف تسجيل الدخول للعميل
بالنسبة إلى طلبات البيانات من واجهة برمجة التطبيقات لإعداد التقارير في "إعلانات شبكة البحث 360" التي يقدّمها حساب إداري إلى حساب عميل (أي عند تسجيل الدخول كحساب إداري لتقديم طلبات البيانات من واجهة برمجة التطبيقات إلى أحد حسابات العملاء)، عليك أيضًا تقديم عنوان 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