A B C D E F G H I L M N O P R S T V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractGoogleAdsClient - Class in com.google.ads.googleads.lib
- AbstractGoogleAdsClient() - Constructor for class com.google.ads.googleads.lib.AbstractGoogleAdsClient
- allSetFieldsOf(T) - Static method in class com.google.ads.googleads.lib.utils.FieldMasks
-
Computes a FieldMask based on all of the fields of message that have been set.
- ApiCatalog - Interface in com.google.ads.googleads.lib.catalog
-
Provides metadata about the Google Ads API versions supported in the client library.
B
- build() - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Returns a new instance of
GoogleAdsClient
based on the attributes of this builder. - build() - Method in class com.google.ads.googleads.lib.GoogleAdsHeaderProvider.Builder
-
Constructs a provider from the currently configured values.
- Builder() - Constructor for class com.google.ads.googleads.lib.GoogleAdsClient.Builder
- Builder() - Constructor for class com.google.ads.googleads.lib.GoogleAdsHeaderProvider.Builder
C
- CLIENT_ID - com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
- CLIENT_SECRET - com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
- com.google.ads.googleads.lib - package com.google.ads.googleads.lib
- com.google.ads.googleads.lib.callables - package com.google.ads.googleads.lib.callables
- com.google.ads.googleads.lib.catalog - package com.google.ads.googleads.lib.catalog
- com.google.ads.googleads.lib.logging - package com.google.ads.googleads.lib.logging
- com.google.ads.googleads.lib.logging.scrub - package com.google.ads.googleads.lib.logging.scrub
- com.google.ads.googleads.lib.reflect - package com.google.ads.googleads.lib.reflect
- com.google.ads.googleads.lib.utils - package com.google.ads.googleads.lib.utils
- com.google.ads.googleads.lib.utils.messageproxy - package com.google.ads.googleads.lib.utils.messageproxy
- compare(T, T) - Static method in class com.google.ads.googleads.lib.utils.FieldMasks
-
Compares two protobuf message objects and computes a FieldMask based on the differences between the two objects.
- compareTo(Version) - Method in class com.google.ads.googleads.lib.catalog.Version
-
Allows sorting of versions, higher version numbers have lower sorting rank, as in v1 < v0.
- containsMessage(Message) - Method in class com.google.ads.googleads.lib.catalog.Version
-
Returns true if this Version is the same as that of the provided message.
- createAllVersionsClient(TransportChannelProvider, Credentials) - Method in interface com.google.ads.googleads.lib.catalog.ApiCatalog
-
Instantiates a new GoogleAdsAllVersions object for the given TransportChannelProvider and Credentials.
- createAllVersionsClient(TransportChannelProvider, Credentials) - Method in class com.google.ads.googleads.lib.catalog.GeneratedCatalog
D
- DEFAULT_PROPERTIES_CONFIG_FILE_NAME - Static variable in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
The default file name for the properties configuration file.
- DefaultPrimer - Class in com.google.ads.googleads.lib.catalog
-
Implements Primer by running classloading and OAuth flows asynchronously.
- DEVELOPER_TOKEN - com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
E
- edit(Object) - Method in class com.google.ads.googleads.lib.logging.scrub.LogScrubber
-
Scrubs a given input.
- edit(T) - Method in interface com.google.ads.googleads.lib.utils.messageproxy.MessageEditor
-
Performs the edit on an input message.
- ENDPOINT - com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
- equals(Object) - Method in class com.google.ads.googleads.lib.catalog.Version
F
- FieldAccessor - Interface in com.google.ads.googleads.lib.logging.scrub
- FieldDescriptorCache - Class in com.google.ads.googleads.lib.logging.scrub
-
Caches the results of looking up fields in a protobuf message's Descriptor.
- FieldMasks - Class in com.google.ads.googleads.lib.utils
-
Utility methods for working with field masks.
- FieldMasks() - Constructor for class com.google.ads.googleads.lib.utils.FieldMasks
- fromEnvironment() - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
- fromProperties(Properties) - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Updates this builder with values set from a properties object.
- fromPropertiesFile() - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Loads the Google Ads Client configuration file from the default location: "ads.properties".
- fromPropertiesFile(File) - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Updates this builder with values set from a properties file.
G
- GeneratedCatalog - Class in com.google.ads.googleads.lib.catalog
- GeneratedCatalog(ImmutableSet<Version>) - Constructor for class com.google.ads.googleads.lib.catalog.GeneratedCatalog
-
Creates a new constant catalog from a known collection of versions.
- getCredentials() - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Returns the credentials currently configured.
- getCredentials() - Method in class com.google.ads.googleads.lib.GoogleAdsClient
-
Returns the credentials for this client.
- getDefault() - Static method in interface com.google.ads.googleads.lib.catalog.ApiCatalog
-
Returns a ApiCatalog implementation which reflects the current state of the library.
- getDefault() - Static method in class com.google.ads.googleads.lib.catalog.GeneratedCatalog
- getDefault() - Static method in class com.google.ads.googleads.lib.logging.scrub.FieldDescriptorCache
-
Obtains a global instance of the cache.
- getDeveloperToken() - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Returns the developer token currently configured.
- getDeveloperToken() - Method in class com.google.ads.googleads.lib.GoogleAdsClient
-
Returns the developer token.
- getDeveloperToken() - Method in class com.google.ads.googleads.lib.GoogleAdsHeaderProvider
-
Returns the configured developer token.
- getEndpoint() - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Returns the endpoint currently configured.
- getEndpoint() - Method in class com.google.ads.googleads.lib.GoogleAdsClient
-
Returns the endpoint to use.
- getExceptionFactory() - Method in class com.google.ads.googleads.lib.catalog.Version
-
Returns a TypeFactory instance which can be used to create version specific objects without binding to the specific versioned class name.
- getFieldValue(String, Message) - Static method in class com.google.ads.googleads.lib.utils.FieldMasks
-
Gets the field value of a message from a field mask path.
- getGoogleAdsAllVersions() - Method in class com.google.ads.googleads.lib.AbstractGoogleAdsClient
-
Returns the accessor for service client factories, using configuration from this class.
- getHeaders() - Method in class com.google.ads.googleads.lib.GoogleAdsHeaderProvider
- getInstance() - Static method in class com.google.ads.googleads.lib.catalog.Primer
-
Returns an instance of the primer, if enabled.
- getInstance() - Static method in class com.google.ads.googleads.lib.logging.scrub.LogScrubber
- getLatestVersion() - Method in class com.google.ads.googleads.lib.AbstractGoogleAdsClient
- getLatestVersion() - Method in interface com.google.ads.googleads.lib.catalog.ApiCatalog
-
Returns the most recent API version available.
- getLatestVersion() - Method in class com.google.ads.googleads.lib.catalog.GeneratedCatalog
- getLatestVersion() - Method in interface com.google.ads.googleads.lib.GoogleAdsAllVersions
- getLinkedCustomerId() - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Returns the linked customer ID currently configured.
- getLinkedCustomerId() - Method in class com.google.ads.googleads.lib.GoogleAdsClient
-
Returns the linked customer ID for this client.
- getLinkedCustomerId() - Method in class com.google.ads.googleads.lib.GoogleAdsHeaderProvider
-
Returns the configured linked customer ID.
- getLoginCustomerId() - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Returns the login customer ID currently configured.
- getLoginCustomerId() - Method in class com.google.ads.googleads.lib.GoogleAdsClient
-
Returns the login customer ID for this client.
- getLoginCustomerId() - Method in class com.google.ads.googleads.lib.GoogleAdsHeaderProvider
-
Returns the configured login customer ID.
- getPropertyKey() - Method in enum com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
-
The key corresponding to this config property.
- getPropertyValue(Properties) - Method in enum com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
-
Convenience method that gets the value for this config key from the specified
properties
. - getRequestId() - Method in class com.google.ads.googleads.lib.GoogleAdsResponseMetadata
-
Get the request id returned in the RPC headers.
- getServiceClientFactoryClass() - Method in class com.google.ads.googleads.lib.catalog.Version
-
Returns a class which enumerates the service clients for this version.
- getSupportedVersions() - Method in interface com.google.ads.googleads.lib.catalog.ApiCatalog
-
Returns all API versions available in the current catalog.
- getSupportedVersions() - Method in class com.google.ads.googleads.lib.catalog.GeneratedCatalog
- getValues(Message) - Method in interface com.google.ads.googleads.lib.logging.scrub.FieldAccessor
- getValues(Message) - Method in class com.google.ads.googleads.lib.reflect.ReflectionFieldAccessor
- getVersion10() - Method in class com.google.ads.googleads.lib.AbstractGoogleAdsClient
- getVersion10() - Method in interface com.google.ads.googleads.lib.GoogleAdsAllVersions
- getVersion9() - Method in class com.google.ads.googleads.lib.AbstractGoogleAdsClient
- getVersion9() - Method in interface com.google.ads.googleads.lib.GoogleAdsAllVersions
- getVersionName() - Method in class com.google.ads.googleads.lib.catalog.Version
-
Returns the version name, e.g.
- getVersionNumber() - Method in class com.google.ads.googleads.lib.catalog.Version
-
Gets the (major) version number of this version.
- getVersions() - Static method in class com.google.ads.googleads.lib.catalog.VersionFactory
- GOOGLE_ADS_CLIENT_ID - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Client ID for installed app/web flow credentials.
- GOOGLE_ADS_CLIENT_SECRET - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Client secret for installed app/web flow credentials.
- GOOGLE_ADS_CONFIGURATION_FILE_PATH - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Path, including the file name, from which the client configuration file should be read.
- GOOGLE_ADS_DEVELOPER_TOKEN - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Google Ads API developer token.
- GOOGLE_ADS_ENDPOINT - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Google Ads API endpoint.
- GOOGLE_ADS_IMPERSONATED_EMAIL - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Service account user to impersonate for service account credentials.
- GOOGLE_ADS_JSON_KEY_FILE_PATH - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Path to the JSON key (secrets) file for service account credentials.
- GOOGLE_ADS_LINKED_CUSTOMER_ID - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Linked customer ID.
- GOOGLE_ADS_LOGIN_CUSTOMER_ID - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Login customer ID.
- GOOGLE_ADS_REFRESH_TOKEN - com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Refresh token for installed app/web flow credentials.
- GoogleAdsAllVersions - Interface in com.google.ads.googleads.lib
- GoogleAdsClient - Class in com.google.ads.googleads.lib
-
A client for the Google Ads API that handles common configuration and OAuth2 settings.
- GoogleAdsClient() - Constructor for class com.google.ads.googleads.lib.GoogleAdsClient
- GoogleAdsClient.Builder - Class in com.google.ads.googleads.lib
-
Builder for configuring and creating an instance of
GoogleAdsClient
. - GoogleAdsClient.Builder.AdsEnvironmentVariable - Enum in com.google.ads.googleads.lib
-
Enumeration of the environment variables that can be used to configure a
GoogleAdsClient
. - GoogleAdsClient.Builder.ConfigPropertyKey - Enum in com.google.ads.googleads.lib
-
Enum of keys expected in the "ads.properties".
- GoogleAdsExceptionTransformation - Class in com.google.ads.googleads.lib.callables
-
Transforms an ApiException into a GoogleAdsException whenever a binary GoogleAdsFailure message was sent in the RPC trailers.
- GoogleAdsExceptionTransformation() - Constructor for class com.google.ads.googleads.lib.callables.GoogleAdsExceptionTransformation
- GoogleAdsHeaderProvider - Class in com.google.ads.googleads.lib
-
A provider for setting the Google Ads API specific headers.
- GoogleAdsHeaderProvider() - Constructor for class com.google.ads.googleads.lib.GoogleAdsHeaderProvider
- GoogleAdsHeaderProvider.Builder - Class in com.google.ads.googleads.lib
- GoogleAdsResponseMetadata - Class in com.google.ads.googleads.lib
-
GoogleAdsResponseMetadata is used to access the response metadata returned by a Google Ads RPC.
- GoogleAdsResponseMetadata() - Constructor for class com.google.ads.googleads.lib.GoogleAdsResponseMetadata
H
- hashCode() - Method in class com.google.ads.googleads.lib.catalog.Version
I
- interceptCall(MethodDescriptor<ReqT, RespT>, CallOptions, Channel) - Method in class com.google.ads.googleads.lib.logging.LoggingInterceptor
-
Logs the Google Ads API fields required for debugging.
- isDetailEnabled(Level) - Method in class com.google.ads.googleads.lib.logging.RequestLogger
-
Checks if the detailed (request) logger is enabled.
- isEnabled() - Static method in class com.google.ads.googleads.lib.catalog.Primer
-
Checks if the primer should be enabled.
- isSummaryEnabled(Level) - Method in class com.google.ads.googleads.lib.logging.RequestLogger
-
Checks if the summary (headers/trailers) logger is enabled.
L
- LINKED_CUSTOMER_ID - com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
- logDetail(Level, Event.Detail) - Method in class com.google.ads.googleads.lib.logging.RequestLogger
-
Logs the request/response of an RPC call.
- LoggingInterceptor - Class in com.google.ads.googleads.lib.logging
-
An interceptor which logs all RPCs made on a Channel.
- LoggingInterceptor(RequestLogger, ImmutableMap<String, String>, String) - Constructor for class com.google.ads.googleads.lib.logging.LoggingInterceptor
-
Creates with the RequestLogger sink, the constant header data, and the API endpoint.
- LOGIN_CUSTOMER_ID - com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
- LogScrubber - Class in com.google.ads.googleads.lib.logging.scrub
-
Implements log scrubbing, e.g.
- logSummary(Level, Event.Summary) - Method in class com.google.ads.googleads.lib.logging.RequestLogger
-
Logs a summary of an RPC call.
- lookupField(String, MessageOrBuilder) - Method in class com.google.ads.googleads.lib.logging.scrub.FieldDescriptorCache
-
Retrieves a named field from a MessageOrBuilder.
M
- MASK_PATTERN - Static variable in class com.google.ads.googleads.lib.logging.scrub.LogScrubber
- MessageEditor<T> - Interface in com.google.ads.googleads.lib.utils.messageproxy
-
Provides an interface for abstracting edits that are made to a message.
N
- newBuilder() - Static method in class com.google.ads.googleads.lib.GoogleAdsClient
-
Returns a new builder for
GoogleAdsClient
with only default values set. - newBuilder() - Static method in class com.google.ads.googleads.lib.GoogleAdsHeaderProvider
-
Returns a new builder for
GoogleAdsHeaderProvider
with only default values set.
O
- onHeaders(Metadata) - Method in class com.google.ads.googleads.lib.GoogleAdsResponseMetadata
P
- primeAllVersionsAsync() - Method in class com.google.ads.googleads.lib.catalog.DefaultPrimer
- primeAllVersionsAsync() - Method in class com.google.ads.googleads.lib.catalog.Primer
-
Primes the classes required by
GoogleAdsAllVersions
- primeBasicsIfEnabled() - Static method in class com.google.ads.googleads.lib.catalog.Primer
-
Primes any components that can be run without additional state (e.g.
- primeCredentialsAsync(Credentials) - Method in class com.google.ads.googleads.lib.catalog.DefaultPrimer
- primeCredentialsAsync(Credentials) - Method in class com.google.ads.googleads.lib.catalog.Primer
-
Primes the credentials, e.g.
- primeGrpcAsync() - Method in class com.google.ads.googleads.lib.catalog.DefaultPrimer
- primeGrpcAsync() - Method in class com.google.ads.googleads.lib.catalog.Primer
-
Primes the gRPC layer asynchronously.
- primeProtobufAsync() - Method in class com.google.ads.googleads.lib.catalog.DefaultPrimer
- primeProtobufAsync() - Method in class com.google.ads.googleads.lib.catalog.Primer
-
Primes the protobuf layer asynchronously.
- Primer - Class in com.google.ads.googleads.lib.catalog
-
Performs startup performance optimizations to avoid cold-start of clients.
- Primer() - Constructor for class com.google.ads.googleads.lib.catalog.Primer
R
- ReflectionFieldAccessor - Class in com.google.ads.googleads.lib.reflect
-
Sets values on a protobuf object based on a string representation of the path to the value.
- ReflectionFieldAccessor(String) - Constructor for class com.google.ads.googleads.lib.reflect.ReflectionFieldAccessor
- ReflectionScrubber - Class in com.google.ads.googleads.lib.logging.scrub
-
Scrubs messages using reflection.
- ReflectionScrubber() - Constructor for class com.google.ads.googleads.lib.logging.scrub.ReflectionScrubber
- REFRESH_TOKEN - com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
- REQUEST_ID_HEADER_KEY - Static variable in class com.google.ads.googleads.lib.GoogleAdsResponseMetadata
- REQUEST_ID_HEADER_KEY - Static variable in class com.google.ads.googleads.lib.logging.LoggingInterceptor
- RequestLogger - Class in com.google.ads.googleads.lib.logging
-
Dispatches logging requests to the logging library, decoupling logging from the RPC interceptor.
- RequestLogger() - Constructor for class com.google.ads.googleads.lib.logging.RequestLogger
S
- scrub(Message) - Method in class com.google.ads.googleads.lib.logging.scrub.ReflectionScrubber
-
Scrubs the given message using the protobuf descriptor API.
- SearchResponseScrubber - Class in com.google.ads.googleads.lib.logging.scrub
-
Defines GoogleAdsService.search() and searchStream() responses as a special case for response scrubbing.
- SearchResponseScrubber(String) - Constructor for class com.google.ads.googleads.lib.logging.scrub.SearchResponseScrubber
- SERVICE_ACCOUNT_SECRETS_PATH - com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
- SERVICE_ACCOUNT_USER - com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
- setCredentials(Credentials) - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Specifies the OAuth credentials.
- setDeveloperToken(String) - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Sets the developer token used to obtain access to the Google Ads API.
- setDeveloperToken(String) - Method in class com.google.ads.googleads.lib.GoogleAdsHeaderProvider.Builder
-
Sets the developer token.
- setEndpoint(String) - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Optional: Overrides the default endpoint.
- setFieldIfPresent(Message, String) - Method in interface com.google.ads.googleads.lib.logging.scrub.FieldAccessor
- setFieldIfPresent(Message, String) - Method in class com.google.ads.googleads.lib.logging.scrub.SearchResponseScrubber
- setFieldIfPresent(Message, String) - Method in class com.google.ads.googleads.lib.reflect.ReflectionFieldAccessor
- setLinkedCustomerId(Long) - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Required by a small subset of services and use-cases.
- setLinkedCustomerId(Long) - Method in class com.google.ads.googleads.lib.GoogleAdsHeaderProvider.Builder
-
Sets the linked customer ID.
- setLoginCustomerId(Long) - Method in class com.google.ads.googleads.lib.GoogleAdsClient.Builder
-
Required for manager accounts only.
- setLoginCustomerId(Long) - Method in class com.google.ads.googleads.lib.GoogleAdsHeaderProvider.Builder
-
Sets the login customer ID.
- supports(Message) - Method in class com.google.ads.googleads.lib.logging.scrub.ReflectionScrubber
-
Checks if a given message needs to be scrubbed.
- supports(T) - Method in interface com.google.ads.googleads.lib.utils.messageproxy.MessageEditor
-
Checks if this can edit a given message.
T
- toBuilder() - Method in class com.google.ads.googleads.lib.GoogleAdsClient
-
Returns a new
GoogleAdsClient.Builder
with the properties as this instance. - transform(Throwable) - Method in class com.google.ads.googleads.lib.callables.GoogleAdsExceptionTransformation
V
- valueOf(String) - Static method in enum com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.ads.googleads.lib.GoogleAdsClient.Builder.ConfigPropertyKey
-
Returns an array containing the constants of this enum type, in the order they are declared.
- Version - Class in com.google.ads.googleads.lib.catalog
-
Represents the metadata of a version of the Google Ads API.
- VersionFactory - Class in com.google.ads.googleads.lib.catalog
- VersionFactory() - Constructor for class com.google.ads.googleads.lib.catalog.VersionFactory
All Classes All Packages