टाइम आउट

Python के लिए क्लाइंट लाइब्रेरी, कोई डिफ़ॉल्ट टाइम आउट तय नहीं करती. साथ ही, gRPC ट्रांसपोर्ट लेयर के लिए भी कोई डिफ़ॉल्ट डिफ़ॉल्ट सेटिंग नहीं होती. इसका मतलब है कि डिफ़ॉल्ट रूप से, Python की क्लाइंट लाइब्रेरी, टाइम आउट व्यवहार को पूरी तरह से सर्वर को सौंप देती है.

इस्तेमाल के ज़्यादातर मामलों में यह काफ़ी होता है. हालांकि, अगर क्लाइंट-साइड टाइम आउट के बारे में बताना ज़रूरी हो, तो Python की क्लाइंट लाइब्रेरी, स्ट्रीमिंग और एकरी कॉल, दोनों के लिए टाइम आउट ओवरराइड करने की सुविधा देती है.

टाइम आउट की अवधि को दो घंटे या उससे ज़्यादा पर सेट किया जा सकता है. हालांकि, हो सकता है कि एपीआई अब भी बहुत लंबे समय से चल रहे अनुरोधों का समय खत्म कर दे और यह 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)}")
set_custom_client_timeouts.py
      

एक ही कॉल में टाइम आउट की सुविधा

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