org.apache.beam.sdk.io.googleads

Interface GoogleAdsIO.RateLimitPolicy<GoogleAdsErrorT>

All Known Implementing Classes:

GoogleAdsV19.SimpleRateLimitPolicy

Enclosing class:

GoogleAdsIO<GoogleAdsRowT,SearchGoogleAdsStreamRequestT>

public static interface GoogleAdsIO.RateLimitPolicy<GoogleAdsErrorT>

This interface can be used to implement custom client-side rate limiting policies. Custom policies should follow best practices for interacting with the Google Ads API.

See Also:

Best Practices in the Google Ads documentation

Method Summary

Modifier and Type	Method and Description
void	onBeforeRequest(@Nullable java.lang.String developerToken, java.lang.String customerId, com.google.protobuf.Message request) Called before a request is sent.
void	onError(@Nullable java.lang.String developerToken, java.lang.String customerId, com.google.protobuf.Message request, GoogleAdsErrorT error) Called after a request fails with a retryable error.
void	onSuccess(@Nullable java.lang.String developerToken, java.lang.String customerId, com.google.protobuf.Message request) Called after a request succeeds.

Method Detail

onBeforeRequest

void onBeforeRequest(@Nullable java.lang.String developerToken,
                     java.lang.String customerId,
                     com.google.protobuf.Message request)
              throws java.lang.InterruptedException

Called before a request is sent.

Parameters:

developerToken - The developer token used for the request.

customerId - The customer ID specified on the request.

request - Any Google Ads API request.

Throws:

java.lang.InterruptedException

onSuccess

void onSuccess(@Nullable java.lang.String developerToken,
               java.lang.String customerId,
               com.google.protobuf.Message request)

Called after a request succeeds.

Parameters:

developerToken - The developer token used for the request.

customerId - The customer ID specified on the request.

request - Any Google Ads API request.

onError

void onError(@Nullable java.lang.String developerToken,
             java.lang.String customerId,
             com.google.protobuf.Message request,
             GoogleAdsErrorT error)

Called after a request fails with a retryable error.

Parameters:

developerToken - The developer token used for the request.

customerId - The customer ID specified on the request.

request - Any Google Ads API request.

error - A retryable error.