Konfigurasi

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

Catatan: Setelan dinamis yang ditentukan secara eksplisit akan menggantikan setelan yang dimuat dari variabel lingkungan atau file konfigurasi INI, bergantung pada urutan pemanggilan metode builder.

File konfigurasi

Anda dapat menyimpan sebagian besar setelan konfigurasi ini dalam file konfigurasi INI dan menggunakannya saat membuat instance klien, misalnya, google_ads_php.ini.

Builder kredensial dan klien menyediakan metode fromFile untuk memuat setelan dari file tersebut:

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

Jika tidak ada jalur konfigurasi yang diberikan sebagai argumen, metode fromFile akan dimuat dari jalur konfigurasi default, yaitu:

1. Nilai variabel lingkungan bernama GOOGLE_ADS_CONFIGURATION_FILE_PATH jika ditetapkan.
2. Jika tidak, file google_ads_php.ini di direktori HOME Anda.

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile()
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

Konfigurasi dinamis

Anda dapat menetapkan setelan konfigurasi ini secara dinamis saat membuat instance klien:

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->withClientId('INSERT_CLIENT_ID_HERE')
    ->withClientSecret('INSERT_CLIENT_SECRET_HERE')
    ->withRefreshToken('INSERT_REFRESH_TOKEN_HERE')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

Variabel lingkungan konfigurasi

Anda dapat menetapkan beberapa setelan konfigurasi dari variabel lingkungan saat membuat instance klien (lihat variabel lingkungan standar).

Builder kredensial dan klien menyediakan metode fromEnvironmentVariables untuk memuat setelan dari variabel lingkungan.

Catatan: Variabel lingkungan yang tidak ditetapkan tidak akan diperhitungkan.

$oAuth2Credential = (new OAuth2TokenBuilder())
    // ...
    ->fromEnvironmentVariables()
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    // ...
    ->fromEnvironmentVariables()
    ->build();

Kolom konfigurasi

Catatan: Kolom grpcChannelCredential, unaryMiddlewares, streamingMiddlewares, dan grpcInterceptors tidak dapat ditetapkan dari file konfigurasi atau string, dan hanya dapat dikonfigurasi secara dinamis.

Setelan konfigurasi mendukung beberapa kolom yang diatur dalam kategori:

1. Kolom yang digunakan oleh OAuth2TokenBuilder:
   • Mode aplikasi:
     • [OAUTH2] clientId: Client ID OAuth2 Anda.
     • [OAUTH2] clientSecret: Rahasia klien OAuth2 Anda.
     • [OAUTH2] refreshToken: Token refresh OAuth2 Anda.
   • Mode akun layanan:
     • [OAUTH2] jsonKeyFilePath: Jalur kunci JSON.
     • [OAUTH2] scopes: Cakupan OAuth2 (secara default ditetapkan ke https://www.googleapis.com/auth/adwords di v32.1.0 dan yang lebih baru; diperlukan dalam versi sebelum v32.1.0 atau saat menggunakan cakupan kustom; tidak dibaca dari variabel lingkungan oleh fromEnvironmentVariables()).
     • [OAUTH2] impersonatedEmail: Alamat email opsional untuk ditiru identitasnya saat menggunakan delegasi di seluruh domain Google Workspace.
   • Mode Kredensial Default Aplikasi:
     • Jika kolom Application mode atau Service account mode tidak ditetapkan, OAuth2TokenBuilder akan otomatis beralih ke Kredensial Default Aplikasi (ADC).
2. Kolom yang digunakan oleh GoogleAdsClientBuilder:
   • [GOOGLE_ADS] loginCustomerId: ID pelanggan yang diberi otorisasi untuk digunakan dalam permintaan.
   • [GOOGLE_ADS] linkedCustomerId: ID pelanggan tertaut.
   • [GOOGLE_ADS] endpoint: Endpoint server Google Ads API alternatif opsional.
   • [LOGGING] logFilePath: Jalur untuk output logging.
   • [LOGGING] logLevel: Level logging.
   • [CONNECTION] proxy: URL server proxy yang digunakan untuk konektivitas internet.
   • [CONNECTION] transport: Transportasi jaringan (grpc atau rest).
   • [CONNECTION] grpcChannelIsSecure: Apakah saluran gRPC aman.
   • [CONNECTION] grpcChannelCredential: Kredensial saluran gRPC.
   • [CONNECTION] unaryMiddlewares: Middleware unary.
   • [CONNECTION] streamingMiddlewares: Middleware streaming.
   • [CONNECTION] grpcInterceptors: Interseptor gRPC.

Validasi konfigurasi

Setelan konfigurasi diperiksa saat membuat instance klien dan pengecualian akan ditampilkan jika tidak valid. Aturan validasinya adalah sebagai berikut:

1. Kolom [OAUTH2] tidak boleh ditetapkan untuk mode Aplikasi dan mode Akun layanan secara bersamaan.
2. [OAUTH2] jsonKeyFilePath harus ditetapkan saat menggunakan mode Akun layanan (dalam versi sebelum v32.1.0, [OAUTH2] scopes juga harus ditetapkan; dalam v32.1.0 dan yang lebih baru, scopes ditetapkan secara default ke https://www.googleapis.com/auth/adwords).
3. [OAUTH2] clientId, [OAUTH2] clientSecret, dan [OAUTH2] refreshToken harus ditetapkan saat menggunakan mode Aplikasi.
4. Jika ditetapkan, [GOOGLE_ADS] loginCustomerId dan [GOOGLE_ADS] linkedCustomerId harus berupa bilangan positif.
5. Jika ditetapkan, [CONNECTION] proxy harus berupa URL yang valid (lihat filter FILTER_VALIDATE_URL).
6. Jika ditetapkan, [LOGGING] logLevel harus berupa tingkat log PSR yang valid dalam huruf kapital, seperti INFO.
7. Jika ditetapkan, [CONNECTION] transport harus berupa grpc atau rest.
8. Jika [CONNECTION] transport ditetapkan ke grpc, transport gRPC harus didukung oleh lingkungan (lihat Panduan transport).
9. [CONNECTION] grpcChannelIsSecure harus berupa true jika [CONNECTION] transport tidak ditetapkan ke grpc (koneksi REST selalu memerlukan HTTPS).
10. [CONNECTION] grpcChannelCredential hanya dapat ditetapkan jika [CONNECTION] transport ditetapkan ke grpc.
11. [CONNECTION] grpcChannelCredential hanya dapat ditetapkan jika [CONNECTION] grpcChannelIsSecure adalah true.