الاستخدام الأساسي

في ما يلي الاستخدام الأساسي لمكتبة البرامج:

تثبيت

الطريقة التي ننصح بها لتثبيت المكتبة هي استخدام Bundler. أضِف سطرًا إلى Gemfile (مع استبدال x.y.z برقم الإصدار الذي تريد استخدامه):

gem 'google-ads-googleads', '~> x.y.z'

بعد ذلك، نفِّذ الأمر التالي:

bundle install

يستخدم هذا الأمر Bundler لتعديل Gemfile.lock، مع تحديد الإصدار الدقيق من Gem وجميع التبعيات التي تم تثبيتها. يضمن عامل تشغيل الإصدار المتشائم "~> x.y.z" bundle install bundle update ألا يتم تثبيت سوى إصدارات تصحيح جديدة في السلسلة x.y.*، لذا عليك الموافقة يدويًا على الإصدارات الثانوية أو الرئيسية الجديدة من خلال تعديل Gemfile.

خيارات التثبيت الأخرى

إذا كنت لا تستخدم Bundler، يمكنك اتّباع أحد الخيارَين التاليَين:

  1. ثبِّت هذه المكتبة باستخدام RubyGems:

    gem install google-ads-googleads

  2. نزِّل الحزمة من صفحة الإصدارات وثبِّتها من الملف المحلي:

    gem install google-ads-googleads-[version].gem

إعداد المصادقة

لمصادقة طلبات البيانات من واجهة برمجة التطبيقات، اضبط ملف google_ads_config.rb واتّبِع التعليمات الواردة في صفحة المصادقة والتفويض.

الاستخدام

بدءًا من الإصدار 41.1.0 من google-ads-googleads، تتوافق الحزمة مع ميزة التحميل التلقائي (autorequire) في Bundler (Bundler.require). في الإصدارات الأقدم من 41.1.0 (أو عند عدم استخدام Bundler.require)، يجب طلب الحزمة بشكل صريح في الرمز البرمجي:

require 'google/ads/google_ads'

ابدأ تشغيل البرنامج (الذي يحمّل الإعدادات من ~/google_ads_config.rb تلقائيًا) واسترجِع خدمة معيّنة، مثل CampaignService:

# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new

# Fetch the CampaignService client.
campaign_service = client.service.campaign

يمكنك الاطّلاع على الأمثلة على GitHub للحصول على توضيحات أكثر تفصيلاً حول كيفية استخدام المكتبة.

بعد التعرّف على الأمثلة، يمكنك استكشاف عناصر المصنع التي توفّر مجموعة من الطرق المريحة العالية المستوى للتعامل مع Google Ads API.

معالجة الأخطاء

لا تنجح كل طلبات البيانات من واجهة برمجة التطبيقات. يُصدر الخادم استثناءات في حال تعذُّر تنفيذ طلبات البيانات من واجهة برمجة التطبيقات. من المهم تسجيل أخطاء واجهة برمجة التطبيقات والتعامل معها بشكل مناسب.

يتم إنشاء مثيل Google::Ads::GoogleAds::Errors::GoogleAdsError عند حدوث خطأ في واجهة برمجة التطبيقات. وتتضمّن تفاصيل لمساعدتك في تحديد المشكلة التي حدثت، ويمكنك إعداد دالة مساعدة للتعامل مع الأخطاء. اطّلِع على مثال على معالج أخطاء على GitHub.