A B C D E F G H I J L M N O P Q R S T U V W X

A

ACTIVITY_GROUP_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

ACTIVITY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

AD_UNIT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

addUtility(AdsUtility) - Method in class com.google.api.ads.common.lib.utils.AdsUtilityRegistry

Adds the specified utility to the registry.

ADJUSTMENT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

AdManagerHttpHeaderHandler - Class in com.google.api.ads.admanager.lib.soap

Handler used to set the HTTP headers on a SOAP client.

AdManagerHttpHeaderHandler(SoapClientHandlerInterface) - Constructor for class com.google.api.ads.admanager.lib.soap.AdManagerHttpHeaderHandler

Constructor.

AdManagerInternals - Class in com.google.api.ads.admanager.lib.utils

Provides access to some internal guice-injected objects.

AdManagerInternals() - Constructor for class com.google.api.ads.admanager.lib.utils.AdManagerInternals

AdManagerModule - Class in com.google.api.ads.admanager.lib

Guice module for Ad Manager bindings.

AdManagerModule() - Constructor for class com.google.api.ads.admanager.lib.AdManagerModule

AdManagerProductFrameworkModule - Annotation Type in com.google.api.ads.admanager.lib

A simple marker annotation used to specify a Guice module that can tie the Ad Manager library to a SOAP framework.

AdManagerServiceClient - Class in com.google.api.ads.admanager.lib.client

Wrapper of underlying SOAP client which allows access for setting headers retrieved from the session.

AdManagerServiceClient(Object, AdManagerServiceDescriptor, AdManagerSession, SoapClientHandlerInterface, HeaderHandler<AdManagerSession, AdManagerServiceDescriptor>, AdsServiceLoggers) - Constructor for class com.google.api.ads.admanager.lib.client.AdManagerServiceClient

Constructor.

AdManagerServiceClientFactory - Class in com.google.api.ads.admanager.lib.factory

Factory which creates Ad Manager service clients.

AdManagerServiceClientFactory(Injector) - Constructor for class com.google.api.ads.admanager.lib.factory.AdManagerServiceClientFactory

Constructor.

AdManagerServiceClientFactory(AbstractModule) - Constructor for class com.google.api.ads.admanager.lib.factory.AdManagerServiceClientFactory

Deprecated.

use AdManagerServiceClientFactory(Injector)

AdManagerServiceClientFactoryHelper - Class in com.google.api.ads.admanager.lib.factory.helper

Factory helper for Ad Manager.

AdManagerServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<AdManagerServiceClient, AdManagerSession, AdManagerServiceDescriptor>, FactoryModule.AdsServiceDescriptorFactoryInterface<AdManagerServiceDescriptor>, SoapClientHandlerInterface, AdsLibConfiguration) - Constructor for class com.google.api.ads.admanager.lib.factory.helper.AdManagerServiceClientFactoryHelper

Constructor.

AdManagerServiceDescriptor - Class in com.google.api.ads.admanager.lib.client

AdManagerServiceDescriptor provides a class which defines a service that can be instantiated through reflection.

AdManagerServiceDescriptor(Class<?>, String) - Constructor for class com.google.api.ads.admanager.lib.client.AdManagerServiceDescriptor

Constructor.

AdManagerServicesInterface - Interface in com.google.api.ads.admanager.lib.factory

Factory for Ad Manager API services.

AdManagerSession - Class in com.google.api.ads.admanager.lib.client

A AdManagerSession represents a single session of Ad Manager use.

AdManagerSession.Builder - Class in com.google.api.ads.admanager.lib.client

Builder for AdManagerSession.

AdManagerSession.ImmutableAdManagerSession - Class in com.google.api.ads.admanager.lib.client

Immutable, thread-safe implementation of AdManagerSession.

AdManagerSoapModule - Class in com.google.api.ads.admanager.lib

Guice module for Ad Manager SOAP bindings.

AdManagerSoapModule() - Constructor for class com.google.api.ads.admanager.lib.AdManagerSoapModule

ADS_API_LIB_LOG - Static variable in class com.google.api.ads.common.lib.utils.logging.AdsServiceLoggers

The client library logger.

AdsLibraryUserAgentProvider - Class in com.google.api.ads.common.lib.useragent

Provides the ads library user agent.

AdsLibraryUserAgentProvider(AdsBuildConfiguration) - Constructor for class com.google.api.ads.common.lib.useragent.AdsLibraryUserAgentProvider

Constructor.

AdsModule - Class in com.google.api.ads.common.lib

Guice module for common bindings.

AdsModule() - Constructor for class com.google.api.ads.common.lib.AdsModule

AdsServiceClient<S extends AdsSession,D extends AdsServiceDescriptor> - Class in com.google.api.ads.common.lib.client

The base class for all AdsServiceClients.

AdsServiceClient(Object, S, D, SoapClientHandlerInterface<Object>, HeaderHandler<S, D>, AdsServiceLoggers) - Constructor for class com.google.api.ads.common.lib.client.AdsServiceClient

Constructor.

AdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> - Class in com.google.api.ads.common.lib.factory

Factory which creates ads service clients.

AdsServiceClientFactory(AdsServiceClientFactoryHelper) - Constructor for class com.google.api.ads.common.lib.factory.AdsServiceClientFactory

Constructor.

AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> - Interface in com.google.api.ads.common.lib.factory.helper

Interface for helpers of factories which creates ads service clients.

AdsServiceDescriptor - Interface in com.google.api.ads.common.lib.client

Interface for ads service descriptors.

AdsServiceLoggers - Class in com.google.api.ads.common.lib.utils.logging

Allows logging of outgoing and incoming SOAP XML messages as API calls are executed.

AdsServicesInterface<S extends AdsSession> - Interface in com.google.api.ads.common.lib.factory

Service factory for an ads product.

AdsSession - Interface in com.google.api.ads.common.lib.client

Interface for an ads session.

AdsSoapModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession> - Class in com.google.api.ads.common.lib

Guice module for common bindings.

AdsSoapModule() - Constructor for class com.google.api.ads.common.lib.AdsSoapModule

AdsUtilitiesUserAgentProvider - Class in com.google.api.ads.common.lib.useragent

Provides the ads utilities user agent.

AdsUtilitiesUserAgentProvider(AdsUtilityRegistry, AdsLibConfiguration) - Constructor for class com.google.api.ads.common.lib.useragent.AdsUtilitiesUserAgentProvider

AdsUtility - Enum in com.google.api.ads.common.lib.utils

Enumeration of utilities available in the client library.

AdsUtilityInvocationHandler - Class in com.google.api.ads.common.lib.utils

InvocationHandler that updates the AdsUtilityRegistry when a method call on the proxied interface is annotated with UsesAdsUtilities.

AdsUtilityInvocationHandler(Object, AdsUtilityRegistry) - Constructor for class com.google.api.ads.common.lib.utils.AdsUtilityInvocationHandler

AdsUtilityRegistry - Class in com.google.api.ads.common.lib.utils

A thread-safe registry for usage of ads utilities.

ADVERTISER_COMPANY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

ADVERTISER_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

AGENCY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

ArgumentNames - Class in com.google.api.ads.admanager.lib.utils.examples

Contains command line argument formats for example code.

ArgumentNames() - Constructor for class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

AUDIENCE_SEGMENT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

AuthenticationException - Exception in com.google.api.ads.common.lib.exception

Base exception for all authentication exceptions.

AuthenticationException(String) - Constructor for exception com.google.api.ads.common.lib.exception.AuthenticationException

Constructor.

AuthenticationException(String, Throwable) - Constructor for exception com.google.api.ads.common.lib.exception.AuthenticationException

Constructor.

AuthModule - Class in com.google.api.ads.common.lib.auth

Module for authentication.

AuthModule() - Constructor for class com.google.api.ads.common.lib.auth.AuthModule

Default constructor.

AuthorizationHeaderHandler - Class in com.google.api.ads.common.lib.soap

Handler for Authorization headers that can be set on the SOAP client.

AuthorizationHeaderHandler(SoapClientHandlerInterface, AuthorizationHeaderProvider) - Constructor for class com.google.api.ads.common.lib.soap.AuthorizationHeaderHandler

Constructor.

AuthorizationHeaderProvider - Class in com.google.api.ads.common.lib.auth

Authorization header provider that can delegate between different authentication mechanisms depending on the AdsSession.

AuthorizationHeaderProvider(OAuth2AuthorizationHeaderProvider, AdsLibConfiguration, OAuth2Helper) - Constructor for class com.google.api.ads.common.lib.auth.AuthorizationHeaderProvider

Constructor.

AxisCompatible - Interface in com.google.api.ads.common.lib.soap.compatability

Specifies that for the AdsServiceClient to be Axis compatible, it must be able to retrieve a locator class.

B

BASE_RATE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

BaseAdManagerServices - Class in com.google.api.ads.admanager.lib.factory

Base for a utility class which creates Ad Manager service clients.

BaseAdManagerServices(Injector) - Constructor for class com.google.api.ads.admanager.lib.factory.BaseAdManagerServices

Constructor.

BaseAdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> - Class in com.google.api.ads.common.lib.factory

Base factory which creates service clients.

BaseAdsServiceClientFactory(AdsServiceClientFactory<C, S, D>) - Constructor for class com.google.api.ads.common.lib.factory.BaseAdsServiceClientFactory

Constructor.

BaseAdsServiceClientFactory(AbstractModule) - Constructor for class com.google.api.ads.common.lib.factory.BaseAdsServiceClientFactory

Constructor.

BaseAdsServiceClientFactory(Injector) - Constructor for class com.google.api.ads.common.lib.factory.BaseAdsServiceClientFactory

Constructor.

BaseAdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> - Class in com.google.api.ads.common.lib.factory.helper

Abstract helper for AdsServiceClientFactoryHelper.

BaseAdsServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<C, S, D>, FactoryModule.AdsServiceDescriptorFactoryInterface<D>, SoapClientHandlerInterface<?>) - Constructor for class com.google.api.ads.common.lib.factory.helper.BaseAdsServiceClientFactoryHelper

Constructor.

BaseServices<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> - Class in com.google.api.ads.common.lib.factory

Base for a utility class which creates service clients.

BaseServices(BaseAdsServiceClientFactory<C, S, D>) - Constructor for class com.google.api.ads.common.lib.factory.BaseServices

Constructor.

build() - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

Builds the AdManagerSession.

build() - Method in class com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder

build() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

build() - Method in class com.google.api.ads.common.lib.client.RemoteCallReturn.Builder

Returns the RemoteCallReturn this Builder has been constructing.

build() - Method in class com.google.api.ads.common.lib.client.RequestInfo.Builder

Returns the RequestInfo this Builder has been constructing.

build() - Method in class com.google.api.ads.common.lib.client.ResponseInfo.Builder

Returns the ResponseInfo this Builder has been constructing.

build() - Method in interface com.google.api.ads.common.lib.utils.Builder

Constructs this object.

Builder() - Constructor for class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

Constructs an empty builder.

Builder() - Constructor for class com.google.api.ads.common.lib.auth.OfflineCredentials.Builder

Default constructor.

Builder() - Constructor for class com.google.api.ads.common.lib.client.RemoteCallReturn.Builder

Constructor.

Builder() - Constructor for class com.google.api.ads.common.lib.client.RequestInfo.Builder

Builder() - Constructor for class com.google.api.ads.common.lib.client.ResponseInfo.Builder

Builder<T> - Interface in com.google.api.ads.common.lib.utils

Builder interface.

buildImmutable() - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

Builds a thread-safe AdManagerSession.ImmutableAdManagerSession.

buildQuery() - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Builds the query from the clauses.

buildQuery() - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Builds the query from the clauses.

BuildTypeUserAgentProvider - Class in com.google.api.ads.common.lib.useragent

Provides the build type user agent.

BuildTypeUserAgentProvider(AdsBuildConfiguration) - Constructor for class com.google.api.ads.common.lib.useragent.BuildTypeUserAgentProvider

Constructor.

BUYER_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

C

callSoapClient(SoapCall<T>) - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Called from SoapServiceClient.invoke(Object, Method, Object[]) if the method is intended for the SOAP client.

checkServiceClientPreconditions(S, Class<?>) - Method in interface com.google.api.ads.common.lib.factory.helper.AdsServiceClientFactoryHelper

Checks preconditions of the session and interface and throws an exception if the client cannot be generated.

checkServiceClientPreconditions(S, Class<?>) - Method in class com.google.api.ads.common.lib.factory.helper.BaseAdsServiceClientFactoryHelper

Default implementation of passing service client preconditions.

CHILD_NETWORK_CODE - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

clearHeaders(T) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Clears the headers of the SOAP client.

CMS_METADATA_KEY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CMS_METADATA_KEY_NAME - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CMS_METADATA_VALUE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CodeSampleParams - Class in com.google.api.ads.common.lib.utils.examples

A base class for all code examples to handle command line argument parsing and usage printing.

CodeSampleParams() - Constructor for class com.google.api.ads.common.lib.utils.examples.CodeSampleParams

com.google.api.ads.admanager.lib - package com.google.api.ads.admanager.lib

com.google.api.ads.admanager.lib.client - package com.google.api.ads.admanager.lib.client

com.google.api.ads.admanager.lib.factory - package com.google.api.ads.admanager.lib.factory

com.google.api.ads.admanager.lib.factory.helper - package com.google.api.ads.admanager.lib.factory.helper

com.google.api.ads.admanager.lib.soap - package com.google.api.ads.admanager.lib.soap

com.google.api.ads.admanager.lib.utils - package com.google.api.ads.admanager.lib.utils

com.google.api.ads.admanager.lib.utils.examples - package com.google.api.ads.admanager.lib.utils.examples

com.google.api.ads.common.lib - package com.google.api.ads.common.lib

com.google.api.ads.common.lib.auth - package com.google.api.ads.common.lib.auth

com.google.api.ads.common.lib.client - package com.google.api.ads.common.lib.client

com.google.api.ads.common.lib.exception - package com.google.api.ads.common.lib.exception

com.google.api.ads.common.lib.factory - package com.google.api.ads.common.lib.factory

com.google.api.ads.common.lib.factory.helper - package com.google.api.ads.common.lib.factory.helper

com.google.api.ads.common.lib.soap - package com.google.api.ads.common.lib.soap

com.google.api.ads.common.lib.soap.compatability - package com.google.api.ads.common.lib.soap.compatability

com.google.api.ads.common.lib.soap.jaxb - package com.google.api.ads.common.lib.soap.jaxb

com.google.api.ads.common.lib.useragent - package com.google.api.ads.common.lib.useragent

com.google.api.ads.common.lib.utils - package com.google.api.ads.common.lib.utils

com.google.api.ads.common.lib.utils.examples - package com.google.api.ads.common.lib.utils.examples

com.google.api.ads.common.lib.utils.logging - package com.google.api.ads.common.lib.utils.logging

COMPANION_CREATIVE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

COMPANY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

configure() - Method in class com.google.api.ads.admanager.lib.AdManagerModule

configure() - Method in class com.google.api.ads.admanager.lib.AdManagerSoapModule

configure() - Method in class com.google.api.ads.common.lib.AdsModule

Configure common Guice bindings.

configure() - Method in class com.google.api.ads.common.lib.AdsSoapModule

configure() - Method in class com.google.api.ads.common.lib.auth.AuthModule

configure() - Method in class com.google.api.ads.common.lib.factory.FactoryModule

configure() - Method in class com.google.api.ads.common.lib.soap.ProductFrameworkModule

configure() - Method in class com.google.api.ads.common.lib.utils.logging.LoggingModule

configureConfigurations(URL) - Method in class com.google.api.ads.common.lib.soap.ProductFrameworkModule

configureFactories(TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C, S, D>>, TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>>, TypeLiteral<C>, TypeLiteral<D>, Class<H>, Class<F>) - Method in class com.google.api.ads.common.lib.AdsSoapModule

Configures the factories.

configureLogger(String, String) - Method in class com.google.api.ads.common.lib.utils.logging.LoggingModule

configureLogging(String) - Method in class com.google.api.ads.common.lib.AdsModule

Configures the loggers given the prefix.

CONTACT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CONTENT_BUNDLE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CONTENT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

copy(InputStream, OutputStream) - Static method in class com.google.api.ads.common.lib.utils.Streams

Copies the inputStream into the outputSteam and finally closes the both streams.

create(Object, D, S) - Method in interface com.google.api.ads.common.lib.factory.FactoryModule.AdsServiceClientFactoryInterface

Creates an AdsServiceClient given a SOAP client and an AdsServiceDescriptor descriptor.

create(Class<?>, String) - Method in interface com.google.api.ads.common.lib.factory.FactoryModule.AdsServiceDescriptorFactoryInterface

Creates an ads service descriptor given an interface class.

createAdsServiceClient(D, S) - Method in interface com.google.api.ads.common.lib.factory.helper.AdsServiceClientFactoryHelper

Creates an AdsServiceClient for the descriptor, session, and endpoint.

createAdsServiceClient(D, S) - Method in class com.google.api.ads.common.lib.factory.helper.BaseAdsServiceClientFactoryHelper

Creates an AdsServiceClient given an AdsServiceDescriptor descriptor and an AdsSession.

createServiceDescriptor(Class<?>, String) - Method in interface com.google.api.ads.common.lib.factory.helper.AdsServiceClientFactoryHelper

Creates an AdsServiceDescriptor for a specified service.

createServiceDescriptor(Class<?>, String) - Method in class com.google.api.ads.common.lib.factory.helper.BaseAdsServiceClientFactoryHelper

Creates an AdsServiceDescriptor for a specified service.

createSoapCall(Method, Object[]) - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Creates the SoapCall from the soapClientMethod and its args.

createSoapClient(SoapServiceDescriptor) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Creates a SOAP client using the soapServiceDescriptor.

createSoapHeaderElement(QName) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Creates a SOAP header element object specific to the framework that this handler works with.

CREATIVE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CREATIVE_SET_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CREATIVE_WRAPPER_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CsvFiles - Class in com.google.api.ads.common.lib.utils

A utility class for processing and handling CSV files.

CURRENCY_CODE - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CUSTOM_DIMENSION_KEY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CUSTOM_FIELD_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

CustomOAuthConfig(String, String, Internals) - Constructor for class com.google.api.ads.common.lib.auth.OfflineCredentials.CustomOAuthConfig

D

DateTimesHelper<T,D> - Class in com.google.api.ads.admanager.lib.utils

A utility class for handling DateTime objects.

DateTimesHelper(Class<T>, Class<D>) - Constructor for class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Constructor.

dateToString(D) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Returns string representation of this date.

DEFAULT_CONFIGURATION_FILENAME - Static variable in interface com.google.api.ads.common.lib.utils.Builder

The default configuration filename used when Builder.fromFile() is called.

DEFAULT_ENDPOINT - Static variable in class com.google.api.ads.admanager.lib.client.AdManagerSession

DEFAULT_OAUTH2_REFRESH_WINDOW - Static variable in class com.google.api.ads.common.lib.auth.AuthModule

deserialize(Source) - Method in class com.google.api.ads.common.lib.soap.jaxb.JaxBDeserializer

Deserializes the object.

determineVersion(Class<?>) - Method in class com.google.api.ads.admanager.lib.factory.helper.AdManagerServiceClientFactoryHelper

determineVersion(Class<?>) - Method in interface com.google.api.ads.common.lib.factory.helper.AdsServiceClientFactoryHelper

Determines what API version an ads service belongs to.

E

EMAIL_ADDRESS - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

Endpoint - Interface in com.google.api.ads.common.lib.client

Marker interface for Environments to implement.

equals(Object) - Method in class com.google.api.ads.common.lib.soap.SoapCall

EXCHANGE_RATE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

ExtensionUserAgentProvider - Interface in com.google.api.ads.common.lib.useragent

UserAgentProvider for extension frameworks to decorate the user agent with additional information.

extract(InputStream, String[]) - Method in class com.google.api.ads.common.lib.utils.XmlFieldExtractor

Locates the target fields in the specified XML and uses a wildcard XPath to identify the first matching node and return it in a map.

extractNode(Node, Iterable<String>) - Method in class com.google.api.ads.common.lib.utils.NodeExtractor

Extracts the node specified by the xpath list.

extractNodeValue(Node, Iterable<String>) - Method in class com.google.api.ads.common.lib.utils.NodeExtractor

Convenience method for getting the value of a node, handling the case where the node does not exist.

F

FactoryModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession,H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>> - Class in com.google.api.ads.common.lib.factory

Module for factories.

FactoryModule(TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C, S, D>>, TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>>, TypeLiteral<C>, TypeLiteral<D>, Class<H>, Class<F>) - Constructor for class com.google.api.ads.common.lib.factory.FactoryModule

Constructor.

FactoryModule.AdsServiceClientFactoryInterface<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> - Interface in com.google.api.ads.common.lib.factory

Factory interface class to create AdsServiceClient.

FactoryModule.AdsServiceDescriptorFactoryInterface<D extends AdsServiceDescriptor> - Interface in com.google.api.ads.common.lib.factory

Factory interface class to create AdsServiceDescriptor.

FIELD_OPTION_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

forApi(GoogleClientSecretsBuilder.Api) - Method in class com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder

Specifies which GoogleClientSecretsBuilder.Api should this GoogleClientSecrets be generated for.

forApi(OfflineCredentials.OAuthConfig) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.Builder

Specifies which OfflineCredentials.OAuthConfig should this OfflineCredentials be used for.

FrameworkUserAgentProvider - Interface in com.google.api.ads.common.lib.useragent

Provides the framework user agent.

from(Configuration) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

Reads properties from the provided Configuration object.

Known properties: api.admanager.applicationName api.admanager.networkCode api.admanager.endpoint

FROM - Static variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

from - Variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

from(String) - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Sets the statement FROM clause in the form of "table".

from(String) - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Sets the statement FROM clause in the form of "table".

from(Configuration) - Method in class com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder

Reads properties from the provided Configuration object

Understands the following properties suffixes:

clientId clientSecret
For example, the AdWords OAuth2 client ID can be read from: api.adwords.clientId

from(Configuration) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

Reads properties from the provided Configuration object

Understands the following properties suffixes:

refreshToken clientId clientSecret jsonKeyFilePath
For example, the Ad Manager OAuth2 refresh token can be read from: api.admanager.refreshToken

from(Configuration) - Method in interface com.google.api.ads.common.lib.utils.Builder

Populates this builder from the specified Configuration.

fromFile() - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

fromFile(String) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

fromFile(File) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

fromFile(URL) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

fromFile(String) - Method in class com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder

fromFile(File) - Method in class com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder

fromFile(URL) - Method in class com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder

fromFile() - Method in class com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder

fromFile(String) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

fromFile(File) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

fromFile(URL) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

fromFile() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

fromFile() - Method in interface com.google.api.ads.common.lib.utils.Builder

Loads credentials from the "ads.properties" file in one of the following locations according to the following order: in the current directory, in the user home directory, in the classpath

fromFile(String) - Method in interface com.google.api.ads.common.lib.utils.Builder

Populates this builder from a properties file from a specified path.

fromFile(File) - Method in interface com.google.api.ads.common.lib.utils.Builder

Populates this builder from a properties file from a specified path.

fromFile(URL) - Method in interface com.google.api.ads.common.lib.utils.Builder

Populates this builder from a properties file from a specified path.

G

generateCredential() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials

Generates a new offline credential and immediately refreshes it.

get(S, Class<T>) - Method in interface com.google.api.ads.common.lib.factory.AdsServicesInterface

Gets a client for the service represented by the interface with a reference to the session.

get(S, Class<T>) - Method in class com.google.api.ads.common.lib.factory.BaseServices

getAdsServiceDescriptor() - Method in class com.google.api.ads.common.lib.client.AdsServiceClient

Gets the ads service descriptor for this client.

getAdsServiceLoggers() - Method in class com.google.api.ads.common.lib.utils.Internals

Gets the loggers.

getAdsSession() - Method in class com.google.api.ads.common.lib.client.AdsServiceClient

Gets the ads session for this client.

getAdsUtilityRegistry() - Method in class com.google.api.ads.common.lib.utils.Internals

Gets the ads utility registry.

getApplicationName() - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession

Gets the application name.

getAuthorizationHeader(AdsSession, String) - Method in class com.google.api.ads.common.lib.auth.AuthorizationHeaderProvider

Gets a header value that can be set to the Authorization HTTP header.

getAuthorizationHeaderProvider() - Method in class com.google.api.ads.common.lib.utils.Internals

Obtains the Authorization header value.

getBindVariableMap() - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Returns an unmodifiable form of the key to value map.

getBindVariableMap() - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Gets an unmodifiable key-value map.

getClientId() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials

Gets the client ID that will be used to generate a Credential.

getClientSecret() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials

Gets the client secret that will be used to generate a Credential.

getContextName() - Method in class com.google.api.ads.common.lib.client.RequestInfo

Gets the name corresponding to RequestInfo.getContextValue().

getContextName() - Method in class com.google.api.ads.common.lib.soap.RequestInfoXPathSet

getContextValue() - Method in class com.google.api.ads.common.lib.client.RequestInfo

Returns the context value, such as the clientCustomerId for AdWords, or the networkCode for Ad Manager.

getContextXPath() - Method in class com.google.api.ads.common.lib.soap.RequestInfoXPathSet

getCsvDataArray(String, boolean) - Static method in class com.google.api.ads.common.lib.utils.CsvFiles

Returns a List<String[]> that contains all rows of the CSV file.

getCsvDataArray(Reader, boolean) - Static method in class com.google.api.ads.common.lib.utils.CsvFiles

Returns a List<String[]> that contains all rows of the CSV file.

getCsvDataByColumn(String, int, boolean) - Static method in class com.google.api.ads.common.lib.utils.CsvFiles

Returns a List<String> representing a single 0-indexed column.

getCsvDataListMap(String, boolean) - Static method in class com.google.api.ads.common.lib.utils.CsvFiles

Returns a List<Map<String, String>> that contains all rows with a field mapping defined by the header.

getCsvDataMap(String, int, int, boolean) - Static method in class com.google.api.ads.common.lib.utils.CsvFiles

Returns a Map<String, String> mapping of the column designated by key to the column designated by value.

getCsvDataMap(String, boolean) - Static method in class com.google.api.ads.common.lib.utils.CsvFiles

Returns a Map<String, String> mapping of the first column to the second column.

getCsvDataMapArray(String, boolean) - Static method in class com.google.api.ads.common.lib.utils.CsvFiles

Returns a Map<String, String[]> mapping of the first column to an array of the rest of the columns.

getEndpoint() - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession

Gets the endpoint.

getEndpoint() - Method in interface com.google.api.ads.common.lib.client.AdsSession

Returns the server endpoint to make requests against.

getEndpoint() - Method in interface com.google.api.ads.common.lib.client.Endpoint

Returns the endpoint to use.

getEndpointAddress(String) - Method in class com.google.api.ads.admanager.lib.client.AdManagerServiceDescriptor

getEndpointAddress(String) - Method in interface com.google.api.ads.common.lib.client.AdsServiceDescriptor

Gets the endpoint address for this service and server.

getEndpointAddress(T) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Gets the endpoint address on the SOAP client.

getEndpointAddress(String) - Method in interface com.google.api.ads.common.lib.soap.SoapServiceDescriptor

Gets the endpoint address for this service and server.

getException() - Method in class com.google.api.ads.common.lib.client.RemoteCallReturn

Gets the exception from the remote call that was made if one occurred.

getHeader(T, String) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Gets the value of a header given the SOAP client and the header name.

getHttpTransport() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials

Gets the HttpTransport that will be used when generating a Credential.

getHttpTransport() - Method in class com.google.api.ads.common.lib.utils.Internals

Returns an HttpTransport suitable for the java environment.

getInstance() - Static method in class com.google.api.ads.admanager.lib.utils.AdManagerInternals

Returns an Internals configured for Ad Manager.

getInstance() - Static method in class com.google.api.ads.common.lib.utils.AdsUtilityRegistry

Returns the singleton of this class.

getInterfaceClass() - Method in class com.google.api.ads.admanager.lib.client.AdManagerServiceDescriptor

getInterfaceClass() - Method in interface com.google.api.ads.common.lib.client.AdsServiceDescriptor

Gets the class representing the RPC interface of the service.

getInterfaceClass() - Method in interface com.google.api.ads.common.lib.soap.SoapServiceDescriptor

Gets the class representing the RPC interface of the service.

getInternals() - Method in enum com.google.api.ads.common.lib.auth.OfflineCredentials.Api

getInternals() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.CustomOAuthConfig

getInternals() - Method in interface com.google.api.ads.common.lib.auth.OfflineCredentials.OAuthConfig

Returns the internals object for the API that has the OAuth helper.

getJsonKeyFilePath() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials

Gets the file path to a JSON key file that will be used to generate a service account Credential.

getLocatorClass() - Method in class com.google.api.ads.admanager.lib.client.AdManagerServiceDescriptor

getLocatorClass() - Method in interface com.google.api.ads.common.lib.soap.compatability.AxisCompatible

Gets the Axis locator class such that it can be instantiated to create an Axis service client.

getMediaDataFromFile(String) - Static method in class com.google.api.ads.common.lib.utils.Media

Gets the media data byte[] located in fileName.

getMediaDataFromFile(File) - Static method in class com.google.api.ads.common.lib.utils.Media

Gets the media data byte[] located in file.

getMediaDataFromUrl(String) - Static method in class com.google.api.ads.common.lib.utils.Media

Gets the media data byte[] located at url or null if the media could not be loaded.

getMediaDataFromUrl(URL) - Static method in class com.google.api.ads.common.lib.utils.Media

Gets the media data byte[] located at url or null if the media could not be loaded.

getMethodName() - Method in class com.google.api.ads.common.lib.client.RequestInfo

Gets the method name.

getNetworkCode() - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession

Gets the network code.

getOAuth2AuthorizationHeader(OAuth2Compatible) - Method in class com.google.api.ads.common.lib.auth.OAuth2AuthorizationHeaderProvider

Gets the OAuth2 authorization header for the parameters and request URL.

getOAuth2Credential() - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession

Gets the OAuth2 credentials.

getOAuth2Credential() - Method in interface com.google.api.ads.common.lib.auth.OAuth2Compatible

Gets the OAuth parameters.

getOAuth2Helper() - Method in class com.google.api.ads.common.lib.utils.Internals

Gets the OAuth2 helper.

getOffset() - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Gets the current offset.

getOffset() - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Gets the current offset.

getOperationsCount() - Method in class com.google.api.ads.common.lib.client.ResponseInfo

Returns the number of operationsCount from the response.

getOperationsCountXPath() - Method in class com.google.api.ads.common.lib.soap.ResponseInfoXPathSet

getPayload() - Method in class com.google.api.ads.common.lib.client.RequestInfo

Gets the SOAP request XML.

getPayload() - Method in class com.google.api.ads.common.lib.client.ResponseInfo

Gets the response payload (e.g., XML, HTTP request).

getPropertyKeyPrefix() - Method in enum com.google.api.ads.common.lib.auth.OfflineCredentials.Api

getPropertyKeyPrefix() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.CustomOAuthConfig

getPropertyKeyPrefix() - Method in interface com.google.api.ads.common.lib.auth.OfflineCredentials.OAuthConfig

Returns the property key prefix.

getPropKeyPrefix() - Method in enum com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.Api

Gets the property key prefix.

getRefreshToken() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials

Gets the refresh token that will be used to generate a Credential.

getRequestId() - Method in class com.google.api.ads.common.lib.client.ResponseInfo

Gets the SOAP response request ID.

getRequestIdXPath() - Method in class com.google.api.ads.common.lib.soap.ResponseInfoXPathSet

getRequestInfo() - Method in class com.google.api.ads.common.lib.client.RemoteCallReturn

Gets the request info from the remote call that was made.

getResponseInfo() - Method in class com.google.api.ads.common.lib.client.RemoteCallReturn

Gets the response info from the remote call that was made.

getResponseTime() - Method in class com.google.api.ads.common.lib.client.ResponseInfo

Returns the response time in milliseconds.

getResponseTimeXPath() - Method in class com.google.api.ads.common.lib.soap.ResponseInfoXPathSet

getReturnValue() - Method in class com.google.api.ads.common.lib.client.RemoteCallReturn

Gets the return value from the remote call that was made.

getScope() - Method in enum com.google.api.ads.common.lib.auth.OfflineCredentials.Api

getScope() - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.CustomOAuthConfig

getScope() - Method in interface com.google.api.ads.common.lib.auth.OfflineCredentials.OAuthConfig

Returns the API OAuth scope.

getServiceClass() - Method in class com.google.api.ads.admanager.lib.client.AdManagerServiceDescriptor

getServiceClass() - Method in interface com.google.api.ads.common.lib.soap.compatability.JaxWsCompatible

Gets the JAX-WS service class such that it can be instantiated to create an JAX-WS service client.

getServiceClient(S, Class<T>) - Method in class com.google.api.ads.common.lib.factory.AdsServiceClientFactory

Gets a client given a session and the class of the desired stub interface.

getServiceClientAsInterface(S, Class<T>) - Method in class com.google.api.ads.common.lib.factory.BaseAdsServiceClientFactory

Gets a client given a session and the class of the desired stub interface.

getServiceName() - Method in class com.google.api.ads.common.lib.client.RequestInfo

Gets the service name.

getSoapArgs() - Method in class com.google.api.ads.common.lib.soap.SoapCall

Returns the arguments that will be passed into the SOAP call.

getSoapClient() - Method in class com.google.api.ads.common.lib.soap.SoapCall

Returns the underlying SOAP client that call will be made on.

getSoapClient() - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Returns the underlying SOAP client.

getSoapClientHandler() - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Returns the SOAP client handler.

getSoapClientMethod() - Method in class com.google.api.ads.common.lib.soap.SoapCall

Returns the method to invoke on the underlying SOAP client.

getSoapClientMethod(T, Method) - Method in class com.google.api.ads.common.lib.soap.SoapClientHandler

Gets the method from the SOAP client that matches the supplied method.

getSoapClientMethod(T, Method) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Gets the method from the SOAP client that matches the supplied method.

getTrigger() - Method in exception com.google.api.ads.common.lib.exception.ValidationException

getUrl() - Method in class com.google.api.ads.common.lib.client.RequestInfo

Gets the URL the request was made to.

getUserAgent() - Method in class com.google.api.ads.common.lib.useragent.AdsLibraryUserAgentProvider

Generates the library user agent such as Common-Java/1.4

getUserAgent() - Method in class com.google.api.ads.common.lib.useragent.AdsUtilitiesUserAgentProvider

getUserAgent() - Method in class com.google.api.ads.common.lib.useragent.BuildTypeUserAgentProvider

getUserAgent() - Method in class com.google.api.ads.common.lib.useragent.ProductFrameworkUserAgentProvider

Generates the framework user agent such as AdWords-Axis/1.4.

getUserAgent() - Method in class com.google.api.ads.common.lib.useragent.ProductUserAgentProvider

Generates the product user agent such as AwApi-Java.

getUserAgent() - Method in class com.google.api.ads.common.lib.useragent.RuntimeUserAgentProvider

getUserAgent(String) - Method in class com.google.api.ads.common.lib.useragent.UserAgentCombiner

Gets the full user agent in the form of "(UserAgent1,UserAgent2,UserAgent3,...)"

getUserAgent() - Method in interface com.google.api.ads.common.lib.useragent.UserAgentProvider

Gets a user agent.

getUserAgentCombiner() - Method in class com.google.api.ads.common.lib.utils.Internals

Creates a verbose User-Agent header.

getUserAgentIdentifier() - Method in enum com.google.api.ads.common.lib.utils.AdsUtility

Returns the String to use for this utility when generating the user agent of a request.

getVersion() - Method in class com.google.api.ads.admanager.lib.client.AdManagerServiceDescriptor

getVersion() - Method in interface com.google.api.ads.common.lib.client.AdsServiceDescriptor

Gets the version for this service.

getXmlFieldExtractor() - Method in class com.google.api.ads.common.lib.utils.Internals

getXPath() - Method in class com.google.api.ads.common.lib.utils.IterableXPath

GoogleClientSecretsBuilder - Class in com.google.api.ads.common.lib.auth

Builder for GoogleClientSecrets.

GoogleClientSecretsBuilder() - Constructor for class com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder

Constructor.

GoogleClientSecretsBuilder.Api - Enum in com.google.api.ads.common.lib.auth

Enum representing the API that GoogleClientSecretsBuilder can be used for.

GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder - Class in com.google.api.ads.common.lib.auth

Builder for GoogleClientSecrets.

H

handleException(Throwable) - Method in class com.google.api.ads.admanager.lib.client.AdManagerServiceClient

handleException(Throwable) - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Handles the exception.

handleInvocation(Object, Method, Object[]) - Method in class com.google.api.ads.common.lib.utils.AdsUtilityInvocationHandler

hashCode() - Method in class com.google.api.ads.common.lib.soap.SoapCall

HeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor> - Interface in com.google.api.ads.common.lib.client

Interface for handling headers.

HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor> - Class in com.google.api.ads.common.lib.client

No-op implementation of HeaderHandler

help - Variable in class com.google.api.ads.common.lib.utils.examples.CodeSampleParams

HIERARCHY_LEVEL_ONE_KEY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

HIERARCHY_LEVEL_TWO_KEY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

I

increaseOffsetBy(Integer) - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Increases the offset by the amount.

increaseOffsetBy(Integer) - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Increases the offset by the amount.

Internals - Class in com.google.api.ads.common.lib.utils

Provides access to internal utilities.

Internals(AuthorizationHeaderProvider, UserAgentCombiner, HttpTransport, AdsServiceLoggers, OAuth2Helper, AdsUtilityRegistry, XmlFieldExtractor) - Constructor for class com.google.api.ads.common.lib.utils.Internals

Constructor to be injected by guice.

invoke(SoapCall<T>) - Method in class com.google.api.ads.common.lib.soap.SoapClientHandler

Takes a SoapCall object and invokes the method by reflection.

invoke(Object, Method, Object[]) - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Wraps the underlying SOAP RPC such that first the method, by its name, is applied to the runtime class.

invokeSoapCall(SoapCall<T>) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Executes the SoapCall, which has a reference to a SoapClientHandlerInterface.

isDetailsLoggable(boolean) - Method in class com.google.api.ads.common.lib.utils.logging.RemoteCallLoggerDelegate

Returns true if the log level for request details and the specified result is enabled.

isSummaryLoggable(boolean) - Method in class com.google.api.ads.common.lib.utils.logging.RemoteCallLoggerDelegate

Returns true if the log level for request summaries and the specified result is enabled.

IterableXPath - Class in com.google.api.ads.common.lib.utils

Wrapper around an XPath string that allows for iteration over the elements of the XPath.

IterableXPath(String) - Constructor for class com.google.api.ads.common.lib.utils.IterableXPath

iterator() - Method in class com.google.api.ads.common.lib.utils.IterableXPath

Returns an iterator over the elements of IterableXPath.getXPath().

J

JaxBDeserializer<T> - Class in com.google.api.ads.common.lib.soap.jaxb

Deserializes XML to an instance of a JAX-WS generated class.

JaxBDeserializer(Class<T>) - Constructor for class com.google.api.ads.common.lib.soap.jaxb.JaxBDeserializer

Constructs a JAX-WS deserializer for the specified class.

JaxBSerializer<T> - Class in com.google.api.ads.common.lib.soap.jaxb

Serializes a JAX-WS generated class to XML.

JaxBSerializer(Class<T>, QName) - Constructor for class com.google.api.ads.common.lib.soap.jaxb.JaxBSerializer

Constructs a JAX-WS serializer for the specified class.

JaxWsCompatible - Interface in com.google.api.ads.common.lib.soap.compatability

Specifies that for the AdsServiceClient to be JAX-WS compatible, it must be able to retrieve a service class.

L

LABEL_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

LIMIT - Static variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

limit - Variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

limit(Integer) - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Sets the statement LIMIT clause in the form of

"LIMIT <count>"

e.g.

limit(Integer) - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Sets the statement LIMIT clause in the form of

"LIMIT <count>"

e.g.

LINE_ITEM_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

LINKED_DEVICE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

LoggingModule - Class in com.google.api.ads.common.lib.utils.logging

Module for logging.

LoggingModule(String) - Constructor for class com.google.api.ads.common.lib.utils.logging.LoggingModule

Constructor.

logRequest(RemoteCallReturn) - Method in class com.google.api.ads.common.lib.utils.logging.AdsServiceLoggers

Logs basic information on a SOAP request.

logRequestDetails(RemoteCallReturn) - Method in class com.google.api.ads.common.lib.utils.logging.RemoteCallLoggerDelegate

logRequestSummary(RemoteCallReturn) - Method in class com.google.api.ads.common.lib.utils.logging.RemoteCallLoggerDelegate

logSoapCall(RemoteCallReturn) - Method in class com.google.api.ads.common.lib.client.AdsServiceClient

logSoapCall(RemoteCallReturn) - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Logs a SOAP call.

M

Maps - Class in com.google.api.ads.common.lib.utils

A utility class for managing maps as represented in the API.

MASTER_CREATIVE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

Media - Class in com.google.api.ads.common.lib.utils

A utility class for retrieving media data.

N

NAME - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

newBuilder() - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession

Returns a new AdManagerSession.Builder with all settings copied from this session.

NO_OP_PRETTY_PRINTER - Static variable in interface com.google.api.ads.common.lib.utils.logging.PrettyPrinterInterface

Default implementation that simply returns the message.

NodeExtractor - Class in com.google.api.ads.common.lib.utils

Utility that extracts a Node from a parent node given a list of xpaths using DOM methods, not XPathExpression objects.

NodeExtractor() - Constructor for class com.google.api.ads.common.lib.utils.NodeExtractor

NoOpHeaderHandler() - Constructor for class com.google.api.ads.common.lib.client.HeaderHandler.NoOpHeaderHandler

NUM_REQUESTS - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

NUMBER_CUSTOM_FIELD_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

O

OAuth2AuthorizationHeaderProvider - Class in com.google.api.ads.common.lib.auth

OAuth2 authorization header provider.

OAuth2AuthorizationHeaderProvider() - Constructor for class com.google.api.ads.common.lib.auth.OAuth2AuthorizationHeaderProvider

Constructor.

OAuth2Compatible - Interface in com.google.api.ads.common.lib.auth

Interface for a user to be compatible with OAuth2.

OAuth2Helper - Class in com.google.api.ads.common.lib.auth

OAuth2 helper functions.

OAuth2Helper(Logger, Long) - Constructor for class com.google.api.ads.common.lib.auth.OAuth2Helper

Constructor.

OAuthException - Exception in com.google.api.ads.common.lib.exception

An exception thrown when OAuth could not be used correctly.

OAuthException(String) - Constructor for exception com.google.api.ads.common.lib.exception.OAuthException

Constructor.

OAuthException(String, Throwable) - Constructor for exception com.google.api.ads.common.lib.exception.OAuthException

Constructor.

OfflineCredentials - Class in com.google.api.ads.common.lib.auth

OfflineCredentials offline OAuth2 provider.

Example usage:

OfflineCredentials.Api - Enum in com.google.api.ads.common.lib.auth

Enum representing the API that OfflineCredentials can be used for.

OfflineCredentials.Builder - Class in com.google.api.ads.common.lib.auth

Pre-builder for OfflineCredentials.

OfflineCredentials.CustomOAuthConfig - Class in com.google.api.ads.common.lib.auth

A class defining a custom OAuth config.

OfflineCredentials.ForApiBuilder - Class in com.google.api.ads.common.lib.auth

Builder for OfflineCredentials.

OfflineCredentials.OAuthConfig - Interface in com.google.api.ads.common.lib.auth

Interface outlining the values required for OAuth configuration.

OFFSET - Static variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

offset - Variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

offset(Integer) - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Sets the statement OFFSET clause in the form of

"OFFSET <count>"

e.g.

offset(Integer) - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Sets the statement OFFSET clause in the form of

"OFFSET <count>"

e.g.

onException(Exception) - Method in interface com.google.api.ads.admanager.lib.utils.ReportCallback

Called when there was an exception preventing the completion of the asynchronous request.

onFailure() - Method in interface com.google.api.ads.admanager.lib.utils.ReportCallback

Called when there has been a failure due to server-side processing.

onInterruption() - Method in interface com.google.api.ads.admanager.lib.utils.ReportCallback

Called when the wait thread is interrupted.

onSuccess() - Method in interface com.google.api.ads.admanager.lib.utils.ReportCallback

Called when the asynchronous call has completed successfully.

ORDER_BY - Static variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

ORDER_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

orderBy - Variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

orderBy(String) - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Sets the statement ORDER BY clause in the form of

"ORDER BY <property> [ASC | DESC]"

e.g.

orderBy(String) - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Sets the statement ORDER BY clause in the form of

"ORDER BY <property> [ASC | DESC]"

e.g.

P

PACKAGE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

PARENT_AD_UNIT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

parseArguments(String[]) - Method in class com.google.api.ads.common.lib.utils.examples.CodeSampleParams

parseMessage(RequestInfo.Builder, SOAPMessage) - Method in class com.google.api.ads.common.lib.soap.RequestInfoXPathSet

parseMessage(ResponseInfo.Builder, SOAPMessage) - Method in class com.google.api.ads.common.lib.soap.ResponseInfoXPathSet

PLACEMENT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

popRegisteredUtilities() - Method in class com.google.api.ads.common.lib.utils.AdsUtilityRegistry

Returns all utilities in the registry and clears the registry.

PREMIUM_RATE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

prettyPrint(String) - Method in class com.google.api.ads.common.lib.utils.logging.PrettyPrinter

Transforms XML into a pretty-printed format with sensitive strings removed.

prettyPrint(String) - Method in interface com.google.api.ads.common.lib.utils.logging.PrettyPrinterInterface

Transforms the message into a pretty-printed format.

PrettyPrinter - Class in com.google.api.ads.common.lib.utils.logging

A utility class that pretty prints XML messages.

PrettyPrinter(AdsApiConfiguration, Logger, Supplier<XPath>, Supplier<Transformer>, Supplier<DocumentBuilder>) - Constructor for class com.google.api.ads.common.lib.utils.logging.PrettyPrinter

Default constructor used by Guice.

PrettyPrinterInterface - Interface in com.google.api.ads.common.lib.utils.logging

Interface capable of pretty printing messages (e.g., XML).

PRIMARY_SALESPERSON_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

PRIMARY_TRAFFICKER_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

processSoapArguments(Method, Object[]) - Method in class com.google.api.ads.common.lib.soap.SoapClientHandler

Processes the arguments such that they will be ready to be passed into the supplied SOAP client method.

PRODUCT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

PRODUCT_PACKAGE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

PRODUCT_PACKAGE_ITEM_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

PRODUCT_TEMPLATE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

ProductFrameworkModule - Class in com.google.api.ads.common.lib.soap

Module for the product/framework.

ProductFrameworkModule() - Constructor for class com.google.api.ads.common.lib.soap.ProductFrameworkModule

ProductFrameworkUserAgentProvider - Class in com.google.api.ads.common.lib.useragent

Provides product/framework user agent.

ProductFrameworkUserAgentProvider(ProductFrameworkConfiguration) - Constructor for class com.google.api.ads.common.lib.useragent.ProductFrameworkUserAgentProvider

Constructor.

ProductUserAgentProvider - Class in com.google.api.ads.common.lib.useragent

Provides product user agent.

ProductUserAgentProvider(ProductConfiguration) - Constructor for class com.google.api.ads.common.lib.useragent.ProductUserAgentProvider

Constructor.

PROGRAMMATIC_BUYER_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

PROPOSAL_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

PROPOSAL_LINE_ITEM_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

putAllHttpHeaders(T, Map<String, String>) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Puts all headers into the existing HTTP headers of the SOAP client, overwriting any existing header keys.

Q

QueryBuilder<V> - Class in com.google.api.ads.admanager.lib.utils

QueryBuilder allows for queries to be constructed in parts.

QueryBuilder() - Constructor for class com.google.api.ads.admanager.lib.utils.QueryBuilder

Constructs a query builder.

QueryBuilderInterface<V> - Interface in com.google.api.ads.admanager.lib.utils

QueryBuilderInterface allows for queries to be constructed in parts.

R

RATE_CARD_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

readAll(InputStream) - Static method in class com.google.api.ads.common.lib.utils.Streams

Deprecated.

it is always safer to supply a charset. See Streams.readAll(InputStream, Charset).

readAll(InputStream, Charset) - Static method in class com.google.api.ads.common.lib.utils.Streams

Reads all input into memory, close the steam, and return as a String.

RECONCILIATION_LINE_ITEM_REPORT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

RECONCILIATION_ORDER_REPORT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

RECONCILIATION_REPORT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

RECONCILIATION_REPORT_ROW_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

refreshCredential(Credential) - Method in class com.google.api.ads.common.lib.auth.OAuth2Helper

Refreshes the credential if within the refresh window.

RemoteCallLoggerDelegate - Class in com.google.api.ads.common.lib.utils.logging

Delegate for logging RemoteCallReturn objects.

RemoteCallLoggerDelegate(Logger, Logger, PrettyPrinterInterface, RemoteCallLoggerDelegate.RemoteCallType) - Constructor for class com.google.api.ads.common.lib.utils.logging.RemoteCallLoggerDelegate

RemoteCallLoggerDelegate.RemoteCallType - Enum in com.google.api.ads.common.lib.utils.logging

Type of the request or response.

RemoteCallReturn - Class in com.google.api.ads.common.lib.client

Used to package a remote call's return.

RemoteCallReturn.Builder - Class in com.google.api.ads.common.lib.client

Builder for RemoteCallReturn objects.

removeLimitAndOffset() - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Removes the limit and offset from the query.

removeLimitAndOffset() - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Removes the limit and offset from the query.

ReportCallback - Interface in com.google.api.ads.admanager.lib.utils

ReportCallback is called on the completion of asynchronous report downloads.

RequestInfo - Class in com.google.api.ads.common.lib.client

Contains information about the request that was made.

RequestInfo.Builder - Class in com.google.api.ads.common.lib.client

Builder for RequestInfo objects.

RequestInfoXPathSet - Class in com.google.api.ads.common.lib.soap

XPaths to capture from SOAP requests.

RequestInfoXPathSet(AdsApiConfiguration, NodeExtractor, Supplier<Transformer>, Logger) - Constructor for class com.google.api.ads.common.lib.soap.RequestInfoXPathSet

ResponseInfo - Class in com.google.api.ads.common.lib.client

Contains information about the response from the request that was made.

ResponseInfo.Builder - Class in com.google.api.ads.common.lib.client

Builder for ResponseInfo objects.

ResponseInfoXPathSet - Class in com.google.api.ads.common.lib.soap

XPaths to capture from SOAP responses.

ResponseInfoXPathSet(AdsApiConfiguration, NodeExtractor) - Constructor for class com.google.api.ads.common.lib.soap.ResponseInfoXPathSet

RuntimeUserAgentProvider - Class in com.google.api.ads.common.lib.useragent

Gets the runtime user agent.

RuntimeUserAgentProvider() - Constructor for class com.google.api.ads.common.lib.useragent.RuntimeUserAgentProvider

S

SAVED_QUERY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

saveMediaDataToFile(byte[], String) - Static method in class com.google.api.ads.common.lib.utils.Media

Saves media data downloaded from an API in byte[] format into a file on the file system.

saveMediaDataToFile(byte[], File) - Static method in class com.google.api.ads.common.lib.utils.Media

Saves media data downloaded from an API in byte[] format into a file on the file system.

SECONDARY_SALESPERSON_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

SELECT - Static variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

select - Variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

select(String) - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Sets the statement SELECT clause in the form of "a,b" or "*".

select(String) - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Sets the statement SELECT clause in the form of "a,b" or "*".

serialize(T) - Method in class com.google.api.ads.common.lib.soap.jaxb.JaxBSerializer

Serializes the object.

serialize(T, boolean) - Method in class com.google.api.ads.common.lib.soap.jaxb.JaxBSerializer

Serializes the object with the option to include or exclude the XML declaration.

ServiceException - Exception in com.google.api.ads.common.lib.exception

A runtime service exception that usually cannot be recovered from.

ServiceException(String, Throwable) - Constructor for exception com.google.api.ads.common.lib.exception.ServiceException

Constructor.

ServiceException(String) - Constructor for exception com.google.api.ads.common.lib.exception.ServiceException

Constructor.

setAdsSession(S) - Method in class com.google.api.ads.common.lib.client.AdsServiceClient

Sets the ads session for this client.

setAuthorization(Object, AdsSession) - Method in class com.google.api.ads.common.lib.soap.AuthorizationHeaderHandler

Sets the authorization header created from the session on the soap client.

setCompression(T, boolean) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Sets if the SOAP client should use compression.

setEndpointAddress(T, String) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Sets the endpoint address on the SOAP client.

setEndpointAddress(String) - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Sets the endpoint address of the underlying SOAP client.

setHeader(T, String, String, Object) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Sets a header on the SOAP client.

setHeaders() - Method in class com.google.api.ads.common.lib.client.AdsServiceClient

setHeaders(Object, S, D) - Method in class com.google.api.ads.common.lib.client.HeaderHandler.NoOpHeaderHandler

setHeaders(Object, S, D) - Method in interface com.google.api.ads.common.lib.client.HeaderHandler

Sets the headers on the SOAP client using the session and descriptor.

setHeaders() - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Sets the headers for the service client.

setHttpHeaders(Object, AdManagerSession) - Method in class com.google.api.ads.admanager.lib.soap.AdManagerHttpHeaderHandler

Sets the HTTP headers on the SOAP client.

setNetworkCode(String) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.ImmutableAdManagerSession

setNetworkCode(String) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession

Sets the network code.

setOAuth2Credential(Credential) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.ImmutableAdManagerSession

setOAuth2Credential(Credential) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession

Sets the OAuth2 credential.

setRequestTimeout(T, int) - Method in interface com.google.api.ads.common.lib.soap.SoapClientHandlerInterface

Sets the read timeout of the given SOAP client.

SITE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

SoapCall<T> - Class in com.google.api.ads.common.lib.soap

Represents a single call to the SOAP client.

SoapCall(Method, T, Object[]) - Constructor for class com.google.api.ads.common.lib.soap.SoapCall

Constructor.

SoapClientHandler<T> - Class in com.google.api.ads.common.lib.soap

Base class for SOAP client handlers.

SoapClientHandler() - Constructor for class com.google.api.ads.common.lib.soap.SoapClientHandler

Default constructor.

SoapClientHandlerInterface<T> - Interface in com.google.api.ads.common.lib.soap

Interface for SOAP client handlers.

SoapServiceClient<T> - Class in com.google.api.ads.common.lib.soap

The SoapServiceClient class pairs together the soapClient and soapClientHandler so that calls made through the SoapServiceClient.invoke(Object, Method, Object[]) method can be dispatched and handled correctly in the SOAP layer.

SoapServiceClient(SoapClientHandlerInterface<T>, T) - Constructor for class com.google.api.ads.common.lib.soap.SoapServiceClient

Protected constructor.

SoapServiceDescriptor - Interface in com.google.api.ads.common.lib.soap

Describes a SOAP service.

Streams - Class in com.google.api.ads.common.lib.utils

Helper class to perform stream operations.

T

TARGETED_VIDEO_AD_UNIT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TARGETING_KEY_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TARGETING_KEY_ID_1 - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TARGETING_KEY_ID_2 - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TARGETING_KEY_ID_3 - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TARGETING_VALUE_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TARGETING_VALUE_ID_1 - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TARGETING_VALUE_ID_3 - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TARGETING_VALUE_IDS_2 - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TEAM_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

toArray(Map<K, V>, T[]) - Static method in class com.google.api.ads.common.lib.utils.Maps

Generates an array of entries from a map.

toCalendar(T) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Gets a calendar for a DateTime using the default locale, i.e.

toCalendar(T, Locale) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Gets a calendar for a DateTime in the supplied locale.

toDateTime(Calendar) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Converts a Calendar object to an API date time preserving the time zone.

toDateTime(Instant, String) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Converts an Instant object to an API date time in the time zone supplied.

toDateTime(DateTime) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Converts a DateTime object to an API date time preserving the time zone.

toDateTime(String, String) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Converts a string in the form of yyyy-MM-dd'T'HH:mm:ss to an API date time in the time zone supplied.

toDateTime(T) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Converts an API date time to a DateTime preserving the time zone.

toDateTimeWithTimeZone(String) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Converts a string in the form of yyyy-MM-dd'T'HH:mm:ss±HH:mm to an API date time in the time zone supplied.

toList(Map<K, V>, Class<T>) - Static method in class com.google.api.ads.common.lib.utils.Maps

Generates a list of entries from a map.

toMap(List<T>) - Static method in class com.google.api.ads.common.lib.utils.Maps

Generates a map from a list of entries.

toMap(T[]) - Static method in class com.google.api.ads.common.lib.utils.Maps

Generates a map from an array an entries.

toString(T) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Returns string representation of this date time.

toString() - Method in class com.google.api.ads.common.lib.client.RequestInfo

toString() - Method in class com.google.api.ads.common.lib.client.ResponseInfo

toString() - Method in exception com.google.api.ads.common.lib.exception.ValidationException

toString() - Method in class com.google.api.ads.common.lib.soap.RequestInfoXPathSet

toString() - Method in class com.google.api.ads.common.lib.soap.ResponseInfoXPathSet

toString() - Method in class com.google.api.ads.common.lib.utils.IterableXPath

toStringForTimeZone(T, String) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Returns string representation of this date time with a different time zone, preserving the millisecond instant.

toStringWithTimeZone(T) - Method in class com.google.api.ads.admanager.lib.utils.DateTimesHelper

Returns string representation of this date time with time zone.

TRAFFIC_FORECAST_SEGMENT_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

TRAFFICKER_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

U

unwrapRemoteCallReturn(RemoteCallReturn) - Method in class com.google.api.ads.common.lib.soap.SoapServiceClient

Unwraps a SOAP remote call return such that if there was an exception, it is thrown and if it was a successful call, the return value of the SOAP call is returned.

URL - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

USER_ID - Static variable in class com.google.api.ads.admanager.lib.utils.examples.ArgumentNames

UserAgentCombiner - Class in com.google.api.ads.common.lib.useragent

Combines all user agents along with a user supplied string.

UserAgentCombiner(ProductUserAgentProvider, UserAgentCombiner.ProductFrameworkProviderHolder, AdsLibraryUserAgentProvider, UserAgentCombiner.FrameworkProviderHolder, RuntimeUserAgentProvider, BuildTypeUserAgentProvider, AdsUtilitiesUserAgentProvider, UserAgentCombiner.ExtensionProviderHolder) - Constructor for class com.google.api.ads.common.lib.useragent.UserAgentCombiner

Constructor that builds an instance based on a list of underlying user agent providers.

UserAgentProvider - Interface in com.google.api.ads.common.lib.useragent

Provides a user agent.

UsesAdsUtilities - Annotation Type in com.google.api.ads.common.lib.utils

Annotation for methods that represent the usage of an AdsUtility.

V

validateQuery() - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Checks that the query is valid.

ValidationException - Exception in com.google.api.ads.common.lib.exception

Exception for validation errors.

ValidationException(String, String) - Constructor for exception com.google.api.ads.common.lib.exception.ValidationException

Constructor.

ValidationException(String, String, Throwable) - Constructor for exception com.google.api.ads.common.lib.exception.ValidationException

Constructor.

valueMap - Variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

valueOf(String) - Static method in enum com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.Api

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.api.ads.common.lib.auth.OfflineCredentials.Api

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.api.ads.common.lib.utils.AdsUtility

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.api.ads.common.lib.utils.logging.RemoteCallLoggerDelegate.RemoteCallType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.Api

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.api.ads.common.lib.auth.OfflineCredentials.Api

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.api.ads.common.lib.utils.AdsUtility

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.api.ads.common.lib.utils.logging.RemoteCallLoggerDelegate.RemoteCallType

Returns an array containing the constants of this enum type, in the order they are declared.

W

WHERE - Static variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

where - Variable in class com.google.api.ads.admanager.lib.utils.QueryBuilder

where(String) - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Sets the statement WHERE clause in the form of

"WHERE <condition> {[AND | OR] <condition> ...}"

e.g.

where(String) - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Sets the statement WHERE clause in the form of

"WHERE <condition> {[AND | OR] <condition> ...}"

e.g.

withApplicationName(String) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

Includes application name (any string of your choice).

withBindVariableValue(String, V) - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Adds a value to the statement in the form of a Value.

withBindVariableValue(String, V) - Method in interface com.google.api.ads.admanager.lib.utils.QueryBuilderInterface

Puts a key-value into the bind variables.

withBindVariableValues(Map<String, V>) - Method in class com.google.api.ads.admanager.lib.utils.QueryBuilder

Adds all key value mappings.

withClientSecrets(String, String) - Method in class com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder

Sets the client ID & secret to create the OAuth2 Credential with.

withClientSecrets(String, String) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

Sets the client ID & secret to create the OAuth2 Credential with.

withContext(String, String) - Method in class com.google.api.ads.common.lib.client.RequestInfo.Builder

Adds the name/value pair for the context of this request.

withEndpoint(String) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

Override the endpoint server.

withException(Throwable) - Method in class com.google.api.ads.common.lib.client.RemoteCallReturn.Builder

Adds an exception to the RemoteCallReturn under construction.

withHttpTransport(HttpTransport) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

Sets the HttpTransport to be used to make the request.

withJsonKeyFilePath(String) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

Sets the path to a JSON key file for authenticating with a service account.

withMethodName(String) - Method in class com.google.api.ads.common.lib.client.RequestInfo.Builder

Adds a method name to the RequestInfo under construction.

withNetworkCode(String) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

Includes network code.

withOAuth2Credential(Credential) - Method in class com.google.api.ads.admanager.lib.client.AdManagerSession.Builder

Includes OAuth2 credential to be used for OAuth2 authentication.

withOperationsCount(Long) - Method in class com.google.api.ads.common.lib.client.ResponseInfo.Builder

withPayload(String) - Method in class com.google.api.ads.common.lib.client.RequestInfo.Builder

Adds the request payload to the RequestInfo under construction.

withPayload(String) - Method in class com.google.api.ads.common.lib.client.ResponseInfo.Builder

Adds the response payload to the ResponseInfo under construction.

withRefreshToken(String) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

Sets the refresh token to create the OAuth2 Credential with.

withRequestId(String) - Method in class com.google.api.ads.common.lib.client.ResponseInfo.Builder

Adds the SOAP response request ID to the ResponseInfo under construction.

withRequestInfo(RequestInfo) - Method in class com.google.api.ads.common.lib.client.RemoteCallReturn.Builder

Adds a request info to the RemoteCallReturn under construction.

withResponseInfo(ResponseInfo) - Method in class com.google.api.ads.common.lib.client.RemoteCallReturn.Builder

Adds a response info to the RemoteCallReturn under construction.

withResponseTimeMillis(Long) - Method in class com.google.api.ads.common.lib.client.ResponseInfo.Builder

withReturnValue(Object) - Method in class com.google.api.ads.common.lib.client.RemoteCallReturn.Builder

Adds a return value to the RemoteCallReturn under construction.

withScopes(List<String>) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

Optionally sets scopes for authenticating with a service account.

withServiceAccountUser(String) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

Sets the service account user to impersonate.

withServiceName(String) - Method in class com.google.api.ads.common.lib.client.RequestInfo.Builder

Adds a service name to the RequestInfo under construction.

withTokenUrlServer(String) - Method in class com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

Sets the token server URL.

withUrl(String) - Method in class com.google.api.ads.common.lib.client.RequestInfo.Builder

Adds the target URL to the RequestInfo under construction.

wrapString(String) - Static method in class com.google.api.ads.common.lib.utils.Streams

Deprecated.

it is always safer to supply a charset. See Streams.wrapString(String, Charset).

wrapString(String, Charset) - Static method in class com.google.api.ads.common.lib.utils.Streams

Wraps the provided string into an InputStream.

write(String, OutputStream) - Static method in class com.google.api.ads.common.lib.utils.Streams

Deprecated.

it is always safer to supply a charset. See Streams.write(String, OutputStream, Charset).

write(String, OutputStream, Charset) - Static method in class com.google.api.ads.common.lib.utils.Streams

Writes the specified string to stream with buffering and closes the stream.

writeCsv(List<String[]>, String) - Static method in class com.google.api.ads.common.lib.utils.CsvFiles

Writes the CSV data located in csvData to the file located at fileName.

X

XmlFieldExtractor - Class in com.google.api.ads.common.lib.utils

Utility class to extract fields from XML.

XmlFieldExtractor(Logger, Supplier<DocumentBuilder>, Supplier<XPath>) - Constructor for class com.google.api.ads.common.lib.utils.XmlFieldExtractor

A B C D E F G H I J L M N O P Q R S T U V W X