کاربرد اصلی کتابخانه کلاینت به شرح زیر است:
نصب
روش پیشنهادی برای نصب، استفاده از bundler است. یک خط به Gemfile خود اضافه کنید (به جای xyz، شماره نسخه مورد نظر خود را قرار دهید):
gem 'google-ads-googleads', '~> x.y.z'
سپس اجرا کنید:
$ bundle install
این دستور از bundler برای به‌روزرسانی Gemfile.lock شما استفاده می‌کند و آن را دقیقاً به همان نسخه gem و تمام وابستگی‌های gem که نصب شده‌اند، قفل می‌کند. عملگر نسخه بدبینانه "~> xyz" باعث می‌شود bundle update فقط نسخه‌های جدید سری xy* را نصب کند، بنابراین باید با به‌روزرسانی مجدد Gemfile خود، نسخه‌های جدید را به صورت دستی انتخاب کنید.
سایر گزینه‌های نصب
اگر از bundler استفاده نمی‌کنید، می‌توانید از یکی از این گزینه‌ها استفاده کنید:
- این کتابخانه را با استفاده از gem نصب کنید:
terminal $ [sudo] gem install google-ads-googleads - جم را از صفحه انتشارها دانلود کنید و آن را از فایل محلی نصب کنید:
terminal $ [sudo] gem install google-ads-googleads-[version].gem
تنظیم احراز هویت
برای تأیید اعتبار فراخوانی‌های API خود، دستورالعمل‌های موجود در صفحه «تأیید اعتبار و مجوز» را دنبال کنید.
کاربرد
برای گنجاندن گوهر در کد خود:
require 'google/ads/google_ads'
برای دریافت یک سرویس خاص، برای مثال CampaignService:
client = Google::Ads::GoogleAds::GoogleAdsClient.new
campaign_service = client.service.campaign
برای نمایش‌های دقیق‌تر نحوه استفاده از کتابخانه، به مثال‌های موجود در گیت‌هاب مراجعه کنید.
پس از آشنایی با مثال‌ها، توصیه می‌کنیم با factoryها نیز آشنا شوید که مجموعه‌ای از متدهای سطح بالا را برای کار با API گوگل ادز ارائه می‌دهد.
مدیریت خطا
هر فراخوانی API موفق نخواهد بود. اگر فراخوانی‌های API شما به هر دلیلی با شکست مواجه شوند، سرور می‌تواند خطا صادر کند. مهم است که خطاهای API را ثبت کرده و به طور مناسب آنها را مدیریت کنید.
یک نمونه از GoogleAdsException زمانی که یک خطای API رخ می‌دهد، ایجاد می‌شود. این نمونه حاوی جزئیاتی است که به شما کمک می‌کند بفهمید چه چیزی اشتباه رخ داده است و می‌توانید یک تابع کمکی برای مدیریت خطاها تنظیم کنید. نمونه‌ای از یک مدیریت‌کننده خطا را در GitHub ببینید.