設定

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

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

クライアント ライブラリを構成するには、実行時に GoogleAdsConfig オブジェクトを初期化することをおすすめします。

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = "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 のビルドルールを修正する

最後に、プロジェクトに新しい構成ファイルを含めます。このファイルのプロパティを [常に出力フォルダにコピー] に変更します。

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

カスタム 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 Ads .NET ライブラリでサポートされている設定は次のとおりです。

接続の設定

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

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

この例では、メッセージ サイズ(423184132 bytes)がライブラリが処理できるサイズ(67108864 bytes)よりも大きいことがエラーの原因です。このエラーを回避するには、MaxReceiveMessageLengthInBytes500000000 に増やします。

このエラーは、コードがかなり大きな 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: Grpc.Core ライブラリを基盤となるトランスポート レイヤとして使用するには、この設定を true に設定します。詳細については、gRPC サポートガイドをご覧ください。

Google Ads API の設定

次の設定は、Google Ads API に固有のものです。

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