يجب توفّر بيانات اعتماد تطبيق OAuth 2.0 والرمز المميّز للمطوِّر عند طلب بيانات Google Ads API. إذا كنت تجري طلبات بيانات من واجهة برمجة التطبيقات
باستخدام حساب إداري على "إعلانات Google"، عليك أيضًا تحديد عنوان login-customer-id
مع كل طلب. توضّح هذه الصفحة طريقة ضبط هذه القيم وتوثّق العديد من عناوين HTTP الإضافية الخاصة بواجهة برمجة التطبيقات والتي يتم إرسالها واستلامها عند استخدام واجهة REST.
بيانات اعتماد OAuth 2.0
تستخدم Google Ads API بيانات اعتماد التطبيق لتحديد طلبات واجهة برمجة التطبيقات وتفويضها. يمكن ضبط كل من برامج OAuth 2.0 وحسابات الخدمة. ولمزيد من التفاصيل حول ضبط التفويض من جهة العميل، يُرجى الاطّلاع على OAuth2 في Google Ads API.
إذا كنت حديث العهد باستخدام Google APIs، يمكنك استخدام oauth2l أو منشأة OAuth 2.0 لتجربة بيانات اعتماد التطبيق وGoogle Ads API قبل كتابة الرمز للتطبيق.
استخدام تدفقات تطبيق الويب أو سطح المكتب
اتّبِع الخطوات من أجل ضبط مشروع وحدة تحكّم Google API على واجهة Google Ads API. سجِّل معرِّف العميل وسر العميل، ثم ارجع إلى هذه الصفحة.
بعد إنشاء عميل OAuth، اتّبِع تعليمات مسار تطبيق متوافق مع أجهزة الكمبيوتر المكتبي أو تعليمات مسار تطبيق الويب لإنشاء رمز مميّز لإعادة التحميل ورمز دخول.
استخدام حسابات الخدمة
اتّبِع التعليمات الشائعة في دليل حسابات الخدمة لإعداد الوصول إلى حساب الخدمة لخدمة Google Ads API.
بعد إعداد حساب خدمة للوصول إلى حسابك على "إعلانات Google"، اتّبِع الإرشادات الواردة في
دليل استخدام OAuth 2.0 للتطبيقات من خادم إلى خادم
واختَر علامة التبويب HTTP/REST. إنّ scope المستخدَم للوصول إلى Google Ads API هو https://www.googleapis.com/auth/adwords.
إنشاء رموز دخول جديدة
بعد توفُّر معرّف عميل وسر العميل ورمز مميّز لإعادة التحميل، يمكنك إنشاء رمز دخول جديد لاستخدامه في طلبات البيانات من واجهة برمجة التطبيقات باستخدام أداة سطر الأوامر 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 لكل طلب بيانات من Google Ads API:
GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
عناوين الطلبات
الرمز المميز للمطوِّر
تتطلّب Google Ads API أيضًا الرمز المميّز للمطوِّر من أجل إجراء عمليات استدعاء لواجهة برمجة التطبيقات. يمكنك تقديم طلب للحصول على رمز مميّز لحسابك الإداري مباشرةً من واجهة مستخدم "إعلانات Google". لمزيد من التفاصيل عن إعداد الرمز المميز للمطوِّر، راجع الحصول على الرمز المميز للمطوِّر.
وعليك تضمين قيمة الرمز المميّز للمطوِّر في عنوان HTTP يتضمّن developer-token لكل طلب بيانات من Google Ads API:
GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
الرقم التعريفي لتسجيل الدخول للعميل
بالنسبة إلى طلبات Google Ads API التي يجريها أحد المدراء لحساب عميل (أي عند تسجيل الدخول كمدير لإجراء طلبات بيانات من واجهة برمجة التطبيقات إلى أحد حسابات العملاء)، عليك أيضًا توفير عنوان HTTP يتضمّن العنصر login-customer-id. تمثّل هذه القيمة الرقم التعريفي لعميل "إعلانات Google" للمدير الذي يجري طلب بيانات من واجهة برمجة التطبيقات.
يكافئ تضمين هذا العنوان اختيار حساب في واجهة مستخدم "إعلانات Google" بعد تسجيل الدخول أو النقر على صورة ملفك الشخصي في أعلى يسار الصفحة. عند تحديد الرقم التعريفي للعميل، احرص على إزالة أي واصلات (—)، مثلاً: 1234567890 وليس 123-456-7890.
GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
الرقم التعريفي للعميل المرتبط
لا يستخدم هذا العنوان سوى مقدمي تحليلات التطبيقات التابعين لجهات خارجية عند تحميل الإحالات الناجحة إلى حساب مرتبط على "إعلانات Google". يُرجى الاطّلاع على دليل بنية طلب البيانات من واجهة برمجة التطبيقات لمعرفة مزيد من التفاصيل.
...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID
عناوين الردود
يتم عرض العناوين التالية في استجابات HTTP من واجهة برمجة التطبيقات.
معرّف الطلب
والسمة request-id هي سلسلة تعرِّف طلب البيانات من واجهة برمجة التطبيقات بشكل فريد. عند تصحيح الأخطاء أو تحديد المشاكل وحلّها في طلبات بيانات محدّدة من واجهة برمجة التطبيقات، يكون request-id معرّفًا مهمًا يكون مفيدًا عند التواصل مع فريق دعم المطوّرين على Google.
request-id: 2a5Cj89VV7CNhya1DZjjrC