設定

Google Ads API クライアント ライブラリには、ライブラリの動作をカスタマイズするために使用できる設定がいくつか用意されています。

実行時にライブラリを構成する

クライアント ライブラリを構成する推奨の方法は、実行時に GoogleAdsConfig オブジェクトを初期化することです。

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

GoogleAdsClient client = new GoogleAdsClient(config);

代替構成オプション

クライアント ライブラリを構成するための追加オプションも用意されています。これらのオプションを有効にするには、プロジェクトの Google.Ads.GoogleAds.Extensions パッケージに Nuget 参照を追加します。

これらのオプションのいずれかを使用する場合は、構成設定が自動的に取得されません。次の例に示すように、明示的に読み込む必要があります。

App.config を使用して構成する

Google Ads API に固有の設定はすべて、App.config ファイルの GoogleAdsApi ノードに保存されます。一般的な構成 App.config は次のとおりです。

<?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>

App.config ファイルから構成設定を読み込むには、GoogleAdsConfig オブジェクトで LoadFromDefaultAppConfigSection メソッドを呼び出します。

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

別の App.config ファイルを指定する

App.config が煩雑になるのを避けたい場合は、configSource プロパティを使用して、ライブラリ固有の構成を独自の構成ファイルに移動できます。

ステップ 1: App.config で configSource を指定する

App.config を次のように変更します。

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

ステップ 2: 構成ファイルの内容を指定する

次に、configSource で指定した名前で別の構成ファイルを作成し、App.config からこのファイルに構成ノードを移動します。

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

ステップ 3: csproj のビルドルールを修正する

最後に、新しい構成ファイルをプロジェクトに含めます。このファイルのプロパティを [Always copy to output folder] に変更します。

次に、プロジェクトをビルドして実行します。アプリケーションは、新しい構成ファイルから値を取得し始めます。

カスタム JSON ファイルを使用した構成

IConfigurationRoot インスタンスを使用して、クライアント ライブラリを構成できます。

JSON ファイルを作成する

App.config ファイルと同様の構造を持つ GoogleAdsApi.json という名前の JSON ファイルを作成します。

{
    "Timeout": "2000",

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

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

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

構成を読み込む

次に、JSON ファイルを 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);

settings.json を使用した構成

ここでのプロセスは、カスタム JSON を使用する場合と似ていますが、キーは GoogleAdsApi という名前のセクションに配置する必要があります。

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

次に、ページで IConfiguration インスタンスを使用できます。

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

環境変数を使用した構成

環境変数を使用して GoogleAdsClient を初期化することもできます。

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

サポートされている環境変数の全リストをご覧ください。

構成フィールド

Google 広告 .NET ライブラリでサポートされている設定のリストは次のとおりです。

接続の設定

  • Timeout: このキーを使用して、サービス タイムアウトをミリ秒単位で設定します。デフォルト値は、googleads_grpc_service_config.json の method_config/timeout 設定に基づいて設定されます。API 呼び出しの最大時間を短く制限する必要がある場合は、値を小さく設定します。タイムアウトは 2 時間以上に設定できますが、API は非常に長いリクエストをタイムアウトして DEADLINE_EXCEEDED エラーを返すことがあります。
  • ProxyServer: プロキシを使用してインターネットに接続する場合は、HTTP プロキシ サーバーの URL に設定します。
  • ProxyUser: プロキシ サーバーに対する認証に必要なユーザー名に設定します。ユーザー名が不要な場合は、このフィールドを空のままにします。
  • ProxyPassword: ProxyUser の値を設定した場合は、ProxyUser のパスワードに設定します。
  • ProxyDomain: プロキシ サーバーで設定が必要な場合は、ProxyUser のドメインに設定します。
  • MaxReceiveMessageLengthInBytes: この設定を使用して、クライアント ライブラリが処理できる API レスポンスの最大サイズを増やします。デフォルト値は 64 MB です。
  • MaxMetadataSizeInBytes: この設定を使用して、クライアント ライブラリが処理できる API エラー レスポンスの最大サイズを増やします。デフォルト値は 16 MB です。

MaxReceiveMessageLengthInBytes と MaxMetadataSizeInBytes の設定を調整して、特定の ResourceExhausted エラーを修正します。これらの設定は、Status(StatusCode="ResourceExhausted",Detail="Received message larger than max (423184132 versus 67108864)" 形式のエラーに対処します。

この例では、メッセージ サイズ（423184132 bytes）がライブラリで処理できるサイズ（67108864 bytes）よりも大きいため、エラーが発生しています。このエラーを回避するには、MaxReceiveMessageLengthInBytes を 500000000 に増やします。

このエラーは、コードが非常に大きな Response オブジェクト（大きな SearchGoogleAdsResponse など）を処理したことも示しています。これは、.NET のラージ オブジェクト ヒープが原因で、コードのパフォーマンスに影響する可能性があります。パフォーマンスの問題が発生した場合は、API 呼び出しの再編成やアプリの一部の再設計を検討する必要があるかもしれません。

OAuth2 の設定

OAuth2 を使用して Google Ads API サーバーに対する呼び出しを承認する場合は、次の構成キーを設定する必要があります。

  • AuthorizationMethod: OAuth2 に設定します。
  • OAuth2Mode: APPLICATION または SERVICE_ACCOUNT に設定します。
  • OAuth2ClientId: この値を OAuth2 クライアント ID に設定します。
  • OAuth2ClientSecret: この値は OAuth2 クライアント シークレットに設定します。
  • OAuth2Scope: 複数の API の OAuth2 トークンを承認する場合は、この値を異なるスコープに設定します。この設定は省略可能です。

OAuth2Mode == APPLICATION を使用している場合は、次の追加の構成キーを設定する必要があります。

  • OAuth2RefreshToken: OAuth2 トークンを再利用する場合は、この値を事前に生成された OAuth2 更新トークンに設定します。この設定は省略可能です。
  • OAuth2RedirectUri: この値を OAuth2 リダイレクト URL に設定します。この設定は省略可能です。

詳細については、次のガイドをご覧ください。

OAuth2Mode == SERVICE_ACCOUNT を使用している場合は、次の追加の構成キーを設定する必要があります。

  • OAuth2PrnEmail: この値は、権限借用するアカウントのメールアドレスに設定します。
  • OAuth2SecretsJsonPath: この値を OAuth2 JSON 構成ファイルのパスに設定します。

詳細については、OAuth サービス アカウント フローガイドをご覧ください。

交通手段の設定

  • UseGrpcCore: この設定を true に設定すると、基盤となるトランスポート レイヤとして Grpc.Core ライブラリが使用されます。以前の Grpc ライブラリを使用するをご覧ください。

Google Ads API の設定

以下は、Google Ads API に固有の設定です。

  • DeveloperToken: デベロッパー トークンに設定します。
  • LoginCustomerId: これは、リクエストで使用する承認済みクライアントのお客様 ID で、ハイフン（-）なしで使用します。
  • LinkedCustomerId: このヘッダーは、Google 広告の UI のリンク済みアカウント（Google Ads API の AccountLink リソース）で権限が付与されている場合に、エンティティのリソースを更新するメソッドでのみ必要です。この値は、指定された顧客 ID のリソースを更新するデータ プロバイダの顧客 ID に設定します。ハイフンなしで設定する必要があります（-）。リンク済みアカウントの詳細