برنامه کمکی جستجو

Fetching references to proto classes when using the API requires that you either have an intrinsic understanding of the API or frequently look up the proto reference documentation for the exact namespace path.

ProtoLookupUtil

روش‌های ابزار جستجو در GoogleAdsClient (پشتیبانی‌شده توسط Factories و ServiceLookup، جایگزین کلاس قدیمی ProtoLookupUtil) به شما امکان می‌دهد بدون نیاز به پیگیری شماره‌های نسخه API و فضاهای نام ماژول، نمونه‌های سرویس‌ها، عملیات، شمارش‌ها، و منابع را جستجو و ایجاد کنید. به‌طور پیش‌فرض، این روش‌ها از بالاترین نسخه API پشتیبانی‌شده توسط gem نصب‌شده شما استفاده می‌کنند (V26 در جدیدترین نسخه، که نسخه‌های جزئی API مانند v25.1 از ماژول نسخه اصلی خود V25 استفاده می‌کنند)، یا می‌توانید یک پیشوند نسخه صریح (مانند v26) را در فراخوانی جستجو مشخص کنید.

بدون ابزار جستجو، شما یک منبع پویش را مستقیماً از فضای نام نسخه‌دار آن نمونه‌سازی می‌کنید:

campaign =
  Google::Ads::GoogleAds::V26::Resources::Campaign.new

با روش‌های جستجوی کارخواه، می‌توانید منبع را مستقیماً از کارخواه نمونه‌سازی کنید:

campaign = client.resource.campaign

هنگام واکشی منبع، سرویس، یا عملیات، نمونه‌ای از آن نهاد برگردانده می‌شود:

# Instantiate an operation
operation = client.operation.campaign

جستجوی خدمات

از روش client.service برای واکشی کارخواهان سرویس استفاده کنید، حتی اگر از این ابزار کمکی برای نهادهای دیگر استفاده نمی‌کنید. client.service به‌طور خودکار اعتبارنامه‌های اصالت‌سنجی و تنظیمات انتقال شما را در سرویس کلاینت برگردانده‌شده پیکربندی می‌کند:

campaign_service = client.service.campaign

جستجوی فهرست

برای فیلدهای enum در پیام‌های protobuf، به‌جای جستجوی پیمانه شمارش، مستقیماً یک نماد Ruby اختصاص دهید:

campaign.status = :PAUSED

برای بازرسی یا تکرار روی همه نمادهای معتبر برای شمارش در زمان اجرا، از client.enum استفاده کنید که Google::Protobuf::EnumDescriptor را برای آن شمارش برمی‌گرداند:

status_enum = client.enum.campaign_status
status_enum.each { |status| p status }