استفاده پایه

استفاده پایه از کتابخانه کلاینت به‌صورت زیر است:

نصب

روش توصیه‌شده برای نصب کتابخانه استفاده از Bundler است. خطی به Gemfile اضافه کنید (x.y.z را با شماره نسخه‌ای که می‌خواهید استفاده کنید جایگزین کنید):

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

سپس این دستور را اجرا کنید:

bundle install

این فرمان از Bundler برای به‌روزرسانی Gemfile.lock شما استفاده می‌کند و آن را به نسخه دقیق gem و همه وابستگی‌های gem که نصب شده‌اند قفل می‌کند. عملگر نسخه بدبینانه "~> x.y.z" تضمین می‌کند که bundle install یا bundle update فقط نسخه‌های وصله جدید را در سری x.y.* نصب می‌کند، بنابراین باید با به‌روزرسانی Gemfile خود، به‌صورت دستی نسخه‌های فرعی یا اصلی جدید را انتخاب کنید.

گزینه‌های نصب دیگر

اگر از Bundler استفاده نمی‌کنید، می‌توانید از یکی از این گزینه‌ها استفاده کنید:

1. این کتابخانه را بااستفاده از RubyGems نصب کنید:

   gem install google-ads-googleads
   

2. gem را از صفحه «نسخه‌های پخش» بارگیری کنید و آن را از فایل محلی نصب کنید:

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

راه‌اندازی اصالت‌سنجی

برای اصالت‌سنجی کردن فراخوانی‌های میانای برنامه‌سازی کاربردی، فایل google_ads_config.rb را پیکربندی کنید و دستورالعمل‌های موجود در صفحه اصالت‌سنجی و صدور مجوز را دنبال کنید.

کاربرد

از نسخه ۴۱.۱.۰ google-ads-googleads، gem از Bundler autorequire (Bundler.require) پشتیبانی می‌کند. در نسخه‌های قبل‌از نسخه ۴۱.۱.۰ (یا وقتی از Bundler.require استفاده نمی‌شود)، gem را به‌طور صریح در کدتان درخواست کنید:

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 ارائه می‌دهند.

مدیریت کردن خطا

همه فراخوانی‌های میانای برنامه‌سازی کاربردی موفقیت‌آمیز نیستند. اگر فراخوانی‌های میانای برنامه‌سازی کاربردی شما ناموفق باشد، سرور استثناهایی را مطرح می‌کند. مهم است که خطاهای API را ضبط کنید و به‌درستی آن‌ها را مدیریت کنید.

وقتی خطای API رخ می‌دهد، نمونه Google::Ads::GoogleAds::Errors::GoogleAdsError مطرح می‌شود. این شیء حاوی جزئیاتی است که به شما کمک می‌کند تشخیص دهید چه مشکلی پیش آمده است، و می‌توانید یک تابع کمکی برای مدیریت خطاها راه‌اندازی کنید. نمونه‌ای از کنترل‌کننده خطا در GitHub را ببینید.