Python 用のクライアント ライブラリでは、デフォルトのタイムアウトや gRPC トランスポート レイヤで指定されるデフォルトはありません。つまり、デフォルトでは、Python 用のクライアント ライブラリはタイムアウトの動作をサーバーに完全に委任します。
ほとんどのユースケースではこれで十分ですが、クライアント側のタイムアウトを指定する必要がある場合、Python 用のクライアント ライブラリでは、ストリーミング呼び出しと単項呼び出しの両方でタイムアウト オーバーライドがサポートされます。
タイムアウトを 2 時間以上に設定できますが、それでも API が非常に長時間実行リクエストをタイムアウトし、DEADLINE_EXCEEDED エラーを返すことがあります。これが問題になる場合は、クエリを分割してチャンクを並行して実行できます。これにより、長時間実行リクエストが失敗する状況が回避され、復元する唯一の方法はリクエストを再開します。
ストリーミング呼び出しのタイムアウト
このタイプの呼び出しを使用する Google Ads API サービス メソッドは、GoogleAdsService.SearchStream のみです。
デフォルトのタイムアウトをオーバーライドするには、メソッドを呼び出すときにパラメータを追加する必要があります。
def make_server_streaming_call(client, customer_id):
"""Makes a server streaming call using a custom client timeout.
Args:
client: An initialized GoogleAds client.
customer_id: The str Google Ads customer ID.
"""
ga_service = client.get_service("GoogleAdsService")
campaign_ids = []
try:
search_request = client.get_type("SearchGoogleAdsStreamRequest")
search_request.customer_id = customer_id
search_request.query = _QUERY
stream = ga_service.search_stream(
request=search_request,
# When making any request, an optional "timeout" parameter can be
# provided to specify a client-side response deadline in seconds.
# If not set, then no timeout will be enforced by the client and
# the channel will remain open until the response is completed or
# severed, either manually or by the server.
timeout=_CLIENT_TIMEOUT_SECONDS,
)
for batch in stream:
for row in batch.results:
campaign_ids.append(row.campaign.id)
print("The server streaming call completed before the timeout.")
except DeadlineExceeded as ex:
print("The server streaming call did not complete before the timeout.")
sys.exit(1)
except GoogleAdsException as ex:
print(
f"Request with ID '{ex.request_id}' failed with status "
f"'{ex.error.code().name}' and includes the following errors:"
)
for error in ex.failure.errors:
print(f"\tError with message '{error.message}'.")
if error.location:
for field_path_element in error.location.field_path_elements:
print(f"\t\tOn field: {field_path_element.field_name}")
sys.exit(1)
print(f"Total # of campaign IDs retrieved: {len(campaign_ids)}")
単項呼び出しのタイムアウト
Google Ads API サービスのほとんどのメソッドでは、単項呼び出しを使用します。一般的な例としては、GoogleAdsService.Search や GoogleAdsService.Mutate が挙げられます。
デフォルトのタイムアウトをオーバーライドするには、メソッドを呼び出すときにパラメータを追加する必要があります。
def make_unary_call(client, customer_id):
"""Makes a unary call using a custom client timeout.
Args:
client: An initialized GoogleAds client.
customer_id: The Google Ads customer ID.
"""
ga_service = client.get_service("GoogleAdsService")
campaign_ids = []
try:
search_request = client.get_type("SearchGoogleAdsRequest")
search_request.customer_id = customer_id
search_request.query = _QUERY
results = ga_service.search(
request=search_request,
# When making any request, an optional "retry" parameter can be
# provided to specify its retry behavior. Complete information about
# these settings can be found here:
# https://googleapis.dev/python/google-api-core/latest/retry.html
retry=Retry(
# Sets the maximum accumulative timeout of the call; it
# includes all tries.
deadline=_CLIENT_TIMEOUT_SECONDS,
# Sets the timeout that is used for the first try to one tenth
# of the maximum accumulative timeout of the call.
# Note: This overrides the default value and can lead to
# RequestError.RPC_DEADLINE_TOO_SHORT errors when too small. We
# recommend changing the value only if necessary.
initial=_CLIENT_TIMEOUT_SECONDS / 10,
# Sets the maximum timeout that can be used for any given try
# to one fifth of the maximum accumulative timeout of the call
# (two times greater than the timeout that is needed for the
# first try).
maximum=_CLIENT_TIMEOUT_SECONDS / 5,
),
)
for row in results:
campaign_ids.append(row.campaign.id)
print("The unary call completed before the timeout.")
except DeadlineExceeded as ex:
print("The unary call did not complete before the timeout.")
sys.exit(1)
except GoogleAdsException as ex:
print(
f"Request with ID '{ex.request_id}' failed with status "
f"'{ex.error.code().name}' and includes the following errors:"
)
for error in ex.failure.errors:
print(f"\tError with message '{error.message}'.")
if error.location:
for field_path_element in error.location.field_path_elements:
print(f"\t\tOn field: {field_path_element.field_name}")
sys.exit(1)
print(f"Total # of campaign IDs retrieved: {len(campaign_ids)}")