Halaman ini diterjemahkan oleh Cloud Translation API.

Konfigurasi

Library klien Google Ads API menyediakan beberapa setelan konfigurasi yang dapat Anda gunakan untuk menyesuaikan perilaku library.

Mengonfigurasi library saat runtime

Cara yang lebih disukai untuk mengonfigurasi library klien adalah dengan menginisialisasi objek GoogleAdsConfig saat runtime:

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = "APPLICATION",
    OAuth2ClientId = "******.apps.googleusercontent.com",
    OAuth2ClientSecret = "******",
    OAuth2RefreshToken = "******"
};

GoogleAdsClient client = new GoogleAdsClient(config);

Opsi konfigurasi alternatif

Kami juga menyediakan beberapa opsi tambahan untuk mengonfigurasi library klien: untuk mengaktifkannya, tambahkan referensi Nuget ke paket Google.Ads.GoogleAds.Extensions dalam project Anda.

Jika Anda menggunakan salah satu opsi ini, setelan konfigurasi tidak akan diambil secara otomatis: Anda harus memuatnya secara eksplisit seperti yang ditunjukkan di bawah ini.

Mengonfigurasi menggunakan App.config

Semua setelan khusus untuk Google Ads API disimpan dalam node GoogleAdsApi file App.config. Konfigurasi standar App.config adalah sebagai berikut:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler" />
  </configSections>
  <GoogleAdsApi>
    <!-- Set the service timeout in milliseconds. -->
    <add key="Timeout" value="2000" />

    <!-- Proxy settings for library. -->
    <add key="ProxyServer" value="http://localhost:8888"/>
    <add key="ProxyUser" value=""/>
    <add key="ProxyPassword" value=""/>
    <add key="ProxyDomain" value=""/>

    <!-- API-specific settings -->
    <add key="DeveloperToken" value="******"/>

    <!-- OAuth2 settings -->
    <add key = "OAuth2Mode" value="APPLICATION"/>
    <add key = "OAuth2ClientId" value = "******.apps.googleusercontent.com" />
    <add key = "OAuth2ClientSecret" value = "******" />
    <add key = "OAuth2RefreshToken" value = "******" />
  </GoogleAdsApi>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
  </startup>
</configuration>

Untuk memuat setelan konfigurasi dari file App.config, panggil metode LoadFromDefaultAppConfigSection pada objek GoogleAdsConfig:

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromDefaultAppConfigSection();
GoogleAdsClient client = new GoogleAdsClient(config);

Menentukan file App.config terpisah

Jika tidak ingin App.config terlihat berantakan, Anda dapat memindahkan konfigurasi khusus library ke dalam file konfigurasinya sendiri menggunakan properti configSource.

Langkah 1: Menentukan configSource di App.config

Ubah App.config Anda agar terlihat seperti ini:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler"/>
  </configSections>
  <GoogleAdsApi configSource="GoogleAdsApi.config"/>
...
</configuration>

Langkah 2: Menentukan konten file konfigurasi

Sekarang buat file konfigurasi lain dengan nama yang Anda tentukan di configSource, lalu pindahkan node konfigurasi dari App.config ke dalam file ini:

<?xml version="1.0" encoding="utf-8" ?>
<GoogleAdsApi>
  ... More settings.
</GoogleAdsApi>

Langkah 3: Perbaiki aturan build di csproj Anda

Terakhir, sertakan file konfigurasi baru dalam proyek Anda. Ubah properti file ini menjadi Always copy to output folder.

Sekarang, build dan jalankan project Anda. Aplikasi Anda akan mulai mengambil nilai dari file konfigurasi baru.

Konfigurasi menggunakan file JSON kustom

Anda dapat menggunakan instance IConfigurationRoot untuk mengonfigurasi library klien.

Membuat file JSON

Buat file JSON bernama GoogleAdsApi.json yang memiliki struktur serupa dengan file App.config.

{
    "Timeout": "2000",

    "ProxyServer": "http://localhost:8888",
    "ProxyUser": "",
    "ProxyPassword": "",
    "ProxyDomain": "",

    "DeveloperToken": "******",

    "OAuth2Mode": "APPLICATION",
    "OAuth2ClientId": "******.apps.googleusercontent.com",
    "OAuth2ClientSecret": "******",
    "OAuth2RefreshToken": "******",
}

Memuat konfigurasi

Selanjutnya, muat file JSON ke IConfigurationRoot.

ConfigurationBuilder builder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("GoogleAdsApi.json");
IConfigurationRoot configRoot = builder.Build();

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromConfigurationRoot(configRoot);
GoogleAdsClient client = new GoogleAdsClient(config);

Konfigurasi menggunakan settings.json

Proses di sini mirip dengan menggunakan JSON kustom, hanya saja kunci harus berada di bagian bernama GoogleAdsApi:

{
    "GoogleAdsApi":
    {
        "DeveloperToken": "******",
        "OAuth2Mode": "APPLICATION",
        "OAuth2ClientId": "******.apps.googleusercontent.com",
        "OAuth2ClientSecret": "******",
        "OAuth2RefreshToken": "******",
        ...
    }
    // More settings...
}

Selanjutnya, Anda dapat menggunakan instance IConfiguration di halaman Anda:

IConfigurationSection section = Configuration.GetSection("GoogleAdsApi");
GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromConfigurationSection(section);
GoogleAdsClient client = new GoogleAdsClient(config);

Konfigurasi menggunakan variabel lingkungan

Anda juga dapat melakukan inisialisasi GoogleAdsClient menggunakan variabel lingkungan:

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromEnvironmentVariables();
GoogleAdsClient client = new GoogleAdsClient(config);

Lihat daftar lengkap variabel lingkungan yang didukung.

Kolom konfigurasi

Berikut adalah daftar setelan yang didukung library .NET Google Ads.

Setelan konektivitas

Timeout: Gunakan kunci ini untuk menyetel waktu tunggu layanan dalam milidetik. Nilai default ditetapkan berdasarkan setelan method_config/timeout di googleads_grpc_service_config.json. Tetapkan nilai yang lebih rendah jika Anda perlu menerapkan batas yang lebih singkat pada waktu maksimum untuk panggilan API. Anda dapat menetapkan waktu tunggu ke 2 jam atau lebih, tetapi API mungkin masih akan kehabisan waktu permintaan yang berjalan sangat lama dan menampilkan error DEADLINE_EXCEEDED.
ProxyServer: Menetapkannya ke URL server proxy HTTP jika Anda menggunakan proxy untuk terhubung ke internet.
ProxyUser: Tetapkan string ini ke nama pengguna yang Anda perlukan untuk melakukan autentikasi terhadap server proxy. Biarkan kosong jika nama pengguna tidak diperlukan.
ProxyPassword: Tetapkan string ini ke sandi ProxyUser jika Anda menetapkan nilai untuk ProxyUser.
ProxyDomain: Setel ini ke domain untuk ProxyUser jika server proxy Anda memerlukannya untuk menyetelnya.
MaxReceiveMessageLengthInBytes: Gunakan setelan ini untuk meningkatkan ukuran maksimum respons API yang dapat ditangani library klien. Nilai defaultnya adalah 64 MB.
MaxMetadataSizeInBytes: Gunakan setelan ini untuk meningkatkan ukuran maksimum respons error API yang dapat ditangani library klien. Nilai defaultnya adalah 16 MB.

Sesuaikan setelan MaxReceiveMessageLengthInBytes dan MaxMetadataSizeInBytes untuk memperbaiki error ResourceExhausted tertentu. Setelan ini mengatasi error dalam formulir Status(StatusCode="ResourceExhausted",Detail="Received message larger than max (423184132 versus 67108864)".

Dalam contoh ini, error disebabkan oleh ukuran pesan (423184132 bytes) yang lebih besar daripada yang dapat ditangani library (67108864 bytes). Tingkatkan MaxReceiveMessageLengthInBytes menjadi 500000000 untuk menghindari error ini.

Perlu diperhatikan bahwa error ini juga menunjukkan bahwa kode Anda menangani objek Respons yang sangat besar (seperti SearchGoogleAdsResponse yang besar). Hal ini dapat berdampak pada performa kode Anda karena Heap Objek Besar .NET. Jika hal ini menjadi masalah performa, Anda mungkin harus mencari tahu cara mengatur ulang panggilan API atau mendesain ulang bagian-bagian aplikasi.

Setelan OAuth2

Saat menggunakan OAuth2 untuk memberi otorisasi panggilan terhadap server Google Ads API, Anda harus menetapkan kunci konfigurasi berikut:

AuthorizationMethod: Tetapkan ke OAuth2.
OAuth2Mode: Tetapkan ke APPLICATION atau SERVICE_ACCOUNT.
OAuth2ClientId: Tetapkan nilai ini ke client ID OAuth2 Anda.
OAuth2ClientSecret: Tetapkan nilai ini ke rahasia klien OAuth2 Anda.
OAuth2Scope: Tetapkan nilai ini ke cakupan yang berbeda jika Anda ingin memberikan otorisasi token OAuth2 untuk beberapa API. Setelan ini bersifat opsional.

Jika menggunakan OAuth2Mode == APPLICATION, Anda perlu menetapkan kunci konfigurasi tambahan berikut.

OAuth2RefreshToken: Tetapkan nilai ini ke token refresh OAuth2 yang dibuat sebelumnya jika Anda ingin menggunakan kembali token OAuth2. Setelan ini bersifat opsional.
OAuth2RedirectUri: Tetapkan nilai ini ke URL alihan OAuth2. Setelan ini bersifat opsional.

Lihat panduan berikut untuk detail selengkapnya:

Jika menggunakan OAuth2Mode == SERVICE_ACCOUNT, Anda perlu menetapkan kunci konfigurasi tambahan berikut.

OAuth2PrnEmail: Tetapkan nilai ini ke alamat email akun yang Anda tiru.
OAuth2SecretsJsonPath: Tetapkan nilai ini ke jalur file konfigurasi JSON OAuth2.

Lihat panduan alur akun layanan OAuth untuk mengetahui detail selengkapnya.

Setelan transportasi

UseGrpcCore: Menetapkan setelan ini ke true untuk menggunakan library Grpc.Core sebagai lapisan transpor dasar. Lihat panduan dukungan gRPC untuk detail selengkapnya.

Setelan Google Ads API

Setelan berikut khusus untuk Google Ads API.

DeveloperToken: Tetapkan parameter ini ke token developer Anda.
LoginCustomerId: Ini adalah ID pelanggan dari pelanggan yang diberi otorisasi untuk digunakan dalam permintaan, tanpa tanda hubung (-).
LinkedCustomerId: Header ini hanya diperlukan untuk metode yang memperbarui resource suatu entitas jika diizinkan melalui Akun Tertaut di UI Google Ads (referensi AccountLink di Google Ads API). Setel nilai ini ke ID pelanggan penyedia data yang memperbarui resource ID pelanggan yang ditentukan. Atribut ini harus ditetapkan tanpa tanda hubung (-). Pelajari Akun Tertaut lebih lanjut.