org.apache.beam.sdk.io.googleads

Class GoogleAdsV17.ReadAll

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<com.google.ads.googleads.v17.services.SearchGoogleAdsStreamRequest>,PCollection<com.google.ads.googleads.v17.services.GoogleAdsRow>>

org.apache.beam.sdk.io.googleads.GoogleAdsV17.ReadAll

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

GoogleAdsV17

public abstract static class GoogleAdsV17.ReadAll
extends PTransform<PCollection<com.google.ads.googleads.v17.services.SearchGoogleAdsStreamRequest>,PCollection<com.google.ads.googleads.v17.services.GoogleAdsRow>>

A PTransform that reads the results of many SearchGoogleAdsStreamRequest objects as GoogleAdsRow objects. *

See Also:

GoogleAdsIO.v17(), GoogleAdsV17.readAll(), Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
ReadAll()

Method Summary

Modifier and Type	Method and Description
PCollection<com.google.ads.googleads.v17.services.GoogleAdsRow>	expand(PCollection<com.google.ads.googleads.v17.services.SearchGoogleAdsStreamRequest> input) Override this method to specify how this PTransform should be expanded on the given InputT.
GoogleAdsV17.ReadAll	withDeveloperToken(@Nullable java.lang.String developerToken) Creates and returns a new GoogleAdsV17.ReadAll transform with the specified developer token.
GoogleAdsV17.ReadAll	withGoogleAdsClientFactory(GoogleAdsClientFactory googleAdsClientFactory) Creates and returns a new GoogleAdsV17.ReadAll transform with the specified client factory.
GoogleAdsV17.ReadAll	withLoginCustomerId(@Nullable java.lang.Long loginCustomerId) Creates and returns a new GoogleAdsV17.ReadAll transform with the specified login customer ID.
GoogleAdsV17.ReadAll	withRateLimitPolicy(GoogleAdsV17.RateLimitPolicyFactory rateLimitPolicyFactory) Creates and returns a new GoogleAdsV17.ReadAll transform with the specified rate limit policy factory.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReadAll

public ReadAll()

Method Detail

withDeveloperToken

public GoogleAdsV17.ReadAll withDeveloperToken(@Nullable java.lang.String developerToken)

Creates and returns a new GoogleAdsV17.ReadAll transform with the specified developer token. A developer token is required to access the Google Ads API.

Parameters:

developerToken - The developer token to set.

Returns:

A new GoogleAdsV17.ReadAll transform with the specified developer token.

See Also:

GoogleAdsClient

withLoginCustomerId

public GoogleAdsV17.ReadAll withLoginCustomerId(@Nullable java.lang.Long loginCustomerId)

Creates and returns a new GoogleAdsV17.ReadAll transform with the specified login customer ID. A login customer ID is only required for manager accounts.

Parameters:

loginCustomerId - The login customer ID to set.

Returns:

A new GoogleAdsV17.ReadAll transform with the specified login customer ID.

See Also:

GoogleAdsClient

withGoogleAdsClientFactory

public GoogleAdsV17.ReadAll withGoogleAdsClientFactory(GoogleAdsClientFactory googleAdsClientFactory)

Creates and returns a new GoogleAdsV17.ReadAll transform with the specified client factory. A GoogleAdsClientFactory builds the GoogleAdsClient used to construct service clients. The DefaultGoogleAdsClientFactory should be sufficient for most purposes unless the construction of GoogleAdsClient requires customization.

Parameters:

googleAdsClientFactory -

Returns:

A new GoogleAdsV17.ReadAll transform with the specified client factory.

See Also:

GoogleAdsClient

withRateLimitPolicy

public GoogleAdsV17.ReadAll withRateLimitPolicy(GoogleAdsV17.RateLimitPolicyFactory rateLimitPolicyFactory)

Creates and returns a new GoogleAdsV17.ReadAll transform with the specified rate limit policy factory. A GoogleAdsV17.RateLimitPolicyFactory builds the GoogleAdsV17.RateLimitPolicy used to limit the number of requests made by ReadAll.ReadAllFn. The Google Ads API enforces global limits from the developer token down to the customer ID and it is recommended to host a shared rate limiting service to coordinate traffic to the Google Ads API across all applications using the same developer token. Users of these transforms are strongly advised to implement their own GoogleAdsV17.RateLimitPolicy and GoogleAdsV17.RateLimitPolicyFactory to interact with a shared rate limiting service for any production workloads.

Parameters:

rateLimitPolicyFactory -

Returns:

A new GoogleAdsV17.ReadAll transform with the specified rate limit policy factory.

See Also:

GoogleAdsClient

expand

public PCollection<com.google.ads.googleads.v17.services.GoogleAdsRow> expand(PCollection<com.google.ads.googleads.v17.services.SearchGoogleAdsStreamRequest> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<com.google.ads.googleads.v17.services.SearchGoogleAdsStreamRequest>,PCollection<com.google.ads.googleads.v17.services.GoogleAdsRow>>