Zeitlimits

Die Clientbibliothek für Python gibt keine Standardzeitüberschreitungen an und es sind auch keine Standardwerte für die gRPC-Transportschicht festgelegt. Das bedeutet, dass die Clientbibliothek für Python standardmäßig das Zeitüberschreitungsverhalten vollständig an den Server delegiert.

Das ist für die meisten Anwendungsfälle ausreichend. Wenn jedoch ein clientseitiger Zeitüberschreitungswert angegeben werden muss, unterstützt die Clientbibliothek für Python sowohl Timeout-Überschreibungen für Streaming- als auch für unary-Aufrufe.

Sie können das Zeitlimit auf mindestens zwei Stunden festlegen. Bei extrem lang laufenden Anfragen kann es jedoch trotzdem zu einem Zeitüberschreitungsfehler der API kommen, der den Fehlercode DEADLINE_EXCEEDED zurückgibt. Wenn dies ein Problem darstellt, können Sie die Abfrage aufteilen und die einzelnen Teile parallel ausführen. So wird verhindert, dass eine lang laufende Anfrage fehlschlägt und nur durch einen Neustart der Anfrage wiederhergestellt werden kann.

Zeitüberschreitungen beim Streaming von Anrufen

Die einzige Google Ads API-Dienstmethode, bei der diese Art von Aufruf verwendet wird, ist GoogleAdsService.SearchStream.

Wenn Sie die Standardzeitüberschreitung überschreiben möchten, müssen Sie beim Aufrufen der Methode einen zusätzlichen Parameter hinzufügen:

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)}")
set_custom_client_timeouts.py
      

Zeitüberschreitungen für unary calls

Die meisten Google Ads API-Dienstmethoden verwenden unäre Aufrufe. Typische Beispiele sind GoogleAdsService.Search und GoogleAdsService.Mutate.

Wenn Sie die Standardzeitüberschreitung überschreiben möchten, müssen Sie beim Aufrufen der Methode einen zusätzlichen Parameter hinzufügen:

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)}")
set_custom_client_timeouts.py