قبل بدء كتابة أول تطبيق عميل لك، عليك إجراء بعض الأمور، إذا لم يسبق لك إجراؤها.
الحصول على حساب Google
يجب أن يكون لديك حساب Google من أجل إنشاء مشروع في Google API Console. إذا كان لديك حساب، تكون قد انتهيت من عملية إعداد حسابك.
قد تحتاج أيضًا إلى حساب Google منفصل لأغراض الاختبار.
تجربة "تقرير تجارب الإعلانات" من Google
تفترض مستندات واجهة برمجة التطبيقات هذه أنّك استخدمت "تقرير تجارب الإعلانات" من Google، وأنّك على دراية بمفاهيم برمجة الويب وتنسيقات بيانات الويب.
إذا لم يسبق لك استخدام "تقرير تجارب الإعلانات" من Google، جرِّب واجهة المستخدم قبل البدء في كتابة الرموز.
إنشاء مشروع لعميلك
قبل إرسال طلبات إلى "تقرير تجربة الإعلانات على Google"، عليك تزويد Google بمعلومات حول عميلك وتفعيل إمكانية الوصول إلى واجهة برمجة التطبيقات. يمكنك إجراء ذلك عن طريق الاستعانة بوحدة التحكم في Google API لإنشاء مشروع، وهو مجموعة معرَّفة من الإعدادات ومعلومات الدخول إلى واجهة برمجة التطبيقات، ولتسجيل تطبيقك.
التعرّف على أساسيات REST
هناك طريقتان لاستدعاء واجهة برمجة التطبيقات:
- إرسال طلبات HTTP وتحليل الردود
- استخدام مكتبات برامج
إذا قرّرت عدم استخدام مكتبات البرامج، عليك فهم أساسيات REST.
REST هو نمط من بنية البرامج يوفّر طريقة ملائمة ومتسقة لطلب البيانات وتعديلها.
يشير مصطلح REST إلى عبارة "نقل الحالة التمثيلية". في سياق Google APIs، يشير ذلك إلى استخدام أفعال HTTP لاسترداد وتعديل تمثيلات البيانات التي تخزّنها Google.
في نظام RESTful، يتم تخزين الموارد في مخزن بيانات، ويرسل العميل طلبًا إلى الخادم لتنفيذ إجراء معيّن (مثل إنشاء مورد أو استرداده أو تعديله أو حذفه)، وينفّذ الخادم الإجراء ويرسل ردًا، غالبًا ما يكون في شكل تمثيل للمورد المحدّد.
في واجهات RESTful API من Google، يحدّد العميل إجراءً باستخدام فعل HTTP، مثل POST
أو GET
أو PUT
أو DELETE
. تحدّد هذه السمة موردًا من خلال معرّف موارد منتظم (URI) فريد عالميًا بالتنسيق التالي:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
بما أنّ جميع موارد واجهة برمجة التطبيقات تتضمّن معرّفات موارد موحّدة فريدة يمكن الوصول إليها عبر HTTP، يتيح REST تخزين البيانات مؤقتًا ويتم تحسينه للعمل مع البنية الأساسية الموزّعة للويب.
قد تجد تعريفات الطرق في مستندات معايير HTTP 1.1 مفيدة، فهي تتضمّن مواصفات GET
وPOST
وPUT
وDELETE
.
REST في "واجهة برمجة التطبيقات لتقرير تجارب الإعلانات" من Google
تتطابق عمليات Google Ad Experience Report API مباشرةً مع أفعال REST HTTP.
في ما يلي التنسيقات المحدّدة لمعرّفات الموارد الموحّدة الخاصة بواجهة برمجة التطبيقات مع "تقرير تجارب الإعلانات" من Google:
https://adexperiencereport.googleapis.com/v1/resourcePath?parameters
يتم تلخيص المجموعة الكاملة من معرّفات الموارد المنتظمة (URI) المستخدَمة لكل عملية متوافقة في واجهة برمجة التطبيقات في مستند مرجع واجهة برمجة التطبيقات لتقرير تجارب الإعلانات من Google.
التعرّف على أساسيات JSON
تعرض "واجهة برمجة التطبيقات لتقرير تجارب الإعلانات" من Google البيانات بتنسيق JSON.
JSON (JavaScript Object Notation) هو تنسيق بيانات شائع ومستقل عن اللغة، ويوفر تمثيلاً نصيًا بسيطًا لبُنى البيانات العشوائية. لمزيد من المعلومات، يُرجى الاطّلاع على json.org.