Pengambil Layanan dan Jenis

Mengambil referensi ke semua class proto yang diperlukan untuk menggunakan API di Python dapat menjadi sangat detail dan mengharuskan Anda memiliki pemahaman intrinsik tentang API atau sering beralih konteks untuk mereferensikan proto atau dokumentasi.

Metode get_service dan get_type klien

Kedua metode getter ini memungkinkan Anda mengambil objek layanan atau jenis apa pun di API. Metode get_service digunakan untuk mengambil klien layanan. get_type digunakan untuk objek lainnya. Class klien layanan ditentukan dalam kode di jalur versi google/ads/googleads/v*/services/services/ dan semua jenis ditentukan dalam berbagai kategori objek, google/ads/googleads/v*/common|enums|errors|resources|services/types/. Semua kode di bawah direktori versi dibuat, jadi sebaiknya gunakan metode ini, bukan mengimpor objek secara langsung, jika struktur codebase berubah.

Berikut adalah contoh cara menggunakan metode get_service untuk mengambil instance klien GoogleAdsService.

from google.ads.googleads.client import GoogleAdsClient

# "load_from_storage" loads your API credentials from disk so they
# can be used for service initialization. Providing the optional `version`
# parameter means that the v25 version of GoogleAdsService will
# be returned.
client = GoogleAdsClient.load_from_storage(version="v25")
googleads_service = client.get_service("GoogleAdsService")

Berikut adalah contoh cara menggunakan metode get_type untuk mengambil instance Campaign.

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage(version="v25")
campaign = client.get_type("Campaign")

Enum

Meskipun Anda dapat menggunakan metode get_type untuk mengambil Enum, setiap instance GoogleAdsClient juga memiliki atribut enums yang memuat Enum secara dinamis menggunakan mekanisme yang sama dengan metode get_type. Antarmuka ini dimaksudkan agar lebih sederhana dan lebih mudah dibaca daripada menggunakan get_type:

client = GoogleAdsClient.load_from_storage(version=v25)

campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED

Kolom objek proto yang merupakan enum ditampilkan di Python oleh jenis enum native enum. Artinya, Anda dapat dengan mudah membaca nilai anggota. Menggunakan instance campaign dari contoh sebelumnya di Python repl:

>>> print(campaign.status)
CampaignStatus.PAUSED
>>> type(campaign.status)
<enum 'CampaignStatus'>
>>> print(campaign.status.value)
3

Terkadang, Anda perlu mengetahui nama kolom yang sesuai dengan nilai enum seperti yang ditunjukkan di atas. Anda dapat mengakses informasi ini menggunakan atribut name:

>>> print(campaign.status.name)
'PAUSED'
>>> type(campaign.status.name)
<class 'str'>

Interaksi dengan enum berbeda-beda, bergantung pada apakah Anda memiliki use_proto_plus konfigurasi yang ditetapkan ke true atau false. Untuk mengetahui detail tentang kedua antarmuka, lihat dokumentasi pesan protobuf.

Pembuatan Versi

Beberapa versi API dipertahankan pada saat yang sama. Meskipun v25 mungkin merupakan versi terbaru, versi sebelumnya masih dapat diakses hingga dihentikan. Library akan menyertakan class pesan proto terpisah yang sesuai dengan setiap versi API aktif. Untuk mengakses class pesan untuk versi tertentu, berikan parameter kata kunci version saat menginisialisasi klien sehingga selalu menampilkan instance dari versi yang diberikan tersebut:

client = GoogleAdsService.load_from_storage(version="/google-ads/api/reference/rpc/v25/")
# The Campaign instance will be from the v25 version of the API.
campaign = client.get_type("Campaign")

Anda juga dapat menentukan versi saat memanggil metode get_service dan get_type. Tindakan ini akan mengganti versi yang diberikan saat menginisialisasi klien:

client = GoogleAdsService.load_from_storage()
# This will load the v25 version of the GoogleAdsService.
googleads_service = client.get_service(
    "GoogleAdsService", version="v25")

client = GoogleAdsService.load_from_storage(version="v25")
# This will load the v23 version of a Campaign.
campaign = client.get_type("Campaign", version="v23")

Jika tidak ada parameter kata kunci version yang diberikan, library akan menggunakan versi terbaru secara default. Daftar terbaru versi terbaru dan versi lain yang tersedia dapat ditemukan di bagian navigasi sebelah kiri Referensi API dokumentasi.