public class AdManagerAxisHeaderHandler +extends Object +implements HeaderHandler<AdManagerSession,AdManagerServiceDescriptor>+
HeaderHandler.HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>| Constructor and Description | +
|---|
AdManagerAxisHeaderHandler(AxisHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor)
+Sets the headers on the SOAP client using the session and descriptor.
+ |
+
@Inject +public AdManagerAxisHeaderHandler(AxisHandler soapClientHandler, + com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration, + com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration, + AuthorizationHeaderHandler authorizationHeaderHandler, + AdManagerHttpHeaderHandler adManagerHttpHeaderHandler, + UserAgentCombiner userAgentCombiner)+
soapClientHandler - the SOAP client handleradManagerApiConfiguration - the Ad Manager API configurationauthorizationHeaderHandler - the authorization header handleradManagerHttpHeaderHandler - the Ad Manager HTTP header handleruserAgentCombiner - the full user agent providerpublic void setHeaders(Object soapClient, + AdManagerSession adManagerSession, + AdManagerServiceDescriptor adManagerServiceDescriptor) + throws AuthenticationException, + ServiceException+
HeaderHandlersetHeaders in interface HeaderHandler<AdManagerSession,AdManagerServiceDescriptor>soapClient - the SOAP clientadManagerSession - the ads sessionadManagerServiceDescriptor - the ads service descriptorAuthenticationException - if there was a problem authenticating the
+ sessionServiceException - if there was a problem setting the headersHeaderHandler.setHeaders(Object, com.google.api.ads.common.lib.client.AdsSession,
+ com.google.api.ads.common.lib.client.AdsServiceDescriptor)Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/AdManagerAxisModule.html b/5.3.0/com/google/api/ads/admanager/axis/AdManagerAxisModule.html new file mode 100644 index 0000000000..740cd46e80 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/AdManagerAxisModule.html @@ -0,0 +1,306 @@ + + + + + + +public class AdManagerAxisModule +extends ProductFrameworkModule+
| Constructor and Description | +
|---|
AdManagerAxisModule() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+configure() |
+
configureConfigurationsaddError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/class-use/AdManagerAxisHeaderHandler.html b/5.3.0/com/google/api/ads/admanager/axis/class-use/AdManagerAxisHeaderHandler.html new file mode 100644 index 0000000000..c8b985b5ec --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/class-use/AdManagerAxisHeaderHandler.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/class-use/AdManagerAxisModule.html b/5.3.0/com/google/api/ads/admanager/axis/class-use/AdManagerAxisModule.html new file mode 100644 index 0000000000..87312b0928 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/class-use/AdManagerAxisModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/factory/AdManagerServices.html b/5.3.0/com/google/api/ads/admanager/axis/factory/AdManagerServices.html new file mode 100644 index 0000000000..1e383dd71e --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/factory/AdManagerServices.html @@ -0,0 +1,283 @@ + + + + + + +public final class AdManagerServices +extends BaseAdManagerServices+
Usage example: + +
+ AdManagerSession session = new AdManagerSession.Builder()...build();
+ InventoryServiceInterface inventoryService =
+ new AdManagerServices().get(session, InventoryServiceInterface.class);
+ inventoryService.makeRequest(...);
+ ...
+ session.setNetworkCode(...);
+ inventoryService.makeRequest(...);
+ Implementation is thread-safe.
| Constructor and Description | +
|---|
AdManagerServices() |
+
getclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/factory/class-use/AdManagerServices.html b/5.3.0/com/google/api/ads/admanager/axis/factory/class-use/AdManagerServices.html new file mode 100644 index 0000000000..b7d3e00050 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/factory/class-use/AdManagerServices.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/factory/package-frame.html b/5.3.0/com/google/api/ads/admanager/axis/factory/package-frame.html new file mode 100644 index 0000000000..ae4c790218 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/factory/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| AdManagerServices | +
+ Utility class to create Ad Manager service clients.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/factory/package-tree.html b/5.3.0/com/google/api/ads/admanager/axis/factory/package-tree.html new file mode 100644 index 0000000000..ac3a2af0ca --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/factory/package-tree.html @@ -0,0 +1,147 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/factory/package-use.html b/5.3.0/com/google/api/ads/admanager/axis/factory/package-use.html new file mode 100644 index 0000000000..b09701c57d --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/factory/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/package-frame.html b/5.3.0/com/google/api/ads/admanager/axis/package-frame.html new file mode 100644 index 0000000000..d2c0dfc8c8 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Class | +Description | +
|---|---|
| AdManagerAxisHeaderHandler | +
+ Ad Manager implementation of
+HeaderHandler. |
+
| AdManagerAxisModule | +
+ Guice module to bind Ad Manager's SOAP header handler to an Axis-friendly implementation.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/package-tree.html b/5.3.0/com/google/api/ads/admanager/axis/package-tree.html new file mode 100644 index 0000000000..c4e871e375 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/package-tree.html @@ -0,0 +1,148 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/package-use.html b/5.3.0/com/google/api/ads/admanager/axis/package-use.html new file mode 100644 index 0000000000..6dcb7c9c4f --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/DateTimes.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/DateTimes.html new file mode 100644 index 0000000000..d3db03cfa3 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/DateTimes.html @@ -0,0 +1,477 @@ + + + + + + +public final class DateTimes +extends Object+
DateTime objects.| Modifier and Type | +Method and Description | +
|---|---|
static Calendar |
+toCalendar(com.google.api.ads.admanager.axis.v202302.DateTime dateTime)
+Gets a calendar for a
+DateTime using the default locale, i.e. |
+
static Calendar |
+toCalendar(com.google.api.ads.admanager.axis.v202302.DateTime dateTime,
+ Locale locale)
+Gets a calendar for a
+DateTime in the supplied locale. |
+
static com.google.api.ads.admanager.axis.v202302.DateTime |
+toDateTime(Calendar calendar)
+Converts a
+Calendar object to an API date time preserving the time zone. |
+
static com.google.api.ads.admanager.axis.v202302.DateTime |
+toDateTime(org.joda.time.DateTime dateTime)
+Converts a
+DateTime object to an API date time preserving the time zone. |
+
static org.joda.time.DateTime |
+toDateTime(com.google.api.ads.admanager.axis.v202302.DateTime dateTime)
+Converts an API date time to a
+DateTime preserving the time zone. |
+
static com.google.api.ads.admanager.axis.v202302.DateTime |
+toDateTime(org.joda.time.Instant instant,
+ String timeZoneId)
+Converts an
+Instant object to an API date time in the time zone supplied. |
+
static com.google.api.ads.admanager.axis.v202302.DateTime |
+toDateTime(String dateTime,
+ String timeZoneId)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied. |
+
static com.google.api.ads.admanager.axis.v202302.DateTime |
+toDateTimeWithTimeZone(String dateTime)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied. |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202302.Date date)
+Returns string representation of this date.
+ |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202302.DateTime dateTime)
+Returns string representation of this date time.
+ |
+
static String |
+toStringForTimeZone(com.google.api.ads.admanager.axis.v202302.DateTime dateTime,
+ String newZoneId)
+Returns string representation of this date time with a different time zone, preserving the
+ millisecond instant.
+ |
+
static String |
+toStringWithTimeZone(com.google.api.ads.admanager.axis.v202302.DateTime dateTime)
+Returns string representation of this date time with time zone.
+ |
+
public static com.google.api.ads.admanager.axis.v202302.DateTime toDateTime(Calendar calendar)+
Calendar object to an API date time preserving the time zone.public static com.google.api.ads.admanager.axis.v202302.DateTime toDateTime(org.joda.time.Instant instant, + String timeZoneId)+
Instant object to an API date time in the time zone supplied.public static com.google.api.ads.admanager.axis.v202302.DateTime toDateTime(org.joda.time.DateTime dateTime)+
DateTime object to an API date time preserving the time zone.public static com.google.api.ads.admanager.axis.v202302.DateTime toDateTime(String dateTime, + String timeZoneId)+
yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.public static com.google.api.ads.admanager.axis.v202302.DateTime toDateTimeWithTimeZone(String dateTime)+
yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.public static org.joda.time.DateTime toDateTime(com.google.api.ads.admanager.axis.v202302.DateTime dateTime)+
DateTime preserving the time zone.public static Calendar toCalendar(com.google.api.ads.admanager.axis.v202302.DateTime dateTime)+
DateTime using the default locale, i.e. Locale.getDefault().public static Calendar toCalendar(com.google.api.ads.admanager.axis.v202302.DateTime dateTime, + Locale locale)+
DateTime in the supplied locale.public static String toString(com.google.api.ads.admanager.axis.v202302.Date date)+
date - the date to stringifyDate in yyyy-MM-ddpublic static String toString(com.google.api.ads.admanager.axis.v202302.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:sspublic static String toStringWithTimeZone(com.google.api.ads.admanager.axis.v202302.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm,
+ i.e. 2013-09-013T12:02:03+08:00 or 2013-09-013T12:02:03Z for Etc/GMT.public static String toStringForTimeZone(com.google.api.ads.admanager.axis.v202302.DateTime dateTime, + String newZoneId)+
This method is useful for finding the local time in another time zone, especially for + filtering. + +
For example, if this date time holds 12:30 in Europe/London, the result from this method + with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, + i.e. + +
String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
+ String statementPart =
+ "startDateTime > "
+ + DateTimes.toString(apiDateTime, timeZoneId);
+ //...
+ statementBuilder.where(statementPart);
+ DateTime.withZone(org.joda.time.DateTimeZone).dateTime - the date time to stringify into a new time zonenewZoneId - the time zone ID of the new zoneDateTime in yyyy-MM-dd'T'HH:mm:ssCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/Pql.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/Pql.html new file mode 100644 index 0000000000..7d6ff4ee50 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/Pql.html @@ -0,0 +1,509 @@ + + + + + + +public final class Pql +extends Object+
+
+ ResultSet combinedResultSet = null
+ do {
+ ResultSet resultSet = pqlService.select(pagedStatement);
+ combinedResultSet = (combinedResultSet == null) ? resultSet :
+ Pql.combineResultSet(combinedResultSet, resultSet);
+ // ...
+ } while(!finishedCollectingResultSets)
+ //...
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ | Modifier and Type | +Method and Description | +
|---|---|
static com.google.api.ads.admanager.axis.v202302.ResultSet |
+combineResultSets(com.google.api.ads.admanager.axis.v202302.ResultSet first,
+ com.google.api.ads.admanager.axis.v202302.ResultSet second)
+Combines the first and second result sets, if and only if, the columns of both result sets
+ match.
+ |
+
static com.google.api.ads.admanager.axis.v202302.Value |
+createValue(Object value)
+Creates a
+Value from the value i.e. |
+
static Object |
+getApiValue(com.google.api.ads.admanager.axis.v202302.Value value)
+Gets the underlying value of the
+Value object that's comparable to what would be
+ returned in any other API object (i.e. |
+
static List<String> |
+getColumnLabels(com.google.api.ads.admanager.axis.v202302.ResultSet resultSet)
+Gets the column labels for the result set.
+ |
+
static Object |
+getCsvValue(com.google.api.ads.admanager.axis.v202302.Value value)
+Gets the underlying value of the
+Value object that should be used for CSV conversion
+ (i.e. |
+
static Object |
+getNativeValue(com.google.api.ads.admanager.axis.v202302.Value value)
+Gets the underlying value of the
+Value object that's considered native to Java (i.e. |
+
static List<String> |
+getRowStringValues(com.google.api.ads.admanager.axis.v202302.Row row)
+Gets the values in a row of the result set in the form of a string list.
+ |
+
static String |
+resultSetToString(com.google.api.ads.admanager.axis.v202302.ResultSet resultSet)
+Gets the result set as a table representation in the form of:
+ |
+
static List<String[]> |
+resultSetToStringArrayList(com.google.api.ads.admanager.axis.v202302.ResultSet resultSet)
+Gets the result set as list of string arrays, which can be transformed to a CSV using
+CsvFiles such as |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202302.Value value)
+Creates a String from the Value.
+ |
+
public static com.google.api.ads.admanager.axis.v202302.Value createValue(Object value)+
Value from the value i.e. a TextValue for a value of type String, BooleanValue for type Boolean, NumberValue for type Double, Long, or Integer, DateTimeValue for type DateTime, and
+ DateValue for type Date. If the value is a Value, the value is
+ returned. If the value is null, an empty TextValue is returned.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static String toString(com.google.api.ads.admanager.axis.v202302.Value value)+
DateTimes.toString(Date) and DateTimes.toStringWithTimeZone(DateTime)
+ respectively.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static Object getApiValue(com.google.api.ads.admanager.axis.v202302.Value value)+
Value object that's comparable to what would be
+ returned in any other API object (i.e. DateTimeValue will return an API DateTime, not a Joda
+ DateTime).value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getNativeValue(com.google.api.ads.admanager.axis.v202302.Value value)+
Value object that's considered native to Java (i.e.
+ DateTimeValue will return a Joda DateTime, not an API DateTime and DateValue will return a
+ string in the form of "yyyy-MM-dd").value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getCsvValue(com.google.api.ads.admanager.axis.v202302.Value value)+
Value object that should be used for CSV conversion
+ (i.e. DateTimeValue will return a String representation, but NumberValue will return a Long or
+ Double).value - the value to convertValue or null if the underlying value is
+ nullIllegalArgumentException - if value cannot be convertedpublic static List<String[]> resultSetToStringArrayList(com.google.api.ads.admanager.axis.v202302.ResultSet resultSet)+
CsvFiles such as
+
+
+
+ ResultSet combinedResultSet = Pql.combineResultSet(resultSet1, resultSet2);
+ //...
+ combinedResultSet = Pql.combineResultSet(combinedResultSet, resultSet3);
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ resultSet - the result set to convert to a CSV compatible formatpublic static String resultSetToString(com.google.api.ads.admanager.axis.v202302.ResultSet resultSet) + throws IllegalAccessException+
+ +-------+-------+-------+ + |column1|column2|column3| + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ +
resultSet - the result set to display as a stringIllegalAccessException - if the values of the result set cannot be accessedpublic static List<String> getColumnLabels(com.google.api.ads.admanager.axis.v202302.ResultSet resultSet)+
resultSet - the result set to get the column labels forpublic static List<String> getRowStringValues(com.google.api.ads.admanager.axis.v202302.Row row)+
row - the row to get the values forpublic static com.google.api.ads.admanager.axis.v202302.ResultSet combineResultSets(com.google.api.ads.admanager.axis.v202302.ResultSet first, + com.google.api.ads.admanager.axis.v202302.ResultSet second)+
IllegalArgumentException - if the columns of the first result set don't match the secondCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/ReportDownloader.html new file mode 100644 index 0000000000..3abe8da495 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/ReportDownloader.html @@ -0,0 +1,472 @@ + + + + + + +public class ReportDownloader +extends Object+
ReportServiceInterface.
+
+ There are two main functions of this class: + +
OutputStream
+ ReportUtils also provides the method whenReportReady(ReportCallback) to wait
+ for a scheduled report to finish processing before taking an action on the report through the
+ supplied ReportCallback.
| Modifier and Type | +Field and Description | +
|---|---|
static Charset |
+REPORT_CHARSET |
+
static int |
+SLEEP_TIMER
+The time to sleep before each request to the service.
+ |
+
| Constructor and Description | +
|---|
ReportDownloader(com.google.api.ads.admanager.axis.v202302.ReportServiceInterface reportService,
+ long reportJobId)
+Constructs a
+ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on. |
+
| Modifier and Type | +Method and Description | +
|---|---|
URL |
+getDownloadUrl(com.google.api.ads.admanager.axis.v202302.ReportDownloadOptions options)
+Gets the download URL for a GZip or plain-text format report.
+ |
+
com.google.common.io.CharSource |
+getReportAsCharSource(com.google.api.ads.admanager.axis.v202302.ReportDownloadOptions options)
+Returns a CharSource of report contents with
+ReportDownloadOptions. |
+
boolean |
+waitForReportReady()
+Blocks and waits for a report to be ready.
+ |
+
Thread |
+whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
public static final Charset REPORT_CHARSET+
public static final int SLEEP_TIMER+
public ReportDownloader(com.google.api.ads.admanager.axis.v202302.ReportServiceInterface reportService, + long reportJobId)+
ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.reportService - the ReportService stub to make calls toreportJobId - the report job IDpublic Thread whenReportReady(ReportCallback callback)+
ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ callback - the ReportCallback to call when the job has finished, successfully or
+ otherwiseThread.interrupt() can
+ be called on the returned thread to interrupt it.IllegalArgumentException - if callback == nullpublic boolean waitForReportReady() + throws RemoteException, + InterruptedException+
ReportJobStatus is received that is
+ not ReportJobStatus#Pending or ReportJobStatus#InProgress, the report is
+ considered finished, and the method is returned with a true if the report was
+ successful, or an false if not.true if the report was successful, false otherwiseRemoteException - if there was an error performing one of the SOAP callsInterruptedException - if the thread was interruptedpublic URL getDownloadUrl(com.google.api.ads.admanager.axis.v202302.ReportDownloadOptions options) + throws RemoteException, + MalformedURLException+
+ URL url = reportDownloader.getDownloadUrl(options);
+ Resources.asByteSource(url).copyTo(Files.asByteSink(file));
+ options - the options to download the report withRemoteException - if there was an error performing any Axis callMalformedURLException - if there is an error forming the download URLIllegalStateException - if the report is not ready to be downloadedpublic com.google.common.io.CharSource getReportAsCharSource(com.google.api.ads.admanager.axis.v202302.ReportDownloadOptions options) + throws IOException+
ReportDownloadOptions. The ExportFormat
+ must be string-based, such as ExportFormat.CSV_DUMP.options - the options to download the report withIOException - if there was an error performing any I/O action, including any SOAP callsIllegalStateException - if the report is not ready to be downloadedIllegalArgumentException - if the ExportFormat is not a string-based formatCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/StatementBuilder.html new file mode 100644 index 0000000000..50b20e3065 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/StatementBuilder.html @@ -0,0 +1,545 @@ + + + + + + +public final class StatementBuilder +extends Object+
StatementBuilder allows for statements to be constructed in parts.
+
+ Typical usage is: + +
+ StatementBuilder statementBuilder = new StatementBuilder()
+ .where("lastModifiedDateTime > :yesterday AND type = :type")
+ .orderBy("name DESC")
+ .limit(200)
+ .offset(20)
+ .withBindVariableValue("yesterday",
+ DateTimes.fromDate(new org.joda.time.DateTime().minusDays(1).toDate()))
+ .withBindVariableValue("type", "Type")
+
+ Statement statement = statementBuilder.toStatement();
+ //...
+ statementBuilder.increaseOffsetBy(20);
+ statement = statementBuilder.toStatement();
+ | Modifier and Type | +Field and Description | +
|---|---|
static int |
+SUGGESTED_PAGE_LIMIT |
+
| Constructor and Description | +
|---|
StatementBuilder()
+Constructs a statement builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery() |
+
StatementBuilder |
+from(String table) |
+
Map<String,com.google.api.ads.admanager.axis.v202302.Value> |
+getBindVariableMap() |
+
Integer |
+getOffset() |
+
StatementBuilder |
+increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+limit(Integer count) |
+
StatementBuilder |
+offset(Integer count) |
+
StatementBuilder |
+orderBy(String orderBy) |
+
StatementBuilder |
+removeLimitAndOffset() |
+
StatementBuilder |
+select(String columns) |
+
com.google.api.ads.admanager.axis.v202302.Statement |
+toStatement()
+Gets the
+Statement representing the state of this statement builder. |
+
StatementBuilder |
+where(String conditions) |
+
StatementBuilder |
+withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+withBindVariableValue(String key,
+ com.google.api.ads.admanager.axis.v202302.Value value)
+Adds a bind variable value to the statement.
+ |
+
public static final int SUGGESTED_PAGE_LIMIT+
public StatementBuilder()+
@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + Object value)+
Pql.createValue(Object). If the value is of type Value, no conversion will be done.key - the value keyvalue - the bind variable value@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + com.google.api.ads.admanager.axis.v202302.Value value)+
key - the value keyvalue - the bind variable valuepublic com.google.api.ads.admanager.axis.v202302.Statement toStatement()+
Statement representing the state of this statement builder.Statement@CanIgnoreReturnValue +public StatementBuilder select(String columns)+
@CanIgnoreReturnValue +public StatementBuilder from(String table)+
@CanIgnoreReturnValue +public StatementBuilder where(String conditions)+
@CanIgnoreReturnValue +public StatementBuilder limit(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder offset(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder increaseOffsetBy(Integer amount)+
public Integer getOffset()+
@CanIgnoreReturnValue +public StatementBuilder removeLimitAndOffset()+
@CanIgnoreReturnValue +public StatementBuilder orderBy(String orderBy)+
public Map<String,com.google.api.ads.admanager.axis.v202302.Value> getBindVariableMap()+
public String buildQuery()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/DateTimes.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/DateTimes.html new file mode 100644 index 0000000000..4e7350d665 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/DateTimes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/Pql.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/Pql.html new file mode 100644 index 0000000000..6931599bfc --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/Pql.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/ReportDownloader.html new file mode 100644 index 0000000000..f7bdd5db0f --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/ReportDownloader.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/StatementBuilder.html new file mode 100644 index 0000000000..a62ad073ae --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/class-use/StatementBuilder.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis.utils.v202302 | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
StatementBuilder |
+StatementBuilder.from(String table) |
+
StatementBuilder |
+StatementBuilder.increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+StatementBuilder.limit(Integer count) |
+
StatementBuilder |
+StatementBuilder.offset(Integer count) |
+
StatementBuilder |
+StatementBuilder.orderBy(String orderBy) |
+
StatementBuilder |
+StatementBuilder.removeLimitAndOffset() |
+
StatementBuilder |
+StatementBuilder.select(String columns) |
+
StatementBuilder |
+StatementBuilder.where(String conditions) |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ com.google.api.ads.admanager.axis.v202302.Value value)
+Adds a bind variable value to the statement.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/package-frame.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/package-frame.html new file mode 100644 index 0000000000..ca89d89ca2 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| DateTimes | +
+ A utility class for handling
+DateTime objects. |
+
| Pql | +
+ A utility class for handling PQL objects.
+ |
+
| ReportDownloader | +
+ Retrieves reports using a
+ReportServiceInterface. |
+
| StatementBuilder | +
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/package-tree.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/package-tree.html new file mode 100644 index 0000000000..716378c5fe --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/package-tree.html @@ -0,0 +1,142 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/package-use.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/package-use.html new file mode 100644 index 0000000000..046216aa6d --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202302/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis.utils.v202302 | ++ |
| Class and Description | +
|---|
StatementBuilder
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/DateTimes.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/DateTimes.html new file mode 100644 index 0000000000..b5ed994e55 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/DateTimes.html @@ -0,0 +1,477 @@ + + + + + + +public final class DateTimes +extends Object+
DateTime objects.| Modifier and Type | +Method and Description | +
|---|---|
static Calendar |
+toCalendar(com.google.api.ads.admanager.axis.v202305.DateTime dateTime)
+Gets a calendar for a
+DateTime using the default locale, i.e. |
+
static Calendar |
+toCalendar(com.google.api.ads.admanager.axis.v202305.DateTime dateTime,
+ Locale locale)
+Gets a calendar for a
+DateTime in the supplied locale. |
+
static com.google.api.ads.admanager.axis.v202305.DateTime |
+toDateTime(Calendar calendar)
+Converts a
+Calendar object to an API date time preserving the time zone. |
+
static com.google.api.ads.admanager.axis.v202305.DateTime |
+toDateTime(org.joda.time.DateTime dateTime)
+Converts a
+DateTime object to an API date time preserving the time zone. |
+
static org.joda.time.DateTime |
+toDateTime(com.google.api.ads.admanager.axis.v202305.DateTime dateTime)
+Converts an API date time to a
+DateTime preserving the time zone. |
+
static com.google.api.ads.admanager.axis.v202305.DateTime |
+toDateTime(org.joda.time.Instant instant,
+ String timeZoneId)
+Converts an
+Instant object to an API date time in the time zone supplied. |
+
static com.google.api.ads.admanager.axis.v202305.DateTime |
+toDateTime(String dateTime,
+ String timeZoneId)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied. |
+
static com.google.api.ads.admanager.axis.v202305.DateTime |
+toDateTimeWithTimeZone(String dateTime)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied. |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202305.Date date)
+Returns string representation of this date.
+ |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202305.DateTime dateTime)
+Returns string representation of this date time.
+ |
+
static String |
+toStringForTimeZone(com.google.api.ads.admanager.axis.v202305.DateTime dateTime,
+ String newZoneId)
+Returns string representation of this date time with a different time zone, preserving the
+ millisecond instant.
+ |
+
static String |
+toStringWithTimeZone(com.google.api.ads.admanager.axis.v202305.DateTime dateTime)
+Returns string representation of this date time with time zone.
+ |
+
public static com.google.api.ads.admanager.axis.v202305.DateTime toDateTime(Calendar calendar)+
Calendar object to an API date time preserving the time zone.public static com.google.api.ads.admanager.axis.v202305.DateTime toDateTime(org.joda.time.Instant instant, + String timeZoneId)+
Instant object to an API date time in the time zone supplied.public static com.google.api.ads.admanager.axis.v202305.DateTime toDateTime(org.joda.time.DateTime dateTime)+
DateTime object to an API date time preserving the time zone.public static com.google.api.ads.admanager.axis.v202305.DateTime toDateTime(String dateTime, + String timeZoneId)+
yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.public static com.google.api.ads.admanager.axis.v202305.DateTime toDateTimeWithTimeZone(String dateTime)+
yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.public static org.joda.time.DateTime toDateTime(com.google.api.ads.admanager.axis.v202305.DateTime dateTime)+
DateTime preserving the time zone.public static Calendar toCalendar(com.google.api.ads.admanager.axis.v202305.DateTime dateTime)+
DateTime using the default locale, i.e. Locale.getDefault().public static Calendar toCalendar(com.google.api.ads.admanager.axis.v202305.DateTime dateTime, + Locale locale)+
DateTime in the supplied locale.public static String toString(com.google.api.ads.admanager.axis.v202305.Date date)+
date - the date to stringifyDate in yyyy-MM-ddpublic static String toString(com.google.api.ads.admanager.axis.v202305.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:sspublic static String toStringWithTimeZone(com.google.api.ads.admanager.axis.v202305.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm,
+ i.e. 2013-09-013T12:02:03+08:00 or 2013-09-013T12:02:03Z for Etc/GMT.public static String toStringForTimeZone(com.google.api.ads.admanager.axis.v202305.DateTime dateTime, + String newZoneId)+
This method is useful for finding the local time in another time zone, especially for + filtering. + +
For example, if this date time holds 12:30 in Europe/London, the result from this method + with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, + i.e. + +
String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
+ String statementPart =
+ "startDateTime > "
+ + DateTimes.toString(apiDateTime, timeZoneId);
+ //...
+ statementBuilder.where(statementPart);
+ DateTime.withZone(org.joda.time.DateTimeZone).dateTime - the date time to stringify into a new time zonenewZoneId - the time zone ID of the new zoneDateTime in yyyy-MM-dd'T'HH:mm:ssCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/Pql.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/Pql.html new file mode 100644 index 0000000000..30e4d2689d --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/Pql.html @@ -0,0 +1,509 @@ + + + + + + +public final class Pql +extends Object+
+
+ ResultSet combinedResultSet = null
+ do {
+ ResultSet resultSet = pqlService.select(pagedStatement);
+ combinedResultSet = (combinedResultSet == null) ? resultSet :
+ Pql.combineResultSet(combinedResultSet, resultSet);
+ // ...
+ } while(!finishedCollectingResultSets)
+ //...
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ | Modifier and Type | +Method and Description | +
|---|---|
static com.google.api.ads.admanager.axis.v202305.ResultSet |
+combineResultSets(com.google.api.ads.admanager.axis.v202305.ResultSet first,
+ com.google.api.ads.admanager.axis.v202305.ResultSet second)
+Combines the first and second result sets, if and only if, the columns of both result sets
+ match.
+ |
+
static com.google.api.ads.admanager.axis.v202305.Value |
+createValue(Object value)
+Creates a
+Value from the value i.e. |
+
static Object |
+getApiValue(com.google.api.ads.admanager.axis.v202305.Value value)
+Gets the underlying value of the
+Value object that's comparable to what would be
+ returned in any other API object (i.e. |
+
static List<String> |
+getColumnLabels(com.google.api.ads.admanager.axis.v202305.ResultSet resultSet)
+Gets the column labels for the result set.
+ |
+
static Object |
+getCsvValue(com.google.api.ads.admanager.axis.v202305.Value value)
+Gets the underlying value of the
+Value object that should be used for CSV conversion
+ (i.e. |
+
static Object |
+getNativeValue(com.google.api.ads.admanager.axis.v202305.Value value)
+Gets the underlying value of the
+Value object that's considered native to Java (i.e. |
+
static List<String> |
+getRowStringValues(com.google.api.ads.admanager.axis.v202305.Row row)
+Gets the values in a row of the result set in the form of a string list.
+ |
+
static String |
+resultSetToString(com.google.api.ads.admanager.axis.v202305.ResultSet resultSet)
+Gets the result set as a table representation in the form of:
+ |
+
static List<String[]> |
+resultSetToStringArrayList(com.google.api.ads.admanager.axis.v202305.ResultSet resultSet)
+Gets the result set as list of string arrays, which can be transformed to a CSV using
+CsvFiles such as |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202305.Value value)
+Creates a String from the Value.
+ |
+
public static com.google.api.ads.admanager.axis.v202305.Value createValue(Object value)+
Value from the value i.e. a TextValue for a value of type String, BooleanValue for type Boolean, NumberValue for type Double, Long, or Integer, DateTimeValue for type DateTime, and
+ DateValue for type Date. If the value is a Value, the value is
+ returned. If the value is null, an empty TextValue is returned.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static String toString(com.google.api.ads.admanager.axis.v202305.Value value)+
DateTimes.toString(Date) and DateTimes.toStringWithTimeZone(DateTime)
+ respectively.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static Object getApiValue(com.google.api.ads.admanager.axis.v202305.Value value)+
Value object that's comparable to what would be
+ returned in any other API object (i.e. DateTimeValue will return an API DateTime, not a Joda
+ DateTime).value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getNativeValue(com.google.api.ads.admanager.axis.v202305.Value value)+
Value object that's considered native to Java (i.e.
+ DateTimeValue will return a Joda DateTime, not an API DateTime and DateValue will return a
+ string in the form of "yyyy-MM-dd").value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getCsvValue(com.google.api.ads.admanager.axis.v202305.Value value)+
Value object that should be used for CSV conversion
+ (i.e. DateTimeValue will return a String representation, but NumberValue will return a Long or
+ Double).value - the value to convertValue or null if the underlying value is
+ nullIllegalArgumentException - if value cannot be convertedpublic static List<String[]> resultSetToStringArrayList(com.google.api.ads.admanager.axis.v202305.ResultSet resultSet)+
CsvFiles such as
+
+
+
+ ResultSet combinedResultSet = Pql.combineResultSet(resultSet1, resultSet2);
+ //...
+ combinedResultSet = Pql.combineResultSet(combinedResultSet, resultSet3);
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ resultSet - the result set to convert to a CSV compatible formatpublic static String resultSetToString(com.google.api.ads.admanager.axis.v202305.ResultSet resultSet) + throws IllegalAccessException+
+ +-------+-------+-------+ + |column1|column2|column3| + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ +
resultSet - the result set to display as a stringIllegalAccessException - if the values of the result set cannot be accessedpublic static List<String> getColumnLabels(com.google.api.ads.admanager.axis.v202305.ResultSet resultSet)+
resultSet - the result set to get the column labels forpublic static List<String> getRowStringValues(com.google.api.ads.admanager.axis.v202305.Row row)+
row - the row to get the values forpublic static com.google.api.ads.admanager.axis.v202305.ResultSet combineResultSets(com.google.api.ads.admanager.axis.v202305.ResultSet first, + com.google.api.ads.admanager.axis.v202305.ResultSet second)+
IllegalArgumentException - if the columns of the first result set don't match the secondCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/ReportDownloader.html new file mode 100644 index 0000000000..fa4cb66927 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/ReportDownloader.html @@ -0,0 +1,472 @@ + + + + + + +public class ReportDownloader +extends Object+
ReportServiceInterface.
+
+ There are two main functions of this class: + +
OutputStream
+ ReportUtils also provides the method whenReportReady(ReportCallback) to wait
+ for a scheduled report to finish processing before taking an action on the report through the
+ supplied ReportCallback.
| Modifier and Type | +Field and Description | +
|---|---|
static Charset |
+REPORT_CHARSET |
+
static int |
+SLEEP_TIMER
+The time to sleep before each request to the service.
+ |
+
| Constructor and Description | +
|---|
ReportDownloader(com.google.api.ads.admanager.axis.v202305.ReportServiceInterface reportService,
+ long reportJobId)
+Constructs a
+ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on. |
+
| Modifier and Type | +Method and Description | +
|---|---|
URL |
+getDownloadUrl(com.google.api.ads.admanager.axis.v202305.ReportDownloadOptions options)
+Gets the download URL for a GZip or plain-text format report.
+ |
+
com.google.common.io.CharSource |
+getReportAsCharSource(com.google.api.ads.admanager.axis.v202305.ReportDownloadOptions options)
+Returns a CharSource of report contents with
+ReportDownloadOptions. |
+
boolean |
+waitForReportReady()
+Blocks and waits for a report to be ready.
+ |
+
Thread |
+whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
public static final Charset REPORT_CHARSET+
public static final int SLEEP_TIMER+
public ReportDownloader(com.google.api.ads.admanager.axis.v202305.ReportServiceInterface reportService, + long reportJobId)+
ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.reportService - the ReportService stub to make calls toreportJobId - the report job IDpublic Thread whenReportReady(ReportCallback callback)+
ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ callback - the ReportCallback to call when the job has finished, successfully or
+ otherwiseThread.interrupt() can
+ be called on the returned thread to interrupt it.IllegalArgumentException - if callback == nullpublic boolean waitForReportReady() + throws RemoteException, + InterruptedException+
ReportJobStatus is received that is
+ not ReportJobStatus#Pending or ReportJobStatus#InProgress, the report is
+ considered finished, and the method is returned with a true if the report was
+ successful, or an false if not.true if the report was successful, false otherwiseRemoteException - if there was an error performing one of the SOAP callsInterruptedException - if the thread was interruptedpublic URL getDownloadUrl(com.google.api.ads.admanager.axis.v202305.ReportDownloadOptions options) + throws RemoteException, + MalformedURLException+
+ URL url = reportDownloader.getDownloadUrl(options);
+ Resources.asByteSource(url).copyTo(Files.asByteSink(file));
+ options - the options to download the report withRemoteException - if there was an error performing any Axis callMalformedURLException - if there is an error forming the download URLIllegalStateException - if the report is not ready to be downloadedpublic com.google.common.io.CharSource getReportAsCharSource(com.google.api.ads.admanager.axis.v202305.ReportDownloadOptions options) + throws IOException+
ReportDownloadOptions. The ExportFormat
+ must be string-based, such as ExportFormat.CSV_DUMP.options - the options to download the report withIOException - if there was an error performing any I/O action, including any SOAP callsIllegalStateException - if the report is not ready to be downloadedIllegalArgumentException - if the ExportFormat is not a string-based formatCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/StatementBuilder.html new file mode 100644 index 0000000000..865f017213 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/StatementBuilder.html @@ -0,0 +1,545 @@ + + + + + + +public final class StatementBuilder +extends Object+
StatementBuilder allows for statements to be constructed in parts.
+
+ Typical usage is: + +
+ StatementBuilder statementBuilder = new StatementBuilder()
+ .where("lastModifiedDateTime > :yesterday AND type = :type")
+ .orderBy("name DESC")
+ .limit(200)
+ .offset(20)
+ .withBindVariableValue("yesterday",
+ DateTimes.fromDate(new org.joda.time.DateTime().minusDays(1).toDate()))
+ .withBindVariableValue("type", "Type")
+
+ Statement statement = statementBuilder.toStatement();
+ //...
+ statementBuilder.increaseOffsetBy(20);
+ statement = statementBuilder.toStatement();
+ | Modifier and Type | +Field and Description | +
|---|---|
static int |
+SUGGESTED_PAGE_LIMIT |
+
| Constructor and Description | +
|---|
StatementBuilder()
+Constructs a statement builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery() |
+
StatementBuilder |
+from(String table) |
+
Map<String,com.google.api.ads.admanager.axis.v202305.Value> |
+getBindVariableMap() |
+
Integer |
+getOffset() |
+
StatementBuilder |
+increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+limit(Integer count) |
+
StatementBuilder |
+offset(Integer count) |
+
StatementBuilder |
+orderBy(String orderBy) |
+
StatementBuilder |
+removeLimitAndOffset() |
+
StatementBuilder |
+select(String columns) |
+
com.google.api.ads.admanager.axis.v202305.Statement |
+toStatement()
+Gets the
+Statement representing the state of this statement builder. |
+
StatementBuilder |
+where(String conditions) |
+
StatementBuilder |
+withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+withBindVariableValue(String key,
+ com.google.api.ads.admanager.axis.v202305.Value value)
+Adds a bind variable value to the statement.
+ |
+
public static final int SUGGESTED_PAGE_LIMIT+
public StatementBuilder()+
@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + Object value)+
Pql.createValue(Object). If the value is of type Value, no conversion will be done.key - the value keyvalue - the bind variable value@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + com.google.api.ads.admanager.axis.v202305.Value value)+
key - the value keyvalue - the bind variable valuepublic com.google.api.ads.admanager.axis.v202305.Statement toStatement()+
Statement representing the state of this statement builder.Statement@CanIgnoreReturnValue +public StatementBuilder select(String columns)+
@CanIgnoreReturnValue +public StatementBuilder from(String table)+
@CanIgnoreReturnValue +public StatementBuilder where(String conditions)+
@CanIgnoreReturnValue +public StatementBuilder limit(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder offset(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder increaseOffsetBy(Integer amount)+
public Integer getOffset()+
@CanIgnoreReturnValue +public StatementBuilder removeLimitAndOffset()+
@CanIgnoreReturnValue +public StatementBuilder orderBy(String orderBy)+
public Map<String,com.google.api.ads.admanager.axis.v202305.Value> getBindVariableMap()+
public String buildQuery()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/DateTimes.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/DateTimes.html new file mode 100644 index 0000000000..e03240f628 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/DateTimes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/Pql.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/Pql.html new file mode 100644 index 0000000000..0e422f8d5b --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/Pql.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/ReportDownloader.html new file mode 100644 index 0000000000..d2e89ff7f6 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/ReportDownloader.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/StatementBuilder.html new file mode 100644 index 0000000000..f77f009f25 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/class-use/StatementBuilder.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis.utils.v202305 | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
StatementBuilder |
+StatementBuilder.from(String table) |
+
StatementBuilder |
+StatementBuilder.increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+StatementBuilder.limit(Integer count) |
+
StatementBuilder |
+StatementBuilder.offset(Integer count) |
+
StatementBuilder |
+StatementBuilder.orderBy(String orderBy) |
+
StatementBuilder |
+StatementBuilder.removeLimitAndOffset() |
+
StatementBuilder |
+StatementBuilder.select(String columns) |
+
StatementBuilder |
+StatementBuilder.where(String conditions) |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ com.google.api.ads.admanager.axis.v202305.Value value)
+Adds a bind variable value to the statement.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/package-frame.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/package-frame.html new file mode 100644 index 0000000000..15703ed441 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| DateTimes | +
+ A utility class for handling
+DateTime objects. |
+
| Pql | +
+ A utility class for handling PQL objects.
+ |
+
| ReportDownloader | +
+ Retrieves reports using a
+ReportServiceInterface. |
+
| StatementBuilder | +
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/package-tree.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/package-tree.html new file mode 100644 index 0000000000..24d9a93f4f --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/package-tree.html @@ -0,0 +1,142 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/package-use.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/package-use.html new file mode 100644 index 0000000000..5311daa152 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202305/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis.utils.v202305 | ++ |
| Class and Description | +
|---|
StatementBuilder
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/DateTimes.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/DateTimes.html new file mode 100644 index 0000000000..3bc16df234 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/DateTimes.html @@ -0,0 +1,477 @@ + + + + + + +public final class DateTimes +extends Object+
DateTime objects.| Modifier and Type | +Method and Description | +
|---|---|
static Calendar |
+toCalendar(com.google.api.ads.admanager.axis.v202308.DateTime dateTime)
+Gets a calendar for a
+DateTime using the default locale, i.e. |
+
static Calendar |
+toCalendar(com.google.api.ads.admanager.axis.v202308.DateTime dateTime,
+ Locale locale)
+Gets a calendar for a
+DateTime in the supplied locale. |
+
static com.google.api.ads.admanager.axis.v202308.DateTime |
+toDateTime(Calendar calendar)
+Converts a
+Calendar object to an API date time preserving the time zone. |
+
static com.google.api.ads.admanager.axis.v202308.DateTime |
+toDateTime(org.joda.time.DateTime dateTime)
+Converts a
+DateTime object to an API date time preserving the time zone. |
+
static org.joda.time.DateTime |
+toDateTime(com.google.api.ads.admanager.axis.v202308.DateTime dateTime)
+Converts an API date time to a
+DateTime preserving the time zone. |
+
static com.google.api.ads.admanager.axis.v202308.DateTime |
+toDateTime(org.joda.time.Instant instant,
+ String timeZoneId)
+Converts an
+Instant object to an API date time in the time zone supplied. |
+
static com.google.api.ads.admanager.axis.v202308.DateTime |
+toDateTime(String dateTime,
+ String timeZoneId)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied. |
+
static com.google.api.ads.admanager.axis.v202308.DateTime |
+toDateTimeWithTimeZone(String dateTime)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied. |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202308.Date date)
+Returns string representation of this date.
+ |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202308.DateTime dateTime)
+Returns string representation of this date time.
+ |
+
static String |
+toStringForTimeZone(com.google.api.ads.admanager.axis.v202308.DateTime dateTime,
+ String newZoneId)
+Returns string representation of this date time with a different time zone, preserving the
+ millisecond instant.
+ |
+
static String |
+toStringWithTimeZone(com.google.api.ads.admanager.axis.v202308.DateTime dateTime)
+Returns string representation of this date time with time zone.
+ |
+
public static com.google.api.ads.admanager.axis.v202308.DateTime toDateTime(Calendar calendar)+
Calendar object to an API date time preserving the time zone.public static com.google.api.ads.admanager.axis.v202308.DateTime toDateTime(org.joda.time.Instant instant, + String timeZoneId)+
Instant object to an API date time in the time zone supplied.public static com.google.api.ads.admanager.axis.v202308.DateTime toDateTime(org.joda.time.DateTime dateTime)+
DateTime object to an API date time preserving the time zone.public static com.google.api.ads.admanager.axis.v202308.DateTime toDateTime(String dateTime, + String timeZoneId)+
yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.public static com.google.api.ads.admanager.axis.v202308.DateTime toDateTimeWithTimeZone(String dateTime)+
yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.public static org.joda.time.DateTime toDateTime(com.google.api.ads.admanager.axis.v202308.DateTime dateTime)+
DateTime preserving the time zone.public static Calendar toCalendar(com.google.api.ads.admanager.axis.v202308.DateTime dateTime)+
DateTime using the default locale, i.e. Locale.getDefault().public static Calendar toCalendar(com.google.api.ads.admanager.axis.v202308.DateTime dateTime, + Locale locale)+
DateTime in the supplied locale.public static String toString(com.google.api.ads.admanager.axis.v202308.Date date)+
date - the date to stringifyDate in yyyy-MM-ddpublic static String toString(com.google.api.ads.admanager.axis.v202308.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:sspublic static String toStringWithTimeZone(com.google.api.ads.admanager.axis.v202308.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm,
+ i.e. 2013-09-013T12:02:03+08:00 or 2013-09-013T12:02:03Z for Etc/GMT.public static String toStringForTimeZone(com.google.api.ads.admanager.axis.v202308.DateTime dateTime, + String newZoneId)+
This method is useful for finding the local time in another time zone, especially for + filtering. + +
For example, if this date time holds 12:30 in Europe/London, the result from this method + with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, + i.e. + +
String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
+ String statementPart =
+ "startDateTime > "
+ + DateTimes.toString(apiDateTime, timeZoneId);
+ //...
+ statementBuilder.where(statementPart);
+ DateTime.withZone(org.joda.time.DateTimeZone).dateTime - the date time to stringify into a new time zonenewZoneId - the time zone ID of the new zoneDateTime in yyyy-MM-dd'T'HH:mm:ssCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/Pql.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/Pql.html new file mode 100644 index 0000000000..4d5bd272ce --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/Pql.html @@ -0,0 +1,509 @@ + + + + + + +public final class Pql +extends Object+
+
+ ResultSet combinedResultSet = null
+ do {
+ ResultSet resultSet = pqlService.select(pagedStatement);
+ combinedResultSet = (combinedResultSet == null) ? resultSet :
+ Pql.combineResultSet(combinedResultSet, resultSet);
+ // ...
+ } while(!finishedCollectingResultSets)
+ //...
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ | Modifier and Type | +Method and Description | +
|---|---|
static com.google.api.ads.admanager.axis.v202308.ResultSet |
+combineResultSets(com.google.api.ads.admanager.axis.v202308.ResultSet first,
+ com.google.api.ads.admanager.axis.v202308.ResultSet second)
+Combines the first and second result sets, if and only if, the columns of both result sets
+ match.
+ |
+
static com.google.api.ads.admanager.axis.v202308.Value |
+createValue(Object value)
+Creates a
+Value from the value i.e. |
+
static Object |
+getApiValue(com.google.api.ads.admanager.axis.v202308.Value value)
+Gets the underlying value of the
+Value object that's comparable to what would be
+ returned in any other API object (i.e. |
+
static List<String> |
+getColumnLabels(com.google.api.ads.admanager.axis.v202308.ResultSet resultSet)
+Gets the column labels for the result set.
+ |
+
static Object |
+getCsvValue(com.google.api.ads.admanager.axis.v202308.Value value)
+Gets the underlying value of the
+Value object that should be used for CSV conversion
+ (i.e. |
+
static Object |
+getNativeValue(com.google.api.ads.admanager.axis.v202308.Value value)
+Gets the underlying value of the
+Value object that's considered native to Java (i.e. |
+
static List<String> |
+getRowStringValues(com.google.api.ads.admanager.axis.v202308.Row row)
+Gets the values in a row of the result set in the form of a string list.
+ |
+
static String |
+resultSetToString(com.google.api.ads.admanager.axis.v202308.ResultSet resultSet)
+Gets the result set as a table representation in the form of:
+ |
+
static List<String[]> |
+resultSetToStringArrayList(com.google.api.ads.admanager.axis.v202308.ResultSet resultSet)
+Gets the result set as list of string arrays, which can be transformed to a CSV using
+CsvFiles such as |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202308.Value value)
+Creates a String from the Value.
+ |
+
public static com.google.api.ads.admanager.axis.v202308.Value createValue(Object value)+
Value from the value i.e. a TextValue for a value of type String, BooleanValue for type Boolean, NumberValue for type Double, Long, or Integer, DateTimeValue for type DateTime, and
+ DateValue for type Date. If the value is a Value, the value is
+ returned. If the value is null, an empty TextValue is returned.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static String toString(com.google.api.ads.admanager.axis.v202308.Value value)+
DateTimes.toString(Date) and DateTimes.toStringWithTimeZone(DateTime)
+ respectively.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static Object getApiValue(com.google.api.ads.admanager.axis.v202308.Value value)+
Value object that's comparable to what would be
+ returned in any other API object (i.e. DateTimeValue will return an API DateTime, not a Joda
+ DateTime).value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getNativeValue(com.google.api.ads.admanager.axis.v202308.Value value)+
Value object that's considered native to Java (i.e.
+ DateTimeValue will return a Joda DateTime, not an API DateTime and DateValue will return a
+ string in the form of "yyyy-MM-dd").value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getCsvValue(com.google.api.ads.admanager.axis.v202308.Value value)+
Value object that should be used for CSV conversion
+ (i.e. DateTimeValue will return a String representation, but NumberValue will return a Long or
+ Double).value - the value to convertValue or null if the underlying value is
+ nullIllegalArgumentException - if value cannot be convertedpublic static List<String[]> resultSetToStringArrayList(com.google.api.ads.admanager.axis.v202308.ResultSet resultSet)+
CsvFiles such as
+
+
+
+ ResultSet combinedResultSet = Pql.combineResultSet(resultSet1, resultSet2);
+ //...
+ combinedResultSet = Pql.combineResultSet(combinedResultSet, resultSet3);
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ resultSet - the result set to convert to a CSV compatible formatpublic static String resultSetToString(com.google.api.ads.admanager.axis.v202308.ResultSet resultSet) + throws IllegalAccessException+
+ +-------+-------+-------+ + |column1|column2|column3| + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ +
resultSet - the result set to display as a stringIllegalAccessException - if the values of the result set cannot be accessedpublic static List<String> getColumnLabels(com.google.api.ads.admanager.axis.v202308.ResultSet resultSet)+
resultSet - the result set to get the column labels forpublic static List<String> getRowStringValues(com.google.api.ads.admanager.axis.v202308.Row row)+
row - the row to get the values forpublic static com.google.api.ads.admanager.axis.v202308.ResultSet combineResultSets(com.google.api.ads.admanager.axis.v202308.ResultSet first, + com.google.api.ads.admanager.axis.v202308.ResultSet second)+
IllegalArgumentException - if the columns of the first result set don't match the secondCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/ReportDownloader.html new file mode 100644 index 0000000000..470035a3bf --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/ReportDownloader.html @@ -0,0 +1,472 @@ + + + + + + +public class ReportDownloader +extends Object+
ReportServiceInterface.
+
+ There are two main functions of this class: + +
OutputStream
+ ReportUtils also provides the method whenReportReady(ReportCallback) to wait
+ for a scheduled report to finish processing before taking an action on the report through the
+ supplied ReportCallback.
| Modifier and Type | +Field and Description | +
|---|---|
static Charset |
+REPORT_CHARSET |
+
static int |
+SLEEP_TIMER
+The time to sleep before each request to the service.
+ |
+
| Constructor and Description | +
|---|
ReportDownloader(com.google.api.ads.admanager.axis.v202308.ReportServiceInterface reportService,
+ long reportJobId)
+Constructs a
+ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on. |
+
| Modifier and Type | +Method and Description | +
|---|---|
URL |
+getDownloadUrl(com.google.api.ads.admanager.axis.v202308.ReportDownloadOptions options)
+Gets the download URL for a GZip or plain-text format report.
+ |
+
com.google.common.io.CharSource |
+getReportAsCharSource(com.google.api.ads.admanager.axis.v202308.ReportDownloadOptions options)
+Returns a CharSource of report contents with
+ReportDownloadOptions. |
+
boolean |
+waitForReportReady()
+Blocks and waits for a report to be ready.
+ |
+
Thread |
+whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
public static final Charset REPORT_CHARSET+
public static final int SLEEP_TIMER+
public ReportDownloader(com.google.api.ads.admanager.axis.v202308.ReportServiceInterface reportService, + long reportJobId)+
ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.reportService - the ReportService stub to make calls toreportJobId - the report job IDpublic Thread whenReportReady(ReportCallback callback)+
ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ callback - the ReportCallback to call when the job has finished, successfully or
+ otherwiseThread.interrupt() can
+ be called on the returned thread to interrupt it.IllegalArgumentException - if callback == nullpublic boolean waitForReportReady() + throws RemoteException, + InterruptedException+
ReportJobStatus is received that is
+ not ReportJobStatus#Pending or ReportJobStatus#InProgress, the report is
+ considered finished, and the method is returned with a true if the report was
+ successful, or an false if not.true if the report was successful, false otherwiseRemoteException - if there was an error performing one of the SOAP callsInterruptedException - if the thread was interruptedpublic URL getDownloadUrl(com.google.api.ads.admanager.axis.v202308.ReportDownloadOptions options) + throws RemoteException, + MalformedURLException+
+ URL url = reportDownloader.getDownloadUrl(options);
+ Resources.asByteSource(url).copyTo(Files.asByteSink(file));
+ options - the options to download the report withRemoteException - if there was an error performing any Axis callMalformedURLException - if there is an error forming the download URLIllegalStateException - if the report is not ready to be downloadedpublic com.google.common.io.CharSource getReportAsCharSource(com.google.api.ads.admanager.axis.v202308.ReportDownloadOptions options) + throws IOException+
ReportDownloadOptions. The ExportFormat
+ must be string-based, such as ExportFormat.CSV_DUMP.options - the options to download the report withIOException - if there was an error performing any I/O action, including any SOAP callsIllegalStateException - if the report is not ready to be downloadedIllegalArgumentException - if the ExportFormat is not a string-based formatCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/StatementBuilder.html new file mode 100644 index 0000000000..f3ab119a3a --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/StatementBuilder.html @@ -0,0 +1,545 @@ + + + + + + +public final class StatementBuilder +extends Object+
StatementBuilder allows for statements to be constructed in parts.
+
+ Typical usage is: + +
+ StatementBuilder statementBuilder = new StatementBuilder()
+ .where("lastModifiedDateTime > :yesterday AND type = :type")
+ .orderBy("name DESC")
+ .limit(200)
+ .offset(20)
+ .withBindVariableValue("yesterday",
+ DateTimes.fromDate(new org.joda.time.DateTime().minusDays(1).toDate()))
+ .withBindVariableValue("type", "Type")
+
+ Statement statement = statementBuilder.toStatement();
+ //...
+ statementBuilder.increaseOffsetBy(20);
+ statement = statementBuilder.toStatement();
+ | Modifier and Type | +Field and Description | +
|---|---|
static int |
+SUGGESTED_PAGE_LIMIT |
+
| Constructor and Description | +
|---|
StatementBuilder()
+Constructs a statement builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery() |
+
StatementBuilder |
+from(String table) |
+
Map<String,com.google.api.ads.admanager.axis.v202308.Value> |
+getBindVariableMap() |
+
Integer |
+getOffset() |
+
StatementBuilder |
+increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+limit(Integer count) |
+
StatementBuilder |
+offset(Integer count) |
+
StatementBuilder |
+orderBy(String orderBy) |
+
StatementBuilder |
+removeLimitAndOffset() |
+
StatementBuilder |
+select(String columns) |
+
com.google.api.ads.admanager.axis.v202308.Statement |
+toStatement()
+Gets the
+Statement representing the state of this statement builder. |
+
StatementBuilder |
+where(String conditions) |
+
StatementBuilder |
+withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+withBindVariableValue(String key,
+ com.google.api.ads.admanager.axis.v202308.Value value)
+Adds a bind variable value to the statement.
+ |
+
public static final int SUGGESTED_PAGE_LIMIT+
public StatementBuilder()+
@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + Object value)+
Pql.createValue(Object). If the value is of type Value, no conversion will be done.key - the value keyvalue - the bind variable value@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + com.google.api.ads.admanager.axis.v202308.Value value)+
key - the value keyvalue - the bind variable valuepublic com.google.api.ads.admanager.axis.v202308.Statement toStatement()+
Statement representing the state of this statement builder.Statement@CanIgnoreReturnValue +public StatementBuilder select(String columns)+
@CanIgnoreReturnValue +public StatementBuilder from(String table)+
@CanIgnoreReturnValue +public StatementBuilder where(String conditions)+
@CanIgnoreReturnValue +public StatementBuilder limit(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder offset(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder increaseOffsetBy(Integer amount)+
public Integer getOffset()+
@CanIgnoreReturnValue +public StatementBuilder removeLimitAndOffset()+
@CanIgnoreReturnValue +public StatementBuilder orderBy(String orderBy)+
public Map<String,com.google.api.ads.admanager.axis.v202308.Value> getBindVariableMap()+
public String buildQuery()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/DateTimes.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/DateTimes.html new file mode 100644 index 0000000000..4f9255d9bc --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/DateTimes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/Pql.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/Pql.html new file mode 100644 index 0000000000..f6032919b9 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/Pql.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/ReportDownloader.html new file mode 100644 index 0000000000..f6f7e97202 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/ReportDownloader.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/StatementBuilder.html new file mode 100644 index 0000000000..4b46747da1 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/class-use/StatementBuilder.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis.utils.v202308 | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
StatementBuilder |
+StatementBuilder.from(String table) |
+
StatementBuilder |
+StatementBuilder.increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+StatementBuilder.limit(Integer count) |
+
StatementBuilder |
+StatementBuilder.offset(Integer count) |
+
StatementBuilder |
+StatementBuilder.orderBy(String orderBy) |
+
StatementBuilder |
+StatementBuilder.removeLimitAndOffset() |
+
StatementBuilder |
+StatementBuilder.select(String columns) |
+
StatementBuilder |
+StatementBuilder.where(String conditions) |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ com.google.api.ads.admanager.axis.v202308.Value value)
+Adds a bind variable value to the statement.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/package-frame.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/package-frame.html new file mode 100644 index 0000000000..5e8a996d8b --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| DateTimes | +
+ A utility class for handling
+DateTime objects. |
+
| Pql | +
+ A utility class for handling PQL objects.
+ |
+
| ReportDownloader | +
+ Retrieves reports using a
+ReportServiceInterface. |
+
| StatementBuilder | +
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/package-tree.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/package-tree.html new file mode 100644 index 0000000000..27566c7597 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/package-tree.html @@ -0,0 +1,142 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/package-use.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/package-use.html new file mode 100644 index 0000000000..bc4c90d368 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202308/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis.utils.v202308 | ++ |
| Class and Description | +
|---|
StatementBuilder
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/DateTimes.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/DateTimes.html new file mode 100644 index 0000000000..a33c0a152b --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/DateTimes.html @@ -0,0 +1,477 @@ + + + + + + +public final class DateTimes +extends Object+
DateTime objects.| Modifier and Type | +Method and Description | +
|---|---|
static Calendar |
+toCalendar(com.google.api.ads.admanager.axis.v202311.DateTime dateTime)
+Gets a calendar for a
+DateTime using the default locale, i.e. |
+
static Calendar |
+toCalendar(com.google.api.ads.admanager.axis.v202311.DateTime dateTime,
+ Locale locale)
+Gets a calendar for a
+DateTime in the supplied locale. |
+
static com.google.api.ads.admanager.axis.v202311.DateTime |
+toDateTime(Calendar calendar)
+Converts a
+Calendar object to an API date time preserving the time zone. |
+
static com.google.api.ads.admanager.axis.v202311.DateTime |
+toDateTime(org.joda.time.DateTime dateTime)
+Converts a
+DateTime object to an API date time preserving the time zone. |
+
static org.joda.time.DateTime |
+toDateTime(com.google.api.ads.admanager.axis.v202311.DateTime dateTime)
+Converts an API date time to a
+DateTime preserving the time zone. |
+
static com.google.api.ads.admanager.axis.v202311.DateTime |
+toDateTime(org.joda.time.Instant instant,
+ String timeZoneId)
+Converts an
+Instant object to an API date time in the time zone supplied. |
+
static com.google.api.ads.admanager.axis.v202311.DateTime |
+toDateTime(String dateTime,
+ String timeZoneId)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied. |
+
static com.google.api.ads.admanager.axis.v202311.DateTime |
+toDateTimeWithTimeZone(String dateTime)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied. |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202311.Date date)
+Returns string representation of this date.
+ |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202311.DateTime dateTime)
+Returns string representation of this date time.
+ |
+
static String |
+toStringForTimeZone(com.google.api.ads.admanager.axis.v202311.DateTime dateTime,
+ String newZoneId)
+Returns string representation of this date time with a different time zone, preserving the
+ millisecond instant.
+ |
+
static String |
+toStringWithTimeZone(com.google.api.ads.admanager.axis.v202311.DateTime dateTime)
+Returns string representation of this date time with time zone.
+ |
+
public static com.google.api.ads.admanager.axis.v202311.DateTime toDateTime(Calendar calendar)+
Calendar object to an API date time preserving the time zone.public static com.google.api.ads.admanager.axis.v202311.DateTime toDateTime(org.joda.time.Instant instant, + String timeZoneId)+
Instant object to an API date time in the time zone supplied.public static com.google.api.ads.admanager.axis.v202311.DateTime toDateTime(org.joda.time.DateTime dateTime)+
DateTime object to an API date time preserving the time zone.public static com.google.api.ads.admanager.axis.v202311.DateTime toDateTime(String dateTime, + String timeZoneId)+
yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.public static com.google.api.ads.admanager.axis.v202311.DateTime toDateTimeWithTimeZone(String dateTime)+
yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.public static org.joda.time.DateTime toDateTime(com.google.api.ads.admanager.axis.v202311.DateTime dateTime)+
DateTime preserving the time zone.public static Calendar toCalendar(com.google.api.ads.admanager.axis.v202311.DateTime dateTime)+
DateTime using the default locale, i.e. Locale.getDefault().public static Calendar toCalendar(com.google.api.ads.admanager.axis.v202311.DateTime dateTime, + Locale locale)+
DateTime in the supplied locale.public static String toString(com.google.api.ads.admanager.axis.v202311.Date date)+
date - the date to stringifyDate in yyyy-MM-ddpublic static String toString(com.google.api.ads.admanager.axis.v202311.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:sspublic static String toStringWithTimeZone(com.google.api.ads.admanager.axis.v202311.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm,
+ i.e. 2013-09-013T12:02:03+08:00 or 2013-09-013T12:02:03Z for Etc/GMT.public static String toStringForTimeZone(com.google.api.ads.admanager.axis.v202311.DateTime dateTime, + String newZoneId)+
This method is useful for finding the local time in another time zone, especially for + filtering. + +
For example, if this date time holds 12:30 in Europe/London, the result from this method + with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, + i.e. + +
String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
+ String statementPart =
+ "startDateTime > "
+ + DateTimes.toString(apiDateTime, timeZoneId);
+ //...
+ statementBuilder.where(statementPart);
+ DateTime.withZone(org.joda.time.DateTimeZone).dateTime - the date time to stringify into a new time zonenewZoneId - the time zone ID of the new zoneDateTime in yyyy-MM-dd'T'HH:mm:ssCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/Pql.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/Pql.html new file mode 100644 index 0000000000..ea8f719962 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/Pql.html @@ -0,0 +1,509 @@ + + + + + + +public final class Pql +extends Object+
+
+ ResultSet combinedResultSet = null
+ do {
+ ResultSet resultSet = pqlService.select(pagedStatement);
+ combinedResultSet = (combinedResultSet == null) ? resultSet :
+ Pql.combineResultSet(combinedResultSet, resultSet);
+ // ...
+ } while(!finishedCollectingResultSets)
+ //...
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ | Modifier and Type | +Method and Description | +
|---|---|
static com.google.api.ads.admanager.axis.v202311.ResultSet |
+combineResultSets(com.google.api.ads.admanager.axis.v202311.ResultSet first,
+ com.google.api.ads.admanager.axis.v202311.ResultSet second)
+Combines the first and second result sets, if and only if, the columns of both result sets
+ match.
+ |
+
static com.google.api.ads.admanager.axis.v202311.Value |
+createValue(Object value)
+Creates a
+Value from the value i.e. |
+
static Object |
+getApiValue(com.google.api.ads.admanager.axis.v202311.Value value)
+Gets the underlying value of the
+Value object that's comparable to what would be
+ returned in any other API object (i.e. |
+
static List<String> |
+getColumnLabels(com.google.api.ads.admanager.axis.v202311.ResultSet resultSet)
+Gets the column labels for the result set.
+ |
+
static Object |
+getCsvValue(com.google.api.ads.admanager.axis.v202311.Value value)
+Gets the underlying value of the
+Value object that should be used for CSV conversion
+ (i.e. |
+
static Object |
+getNativeValue(com.google.api.ads.admanager.axis.v202311.Value value)
+Gets the underlying value of the
+Value object that's considered native to Java (i.e. |
+
static List<String> |
+getRowStringValues(com.google.api.ads.admanager.axis.v202311.Row row)
+Gets the values in a row of the result set in the form of a string list.
+ |
+
static String |
+resultSetToString(com.google.api.ads.admanager.axis.v202311.ResultSet resultSet)
+Gets the result set as a table representation in the form of:
+ |
+
static List<String[]> |
+resultSetToStringArrayList(com.google.api.ads.admanager.axis.v202311.ResultSet resultSet)
+Gets the result set as list of string arrays, which can be transformed to a CSV using
+CsvFiles such as |
+
static String |
+toString(com.google.api.ads.admanager.axis.v202311.Value value)
+Creates a String from the Value.
+ |
+
public static com.google.api.ads.admanager.axis.v202311.Value createValue(Object value)+
Value from the value i.e. a TextValue for a value of type String, BooleanValue for type Boolean, NumberValue for type Double, Long, or Integer, DateTimeValue for type DateTime, and
+ DateValue for type Date. If the value is a Value, the value is
+ returned. If the value is null, an empty TextValue is returned.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static String toString(com.google.api.ads.admanager.axis.v202311.Value value)+
DateTimes.toString(Date) and DateTimes.toStringWithTimeZone(DateTime)
+ respectively.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static Object getApiValue(com.google.api.ads.admanager.axis.v202311.Value value)+
Value object that's comparable to what would be
+ returned in any other API object (i.e. DateTimeValue will return an API DateTime, not a Joda
+ DateTime).value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getNativeValue(com.google.api.ads.admanager.axis.v202311.Value value)+
Value object that's considered native to Java (i.e.
+ DateTimeValue will return a Joda DateTime, not an API DateTime and DateValue will return a
+ string in the form of "yyyy-MM-dd").value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getCsvValue(com.google.api.ads.admanager.axis.v202311.Value value)+
Value object that should be used for CSV conversion
+ (i.e. DateTimeValue will return a String representation, but NumberValue will return a Long or
+ Double).value - the value to convertValue or null if the underlying value is
+ nullIllegalArgumentException - if value cannot be convertedpublic static List<String[]> resultSetToStringArrayList(com.google.api.ads.admanager.axis.v202311.ResultSet resultSet)+
CsvFiles such as
+
+
+
+ ResultSet combinedResultSet = Pql.combineResultSet(resultSet1, resultSet2);
+ //...
+ combinedResultSet = Pql.combineResultSet(combinedResultSet, resultSet3);
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ resultSet - the result set to convert to a CSV compatible formatpublic static String resultSetToString(com.google.api.ads.admanager.axis.v202311.ResultSet resultSet) + throws IllegalAccessException+
+ +-------+-------+-------+ + |column1|column2|column3| + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ +
resultSet - the result set to display as a stringIllegalAccessException - if the values of the result set cannot be accessedpublic static List<String> getColumnLabels(com.google.api.ads.admanager.axis.v202311.ResultSet resultSet)+
resultSet - the result set to get the column labels forpublic static List<String> getRowStringValues(com.google.api.ads.admanager.axis.v202311.Row row)+
row - the row to get the values forpublic static com.google.api.ads.admanager.axis.v202311.ResultSet combineResultSets(com.google.api.ads.admanager.axis.v202311.ResultSet first, + com.google.api.ads.admanager.axis.v202311.ResultSet second)+
IllegalArgumentException - if the columns of the first result set don't match the secondCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/ReportDownloader.html new file mode 100644 index 0000000000..311ce486d7 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/ReportDownloader.html @@ -0,0 +1,472 @@ + + + + + + +public class ReportDownloader +extends Object+
ReportServiceInterface.
+
+ There are two main functions of this class: + +
OutputStream
+ ReportUtils also provides the method whenReportReady(ReportCallback) to wait
+ for a scheduled report to finish processing before taking an action on the report through the
+ supplied ReportCallback.
| Modifier and Type | +Field and Description | +
|---|---|
static Charset |
+REPORT_CHARSET |
+
static int |
+SLEEP_TIMER
+The time to sleep before each request to the service.
+ |
+
| Constructor and Description | +
|---|
ReportDownloader(com.google.api.ads.admanager.axis.v202311.ReportServiceInterface reportService,
+ long reportJobId)
+Constructs a
+ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on. |
+
| Modifier and Type | +Method and Description | +
|---|---|
URL |
+getDownloadUrl(com.google.api.ads.admanager.axis.v202311.ReportDownloadOptions options)
+Gets the download URL for a GZip or plain-text format report.
+ |
+
com.google.common.io.CharSource |
+getReportAsCharSource(com.google.api.ads.admanager.axis.v202311.ReportDownloadOptions options)
+Returns a CharSource of report contents with
+ReportDownloadOptions. |
+
boolean |
+waitForReportReady()
+Blocks and waits for a report to be ready.
+ |
+
Thread |
+whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
public static final Charset REPORT_CHARSET+
public static final int SLEEP_TIMER+
public ReportDownloader(com.google.api.ads.admanager.axis.v202311.ReportServiceInterface reportService, + long reportJobId)+
ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.reportService - the ReportService stub to make calls toreportJobId - the report job IDpublic Thread whenReportReady(ReportCallback callback)+
ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ callback - the ReportCallback to call when the job has finished, successfully or
+ otherwiseThread.interrupt() can
+ be called on the returned thread to interrupt it.IllegalArgumentException - if callback == nullpublic boolean waitForReportReady() + throws RemoteException, + InterruptedException+
ReportJobStatus is received that is
+ not ReportJobStatus#Pending or ReportJobStatus#InProgress, the report is
+ considered finished, and the method is returned with a true if the report was
+ successful, or an false if not.true if the report was successful, false otherwiseRemoteException - if there was an error performing one of the SOAP callsInterruptedException - if the thread was interruptedpublic URL getDownloadUrl(com.google.api.ads.admanager.axis.v202311.ReportDownloadOptions options) + throws RemoteException, + MalformedURLException+
+ URL url = reportDownloader.getDownloadUrl(options);
+ Resources.asByteSource(url).copyTo(Files.asByteSink(file));
+ options - the options to download the report withRemoteException - if there was an error performing any Axis callMalformedURLException - if there is an error forming the download URLIllegalStateException - if the report is not ready to be downloadedpublic com.google.common.io.CharSource getReportAsCharSource(com.google.api.ads.admanager.axis.v202311.ReportDownloadOptions options) + throws IOException+
ReportDownloadOptions. The ExportFormat
+ must be string-based, such as ExportFormat.CSV_DUMP.options - the options to download the report withIOException - if there was an error performing any I/O action, including any SOAP callsIllegalStateException - if the report is not ready to be downloadedIllegalArgumentException - if the ExportFormat is not a string-based formatCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/StatementBuilder.html new file mode 100644 index 0000000000..3e22203c72 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/StatementBuilder.html @@ -0,0 +1,545 @@ + + + + + + +public final class StatementBuilder +extends Object+
StatementBuilder allows for statements to be constructed in parts.
+
+ Typical usage is: + +
+ StatementBuilder statementBuilder = new StatementBuilder()
+ .where("lastModifiedDateTime > :yesterday AND type = :type")
+ .orderBy("name DESC")
+ .limit(200)
+ .offset(20)
+ .withBindVariableValue("yesterday",
+ DateTimes.fromDate(new org.joda.time.DateTime().minusDays(1).toDate()))
+ .withBindVariableValue("type", "Type")
+
+ Statement statement = statementBuilder.toStatement();
+ //...
+ statementBuilder.increaseOffsetBy(20);
+ statement = statementBuilder.toStatement();
+ | Modifier and Type | +Field and Description | +
|---|---|
static int |
+SUGGESTED_PAGE_LIMIT |
+
| Constructor and Description | +
|---|
StatementBuilder()
+Constructs a statement builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery() |
+
StatementBuilder |
+from(String table) |
+
Map<String,com.google.api.ads.admanager.axis.v202311.Value> |
+getBindVariableMap() |
+
Integer |
+getOffset() |
+
StatementBuilder |
+increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+limit(Integer count) |
+
StatementBuilder |
+offset(Integer count) |
+
StatementBuilder |
+orderBy(String orderBy) |
+
StatementBuilder |
+removeLimitAndOffset() |
+
StatementBuilder |
+select(String columns) |
+
com.google.api.ads.admanager.axis.v202311.Statement |
+toStatement()
+Gets the
+Statement representing the state of this statement builder. |
+
StatementBuilder |
+where(String conditions) |
+
StatementBuilder |
+withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+withBindVariableValue(String key,
+ com.google.api.ads.admanager.axis.v202311.Value value)
+Adds a bind variable value to the statement.
+ |
+
public static final int SUGGESTED_PAGE_LIMIT+
public StatementBuilder()+
@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + Object value)+
Pql.createValue(Object). If the value is of type Value, no conversion will be done.key - the value keyvalue - the bind variable value@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + com.google.api.ads.admanager.axis.v202311.Value value)+
key - the value keyvalue - the bind variable valuepublic com.google.api.ads.admanager.axis.v202311.Statement toStatement()+
Statement representing the state of this statement builder.Statement@CanIgnoreReturnValue +public StatementBuilder select(String columns)+
@CanIgnoreReturnValue +public StatementBuilder from(String table)+
@CanIgnoreReturnValue +public StatementBuilder where(String conditions)+
@CanIgnoreReturnValue +public StatementBuilder limit(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder offset(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder increaseOffsetBy(Integer amount)+
public Integer getOffset()+
@CanIgnoreReturnValue +public StatementBuilder removeLimitAndOffset()+
@CanIgnoreReturnValue +public StatementBuilder orderBy(String orderBy)+
public Map<String,com.google.api.ads.admanager.axis.v202311.Value> getBindVariableMap()+
public String buildQuery()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/DateTimes.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/DateTimes.html new file mode 100644 index 0000000000..4c650e0218 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/DateTimes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/Pql.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/Pql.html new file mode 100644 index 0000000000..3607566c3a --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/Pql.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/ReportDownloader.html new file mode 100644 index 0000000000..43904743bd --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/ReportDownloader.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/StatementBuilder.html new file mode 100644 index 0000000000..aa80af22fe --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/class-use/StatementBuilder.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis.utils.v202311 | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
StatementBuilder |
+StatementBuilder.from(String table) |
+
StatementBuilder |
+StatementBuilder.increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+StatementBuilder.limit(Integer count) |
+
StatementBuilder |
+StatementBuilder.offset(Integer count) |
+
StatementBuilder |
+StatementBuilder.orderBy(String orderBy) |
+
StatementBuilder |
+StatementBuilder.removeLimitAndOffset() |
+
StatementBuilder |
+StatementBuilder.select(String columns) |
+
StatementBuilder |
+StatementBuilder.where(String conditions) |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ com.google.api.ads.admanager.axis.v202311.Value value)
+Adds a bind variable value to the statement.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/package-frame.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/package-frame.html new file mode 100644 index 0000000000..41e947bfb9 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| DateTimes | +
+ A utility class for handling
+DateTime objects. |
+
| Pql | +
+ A utility class for handling PQL objects.
+ |
+
| ReportDownloader | +
+ Retrieves reports using a
+ReportServiceInterface. |
+
| StatementBuilder | +
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/package-tree.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/package-tree.html new file mode 100644 index 0000000000..42dbaf2d69 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/package-tree.html @@ -0,0 +1,142 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/package-use.html b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/package-use.html new file mode 100644 index 0000000000..1eee4839b8 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/axis/utils/v202311/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis.utils.v202311 | ++ |
| Class and Description | +
|---|
StatementBuilder
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/AdManagerJaxWsHeaderHandler.html b/5.3.0/com/google/api/ads/admanager/jaxws/AdManagerJaxWsHeaderHandler.html new file mode 100644 index 0000000000..1dffd1aef6 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/AdManagerJaxWsHeaderHandler.html @@ -0,0 +1,340 @@ + + + + + + +public class AdManagerJaxWsHeaderHandler +extends Object +implements HeaderHandler<AdManagerSession,AdManagerServiceDescriptor>+
HeaderHandler for JAX-WS.HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>| Constructor and Description | +
|---|
AdManagerJaxWsHeaderHandler(JaxWsHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor)
+Sets the headers on the SOAP client using the session and descriptor.
+ |
+
@Inject +public AdManagerJaxWsHeaderHandler(JaxWsHandler soapClientHandler, + com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration, + com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration, + AuthorizationHeaderHandler authorizationHeaderHandler, + AdManagerHttpHeaderHandler adManagerHttpHeaderHandler, + UserAgentCombiner userAgentCombiner)+
soapClientHandler - the SOAP client handleradManagerApiConfiguration - the Ad Manager API configurationauthorizationHeaderHandler - the authorization header handleruserAgentCombiner - the full user agent providerpublic void setHeaders(Object soapClient, + AdManagerSession adManagerSession, + AdManagerServiceDescriptor adManagerServiceDescriptor) + throws AuthenticationException, + ServiceException+
HeaderHandlersetHeaders in interface HeaderHandler<AdManagerSession,AdManagerServiceDescriptor>soapClient - the SOAP clientadManagerSession - the ads sessionadManagerServiceDescriptor - the ads service descriptorAuthenticationException - if there was a problem authenticating the
+ sessionServiceException - if there was a problem setting the headersHeaderHandler.setHeaders(Object, com.google.api.ads.common.lib.client.AdsSession,
+ com.google.api.ads.common.lib.client.AdsServiceDescriptor)Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/AdManagerJaxWsModule.html b/5.3.0/com/google/api/ads/admanager/jaxws/AdManagerJaxWsModule.html new file mode 100644 index 0000000000..61d30cc6a7 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/AdManagerJaxWsModule.html @@ -0,0 +1,306 @@ + + + + + + +public class AdManagerJaxWsModule +extends ProductFrameworkModule+
| Constructor and Description | +
|---|
AdManagerJaxWsModule() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+configure() |
+
configureConfigurationsaddError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/class-use/AdManagerJaxWsHeaderHandler.html b/5.3.0/com/google/api/ads/admanager/jaxws/class-use/AdManagerJaxWsHeaderHandler.html new file mode 100644 index 0000000000..1d599276ab --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/class-use/AdManagerJaxWsHeaderHandler.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/class-use/AdManagerJaxWsModule.html b/5.3.0/com/google/api/ads/admanager/jaxws/class-use/AdManagerJaxWsModule.html new file mode 100644 index 0000000000..8221ba3154 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/class-use/AdManagerJaxWsModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/factory/AdManagerServices.html b/5.3.0/com/google/api/ads/admanager/jaxws/factory/AdManagerServices.html new file mode 100644 index 0000000000..a325c40b38 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/factory/AdManagerServices.html @@ -0,0 +1,283 @@ + + + + + + +public final class AdManagerServices +extends BaseAdManagerServices+
Usage example: + +
+ AdManagerSession session = new AdManagerSession.Builder()...build();
+ InventoryServiceInterface inventoryService =
+ new AdManagerServices().get(session, InventoryServiceInterface.class);
+ campaignService.makeRequest(...);
+ ...
+ session.setNetworkCode(...);
+ campaignService.makeRequest(...);
+ Implementation is thread-safe.
| Constructor and Description | +
|---|
AdManagerServices() |
+
getclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/factory/class-use/AdManagerServices.html b/5.3.0/com/google/api/ads/admanager/jaxws/factory/class-use/AdManagerServices.html new file mode 100644 index 0000000000..9c287d8ac4 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/factory/class-use/AdManagerServices.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/factory/package-frame.html b/5.3.0/com/google/api/ads/admanager/jaxws/factory/package-frame.html new file mode 100644 index 0000000000..86cf3a9940 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/factory/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| AdManagerServices | +
+ Utility class to create Ad Manager service clients.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/factory/package-tree.html b/5.3.0/com/google/api/ads/admanager/jaxws/factory/package-tree.html new file mode 100644 index 0000000000..b0b5617eab --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/factory/package-tree.html @@ -0,0 +1,147 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/factory/package-use.html b/5.3.0/com/google/api/ads/admanager/jaxws/factory/package-use.html new file mode 100644 index 0000000000..4513f30d18 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/factory/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/package-frame.html b/5.3.0/com/google/api/ads/admanager/jaxws/package-frame.html new file mode 100644 index 0000000000..c0ae470065 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Class | +Description | +
|---|---|
| AdManagerJaxWsHeaderHandler | +
+ Ad Manager implementation of
+HeaderHandler for JAX-WS. |
+
| AdManagerJaxWsModule | +
+ Guice module to bind Ad Manager's SOAP header handler to a JAX-WS-friendly implementation.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/package-tree.html b/5.3.0/com/google/api/ads/admanager/jaxws/package-tree.html new file mode 100644 index 0000000000..65330f85c2 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/package-tree.html @@ -0,0 +1,148 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/package-use.html b/5.3.0/com/google/api/ads/admanager/jaxws/package-use.html new file mode 100644 index 0000000000..0408b278c5 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/DateTimes.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/DateTimes.html new file mode 100644 index 0000000000..f4aec71d4e --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/DateTimes.html @@ -0,0 +1,477 @@ + + + + + + +public final class DateTimes +extends Object+
DateTime objects.| Modifier and Type | +Method and Description | +
|---|---|
static Calendar |
+toCalendar(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime)
+Gets a calendar for a
+DateTime using the default locale, i.e. |
+
static Calendar |
+toCalendar(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime,
+ Locale locale)
+Gets a calendar for a
+DateTime in the supplied locale. |
+
static com.google.api.ads.admanager.jaxws.v202302.DateTime |
+toDateTime(Calendar calendar)
+Converts a
+Calendar object to an API date time preserving the time zone. |
+
static com.google.api.ads.admanager.jaxws.v202302.DateTime |
+toDateTime(org.joda.time.DateTime dateTime)
+Converts a
+DateTime object to an API date time preserving the time zone. |
+
static org.joda.time.DateTime |
+toDateTime(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime)
+Converts an API date time to a
+DateTime preserving the time zone. |
+
static com.google.api.ads.admanager.jaxws.v202302.DateTime |
+toDateTime(org.joda.time.Instant instant,
+ String timeZoneId)
+Converts an
+Instant object to an API date time in the time zone supplied. |
+
static com.google.api.ads.admanager.jaxws.v202302.DateTime |
+toDateTime(String dateTime,
+ String timeZoneId)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied. |
+
static com.google.api.ads.admanager.jaxws.v202302.DateTime |
+toDateTimeWithTimeZone(String dateTime)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied. |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202302.Date date)
+Returns string representation of this date.
+ |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime)
+Returns string representation of this date time.
+ |
+
static String |
+toStringForTimeZone(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime,
+ String newZoneId)
+Returns string representation of this date time with a different time zone, preserving the
+ millisecond instant.
+ |
+
static String |
+toStringWithTimeZone(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime)
+Returns string representation of this date time with time zone.
+ |
+
public static com.google.api.ads.admanager.jaxws.v202302.DateTime toDateTime(Calendar calendar)+
Calendar object to an API date time preserving the time zone.public static com.google.api.ads.admanager.jaxws.v202302.DateTime toDateTime(org.joda.time.Instant instant, + String timeZoneId)+
Instant object to an API date time in the time zone supplied.public static com.google.api.ads.admanager.jaxws.v202302.DateTime toDateTime(org.joda.time.DateTime dateTime)+
DateTime object to an API date time preserving the time zone.public static com.google.api.ads.admanager.jaxws.v202302.DateTime toDateTime(String dateTime, + String timeZoneId)+
yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.public static com.google.api.ads.admanager.jaxws.v202302.DateTime toDateTimeWithTimeZone(String dateTime)+
yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.public static org.joda.time.DateTime toDateTime(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime)+
DateTime preserving the time zone.public static Calendar toCalendar(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime)+
DateTime using the default locale, i.e. Locale.getDefault().public static Calendar toCalendar(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime, + Locale locale)+
DateTime in the supplied locale.public static String toString(com.google.api.ads.admanager.jaxws.v202302.Date date)+
date - the date to stringifyDate in yyyy-MM-ddpublic static String toString(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:sspublic static String toStringWithTimeZone(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm,
+ i.e. 2013-09-013T12:02:03+08:00 or 2013-09-013T12:02:03Z for Etc/GMT.public static String toStringForTimeZone(com.google.api.ads.admanager.jaxws.v202302.DateTime dateTime, + String newZoneId)+
This method is useful for finding the local time in another time zone, especially for + filtering. + +
For example, if this date time holds 12:30 in Europe/London, the result from this method + with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, + i.e. + +
String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
+ String statementPart =
+ "startDateTime > "
+ + DateTimes.toString(apiDateTime, timeZoneId);
+ //...
+ statementBuilder.where(statementPart);
+ DateTime.withZone(org.joda.time.DateTimeZone).dateTime - the date time to stringify into a new time zonenewZoneId - the time zone ID of the new zoneDateTime in yyyy-MM-dd'T'HH:mm:ssCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/Pql.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/Pql.html new file mode 100644 index 0000000000..34343d8640 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/Pql.html @@ -0,0 +1,509 @@ + + + + + + +public final class Pql +extends Object+
+
+ ResultSet combinedResultSet = null
+ do {
+ ResultSet resultSet = pqlService.select(pagedStatement);
+ combinedResultSet = (combinedResultSet == null) ? resultSet :
+ Pql.combineResultSet(combinedResultSet, resultSet);
+ // ...
+ } while(!finishedCollectingResultSets)
+ //...
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ | Modifier and Type | +Method and Description | +
|---|---|
static com.google.api.ads.admanager.jaxws.v202302.ResultSet |
+combineResultSets(com.google.api.ads.admanager.jaxws.v202302.ResultSet first,
+ com.google.api.ads.admanager.jaxws.v202302.ResultSet second)
+Combines the first and second result sets, if and only if, the columns of both result sets
+ match.
+ |
+
static com.google.api.ads.admanager.jaxws.v202302.Value |
+createValue(Object value)
+Creates a
+Value from the value i.e. |
+
static Object |
+getApiValue(com.google.api.ads.admanager.jaxws.v202302.Value value)
+Gets the underlying value of the
+Value object that's comparable to what would be
+ returned in any other API object (i.e. |
+
static List<String> |
+getColumnLabels(com.google.api.ads.admanager.jaxws.v202302.ResultSet resultSet)
+Gets the column labels for the result set.
+ |
+
static Object |
+getCsvValue(com.google.api.ads.admanager.jaxws.v202302.Value value)
+Gets the underlying value of the
+Value object that should be used for CSV conversion
+ (i.e. |
+
static Object |
+getNativeValue(com.google.api.ads.admanager.jaxws.v202302.Value value)
+Gets the underlying value of the
+Value object that's considered native to Java (i.e. |
+
static List<String> |
+getRowStringValues(com.google.api.ads.admanager.jaxws.v202302.Row row)
+Gets the values in a row of the result set in the form of a string list.
+ |
+
static String |
+resultSetToString(com.google.api.ads.admanager.jaxws.v202302.ResultSet resultSet)
+Gets the result set as a table representation in the form of:
+ |
+
static List<String[]> |
+resultSetToStringArrayList(com.google.api.ads.admanager.jaxws.v202302.ResultSet resultSet)
+Gets the result set as list of string arrays, which can be transformed to a CSV using
+CsvFiles such as |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202302.Value value)
+Creates a String from the Value.
+ |
+
public static com.google.api.ads.admanager.jaxws.v202302.Value createValue(Object value)+
Value from the value i.e. a TextValue for a value of type String, BooleanValue for type Boolean, NumberValue for type Double, Long, or Integer, and DateTimeValue for type DateTime.
+ If the value is a Value, the value is returned. If the value is null, an empty
+ TextValue is returned.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static String toString(com.google.api.ads.admanager.jaxws.v202302.Value value)+
DateTimes.toString(Date) and DateTimes.toStringWithTimeZone(DateTime)
+ respectively.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static Object getApiValue(com.google.api.ads.admanager.jaxws.v202302.Value value)+
Value object that's comparable to what would be
+ returned in any other API object (i.e. DateTimeValue will return an API DateTime, not a Joda
+ DateTime).value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getNativeValue(com.google.api.ads.admanager.jaxws.v202302.Value value)+
Value object that's considered native to Java (i.e.
+ DateTimeValue will return a Joda DateTime, not an API DateTime and DateValue will return a
+ string in the form of "yyyy-MM-dd").value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getCsvValue(com.google.api.ads.admanager.jaxws.v202302.Value value)+
Value object that should be used for CSV conversion
+ (i.e. DateTimeValue will return a String representation, but NumberValue will return a Long or
+ Double).value - the value to convertValue or null if the underlying value is
+ nullIllegalArgumentException - if value cannot be convertedpublic static List<String[]> resultSetToStringArrayList(com.google.api.ads.admanager.jaxws.v202302.ResultSet resultSet)+
CsvFiles such as
+
+
+
+ ResultSet combinedResultSet = Pql.combineResultSet(resultSet1, resultSet2);
+ //...
+ combinedResultSet = Pql.combineResultSet(combinedResultSet, resultSet3);
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ resultSet - the result set to convert to a CSV compatible formatpublic static String resultSetToString(com.google.api.ads.admanager.jaxws.v202302.ResultSet resultSet) + throws IllegalAccessException+
+ +-------+-------+-------+ + |column1|column2|column3| + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ +
resultSet - the result set to display as a stringIllegalAccessException - if the values of the result set cannot be accessedpublic static List<String> getColumnLabels(com.google.api.ads.admanager.jaxws.v202302.ResultSet resultSet)+
resultSet - the result set to get the column labels forpublic static List<String> getRowStringValues(com.google.api.ads.admanager.jaxws.v202302.Row row)+
row - the row to get the values forpublic static com.google.api.ads.admanager.jaxws.v202302.ResultSet combineResultSets(com.google.api.ads.admanager.jaxws.v202302.ResultSet first, + com.google.api.ads.admanager.jaxws.v202302.ResultSet second)+
IllegalArgumentException - if the columns of the first result set don't match the secondCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/ReportDownloader.html new file mode 100644 index 0000000000..c9d8dba076 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/ReportDownloader.html @@ -0,0 +1,474 @@ + + + + + + +public class ReportDownloader +extends Object+
ReportServiceInterface.
+
+ There are two main functions of this class: + +
OutputStream
+ ReportUtils also provides the method whenReportReady(ReportCallback) to wait
+ for a scheduled report to finish processing before taking an action on the report through the
+ supplied ReportCallback.
| Modifier and Type | +Field and Description | +
|---|---|
static Charset |
+REPORT_CHARSET |
+
static int |
+SLEEP_TIMER
+The time to sleep before each request to the service.
+ |
+
| Constructor and Description | +
|---|
ReportDownloader(com.google.api.ads.admanager.jaxws.v202302.ReportServiceInterface reportService,
+ long reportJobId)
+Constructs a
+ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on. |
+
| Modifier and Type | +Method and Description | +
|---|---|
URL |
+getDownloadUrl(com.google.api.ads.admanager.jaxws.v202302.ReportDownloadOptions options)
+Gets the download URL for a GZip or plain-text format report.
+ |
+
com.google.common.io.CharSource |
+getReportAsCharSource(com.google.api.ads.admanager.jaxws.v202302.ReportDownloadOptions options)
+Returns a CharSource of report contents with
+ReportDownloadOptions. |
+
boolean |
+waitForReportReady()
+Blocks and waits for a report to be ready.
+ |
+
Thread |
+whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
public static final Charset REPORT_CHARSET+
public static final int SLEEP_TIMER+
public ReportDownloader(com.google.api.ads.admanager.jaxws.v202302.ReportServiceInterface reportService, + long reportJobId)+
ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.reportService - the ReportService stub to make calls toreportJobId - the report job IDpublic Thread whenReportReady(ReportCallback callback)+
ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ callback - the ReportCallback to call when the job has finished, successfully or
+ otherwiseThread.interrupt() can
+ be called on the returned thread to interrupt it.IllegalArgumentException - if callback == nullpublic boolean waitForReportReady() + throws InterruptedException, + com.google.api.ads.admanager.jaxws.v202302.ApiException_Exception+
ReportJobStatus is received that is
+ not ReportJobStatus#Pending or ReportJobStatus#InProgress, the report is
+ considered finished, and the method is returned with a true if the report was
+ successful, or an false if not.true if the report was successful, false otherwisecom.google.api.ads.admanager.jaxws.v202302.ApiException_Exception - if there was an error performing one of the SOAP callsInterruptedException - if the thread was interruptedpublic URL getDownloadUrl(com.google.api.ads.admanager.jaxws.v202302.ReportDownloadOptions options) + throws com.google.api.ads.admanager.jaxws.v202302.ApiException_Exception, + MalformedURLException+
+ URL url = new URL(reportDownloader.getDownloadUrl(options));
+ Resources.asByteSource(url).copyTo(Files.asByteSink(file));
+ options - the options to download the report withcom.google.api.ads.admanager.jaxws.v202302.ApiException_Exception - if there was an error performing any jaxws callMalformedURLException - if there is an error forming the download URLIllegalStateException - if the report is not ready to be downloadedpublic com.google.common.io.CharSource getReportAsCharSource(com.google.api.ads.admanager.jaxws.v202302.ReportDownloadOptions options) + throws IOException, + com.google.api.ads.admanager.jaxws.v202302.ApiException_Exception+
ReportDownloadOptions. The ExportFormat
+ must be string-based, such as ExportFormat.CSV_DUMP.options - the options to download the report withIOException - if there was an error performing any I/O action, including any SOAP callscom.google.api.ads.admanager.jaxws.v202302.ApiException_Exception - if there was any problem making the SOAP callIllegalStateException - if the report is not ready to be downloadedIllegalArgumentException - if the ExportFormat is not a string-based formatCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/StatementBuilder.html new file mode 100644 index 0000000000..44ddd7f348 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/StatementBuilder.html @@ -0,0 +1,545 @@ + + + + + + +public final class StatementBuilder +extends Object+
StatementBuilder allows for statements to be constructed in parts.
+
+ Typical usage is: + +
+ StatementBuilder statementBuilder = new StatementBuilder()
+ .where("lastModifiedDateTime > :yesterday AND type = :type")
+ .orderBy("name DESC")
+ .limit(200)
+ .offset(20)
+ .withBindVariableValue("yesterday",
+ DateTimes.fromDate(new org.joda.time.DateTime().minusDays(1).toDate()))
+ .withBindVariableValue("type", "Type")
+
+ Statement statement = statementBuilder.toStatement();
+ //...
+ statementBuilder.increaseOffsetBy(20);
+ statement = statementBuilder.toStatement();
+ | Modifier and Type | +Field and Description | +
|---|---|
static int |
+SUGGESTED_PAGE_LIMIT |
+
| Constructor and Description | +
|---|
StatementBuilder()
+Constructs a statement builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery() |
+
StatementBuilder |
+from(String table) |
+
Map<String,com.google.api.ads.admanager.jaxws.v202302.Value> |
+getBindVariableMap() |
+
Integer |
+getOffset() |
+
StatementBuilder |
+increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+limit(Integer count) |
+
StatementBuilder |
+offset(Integer count) |
+
StatementBuilder |
+orderBy(String orderBy) |
+
StatementBuilder |
+removeLimitAndOffset() |
+
StatementBuilder |
+select(String columns) |
+
com.google.api.ads.admanager.jaxws.v202302.Statement |
+toStatement()
+Gets the
+Statement representing the state of this statement builder. |
+
StatementBuilder |
+where(String conditions) |
+
StatementBuilder |
+withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+withBindVariableValue(String key,
+ com.google.api.ads.admanager.jaxws.v202302.Value value)
+Adds a bind variable value to the statement.
+ |
+
public static final int SUGGESTED_PAGE_LIMIT+
public StatementBuilder()+
@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + Object value)+
Pql.createValue(Object). If the value is of type Value, no conversion will be done.key - the value keyvalue - the bind variable value@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + com.google.api.ads.admanager.jaxws.v202302.Value value)+
key - the value keyvalue - the bind variable valuepublic com.google.api.ads.admanager.jaxws.v202302.Statement toStatement()+
Statement representing the state of this statement builder.Statement@CanIgnoreReturnValue +public StatementBuilder select(String columns)+
@CanIgnoreReturnValue +public StatementBuilder from(String table)+
@CanIgnoreReturnValue +public StatementBuilder where(String conditions)+
@CanIgnoreReturnValue +public StatementBuilder limit(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder offset(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder increaseOffsetBy(Integer amount)+
public Integer getOffset()+
@CanIgnoreReturnValue +public StatementBuilder removeLimitAndOffset()+
@CanIgnoreReturnValue +public StatementBuilder orderBy(String orderBy)+
public Map<String,com.google.api.ads.admanager.jaxws.v202302.Value> getBindVariableMap()+
public String buildQuery()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/DateTimes.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/DateTimes.html new file mode 100644 index 0000000000..186b2bf0c7 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/DateTimes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/Pql.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/Pql.html new file mode 100644 index 0000000000..35f6f37369 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/Pql.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/ReportDownloader.html new file mode 100644 index 0000000000..6325eac153 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/ReportDownloader.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/StatementBuilder.html new file mode 100644 index 0000000000..0f7c150c33 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/class-use/StatementBuilder.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.utils.v202302 | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
StatementBuilder |
+StatementBuilder.from(String table) |
+
StatementBuilder |
+StatementBuilder.increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+StatementBuilder.limit(Integer count) |
+
StatementBuilder |
+StatementBuilder.offset(Integer count) |
+
StatementBuilder |
+StatementBuilder.orderBy(String orderBy) |
+
StatementBuilder |
+StatementBuilder.removeLimitAndOffset() |
+
StatementBuilder |
+StatementBuilder.select(String columns) |
+
StatementBuilder |
+StatementBuilder.where(String conditions) |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ com.google.api.ads.admanager.jaxws.v202302.Value value)
+Adds a bind variable value to the statement.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/package-frame.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/package-frame.html new file mode 100644 index 0000000000..35858087bb --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| DateTimes | +
+ A utility class for handling
+DateTime objects. |
+
| Pql | +
+ A utility class for handling PQL objects.
+ |
+
| ReportDownloader | +
+ Retrieves reports using a
+ReportServiceInterface. |
+
| StatementBuilder | +
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/package-tree.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/package-tree.html new file mode 100644 index 0000000000..bda3f7b74f --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/package-tree.html @@ -0,0 +1,142 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/package-use.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/package-use.html new file mode 100644 index 0000000000..e7c432982d --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202302/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.utils.v202302 | ++ |
| Class and Description | +
|---|
StatementBuilder
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/DateTimes.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/DateTimes.html new file mode 100644 index 0000000000..543fb96afe --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/DateTimes.html @@ -0,0 +1,477 @@ + + + + + + +public final class DateTimes +extends Object+
DateTime objects.| Modifier and Type | +Method and Description | +
|---|---|
static Calendar |
+toCalendar(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime)
+Gets a calendar for a
+DateTime using the default locale, i.e. |
+
static Calendar |
+toCalendar(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime,
+ Locale locale)
+Gets a calendar for a
+DateTime in the supplied locale. |
+
static com.google.api.ads.admanager.jaxws.v202305.DateTime |
+toDateTime(Calendar calendar)
+Converts a
+Calendar object to an API date time preserving the time zone. |
+
static com.google.api.ads.admanager.jaxws.v202305.DateTime |
+toDateTime(org.joda.time.DateTime dateTime)
+Converts a
+DateTime object to an API date time preserving the time zone. |
+
static org.joda.time.DateTime |
+toDateTime(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime)
+Converts an API date time to a
+DateTime preserving the time zone. |
+
static com.google.api.ads.admanager.jaxws.v202305.DateTime |
+toDateTime(org.joda.time.Instant instant,
+ String timeZoneId)
+Converts an
+Instant object to an API date time in the time zone supplied. |
+
static com.google.api.ads.admanager.jaxws.v202305.DateTime |
+toDateTime(String dateTime,
+ String timeZoneId)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied. |
+
static com.google.api.ads.admanager.jaxws.v202305.DateTime |
+toDateTimeWithTimeZone(String dateTime)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied. |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202305.Date date)
+Returns string representation of this date.
+ |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime)
+Returns string representation of this date time.
+ |
+
static String |
+toStringForTimeZone(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime,
+ String newZoneId)
+Returns string representation of this date time with a different time zone, preserving the
+ millisecond instant.
+ |
+
static String |
+toStringWithTimeZone(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime)
+Returns string representation of this date time with time zone.
+ |
+
public static com.google.api.ads.admanager.jaxws.v202305.DateTime toDateTime(Calendar calendar)+
Calendar object to an API date time preserving the time zone.public static com.google.api.ads.admanager.jaxws.v202305.DateTime toDateTime(org.joda.time.Instant instant, + String timeZoneId)+
Instant object to an API date time in the time zone supplied.public static com.google.api.ads.admanager.jaxws.v202305.DateTime toDateTime(org.joda.time.DateTime dateTime)+
DateTime object to an API date time preserving the time zone.public static com.google.api.ads.admanager.jaxws.v202305.DateTime toDateTime(String dateTime, + String timeZoneId)+
yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.public static com.google.api.ads.admanager.jaxws.v202305.DateTime toDateTimeWithTimeZone(String dateTime)+
yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.public static org.joda.time.DateTime toDateTime(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime)+
DateTime preserving the time zone.public static Calendar toCalendar(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime)+
DateTime using the default locale, i.e. Locale.getDefault().public static Calendar toCalendar(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime, + Locale locale)+
DateTime in the supplied locale.public static String toString(com.google.api.ads.admanager.jaxws.v202305.Date date)+
date - the date to stringifyDate in yyyy-MM-ddpublic static String toString(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:sspublic static String toStringWithTimeZone(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm,
+ i.e. 2013-09-013T12:02:03+08:00 or 2013-09-013T12:02:03Z for Etc/GMT.public static String toStringForTimeZone(com.google.api.ads.admanager.jaxws.v202305.DateTime dateTime, + String newZoneId)+
This method is useful for finding the local time in another time zone, especially for + filtering. + +
For example, if this date time holds 12:30 in Europe/London, the result from this method + with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, + i.e. + +
String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
+ String statementPart =
+ "startDateTime > "
+ + DateTimes.toString(apiDateTime, timeZoneId);
+ //...
+ statementBuilder.where(statementPart);
+ DateTime.withZone(org.joda.time.DateTimeZone).dateTime - the date time to stringify into a new time zonenewZoneId - the time zone ID of the new zoneDateTime in yyyy-MM-dd'T'HH:mm:ssCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/Pql.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/Pql.html new file mode 100644 index 0000000000..93eeb3bf04 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/Pql.html @@ -0,0 +1,509 @@ + + + + + + +public final class Pql +extends Object+
+
+ ResultSet combinedResultSet = null
+ do {
+ ResultSet resultSet = pqlService.select(pagedStatement);
+ combinedResultSet = (combinedResultSet == null) ? resultSet :
+ Pql.combineResultSet(combinedResultSet, resultSet);
+ // ...
+ } while(!finishedCollectingResultSets)
+ //...
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ | Modifier and Type | +Method and Description | +
|---|---|
static com.google.api.ads.admanager.jaxws.v202305.ResultSet |
+combineResultSets(com.google.api.ads.admanager.jaxws.v202305.ResultSet first,
+ com.google.api.ads.admanager.jaxws.v202305.ResultSet second)
+Combines the first and second result sets, if and only if, the columns of both result sets
+ match.
+ |
+
static com.google.api.ads.admanager.jaxws.v202305.Value |
+createValue(Object value)
+Creates a
+Value from the value i.e. |
+
static Object |
+getApiValue(com.google.api.ads.admanager.jaxws.v202305.Value value)
+Gets the underlying value of the
+Value object that's comparable to what would be
+ returned in any other API object (i.e. |
+
static List<String> |
+getColumnLabels(com.google.api.ads.admanager.jaxws.v202305.ResultSet resultSet)
+Gets the column labels for the result set.
+ |
+
static Object |
+getCsvValue(com.google.api.ads.admanager.jaxws.v202305.Value value)
+Gets the underlying value of the
+Value object that should be used for CSV conversion
+ (i.e. |
+
static Object |
+getNativeValue(com.google.api.ads.admanager.jaxws.v202305.Value value)
+Gets the underlying value of the
+Value object that's considered native to Java (i.e. |
+
static List<String> |
+getRowStringValues(com.google.api.ads.admanager.jaxws.v202305.Row row)
+Gets the values in a row of the result set in the form of a string list.
+ |
+
static String |
+resultSetToString(com.google.api.ads.admanager.jaxws.v202305.ResultSet resultSet)
+Gets the result set as a table representation in the form of:
+ |
+
static List<String[]> |
+resultSetToStringArrayList(com.google.api.ads.admanager.jaxws.v202305.ResultSet resultSet)
+Gets the result set as list of string arrays, which can be transformed to a CSV using
+CsvFiles such as |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202305.Value value)
+Creates a String from the Value.
+ |
+
public static com.google.api.ads.admanager.jaxws.v202305.Value createValue(Object value)+
Value from the value i.e. a TextValue for a value of type String, BooleanValue for type Boolean, NumberValue for type Double, Long, or Integer, and DateTimeValue for type DateTime.
+ If the value is a Value, the value is returned. If the value is null, an empty
+ TextValue is returned.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static String toString(com.google.api.ads.admanager.jaxws.v202305.Value value)+
DateTimes.toString(Date) and DateTimes.toStringWithTimeZone(DateTime)
+ respectively.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static Object getApiValue(com.google.api.ads.admanager.jaxws.v202305.Value value)+
Value object that's comparable to what would be
+ returned in any other API object (i.e. DateTimeValue will return an API DateTime, not a Joda
+ DateTime).value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getNativeValue(com.google.api.ads.admanager.jaxws.v202305.Value value)+
Value object that's considered native to Java (i.e.
+ DateTimeValue will return a Joda DateTime, not an API DateTime and DateValue will return a
+ string in the form of "yyyy-MM-dd").value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getCsvValue(com.google.api.ads.admanager.jaxws.v202305.Value value)+
Value object that should be used for CSV conversion
+ (i.e. DateTimeValue will return a String representation, but NumberValue will return a Long or
+ Double).value - the value to convertValue or null if the underlying value is
+ nullIllegalArgumentException - if value cannot be convertedpublic static List<String[]> resultSetToStringArrayList(com.google.api.ads.admanager.jaxws.v202305.ResultSet resultSet)+
CsvFiles such as
+
+
+
+ ResultSet combinedResultSet = Pql.combineResultSet(resultSet1, resultSet2);
+ //...
+ combinedResultSet = Pql.combineResultSet(combinedResultSet, resultSet3);
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ resultSet - the result set to convert to a CSV compatible formatpublic static String resultSetToString(com.google.api.ads.admanager.jaxws.v202305.ResultSet resultSet) + throws IllegalAccessException+
+ +-------+-------+-------+ + |column1|column2|column3| + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ +
resultSet - the result set to display as a stringIllegalAccessException - if the values of the result set cannot be accessedpublic static List<String> getColumnLabels(com.google.api.ads.admanager.jaxws.v202305.ResultSet resultSet)+
resultSet - the result set to get the column labels forpublic static List<String> getRowStringValues(com.google.api.ads.admanager.jaxws.v202305.Row row)+
row - the row to get the values forpublic static com.google.api.ads.admanager.jaxws.v202305.ResultSet combineResultSets(com.google.api.ads.admanager.jaxws.v202305.ResultSet first, + com.google.api.ads.admanager.jaxws.v202305.ResultSet second)+
IllegalArgumentException - if the columns of the first result set don't match the secondCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/ReportDownloader.html new file mode 100644 index 0000000000..9d8dc9205d --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/ReportDownloader.html @@ -0,0 +1,474 @@ + + + + + + +public class ReportDownloader +extends Object+
ReportServiceInterface.
+
+ There are two main functions of this class: + +
OutputStream
+ ReportUtils also provides the method whenReportReady(ReportCallback) to wait
+ for a scheduled report to finish processing before taking an action on the report through the
+ supplied ReportCallback.
| Modifier and Type | +Field and Description | +
|---|---|
static Charset |
+REPORT_CHARSET |
+
static int |
+SLEEP_TIMER
+The time to sleep before each request to the service.
+ |
+
| Constructor and Description | +
|---|
ReportDownloader(com.google.api.ads.admanager.jaxws.v202305.ReportServiceInterface reportService,
+ long reportJobId)
+Constructs a
+ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on. |
+
| Modifier and Type | +Method and Description | +
|---|---|
URL |
+getDownloadUrl(com.google.api.ads.admanager.jaxws.v202305.ReportDownloadOptions options)
+Gets the download URL for a GZip or plain-text format report.
+ |
+
com.google.common.io.CharSource |
+getReportAsCharSource(com.google.api.ads.admanager.jaxws.v202305.ReportDownloadOptions options)
+Returns a CharSource of report contents with
+ReportDownloadOptions. |
+
boolean |
+waitForReportReady()
+Blocks and waits for a report to be ready.
+ |
+
Thread |
+whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
public static final Charset REPORT_CHARSET+
public static final int SLEEP_TIMER+
public ReportDownloader(com.google.api.ads.admanager.jaxws.v202305.ReportServiceInterface reportService, + long reportJobId)+
ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.reportService - the ReportService stub to make calls toreportJobId - the report job IDpublic Thread whenReportReady(ReportCallback callback)+
ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ callback - the ReportCallback to call when the job has finished, successfully or
+ otherwiseThread.interrupt() can
+ be called on the returned thread to interrupt it.IllegalArgumentException - if callback == nullpublic boolean waitForReportReady() + throws InterruptedException, + com.google.api.ads.admanager.jaxws.v202305.ApiException_Exception+
ReportJobStatus is received that is
+ not ReportJobStatus#Pending or ReportJobStatus#InProgress, the report is
+ considered finished, and the method is returned with a true if the report was
+ successful, or an false if not.true if the report was successful, false otherwisecom.google.api.ads.admanager.jaxws.v202305.ApiException_Exception - if there was an error performing one of the SOAP callsInterruptedException - if the thread was interruptedpublic URL getDownloadUrl(com.google.api.ads.admanager.jaxws.v202305.ReportDownloadOptions options) + throws com.google.api.ads.admanager.jaxws.v202305.ApiException_Exception, + MalformedURLException+
+ URL url = new URL(reportDownloader.getDownloadUrl(options));
+ Resources.asByteSource(url).copyTo(Files.asByteSink(file));
+ options - the options to download the report withcom.google.api.ads.admanager.jaxws.v202305.ApiException_Exception - if there was an error performing any jaxws callMalformedURLException - if there is an error forming the download URLIllegalStateException - if the report is not ready to be downloadedpublic com.google.common.io.CharSource getReportAsCharSource(com.google.api.ads.admanager.jaxws.v202305.ReportDownloadOptions options) + throws IOException, + com.google.api.ads.admanager.jaxws.v202305.ApiException_Exception+
ReportDownloadOptions. The ExportFormat
+ must be string-based, such as ExportFormat.CSV_DUMP.options - the options to download the report withIOException - if there was an error performing any I/O action, including any SOAP callscom.google.api.ads.admanager.jaxws.v202305.ApiException_Exception - if there was any problem making the SOAP callIllegalStateException - if the report is not ready to be downloadedIllegalArgumentException - if the ExportFormat is not a string-based formatCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/StatementBuilder.html new file mode 100644 index 0000000000..f4d7419af3 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/StatementBuilder.html @@ -0,0 +1,545 @@ + + + + + + +public final class StatementBuilder +extends Object+
StatementBuilder allows for statements to be constructed in parts.
+
+ Typical usage is: + +
+ StatementBuilder statementBuilder = new StatementBuilder()
+ .where("lastModifiedDateTime > :yesterday AND type = :type")
+ .orderBy("name DESC")
+ .limit(200)
+ .offset(20)
+ .withBindVariableValue("yesterday",
+ DateTimes.fromDate(new org.joda.time.DateTime().minusDays(1).toDate()))
+ .withBindVariableValue("type", "Type")
+
+ Statement statement = statementBuilder.toStatement();
+ //...
+ statementBuilder.increaseOffsetBy(20);
+ statement = statementBuilder.toStatement();
+ | Modifier and Type | +Field and Description | +
|---|---|
static int |
+SUGGESTED_PAGE_LIMIT |
+
| Constructor and Description | +
|---|
StatementBuilder()
+Constructs a statement builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery() |
+
StatementBuilder |
+from(String table) |
+
Map<String,com.google.api.ads.admanager.jaxws.v202305.Value> |
+getBindVariableMap() |
+
Integer |
+getOffset() |
+
StatementBuilder |
+increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+limit(Integer count) |
+
StatementBuilder |
+offset(Integer count) |
+
StatementBuilder |
+orderBy(String orderBy) |
+
StatementBuilder |
+removeLimitAndOffset() |
+
StatementBuilder |
+select(String columns) |
+
com.google.api.ads.admanager.jaxws.v202305.Statement |
+toStatement()
+Gets the
+Statement representing the state of this statement builder. |
+
StatementBuilder |
+where(String conditions) |
+
StatementBuilder |
+withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+withBindVariableValue(String key,
+ com.google.api.ads.admanager.jaxws.v202305.Value value)
+Adds a bind variable value to the statement.
+ |
+
public static final int SUGGESTED_PAGE_LIMIT+
public StatementBuilder()+
@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + Object value)+
Pql.createValue(Object). If the value is of type Value, no conversion will be done.key - the value keyvalue - the bind variable value@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + com.google.api.ads.admanager.jaxws.v202305.Value value)+
key - the value keyvalue - the bind variable valuepublic com.google.api.ads.admanager.jaxws.v202305.Statement toStatement()+
Statement representing the state of this statement builder.Statement@CanIgnoreReturnValue +public StatementBuilder select(String columns)+
@CanIgnoreReturnValue +public StatementBuilder from(String table)+
@CanIgnoreReturnValue +public StatementBuilder where(String conditions)+
@CanIgnoreReturnValue +public StatementBuilder limit(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder offset(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder increaseOffsetBy(Integer amount)+
public Integer getOffset()+
@CanIgnoreReturnValue +public StatementBuilder removeLimitAndOffset()+
@CanIgnoreReturnValue +public StatementBuilder orderBy(String orderBy)+
public Map<String,com.google.api.ads.admanager.jaxws.v202305.Value> getBindVariableMap()+
public String buildQuery()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/DateTimes.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/DateTimes.html new file mode 100644 index 0000000000..5f4c94bb9d --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/DateTimes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/Pql.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/Pql.html new file mode 100644 index 0000000000..038dc27e42 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/Pql.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/ReportDownloader.html new file mode 100644 index 0000000000..581a9ecd3d --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/ReportDownloader.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/StatementBuilder.html new file mode 100644 index 0000000000..8fcbfbe4e1 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/class-use/StatementBuilder.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.utils.v202305 | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
StatementBuilder |
+StatementBuilder.from(String table) |
+
StatementBuilder |
+StatementBuilder.increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+StatementBuilder.limit(Integer count) |
+
StatementBuilder |
+StatementBuilder.offset(Integer count) |
+
StatementBuilder |
+StatementBuilder.orderBy(String orderBy) |
+
StatementBuilder |
+StatementBuilder.removeLimitAndOffset() |
+
StatementBuilder |
+StatementBuilder.select(String columns) |
+
StatementBuilder |
+StatementBuilder.where(String conditions) |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ com.google.api.ads.admanager.jaxws.v202305.Value value)
+Adds a bind variable value to the statement.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/package-frame.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/package-frame.html new file mode 100644 index 0000000000..f61c2ad74a --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| DateTimes | +
+ A utility class for handling
+DateTime objects. |
+
| Pql | +
+ A utility class for handling PQL objects.
+ |
+
| ReportDownloader | +
+ Retrieves reports using a
+ReportServiceInterface. |
+
| StatementBuilder | +
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/package-tree.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/package-tree.html new file mode 100644 index 0000000000..e96b17600a --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/package-tree.html @@ -0,0 +1,142 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/package-use.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/package-use.html new file mode 100644 index 0000000000..38c56eafbd --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202305/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.utils.v202305 | ++ |
| Class and Description | +
|---|
StatementBuilder
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/DateTimes.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/DateTimes.html new file mode 100644 index 0000000000..30b27996be --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/DateTimes.html @@ -0,0 +1,477 @@ + + + + + + +public final class DateTimes +extends Object+
DateTime objects.| Modifier and Type | +Method and Description | +
|---|---|
static Calendar |
+toCalendar(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime)
+Gets a calendar for a
+DateTime using the default locale, i.e. |
+
static Calendar |
+toCalendar(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime,
+ Locale locale)
+Gets a calendar for a
+DateTime in the supplied locale. |
+
static com.google.api.ads.admanager.jaxws.v202308.DateTime |
+toDateTime(Calendar calendar)
+Converts a
+Calendar object to an API date time preserving the time zone. |
+
static com.google.api.ads.admanager.jaxws.v202308.DateTime |
+toDateTime(org.joda.time.DateTime dateTime)
+Converts a
+DateTime object to an API date time preserving the time zone. |
+
static org.joda.time.DateTime |
+toDateTime(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime)
+Converts an API date time to a
+DateTime preserving the time zone. |
+
static com.google.api.ads.admanager.jaxws.v202308.DateTime |
+toDateTime(org.joda.time.Instant instant,
+ String timeZoneId)
+Converts an
+Instant object to an API date time in the time zone supplied. |
+
static com.google.api.ads.admanager.jaxws.v202308.DateTime |
+toDateTime(String dateTime,
+ String timeZoneId)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied. |
+
static com.google.api.ads.admanager.jaxws.v202308.DateTime |
+toDateTimeWithTimeZone(String dateTime)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied. |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202308.Date date)
+Returns string representation of this date.
+ |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime)
+Returns string representation of this date time.
+ |
+
static String |
+toStringForTimeZone(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime,
+ String newZoneId)
+Returns string representation of this date time with a different time zone, preserving the
+ millisecond instant.
+ |
+
static String |
+toStringWithTimeZone(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime)
+Returns string representation of this date time with time zone.
+ |
+
public static com.google.api.ads.admanager.jaxws.v202308.DateTime toDateTime(Calendar calendar)+
Calendar object to an API date time preserving the time zone.public static com.google.api.ads.admanager.jaxws.v202308.DateTime toDateTime(org.joda.time.Instant instant, + String timeZoneId)+
Instant object to an API date time in the time zone supplied.public static com.google.api.ads.admanager.jaxws.v202308.DateTime toDateTime(org.joda.time.DateTime dateTime)+
DateTime object to an API date time preserving the time zone.public static com.google.api.ads.admanager.jaxws.v202308.DateTime toDateTime(String dateTime, + String timeZoneId)+
yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.public static com.google.api.ads.admanager.jaxws.v202308.DateTime toDateTimeWithTimeZone(String dateTime)+
yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.public static org.joda.time.DateTime toDateTime(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime)+
DateTime preserving the time zone.public static Calendar toCalendar(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime)+
DateTime using the default locale, i.e. Locale.getDefault().public static Calendar toCalendar(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime, + Locale locale)+
DateTime in the supplied locale.public static String toString(com.google.api.ads.admanager.jaxws.v202308.Date date)+
date - the date to stringifyDate in yyyy-MM-ddpublic static String toString(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:sspublic static String toStringWithTimeZone(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm,
+ i.e. 2013-09-013T12:02:03+08:00 or 2013-09-013T12:02:03Z for Etc/GMT.public static String toStringForTimeZone(com.google.api.ads.admanager.jaxws.v202308.DateTime dateTime, + String newZoneId)+
This method is useful for finding the local time in another time zone, especially for + filtering. + +
For example, if this date time holds 12:30 in Europe/London, the result from this method + with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, + i.e. + +
String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
+ String statementPart =
+ "startDateTime > "
+ + DateTimes.toString(apiDateTime, timeZoneId);
+ //...
+ statementBuilder.where(statementPart);
+ DateTime.withZone(org.joda.time.DateTimeZone).dateTime - the date time to stringify into a new time zonenewZoneId - the time zone ID of the new zoneDateTime in yyyy-MM-dd'T'HH:mm:ssCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/Pql.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/Pql.html new file mode 100644 index 0000000000..eb187d0877 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/Pql.html @@ -0,0 +1,509 @@ + + + + + + +public final class Pql +extends Object+
+
+ ResultSet combinedResultSet = null
+ do {
+ ResultSet resultSet = pqlService.select(pagedStatement);
+ combinedResultSet = (combinedResultSet == null) ? resultSet :
+ Pql.combineResultSet(combinedResultSet, resultSet);
+ // ...
+ } while(!finishedCollectingResultSets)
+ //...
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ | Modifier and Type | +Method and Description | +
|---|---|
static com.google.api.ads.admanager.jaxws.v202308.ResultSet |
+combineResultSets(com.google.api.ads.admanager.jaxws.v202308.ResultSet first,
+ com.google.api.ads.admanager.jaxws.v202308.ResultSet second)
+Combines the first and second result sets, if and only if, the columns of both result sets
+ match.
+ |
+
static com.google.api.ads.admanager.jaxws.v202308.Value |
+createValue(Object value)
+Creates a
+Value from the value i.e. |
+
static Object |
+getApiValue(com.google.api.ads.admanager.jaxws.v202308.Value value)
+Gets the underlying value of the
+Value object that's comparable to what would be
+ returned in any other API object (i.e. |
+
static List<String> |
+getColumnLabels(com.google.api.ads.admanager.jaxws.v202308.ResultSet resultSet)
+Gets the column labels for the result set.
+ |
+
static Object |
+getCsvValue(com.google.api.ads.admanager.jaxws.v202308.Value value)
+Gets the underlying value of the
+Value object that should be used for CSV conversion
+ (i.e. |
+
static Object |
+getNativeValue(com.google.api.ads.admanager.jaxws.v202308.Value value)
+Gets the underlying value of the
+Value object that's considered native to Java (i.e. |
+
static List<String> |
+getRowStringValues(com.google.api.ads.admanager.jaxws.v202308.Row row)
+Gets the values in a row of the result set in the form of a string list.
+ |
+
static String |
+resultSetToString(com.google.api.ads.admanager.jaxws.v202308.ResultSet resultSet)
+Gets the result set as a table representation in the form of:
+ |
+
static List<String[]> |
+resultSetToStringArrayList(com.google.api.ads.admanager.jaxws.v202308.ResultSet resultSet)
+Gets the result set as list of string arrays, which can be transformed to a CSV using
+CsvFiles such as |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202308.Value value)
+Creates a String from the Value.
+ |
+
public static com.google.api.ads.admanager.jaxws.v202308.Value createValue(Object value)+
Value from the value i.e. a TextValue for a value of type String, BooleanValue for type Boolean, NumberValue for type Double, Long, or Integer, and DateTimeValue for type DateTime.
+ If the value is a Value, the value is returned. If the value is null, an empty
+ TextValue is returned.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static String toString(com.google.api.ads.admanager.jaxws.v202308.Value value)+
DateTimes.toString(Date) and DateTimes.toStringWithTimeZone(DateTime)
+ respectively.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static Object getApiValue(com.google.api.ads.admanager.jaxws.v202308.Value value)+
Value object that's comparable to what would be
+ returned in any other API object (i.e. DateTimeValue will return an API DateTime, not a Joda
+ DateTime).value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getNativeValue(com.google.api.ads.admanager.jaxws.v202308.Value value)+
Value object that's considered native to Java (i.e.
+ DateTimeValue will return a Joda DateTime, not an API DateTime and DateValue will return a
+ string in the form of "yyyy-MM-dd").value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getCsvValue(com.google.api.ads.admanager.jaxws.v202308.Value value)+
Value object that should be used for CSV conversion
+ (i.e. DateTimeValue will return a String representation, but NumberValue will return a Long or
+ Double).value - the value to convertValue or null if the underlying value is
+ nullIllegalArgumentException - if value cannot be convertedpublic static List<String[]> resultSetToStringArrayList(com.google.api.ads.admanager.jaxws.v202308.ResultSet resultSet)+
CsvFiles such as
+
+
+
+ ResultSet combinedResultSet = Pql.combineResultSet(resultSet1, resultSet2);
+ //...
+ combinedResultSet = Pql.combineResultSet(combinedResultSet, resultSet3);
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ resultSet - the result set to convert to a CSV compatible formatpublic static String resultSetToString(com.google.api.ads.admanager.jaxws.v202308.ResultSet resultSet) + throws IllegalAccessException+
+ +-------+-------+-------+ + |column1|column2|column3| + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ +
resultSet - the result set to display as a stringIllegalAccessException - if the values of the result set cannot be accessedpublic static List<String> getColumnLabels(com.google.api.ads.admanager.jaxws.v202308.ResultSet resultSet)+
resultSet - the result set to get the column labels forpublic static List<String> getRowStringValues(com.google.api.ads.admanager.jaxws.v202308.Row row)+
row - the row to get the values forpublic static com.google.api.ads.admanager.jaxws.v202308.ResultSet combineResultSets(com.google.api.ads.admanager.jaxws.v202308.ResultSet first, + com.google.api.ads.admanager.jaxws.v202308.ResultSet second)+
IllegalArgumentException - if the columns of the first result set don't match the secondCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/ReportDownloader.html new file mode 100644 index 0000000000..d6bc11ffb4 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/ReportDownloader.html @@ -0,0 +1,474 @@ + + + + + + +public class ReportDownloader +extends Object+
ReportServiceInterface.
+
+ There are two main functions of this class: + +
OutputStream
+ ReportUtils also provides the method whenReportReady(ReportCallback) to wait
+ for a scheduled report to finish processing before taking an action on the report through the
+ supplied ReportCallback.
| Modifier and Type | +Field and Description | +
|---|---|
static Charset |
+REPORT_CHARSET |
+
static int |
+SLEEP_TIMER
+The time to sleep before each request to the service.
+ |
+
| Constructor and Description | +
|---|
ReportDownloader(com.google.api.ads.admanager.jaxws.v202308.ReportServiceInterface reportService,
+ long reportJobId)
+Constructs a
+ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on. |
+
| Modifier and Type | +Method and Description | +
|---|---|
URL |
+getDownloadUrl(com.google.api.ads.admanager.jaxws.v202308.ReportDownloadOptions options)
+Gets the download URL for a GZip or plain-text format report.
+ |
+
com.google.common.io.CharSource |
+getReportAsCharSource(com.google.api.ads.admanager.jaxws.v202308.ReportDownloadOptions options)
+Returns a CharSource of report contents with
+ReportDownloadOptions. |
+
boolean |
+waitForReportReady()
+Blocks and waits for a report to be ready.
+ |
+
Thread |
+whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
public static final Charset REPORT_CHARSET+
public static final int SLEEP_TIMER+
public ReportDownloader(com.google.api.ads.admanager.jaxws.v202308.ReportServiceInterface reportService, + long reportJobId)+
ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.reportService - the ReportService stub to make calls toreportJobId - the report job IDpublic Thread whenReportReady(ReportCallback callback)+
ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ callback - the ReportCallback to call when the job has finished, successfully or
+ otherwiseThread.interrupt() can
+ be called on the returned thread to interrupt it.IllegalArgumentException - if callback == nullpublic boolean waitForReportReady() + throws InterruptedException, + com.google.api.ads.admanager.jaxws.v202308.ApiException_Exception+
ReportJobStatus is received that is
+ not ReportJobStatus#Pending or ReportJobStatus#InProgress, the report is
+ considered finished, and the method is returned with a true if the report was
+ successful, or an false if not.true if the report was successful, false otherwisecom.google.api.ads.admanager.jaxws.v202308.ApiException_Exception - if there was an error performing one of the SOAP callsInterruptedException - if the thread was interruptedpublic URL getDownloadUrl(com.google.api.ads.admanager.jaxws.v202308.ReportDownloadOptions options) + throws com.google.api.ads.admanager.jaxws.v202308.ApiException_Exception, + MalformedURLException+
+ URL url = new URL(reportDownloader.getDownloadUrl(options));
+ Resources.asByteSource(url).copyTo(Files.asByteSink(file));
+ options - the options to download the report withcom.google.api.ads.admanager.jaxws.v202308.ApiException_Exception - if there was an error performing any jaxws callMalformedURLException - if there is an error forming the download URLIllegalStateException - if the report is not ready to be downloadedpublic com.google.common.io.CharSource getReportAsCharSource(com.google.api.ads.admanager.jaxws.v202308.ReportDownloadOptions options) + throws IOException, + com.google.api.ads.admanager.jaxws.v202308.ApiException_Exception+
ReportDownloadOptions. The ExportFormat
+ must be string-based, such as ExportFormat.CSV_DUMP.options - the options to download the report withIOException - if there was an error performing any I/O action, including any SOAP callscom.google.api.ads.admanager.jaxws.v202308.ApiException_Exception - if there was any problem making the SOAP callIllegalStateException - if the report is not ready to be downloadedIllegalArgumentException - if the ExportFormat is not a string-based formatCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/StatementBuilder.html new file mode 100644 index 0000000000..5b438f82d8 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/StatementBuilder.html @@ -0,0 +1,545 @@ + + + + + + +public final class StatementBuilder +extends Object+
StatementBuilder allows for statements to be constructed in parts.
+
+ Typical usage is: + +
+ StatementBuilder statementBuilder = new StatementBuilder()
+ .where("lastModifiedDateTime > :yesterday AND type = :type")
+ .orderBy("name DESC")
+ .limit(200)
+ .offset(20)
+ .withBindVariableValue("yesterday",
+ DateTimes.fromDate(new org.joda.time.DateTime().minusDays(1).toDate()))
+ .withBindVariableValue("type", "Type")
+
+ Statement statement = statementBuilder.toStatement();
+ //...
+ statementBuilder.increaseOffsetBy(20);
+ statement = statementBuilder.toStatement();
+ | Modifier and Type | +Field and Description | +
|---|---|
static int |
+SUGGESTED_PAGE_LIMIT |
+
| Constructor and Description | +
|---|
StatementBuilder()
+Constructs a statement builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery() |
+
StatementBuilder |
+from(String table) |
+
Map<String,com.google.api.ads.admanager.jaxws.v202308.Value> |
+getBindVariableMap() |
+
Integer |
+getOffset() |
+
StatementBuilder |
+increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+limit(Integer count) |
+
StatementBuilder |
+offset(Integer count) |
+
StatementBuilder |
+orderBy(String orderBy) |
+
StatementBuilder |
+removeLimitAndOffset() |
+
StatementBuilder |
+select(String columns) |
+
com.google.api.ads.admanager.jaxws.v202308.Statement |
+toStatement()
+Gets the
+Statement representing the state of this statement builder. |
+
StatementBuilder |
+where(String conditions) |
+
StatementBuilder |
+withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+withBindVariableValue(String key,
+ com.google.api.ads.admanager.jaxws.v202308.Value value)
+Adds a bind variable value to the statement.
+ |
+
public static final int SUGGESTED_PAGE_LIMIT+
public StatementBuilder()+
@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + Object value)+
Pql.createValue(Object). If the value is of type Value, no conversion will be done.key - the value keyvalue - the bind variable value@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + com.google.api.ads.admanager.jaxws.v202308.Value value)+
key - the value keyvalue - the bind variable valuepublic com.google.api.ads.admanager.jaxws.v202308.Statement toStatement()+
Statement representing the state of this statement builder.Statement@CanIgnoreReturnValue +public StatementBuilder select(String columns)+
@CanIgnoreReturnValue +public StatementBuilder from(String table)+
@CanIgnoreReturnValue +public StatementBuilder where(String conditions)+
@CanIgnoreReturnValue +public StatementBuilder limit(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder offset(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder increaseOffsetBy(Integer amount)+
public Integer getOffset()+
@CanIgnoreReturnValue +public StatementBuilder removeLimitAndOffset()+
@CanIgnoreReturnValue +public StatementBuilder orderBy(String orderBy)+
public Map<String,com.google.api.ads.admanager.jaxws.v202308.Value> getBindVariableMap()+
public String buildQuery()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/DateTimes.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/DateTimes.html new file mode 100644 index 0000000000..a234131644 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/DateTimes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/Pql.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/Pql.html new file mode 100644 index 0000000000..d17348b30b --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/Pql.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/ReportDownloader.html new file mode 100644 index 0000000000..66c1b752e7 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/ReportDownloader.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/StatementBuilder.html new file mode 100644 index 0000000000..98d593997c --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/class-use/StatementBuilder.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.utils.v202308 | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
StatementBuilder |
+StatementBuilder.from(String table) |
+
StatementBuilder |
+StatementBuilder.increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+StatementBuilder.limit(Integer count) |
+
StatementBuilder |
+StatementBuilder.offset(Integer count) |
+
StatementBuilder |
+StatementBuilder.orderBy(String orderBy) |
+
StatementBuilder |
+StatementBuilder.removeLimitAndOffset() |
+
StatementBuilder |
+StatementBuilder.select(String columns) |
+
StatementBuilder |
+StatementBuilder.where(String conditions) |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ com.google.api.ads.admanager.jaxws.v202308.Value value)
+Adds a bind variable value to the statement.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/package-frame.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/package-frame.html new file mode 100644 index 0000000000..863acaeef3 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| DateTimes | +
+ A utility class for handling
+DateTime objects. |
+
| Pql | +
+ A utility class for handling PQL objects.
+ |
+
| ReportDownloader | +
+ Retrieves reports using a
+ReportServiceInterface. |
+
| StatementBuilder | +
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/package-tree.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/package-tree.html new file mode 100644 index 0000000000..776b36c995 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/package-tree.html @@ -0,0 +1,142 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/package-use.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/package-use.html new file mode 100644 index 0000000000..0b6b821e91 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202308/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.utils.v202308 | ++ |
| Class and Description | +
|---|
StatementBuilder
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/DateTimes.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/DateTimes.html new file mode 100644 index 0000000000..b4cff4b1d9 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/DateTimes.html @@ -0,0 +1,477 @@ + + + + + + +public final class DateTimes +extends Object+
DateTime objects.| Modifier and Type | +Method and Description | +
|---|---|
static Calendar |
+toCalendar(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime)
+Gets a calendar for a
+DateTime using the default locale, i.e. |
+
static Calendar |
+toCalendar(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime,
+ Locale locale)
+Gets a calendar for a
+DateTime in the supplied locale. |
+
static com.google.api.ads.admanager.jaxws.v202311.DateTime |
+toDateTime(Calendar calendar)
+Converts a
+Calendar object to an API date time preserving the time zone. |
+
static com.google.api.ads.admanager.jaxws.v202311.DateTime |
+toDateTime(org.joda.time.DateTime dateTime)
+Converts a
+DateTime object to an API date time preserving the time zone. |
+
static org.joda.time.DateTime |
+toDateTime(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime)
+Converts an API date time to a
+DateTime preserving the time zone. |
+
static com.google.api.ads.admanager.jaxws.v202311.DateTime |
+toDateTime(org.joda.time.Instant instant,
+ String timeZoneId)
+Converts an
+Instant object to an API date time in the time zone supplied. |
+
static com.google.api.ads.admanager.jaxws.v202311.DateTime |
+toDateTime(String dateTime,
+ String timeZoneId)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied. |
+
static com.google.api.ads.admanager.jaxws.v202311.DateTime |
+toDateTimeWithTimeZone(String dateTime)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied. |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202311.Date date)
+Returns string representation of this date.
+ |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime)
+Returns string representation of this date time.
+ |
+
static String |
+toStringForTimeZone(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime,
+ String newZoneId)
+Returns string representation of this date time with a different time zone, preserving the
+ millisecond instant.
+ |
+
static String |
+toStringWithTimeZone(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime)
+Returns string representation of this date time with time zone.
+ |
+
public static com.google.api.ads.admanager.jaxws.v202311.DateTime toDateTime(Calendar calendar)+
Calendar object to an API date time preserving the time zone.public static com.google.api.ads.admanager.jaxws.v202311.DateTime toDateTime(org.joda.time.Instant instant, + String timeZoneId)+
Instant object to an API date time in the time zone supplied.public static com.google.api.ads.admanager.jaxws.v202311.DateTime toDateTime(org.joda.time.DateTime dateTime)+
DateTime object to an API date time preserving the time zone.public static com.google.api.ads.admanager.jaxws.v202311.DateTime toDateTime(String dateTime, + String timeZoneId)+
yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.public static com.google.api.ads.admanager.jaxws.v202311.DateTime toDateTimeWithTimeZone(String dateTime)+
yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.public static org.joda.time.DateTime toDateTime(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime)+
DateTime preserving the time zone.public static Calendar toCalendar(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime)+
DateTime using the default locale, i.e. Locale.getDefault().public static Calendar toCalendar(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime, + Locale locale)+
DateTime in the supplied locale.public static String toString(com.google.api.ads.admanager.jaxws.v202311.Date date)+
date - the date to stringifyDate in yyyy-MM-ddpublic static String toString(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:sspublic static String toStringWithTimeZone(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime)+
toStringForTimeZone(DateTime, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm,
+ i.e. 2013-09-013T12:02:03+08:00 or 2013-09-013T12:02:03Z for Etc/GMT.public static String toStringForTimeZone(com.google.api.ads.admanager.jaxws.v202311.DateTime dateTime, + String newZoneId)+
This method is useful for finding the local time in another time zone, especially for + filtering. + +
For example, if this date time holds 12:30 in Europe/London, the result from this method + with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, + i.e. + +
String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
+ String statementPart =
+ "startDateTime > "
+ + DateTimes.toString(apiDateTime, timeZoneId);
+ //...
+ statementBuilder.where(statementPart);
+ DateTime.withZone(org.joda.time.DateTimeZone).dateTime - the date time to stringify into a new time zonenewZoneId - the time zone ID of the new zoneDateTime in yyyy-MM-dd'T'HH:mm:ssCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/Pql.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/Pql.html new file mode 100644 index 0000000000..69524f76e5 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/Pql.html @@ -0,0 +1,509 @@ + + + + + + +public final class Pql +extends Object+
+
+ ResultSet combinedResultSet = null
+ do {
+ ResultSet resultSet = pqlService.select(pagedStatement);
+ combinedResultSet = (combinedResultSet == null) ? resultSet :
+ Pql.combineResultSet(combinedResultSet, resultSet);
+ // ...
+ } while(!finishedCollectingResultSets)
+ //...
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ | Modifier and Type | +Method and Description | +
|---|---|
static com.google.api.ads.admanager.jaxws.v202311.ResultSet |
+combineResultSets(com.google.api.ads.admanager.jaxws.v202311.ResultSet first,
+ com.google.api.ads.admanager.jaxws.v202311.ResultSet second)
+Combines the first and second result sets, if and only if, the columns of both result sets
+ match.
+ |
+
static com.google.api.ads.admanager.jaxws.v202311.Value |
+createValue(Object value)
+Creates a
+Value from the value i.e. |
+
static Object |
+getApiValue(com.google.api.ads.admanager.jaxws.v202311.Value value)
+Gets the underlying value of the
+Value object that's comparable to what would be
+ returned in any other API object (i.e. |
+
static List<String> |
+getColumnLabels(com.google.api.ads.admanager.jaxws.v202311.ResultSet resultSet)
+Gets the column labels for the result set.
+ |
+
static Object |
+getCsvValue(com.google.api.ads.admanager.jaxws.v202311.Value value)
+Gets the underlying value of the
+Value object that should be used for CSV conversion
+ (i.e. |
+
static Object |
+getNativeValue(com.google.api.ads.admanager.jaxws.v202311.Value value)
+Gets the underlying value of the
+Value object that's considered native to Java (i.e. |
+
static List<String> |
+getRowStringValues(com.google.api.ads.admanager.jaxws.v202311.Row row)
+Gets the values in a row of the result set in the form of a string list.
+ |
+
static String |
+resultSetToString(com.google.api.ads.admanager.jaxws.v202311.ResultSet resultSet)
+Gets the result set as a table representation in the form of:
+ |
+
static List<String[]> |
+resultSetToStringArrayList(com.google.api.ads.admanager.jaxws.v202311.ResultSet resultSet)
+Gets the result set as list of string arrays, which can be transformed to a CSV using
+CsvFiles such as |
+
static String |
+toString(com.google.api.ads.admanager.jaxws.v202311.Value value)
+Creates a String from the Value.
+ |
+
public static com.google.api.ads.admanager.jaxws.v202311.Value createValue(Object value)+
Value from the value i.e. a TextValue for a value of type String, BooleanValue for type Boolean, NumberValue for type Double, Long, or Integer, and DateTimeValue for type DateTime.
+ If the value is a Value, the value is returned. If the value is null, an empty
+ TextValue is returned.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static String toString(com.google.api.ads.admanager.jaxws.v202311.Value value)+
DateTimes.toString(Date) and DateTimes.toStringWithTimeZone(DateTime)
+ respectively.value - the value to convertIllegalArgumentException - if value cannot be convertedpublic static Object getApiValue(com.google.api.ads.admanager.jaxws.v202311.Value value)+
Value object that's comparable to what would be
+ returned in any other API object (i.e. DateTimeValue will return an API DateTime, not a Joda
+ DateTime).value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getNativeValue(com.google.api.ads.admanager.jaxws.v202311.Value value)+
Value object that's considered native to Java (i.e.
+ DateTimeValue will return a Joda DateTime, not an API DateTime and DateValue will return a
+ string in the form of "yyyy-MM-dd").value - the value to convertValue or null if the underlying value is nullIllegalArgumentException - if value cannot be convertedpublic static Object getCsvValue(com.google.api.ads.admanager.jaxws.v202311.Value value)+
Value object that should be used for CSV conversion
+ (i.e. DateTimeValue will return a String representation, but NumberValue will return a Long or
+ Double).value - the value to convertValue or null if the underlying value is
+ nullIllegalArgumentException - if value cannot be convertedpublic static List<String[]> resultSetToStringArrayList(com.google.api.ads.admanager.jaxws.v202311.ResultSet resultSet)+
CsvFiles such as
+
+
+
+ ResultSet combinedResultSet = Pql.combineResultSet(resultSet1, resultSet2);
+ //...
+ combinedResultSet = Pql.combineResultSet(combinedResultSet, resultSet3);
+ CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
+
+ resultSet - the result set to convert to a CSV compatible formatpublic static String resultSetToString(com.google.api.ads.admanager.jaxws.v202311.ResultSet resultSet) + throws IllegalAccessException+
+ +-------+-------+-------+ + |column1|column2|column3| + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ + |value1 |value2 |value3 | + +-------+-------+-------+ +
resultSet - the result set to display as a stringIllegalAccessException - if the values of the result set cannot be accessedpublic static List<String> getColumnLabels(com.google.api.ads.admanager.jaxws.v202311.ResultSet resultSet)+
resultSet - the result set to get the column labels forpublic static List<String> getRowStringValues(com.google.api.ads.admanager.jaxws.v202311.Row row)+
row - the row to get the values forpublic static com.google.api.ads.admanager.jaxws.v202311.ResultSet combineResultSets(com.google.api.ads.admanager.jaxws.v202311.ResultSet first, + com.google.api.ads.admanager.jaxws.v202311.ResultSet second)+
IllegalArgumentException - if the columns of the first result set don't match the secondCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/ReportDownloader.html new file mode 100644 index 0000000000..1e55910e9a --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/ReportDownloader.html @@ -0,0 +1,474 @@ + + + + + + +public class ReportDownloader +extends Object+
ReportServiceInterface.
+
+ There are two main functions of this class: + +
OutputStream
+ ReportUtils also provides the method whenReportReady(ReportCallback) to wait
+ for a scheduled report to finish processing before taking an action on the report through the
+ supplied ReportCallback.
| Modifier and Type | +Field and Description | +
|---|---|
static Charset |
+REPORT_CHARSET |
+
static int |
+SLEEP_TIMER
+The time to sleep before each request to the service.
+ |
+
| Constructor and Description | +
|---|
ReportDownloader(com.google.api.ads.admanager.jaxws.v202311.ReportServiceInterface reportService,
+ long reportJobId)
+Constructs a
+ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on. |
+
| Modifier and Type | +Method and Description | +
|---|---|
URL |
+getDownloadUrl(com.google.api.ads.admanager.jaxws.v202311.ReportDownloadOptions options)
+Gets the download URL for a GZip or plain-text format report.
+ |
+
com.google.common.io.CharSource |
+getReportAsCharSource(com.google.api.ads.admanager.jaxws.v202311.ReportDownloadOptions options)
+Returns a CharSource of report contents with
+ReportDownloadOptions. |
+
boolean |
+waitForReportReady()
+Blocks and waits for a report to be ready.
+ |
+
Thread |
+whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
public static final Charset REPORT_CHARSET+
public static final int SLEEP_TIMER+
public ReportDownloader(com.google.api.ads.admanager.jaxws.v202311.ReportServiceInterface reportService, + long reportJobId)+
ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.reportService - the ReportService stub to make calls toreportJobId - the report job IDpublic Thread whenReportReady(ReportCallback callback)+
ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ callback - the ReportCallback to call when the job has finished, successfully or
+ otherwiseThread.interrupt() can
+ be called on the returned thread to interrupt it.IllegalArgumentException - if callback == nullpublic boolean waitForReportReady() + throws InterruptedException, + com.google.api.ads.admanager.jaxws.v202311.ApiException_Exception+
ReportJobStatus is received that is
+ not ReportJobStatus#Pending or ReportJobStatus#InProgress, the report is
+ considered finished, and the method is returned with a true if the report was
+ successful, or an false if not.true if the report was successful, false otherwisecom.google.api.ads.admanager.jaxws.v202311.ApiException_Exception - if there was an error performing one of the SOAP callsInterruptedException - if the thread was interruptedpublic URL getDownloadUrl(com.google.api.ads.admanager.jaxws.v202311.ReportDownloadOptions options) + throws com.google.api.ads.admanager.jaxws.v202311.ApiException_Exception, + MalformedURLException+
+ URL url = new URL(reportDownloader.getDownloadUrl(options));
+ Resources.asByteSource(url).copyTo(Files.asByteSink(file));
+ options - the options to download the report withcom.google.api.ads.admanager.jaxws.v202311.ApiException_Exception - if there was an error performing any jaxws callMalformedURLException - if there is an error forming the download URLIllegalStateException - if the report is not ready to be downloadedpublic com.google.common.io.CharSource getReportAsCharSource(com.google.api.ads.admanager.jaxws.v202311.ReportDownloadOptions options) + throws IOException, + com.google.api.ads.admanager.jaxws.v202311.ApiException_Exception+
ReportDownloadOptions. The ExportFormat
+ must be string-based, such as ExportFormat.CSV_DUMP.options - the options to download the report withIOException - if there was an error performing any I/O action, including any SOAP callscom.google.api.ads.admanager.jaxws.v202311.ApiException_Exception - if there was any problem making the SOAP callIllegalStateException - if the report is not ready to be downloadedIllegalArgumentException - if the ExportFormat is not a string-based formatCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/StatementBuilder.html new file mode 100644 index 0000000000..c15bafdeeb --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/StatementBuilder.html @@ -0,0 +1,545 @@ + + + + + + +public final class StatementBuilder +extends Object+
StatementBuilder allows for statements to be constructed in parts.
+
+ Typical usage is: + +
+ StatementBuilder statementBuilder = new StatementBuilder()
+ .where("lastModifiedDateTime > :yesterday AND type = :type")
+ .orderBy("name DESC")
+ .limit(200)
+ .offset(20)
+ .withBindVariableValue("yesterday",
+ DateTimes.fromDate(new org.joda.time.DateTime().minusDays(1).toDate()))
+ .withBindVariableValue("type", "Type")
+
+ Statement statement = statementBuilder.toStatement();
+ //...
+ statementBuilder.increaseOffsetBy(20);
+ statement = statementBuilder.toStatement();
+ | Modifier and Type | +Field and Description | +
|---|---|
static int |
+SUGGESTED_PAGE_LIMIT |
+
| Constructor and Description | +
|---|
StatementBuilder()
+Constructs a statement builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery() |
+
StatementBuilder |
+from(String table) |
+
Map<String,com.google.api.ads.admanager.jaxws.v202311.Value> |
+getBindVariableMap() |
+
Integer |
+getOffset() |
+
StatementBuilder |
+increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+limit(Integer count) |
+
StatementBuilder |
+offset(Integer count) |
+
StatementBuilder |
+orderBy(String orderBy) |
+
StatementBuilder |
+removeLimitAndOffset() |
+
StatementBuilder |
+select(String columns) |
+
com.google.api.ads.admanager.jaxws.v202311.Statement |
+toStatement()
+Gets the
+Statement representing the state of this statement builder. |
+
StatementBuilder |
+where(String conditions) |
+
StatementBuilder |
+withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+withBindVariableValue(String key,
+ com.google.api.ads.admanager.jaxws.v202311.Value value)
+Adds a bind variable value to the statement.
+ |
+
public static final int SUGGESTED_PAGE_LIMIT+
public StatementBuilder()+
@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + Object value)+
Pql.createValue(Object). If the value is of type Value, no conversion will be done.key - the value keyvalue - the bind variable value@CanIgnoreReturnValue +public StatementBuilder withBindVariableValue(String key, + com.google.api.ads.admanager.jaxws.v202311.Value value)+
key - the value keyvalue - the bind variable valuepublic com.google.api.ads.admanager.jaxws.v202311.Statement toStatement()+
Statement representing the state of this statement builder.Statement@CanIgnoreReturnValue +public StatementBuilder select(String columns)+
@CanIgnoreReturnValue +public StatementBuilder from(String table)+
@CanIgnoreReturnValue +public StatementBuilder where(String conditions)+
@CanIgnoreReturnValue +public StatementBuilder limit(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder offset(Integer count)+
@CanIgnoreReturnValue +public StatementBuilder increaseOffsetBy(Integer amount)+
public Integer getOffset()+
@CanIgnoreReturnValue +public StatementBuilder removeLimitAndOffset()+
@CanIgnoreReturnValue +public StatementBuilder orderBy(String orderBy)+
public Map<String,com.google.api.ads.admanager.jaxws.v202311.Value> getBindVariableMap()+
public String buildQuery()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/DateTimes.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/DateTimes.html new file mode 100644 index 0000000000..31a2d4940f --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/DateTimes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/Pql.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/Pql.html new file mode 100644 index 0000000000..232ed8de07 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/Pql.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/ReportDownloader.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/ReportDownloader.html new file mode 100644 index 0000000000..9d16af1656 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/ReportDownloader.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/StatementBuilder.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/StatementBuilder.html new file mode 100644 index 0000000000..d8480e0bc5 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/class-use/StatementBuilder.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.utils.v202311 | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
StatementBuilder |
+StatementBuilder.from(String table) |
+
StatementBuilder |
+StatementBuilder.increaseOffsetBy(Integer amount) |
+
StatementBuilder |
+StatementBuilder.limit(Integer count) |
+
StatementBuilder |
+StatementBuilder.offset(Integer count) |
+
StatementBuilder |
+StatementBuilder.orderBy(String orderBy) |
+
StatementBuilder |
+StatementBuilder.removeLimitAndOffset() |
+
StatementBuilder |
+StatementBuilder.select(String columns) |
+
StatementBuilder |
+StatementBuilder.where(String conditions) |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ Object value)
+Adds a bind variable value to the statement.
+ |
+
StatementBuilder |
+StatementBuilder.withBindVariableValue(String key,
+ com.google.api.ads.admanager.jaxws.v202311.Value value)
+Adds a bind variable value to the statement.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/package-frame.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/package-frame.html new file mode 100644 index 0000000000..0bbf9491c1 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| DateTimes | +
+ A utility class for handling
+DateTime objects. |
+
| Pql | +
+ A utility class for handling PQL objects.
+ |
+
| ReportDownloader | +
+ Retrieves reports using a
+ReportServiceInterface. |
+
| StatementBuilder | +
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/package-tree.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/package-tree.html new file mode 100644 index 0000000000..e50f99d34c --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/package-tree.html @@ -0,0 +1,142 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/package-use.html b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/package-use.html new file mode 100644 index 0000000000..4206fc67cc --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/jaxws/utils/v202311/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.utils.v202311 | ++ |
| Class and Description | +
|---|
StatementBuilder
+StatementBuilder allows for statements to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/AdManagerModule.html b/5.3.0/com/google/api/ads/admanager/lib/AdManagerModule.html new file mode 100644 index 0000000000..6b72c48865 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/AdManagerModule.html @@ -0,0 +1,310 @@ + + + + + + +public class AdManagerModule +extends AdsModule+
| Constructor and Description | +
|---|
AdManagerModule() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure()
+Configure common Guice bindings.
+ |
+
configureLoggingaddError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/AdManagerProductFrameworkModule.html b/5.3.0/com/google/api/ads/admanager/lib/AdManagerProductFrameworkModule.html new file mode 100644 index 0000000000..d1cc3cf232 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/AdManagerProductFrameworkModule.html @@ -0,0 +1,169 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/AdManagerSoapModule.html b/5.3.0/com/google/api/ads/admanager/lib/AdManagerSoapModule.html new file mode 100644 index 0000000000..2879ad21d5 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/AdManagerSoapModule.html @@ -0,0 +1,306 @@ + + + + + + +public class AdManagerSoapModule +extends AdsSoapModule<AdManagerServiceClient,AdManagerServiceDescriptor,AdManagerSession>+
| Constructor and Description | +
|---|
AdManagerSoapModule() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure() |
+
configureFactoriesaddError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingprotected void configure()+
configure in class AdsSoapModule<AdManagerServiceClient,AdManagerServiceDescriptor,AdManagerSession>Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/class-use/AdManagerModule.html b/5.3.0/com/google/api/ads/admanager/lib/class-use/AdManagerModule.html new file mode 100644 index 0000000000..d55fbceba8 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/class-use/AdManagerModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/class-use/AdManagerProductFrameworkModule.html b/5.3.0/com/google/api/ads/admanager/lib/class-use/AdManagerProductFrameworkModule.html new file mode 100644 index 0000000000..5a661eb0b8 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/class-use/AdManagerProductFrameworkModule.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerAxisModule
+Guice module to bind Ad Manager's SOAP header handler to an Axis-friendly implementation.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerJaxWsModule
+Guice module to bind Ad Manager's SOAP header handler to a JAX-WS-friendly implementation.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/class-use/AdManagerSoapModule.html b/5.3.0/com/google/api/ads/admanager/lib/class-use/AdManagerSoapModule.html new file mode 100644 index 0000000000..9b367b93a0 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/class-use/AdManagerSoapModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerServiceClient.html b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerServiceClient.html new file mode 100644 index 0000000000..bb9f5ff982 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerServiceClient.html @@ -0,0 +1,343 @@ + + + + + + +public class AdManagerServiceClient +extends AdsServiceClient<AdManagerSession,AdManagerServiceDescriptor>+
| Constructor and Description | +
|---|
AdManagerServiceClient(Object soapClient,
+ AdManagerServiceDescriptor adManagerServiceDescriptor,
+ AdManagerSession adManagerSession,
+ SoapClientHandlerInterface soapClientHandler,
+ HeaderHandler<AdManagerSession,AdManagerServiceDescriptor> adManagerHeaderHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected Throwable |
+handleException(Throwable e)
+Handles the exception.
+ |
+
getAdsServiceDescriptor, getAdsSession, logSoapCall, setAdsSession, setHeaderscallSoapClient, createSoapCall, getSoapClient, getSoapClientHandler, invoke, setEndpointAddress, unwrapRemoteCallReturn@Inject +public AdManagerServiceClient(Object soapClient, + AdManagerServiceDescriptor adManagerServiceDescriptor, + AdManagerSession adManagerSession, + SoapClientHandlerInterface soapClientHandler, + HeaderHandler<AdManagerSession,AdManagerServiceDescriptor> adManagerHeaderHandler, + AdsServiceLoggers adsServiceLoggers)+
soapClient - the SOAP clientadManagerServiceDescriptor - the Ad Manager service descriptoradManagerSession - the Ad Manager sessionsoapClientHandler - the SOAP client handleradManagerHeaderHandler - the Ad Manager header handleradsServiceLoggers - the ads service loggersprotected Throwable handleException(Throwable e)+
SoapServiceClient+ Default behavior is to return the exception unchanged. +
handleException in class SoapServiceClient<Object>e - the exception to handleSoapServiceClient.handleException(java.lang.Throwable)Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerServiceDescriptor.html b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerServiceDescriptor.html new file mode 100644 index 0000000000..1104e5e0ee --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerServiceDescriptor.html @@ -0,0 +1,422 @@ + + + + + + +public class AdManagerServiceDescriptor +extends Object +implements AdsServiceDescriptor, AxisCompatible, JaxWsCompatible+
AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection.| Constructor and Description | +
|---|
AdManagerServiceDescriptor(Class<?> interfaceClass,
+ String version)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getEndpointAddress(String endpointServer)
+Gets the endpoint address for this service and server.
+ |
+
Class<?> |
+getInterfaceClass()
+Gets the class representing the RPC interface of the service.
+ |
+
Class<?> |
+getLocatorClass()
+Gets the Axis locator class such that it can be instantiated to create
+ an Axis service client.
+ |
+
Class<?> |
+getServiceClass()
+Gets the JAX-WS service class such that it can be instantiated to create
+ an JAX-WS service client.
+ |
+
String |
+getVersion()
+Gets the version for this service.
+ |
+
@Inject +public AdManagerServiceDescriptor(Class<?> interfaceClass, + String version)+
interfaceClass - the Class<?> object of the requested interfaceClassversion - the version of the servicepublic Class<?> getInterfaceClass() + throws ServiceException+
AdsServiceDescriptorgetInterfaceClass in interface AdsServiceDescriptorgetInterfaceClass in interface SoapServiceDescriptorServiceException - if the interface could not be retrieved.AdsServiceDescriptor.getInterfaceClass()public String getEndpointAddress(String endpointServer) + throws MalformedURLException+
AdsServiceDescriptorgetEndpointAddress in interface AdsServiceDescriptorgetEndpointAddress in interface SoapServiceDescriptorMalformedURLExceptionAdsServiceDescriptor.getEndpointAddress(String)public String getVersion()+
AdsServiceDescriptorgetVersion in interface AdsServiceDescriptorAdsServiceDescriptor.getVersion()public Class<?> getLocatorClass() + throws ClassNotFoundException+
AxisCompatiblegetLocatorClass in interface AxisCompatibleClassNotFoundException - if no locator class can be foundAxisCompatible.getLocatorClass()public Class<?> getServiceClass() + throws ClassNotFoundException+
JaxWsCompatiblegetServiceClass in interface JaxWsCompatibleClassNotFoundException - if no service class can be foundJaxWsCompatible.getServiceClass()Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerSession.Builder.html b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerSession.Builder.html new file mode 100644 index 0000000000..a02aaba715 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerSession.Builder.html @@ -0,0 +1,568 @@ + + + + + + +public static class AdManagerSession.Builder +extends Object +implements Builder<AdManagerSession>+
AdManagerSession.
+
+ Implementation is not thread-safe.
DEFAULT_CONFIGURATION_FILENAME| Constructor and Description | +
|---|
Builder()
+Constructs an empty builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
AdManagerSession |
+build()
+Builds the
+AdManagerSession. |
+
AdManagerSession.ImmutableAdManagerSession |
+buildImmutable()
+Builds a thread-safe
+AdManagerSession.ImmutableAdManagerSession. |
+
AdManagerSession.Builder |
+from(org.apache.commons.configuration.Configuration config)
+Reads properties from the provided
+Configuration object.+ + Known properties: + + + api.admanager.applicationName + api.admanager.networkCode + api.admanager.endpoint + |
+
AdManagerSession.Builder |
+fromFile()
+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
+ |
+
AdManagerSession.Builder |
+fromFile(File path)
+Populates this builder from a properties file from a specified path.
+ |
+
AdManagerSession.Builder |
+fromFile(String path)
+Populates this builder from a properties file from a specified path.
+ |
+
AdManagerSession.Builder |
+fromFile(URL path)
+Populates this builder from a properties file from a specified path.
+ |
+
AdManagerSession.Builder |
+withApplicationName(String applicationName)
+Includes application name (any string of your choice).
+ |
+
AdManagerSession.Builder |
+withEndpoint(String endpoint)
+Override the endpoint server.
+ |
+
AdManagerSession.Builder |
+withNetworkCode(String networkCode)
+Includes network code.
+ |
+
AdManagerSession.Builder |
+withOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential)
+Includes OAuth2 credential to be used for OAuth2 authentication.
+ |
+
public Builder()+
AdManagerSession, use AdManagerSession.newBuilder() instead.public AdManagerSession.Builder fromFile() + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<AdManagerSession>com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.public AdManagerSession.Builder fromFile(String path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<AdManagerSession>path - the path to try first as a resource, then as a filecom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.public AdManagerSession.Builder fromFile(File path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<AdManagerSession>path - the path to load properties fromcom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.public AdManagerSession.Builder fromFile(URL path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<AdManagerSession>path - the path to try first as a resource, then as a filecom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.@CanIgnoreReturnValue +public AdManagerSession.Builder from(org.apache.commons.configuration.Configuration config)+
Configuration object.from in interface Builder<AdManagerSession>config - the configuration@CanIgnoreReturnValue +public AdManagerSession.Builder withOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential)+
@CanIgnoreReturnValue +public AdManagerSession.Builder withNetworkCode(String networkCode)+
@CanIgnoreReturnValue +public AdManagerSession.Builder withApplicationName(String applicationName)+
@CanIgnoreReturnValue +public AdManagerSession.Builder withEndpoint(String endpoint)+
public AdManagerSession build() + throws ValidationException+
AdManagerSession.build in interface Builder<AdManagerSession>AdManagerSessionValidationException - if the AdManagerSession did not validatepublic AdManagerSession.ImmutableAdManagerSession buildImmutable() + throws ValidationException+
AdManagerSession.ImmutableAdManagerSession.ImmutableAdManagerSessionValidationException - if the attributes of this builder fail validationCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerSession.ImmutableAdManagerSession.html b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerSession.ImmutableAdManagerSession.html new file mode 100644 index 0000000000..37f69eb574 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerSession.ImmutableAdManagerSession.html @@ -0,0 +1,321 @@ + + + + + + +@ThreadSafe +public static final class AdManagerSession.ImmutableAdManagerSession +extends AdManagerSession+
AdManagerSession.Builder, AdManagerSession.ImmutableAdManagerSessionDEFAULT_ENDPOINT| Modifier and Type | +Method and Description | +
|---|---|
void |
+setNetworkCode(String networkCode)
+Sets the network code.
+ |
+
void |
+setOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential)
+Sets the OAuth2 credential.
+ |
+
getApplicationName, getEndpoint, getNetworkCode, getOAuth2Credential, newBuilderpublic void setOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential)+
AdManagerSessionsetOAuth2Credential in class AdManagerSessionpublic void setNetworkCode(String networkCode)+
AdManagerSessionsetNetworkCode in class AdManagerSessionCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerSession.html b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerSession.html new file mode 100644 index 0000000000..98d95028e0 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/AdManagerSession.html @@ -0,0 +1,427 @@ + + + + + + +public class AdManagerSession +extends Object +implements AdsSession, OAuth2Compatible+
AdManagerSession represents a single session of Ad Manager use.
+
+ Implementation is not thread-safe.
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+AdManagerSession.Builder
+Builder for
+AdManagerSession. |
+
static class |
+AdManagerSession.ImmutableAdManagerSession
+Immutable, thread-safe implementation of AdManagerSession.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static String |
+DEFAULT_ENDPOINT |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getApplicationName()
+Gets the application name.
+ |
+
String |
+getEndpoint()
+Gets the endpoint.
+ |
+
String |
+getNetworkCode()
+Gets the network code.
+ |
+
com.google.api.client.auth.oauth2.Credential |
+getOAuth2Credential()
+Gets the OAuth2 credentials.
+ |
+
AdManagerSession.Builder |
+newBuilder()
+Returns a new
+AdManagerSession.Builder with all settings copied from this session. |
+
void |
+setNetworkCode(String networkCode)
+Sets the network code.
+ |
+
void |
+setOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential)
+Sets the OAuth2 credential.
+ |
+
public static final String DEFAULT_ENDPOINT+
public String getApplicationName()+
public com.google.api.client.auth.oauth2.Credential getOAuth2Credential()+
getOAuth2Credential in interface OAuth2Compatiblepublic void setOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential)+
public String getEndpoint()+
getEndpoint in interface AdsSessionpublic String getNetworkCode()+
public void setNetworkCode(String networkCode)+
public AdManagerSession.Builder newBuilder()+
AdManagerSession.Builder with all settings copied from this session. This is not
+ thread-safe unless this session is an AdManagerSession.ImmutableAdManagerSession.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerServiceClient.html b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerServiceClient.html new file mode 100644 index 0000000000..e669e2cca8 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerServiceClient.html @@ -0,0 +1,169 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| Constructor and Description | +
|---|
AdManagerServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<AdManagerServiceDescriptor> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface soapClientHandler,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerServiceDescriptor.html b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerServiceDescriptor.html new file mode 100644 index 0000000000..6f9f1bf9df --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerServiceDescriptor.html @@ -0,0 +1,270 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdManagerAxisHeaderHandler.setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdManagerJaxWsHeaderHandler.setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor) |
+
| Constructor and Description | +
|---|
AdManagerServiceClient(Object soapClient,
+ AdManagerServiceDescriptor adManagerServiceDescriptor,
+ AdManagerSession adManagerSession,
+ SoapClientHandlerInterface soapClientHandler,
+ HeaderHandler<AdManagerSession,AdManagerServiceDescriptor> adManagerHeaderHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdManagerServiceClient(Object soapClient,
+ AdManagerServiceDescriptor adManagerServiceDescriptor,
+ AdManagerSession adManagerSession,
+ SoapClientHandlerInterface soapClientHandler,
+ HeaderHandler<AdManagerSession,AdManagerServiceDescriptor> adManagerHeaderHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerSession.Builder.html b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerSession.Builder.html new file mode 100644 index 0000000000..cfc5caba8b --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerSession.Builder.html @@ -0,0 +1,222 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
AdManagerSession.Builder |
+AdManagerSession.Builder.from(org.apache.commons.configuration.Configuration config)
+Reads properties from the provided
+Configuration object.+ + Known properties: + + + api.admanager.applicationName + api.admanager.networkCode + api.admanager.endpoint + |
+
AdManagerSession.Builder |
+AdManagerSession.Builder.fromFile() |
+
AdManagerSession.Builder |
+AdManagerSession.Builder.fromFile(File path) |
+
AdManagerSession.Builder |
+AdManagerSession.Builder.fromFile(String path) |
+
AdManagerSession.Builder |
+AdManagerSession.Builder.fromFile(URL path) |
+
AdManagerSession.Builder |
+AdManagerSession.newBuilder()
+Returns a new
+AdManagerSession.Builder with all settings copied from this session. |
+
AdManagerSession.Builder |
+AdManagerSession.Builder.withApplicationName(String applicationName)
+Includes application name (any string of your choice).
+ |
+
AdManagerSession.Builder |
+AdManagerSession.Builder.withEndpoint(String endpoint)
+Override the endpoint server.
+ |
+
AdManagerSession.Builder |
+AdManagerSession.Builder.withNetworkCode(String networkCode)
+Includes network code.
+ |
+
AdManagerSession.Builder |
+AdManagerSession.Builder.withOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential)
+Includes OAuth2 credential to be used for OAuth2 authentication.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerSession.ImmutableAdManagerSession.html b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerSession.ImmutableAdManagerSession.html new file mode 100644 index 0000000000..28b3c2724b --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerSession.ImmutableAdManagerSession.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
AdManagerSession.ImmutableAdManagerSession |
+AdManagerSession.Builder.buildImmutable()
+Builds a thread-safe
+AdManagerSession.ImmutableAdManagerSession. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerSession.html b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerSession.html new file mode 100644 index 0000000000..c659d512fd --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/class-use/AdManagerSession.html @@ -0,0 +1,317 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| com.google.api.ads.admanager.lib.soap | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdManagerAxisHeaderHandler.setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdManagerJaxWsHeaderHandler.setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor) |
+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+AdManagerSession.ImmutableAdManagerSession
+Immutable, thread-safe implementation of AdManagerSession.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
AdManagerSession |
+AdManagerSession.Builder.build()
+Builds the
+AdManagerSession. |
+
| Constructor and Description | +
|---|
AdManagerServiceClient(Object soapClient,
+ AdManagerServiceDescriptor adManagerServiceDescriptor,
+ AdManagerSession adManagerSession,
+ SoapClientHandlerInterface soapClientHandler,
+ HeaderHandler<AdManagerSession,AdManagerServiceDescriptor> adManagerHeaderHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdManagerServiceClient(Object soapClient,
+ AdManagerServiceDescriptor adManagerServiceDescriptor,
+ AdManagerSession adManagerSession,
+ SoapClientHandlerInterface soapClientHandler,
+ HeaderHandler<AdManagerSession,AdManagerServiceDescriptor> adManagerHeaderHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdManagerServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<AdManagerServiceDescriptor> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface soapClientHandler,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdManagerHttpHeaderHandler.setHttpHeaders(Object soapClient,
+ AdManagerSession adManagerSession)
+Sets the HTTP headers on the SOAP client.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/package-frame.html b/5.3.0/com/google/api/ads/admanager/lib/client/package-frame.html new file mode 100644 index 0000000000..787f13c6dc --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +| Class | +Description | +
|---|---|
| AdManagerServiceClient | +
+ Wrapper of underlying SOAP client which allows access for setting headers retrieved from the
+ session.
+ |
+
| AdManagerServiceDescriptor | +
+AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection. |
+
| AdManagerSession | +
+ A
+AdManagerSession represents a single session of Ad Manager use. |
+
| AdManagerSession.Builder | +
+ Builder for
+AdManagerSession. |
+
| AdManagerSession.ImmutableAdManagerSession | +
+ Immutable, thread-safe implementation of AdManagerSession.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/package-tree.html b/5.3.0/com/google/api/ads/admanager/lib/client/package-tree.html new file mode 100644 index 0000000000..4deb952823 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/package-tree.html @@ -0,0 +1,154 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/client/package-use.html b/5.3.0/com/google/api/ads/admanager/lib/client/package-use.html new file mode 100644 index 0000000000..ebce70c719 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/client/package-use.html @@ -0,0 +1,285 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| com.google.api.ads.admanager.lib.soap | ++ |
| Class and Description | +
|---|
AdManagerServiceDescriptor
+AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection. |
+
| AdManagerSession
+ A
+AdManagerSession represents a single session of Ad Manager use. |
+
| Class and Description | +
|---|
AdManagerServiceDescriptor
+AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection. |
+
| AdManagerSession
+ A
+AdManagerSession represents a single session of Ad Manager use. |
+
| Class and Description | +
|---|
AdManagerServiceDescriptor
+AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection. |
+
| AdManagerSession
+ A
+AdManagerSession represents a single session of Ad Manager use. |
+
| AdManagerSession.Builder
+ Builder for
+AdManagerSession. |
+
| AdManagerSession.ImmutableAdManagerSession
+ Immutable, thread-safe implementation of AdManagerSession.
+ |
+
| Class and Description | +
|---|
| AdManagerServiceClient
+ Wrapper of underlying SOAP client which allows access for setting headers retrieved from the
+ session.
+ |
+
AdManagerServiceDescriptor
+AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection. |
+
| AdManagerSession
+ A
+AdManagerSession represents a single session of Ad Manager use. |
+
| Class and Description | +
|---|
| AdManagerSession
+ A
+AdManagerSession represents a single session of Ad Manager use. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/AdManagerServiceClientFactory.html b/5.3.0/com/google/api/ads/admanager/lib/factory/AdManagerServiceClientFactory.html new file mode 100644 index 0000000000..5c4fca4cad --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/AdManagerServiceClientFactory.html @@ -0,0 +1,282 @@ + + + + + + +public class AdManagerServiceClientFactory +extends BaseAdsServiceClientFactory<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor>+
| Constructor and Description | +
|---|
AdManagerServiceClientFactory(com.google.inject.AbstractModule module)
+Deprecated.
+
+
+ |
+
AdManagerServiceClientFactory(com.google.inject.Injector injector)
+Constructor.
+ |
+
getServiceClientAsInterfacepublic AdManagerServiceClientFactory(com.google.inject.Injector injector)+
injector - an injector which binds all the necessary classes@Deprecated +public AdManagerServiceClientFactory(com.google.inject.AbstractModule module)+
AdManagerServiceClientFactory(Injector)module - the module used for binding.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/AdManagerServicesInterface.html b/5.3.0/com/google/api/ads/admanager/lib/factory/AdManagerServicesInterface.html new file mode 100644 index 0000000000..d830647493 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/AdManagerServicesInterface.html @@ -0,0 +1,200 @@ + + + + + + +public interface AdManagerServicesInterface +extends AdsServicesInterface<AdManagerSession>+
getCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/BaseAdManagerServices.html b/5.3.0/com/google/api/ads/admanager/lib/factory/BaseAdManagerServices.html new file mode 100644 index 0000000000..a7248f8adf --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/BaseAdManagerServices.html @@ -0,0 +1,277 @@ + + + + + + +public abstract class BaseAdManagerServices +extends BaseServices<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor> +implements AdManagerServicesInterface+
| Modifier | +Constructor and Description | +
|---|---|
protected |
+BaseAdManagerServices(com.google.inject.Injector injector)
+Constructor.
+ |
+
getclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/class-use/AdManagerServiceClientFactory.html b/5.3.0/com/google/api/ads/admanager/lib/factory/class-use/AdManagerServiceClientFactory.html new file mode 100644 index 0000000000..77b8738c7c --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/class-use/AdManagerServiceClientFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/class-use/AdManagerServicesInterface.html b/5.3.0/com/google/api/ads/admanager/lib/factory/class-use/AdManagerServicesInterface.html new file mode 100644 index 0000000000..be3f166578 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/class-use/AdManagerServicesInterface.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.factory | ++ |
| com.google.api.ads.admanager.lib.factory | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServices
+Utility class to create Ad Manager service clients.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BaseAdManagerServices
+Base for a utility class which creates Ad Manager service clients.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/class-use/BaseAdManagerServices.html b/5.3.0/com/google/api/ads/admanager/lib/factory/class-use/BaseAdManagerServices.html new file mode 100644 index 0000000000..0b3f3ebaf1 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/class-use/BaseAdManagerServices.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.factory | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServices
+Utility class to create Ad Manager service clients.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/helper/AdManagerServiceClientFactoryHelper.html b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/AdManagerServiceClientFactoryHelper.html new file mode 100644 index 0000000000..118c9abcf5 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/AdManagerServiceClientFactoryHelper.html @@ -0,0 +1,319 @@ + + + + + + +public class AdManagerServiceClientFactoryHelper +extends BaseAdsServiceClientFactoryHelper<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor>+
| Constructor and Description | +
|---|
AdManagerServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<AdManagerServiceDescriptor> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface soapClientHandler,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+determineVersion(Class<?> interfaceClass)
+Determines what API version an ads service belongs to.
+ |
+
checkServiceClientPreconditions, createAdsServiceClient, createServiceDescriptor@Inject +public AdManagerServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor> adsServiceClientFactory, + FactoryModule.AdsServiceDescriptorFactoryInterface<AdManagerServiceDescriptor> adsServiceDescriptorFactory, + SoapClientHandlerInterface soapClientHandler, + com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration)+
adsServiceClientFactory - the ads service client factoryadsServiceDescriptorFactory - the ads service descriptor factorysoapClientHandler - the SOAP client handleradsLibConfiguration - the lib configurationpublic String determineVersion(Class<?> interfaceClass)+
AdsServiceClientFactoryHelperinterfaceClass - the interface class of the serviceAdsServiceClientFactoryHelper.determineVersion(Class)Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/helper/class-use/AdManagerServiceClientFactoryHelper.html b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/class-use/AdManagerServiceClientFactoryHelper.html new file mode 100644 index 0000000000..365a1df36b --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/class-use/AdManagerServiceClientFactoryHelper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/helper/package-frame.html b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/package-frame.html new file mode 100644 index 0000000000..59e257a641 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| AdManagerServiceClientFactoryHelper | +
+ Factory helper for Ad Manager.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/helper/package-tree.html b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/package-tree.html new file mode 100644 index 0000000000..377078c366 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/package-tree.html @@ -0,0 +1,143 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/helper/package-use.html b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/package-use.html new file mode 100644 index 0000000000..9409d94cc6 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/helper/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/package-frame.html b/5.3.0/com/google/api/ads/admanager/lib/factory/package-frame.html new file mode 100644 index 0000000000..37d256fcc6 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +| Interface | +Description | +
|---|---|
| AdManagerServicesInterface | +
+ Factory for Ad Manager API services.
+ |
+
| Class | +Description | +
|---|---|
| AdManagerServiceClientFactory | +
+ Factory which creates Ad Manager service clients.
+ |
+
| BaseAdManagerServices | +
+ Base for a utility class which creates Ad Manager service clients.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/package-tree.html b/5.3.0/com/google/api/ads/admanager/lib/factory/package-tree.html new file mode 100644 index 0000000000..c8e487b74f --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/package-tree.html @@ -0,0 +1,156 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/factory/package-use.html b/5.3.0/com/google/api/ads/admanager/lib/factory/package-use.html new file mode 100644 index 0000000000..ea3150e4d7 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/factory/package-use.html @@ -0,0 +1,187 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.factory | ++ |
| com.google.api.ads.admanager.lib.factory | ++ |
| Class and Description | +
|---|
| AdManagerServicesInterface
+ Factory for Ad Manager API services.
+ |
+
| BaseAdManagerServices
+ Base for a utility class which creates Ad Manager service clients.
+ |
+
| Class and Description | +
|---|
| AdManagerServicesInterface
+ Factory for Ad Manager API services.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/package-frame.html b/5.3.0/com/google/api/ads/admanager/lib/package-frame.html new file mode 100644 index 0000000000..7e69b8acba --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +| Class | +Description | +
|---|---|
| AdManagerModule | +
+ Guice module for Ad Manager bindings.
+ |
+
| AdManagerSoapModule | +
+ Guice module for Ad Manager SOAP bindings.
+ |
+
| Annotation Type | +Description | +
|---|---|
| AdManagerProductFrameworkModule | +
+ A simple marker annotation used to specify a Guice module that can tie the Ad Manager library to
+ a SOAP framework.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/package-tree.html b/5.3.0/com/google/api/ads/admanager/lib/package-tree.html new file mode 100644 index 0000000000..9445c31bb8 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/package-tree.html @@ -0,0 +1,156 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/package-use.html b/5.3.0/com/google/api/ads/admanager/lib/package-use.html new file mode 100644 index 0000000000..9cdd0d0aa1 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/package-use.html @@ -0,0 +1,184 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| Class and Description | +
|---|
| AdManagerProductFrameworkModule
+ A simple marker annotation used to specify a Guice module that can tie the Ad Manager library to
+ a SOAP framework.
+ |
+
| Class and Description | +
|---|
| AdManagerProductFrameworkModule
+ A simple marker annotation used to specify a Guice module that can tie the Ad Manager library to
+ a SOAP framework.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/soap/AdManagerHttpHeaderHandler.html b/5.3.0/com/google/api/ads/admanager/lib/soap/AdManagerHttpHeaderHandler.html new file mode 100644 index 0000000000..b3f2f6a376 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/soap/AdManagerHttpHeaderHandler.html @@ -0,0 +1,287 @@ + + + + + + +public class AdManagerHttpHeaderHandler +extends Object+
| Constructor and Description | +
|---|
AdManagerHttpHeaderHandler(SoapClientHandlerInterface soapClientHandler)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+setHttpHeaders(Object soapClient,
+ AdManagerSession adManagerSession)
+Sets the HTTP headers on the SOAP client.
+ |
+
@Inject +public AdManagerHttpHeaderHandler(SoapClientHandlerInterface soapClientHandler)+
soapClientHandler - the SOAP client handlerpublic void setHttpHeaders(Object soapClient, + AdManagerSession adManagerSession)+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/soap/class-use/AdManagerHttpHeaderHandler.html b/5.3.0/com/google/api/ads/admanager/lib/soap/class-use/AdManagerHttpHeaderHandler.html new file mode 100644 index 0000000000..a60eed1244 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/soap/class-use/AdManagerHttpHeaderHandler.html @@ -0,0 +1,198 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| Constructor and Description | +
|---|
AdManagerAxisHeaderHandler(AxisHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdManagerJaxWsHeaderHandler(JaxWsHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/soap/package-frame.html b/5.3.0/com/google/api/ads/admanager/lib/soap/package-frame.html new file mode 100644 index 0000000000..5d8327920e --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/soap/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| AdManagerHttpHeaderHandler | +
+ Handler used to set the HTTP headers on a SOAP client.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/soap/package-tree.html b/5.3.0/com/google/api/ads/admanager/lib/soap/package-tree.html new file mode 100644 index 0000000000..e9eb659a39 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/soap/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/soap/package-use.html b/5.3.0/com/google/api/ads/admanager/lib/soap/package-use.html new file mode 100644 index 0000000000..bd55db6823 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/soap/package-use.html @@ -0,0 +1,182 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| Class and Description | +
|---|
| AdManagerHttpHeaderHandler
+ Handler used to set the HTTP headers on a SOAP client.
+ |
+
| Class and Description | +
|---|
| AdManagerHttpHeaderHandler
+ Handler used to set the HTTP headers on a SOAP client.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/AdManagerInternals.html b/5.3.0/com/google/api/ads/admanager/lib/utils/AdManagerInternals.html new file mode 100644 index 0000000000..a99d2ccc65 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/AdManagerInternals.html @@ -0,0 +1,277 @@ + + + + + + +public class AdManagerInternals +extends Object+
| Constructor and Description | +
|---|
AdManagerInternals() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Internals |
+getInstance()
+Returns an
+Internals configured for Ad Manager. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/DateTimesHelper.html b/5.3.0/com/google/api/ads/admanager/lib/utils/DateTimesHelper.html new file mode 100644 index 0000000000..77c9c67e48 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/DateTimesHelper.html @@ -0,0 +1,542 @@ + + + + + + +T - the DateTime typeD - the Date typepublic class DateTimesHelper<T,D> +extends Object+
DateTime objects.| Constructor and Description | +
|---|
DateTimesHelper(Class<T> dateTimeClass,
+ Class<D> dateClass)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+dateToString(D date)
+Returns string representation of this date.
+ |
+
Calendar |
+toCalendar(T dateTime)
+Gets a calendar for a
+DateTime using the default locale, i.e. |
+
Calendar |
+toCalendar(T dateTime,
+ Locale locale)
+Gets a calendar for a
+DateTime in the supplied locale. |
+
T |
+toDateTime(Calendar calendar)
+Converts a
+Calendar object to an API date time preserving the time zone. |
+
T |
+toDateTime(org.joda.time.DateTime dateTime)
+Converts a
+DateTime object to an API date time preserving the time zone. |
+
T |
+toDateTime(org.joda.time.Instant instant,
+ String timeZoneId)
+Converts an
+Instant object to an API date time in the time zone supplied. |
+
T |
+toDateTime(String dateTime,
+ String timeZoneId)
+Converts a string in the form of
+yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied. |
+
org.joda.time.DateTime |
+toDateTime(T dateTime)
+Converts an API date time to a
+DateTime preserving the time zone. |
+
T |
+toDateTimeWithTimeZone(String dateTime)
+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. |
+
String |
+toString(T dateTime)
+Returns string representation of this date time.
+ |
+
String |
+toStringForTimeZone(T dateTime,
+ String newZoneID)
+Returns string representation of this date time with a different time zone, preserving the
+ millisecond instant.
+ |
+
String |
+toStringWithTimeZone(T dateTime)
+Returns string representation of this date time with time zone.
+ |
+
public T toDateTime(Calendar calendar)+
Calendar object to an API date time preserving the time zone.public T toDateTime(org.joda.time.Instant instant, + String timeZoneId)+
Instant object to an API date time in the time zone supplied.public T toDateTime(org.joda.time.DateTime dateTime)+
DateTime object to an API date time preserving the time zone.public T toDateTime(String dateTime, + String timeZoneId)+
yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.public T toDateTimeWithTimeZone(String dateTime)+
yyyy-MM-dd'T'HH:mm:ss±HH:mm to an API date time in the
+ time zone supplied.public String dateToString(D date)+
date - the date to stringifyDate in yyyy-MM-ddpublic org.joda.time.DateTime toDateTime(T dateTime)+
DateTime preserving the time zone.public Calendar toCalendar(T dateTime)+
DateTime using the default locale, i.e. Locale.getDefault().public Calendar toCalendar(T dateTime, + Locale locale)+
DateTime in the supplied locale.public String toString(T dateTime)+
toStringForTimeZone(Object, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:sspublic String toStringWithTimeZone(T dateTime)+
toStringForTimeZone(Object, String) instead.dateTime - the date time to stringifyDateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm,
+ i.e. 2013-09-013T12:02:03+08:00public String toStringForTimeZone(T dateTime, + String newZoneID)+
This method is useful for finding the local time in another time zone, especially for + filtering. + +
For example, if this date time holds 12:30 in Europe/London, the result from this method + with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, + i.e. + +
String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
+ String statementPart =
+ "startDateTime > "
+ + DateTimes.toString(apiDateTime, timeZoneId);
+ //...
+ statementBuilder.where(statementPart);
+ DateTime.withZone(org.joda.time.DateTimeZone).dateTime - the date time to stringify into a new time zonenewZoneID - the time zone ID of the new zoneDateTime in yyyy-MM-dd'T'HH:mm:ssCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/QueryBuilder.html b/5.3.0/com/google/api/ads/admanager/lib/utils/QueryBuilder.html new file mode 100644 index 0000000000..6a3cf1d71b --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/QueryBuilder.html @@ -0,0 +1,854 @@ + + + + + + +V - the type of the API Valuepublic class QueryBuilder<V> +extends Object +implements QueryBuilderInterface<V>+
QueryBuilder allows for queries to be constructed in parts.| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+from |
+
protected static String |
+FROM |
+
protected Integer |
+limit |
+
protected static String |
+LIMIT |
+
protected Integer |
+offset |
+
protected static String |
+OFFSET |
+
protected static String |
+ORDER_BY |
+
protected String |
+orderBy |
+
protected String |
+select |
+
protected static String |
+SELECT |
+
protected Map<String,V> |
+valueMap |
+
protected String |
+where |
+
protected static String |
+WHERE |
+
| Constructor and Description | +
|---|
QueryBuilder()
+Constructs a query builder.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery()
+Builds the query from the clauses.
+ |
+
QueryBuilder<V> |
+from(String table)
+Sets the statement FROM clause in the form of "table".
+ |
+
Map<String,V> |
+getBindVariableMap()
+Returns an unmodifiable form of the key to value map.
+ |
+
Integer |
+getOffset()
+Gets the current offset.
+ |
+
QueryBuilder<V> |
+increaseOffsetBy(Integer amount)
+Increases the offset by the
+amount. |
+
QueryBuilder<V> |
+limit(Integer count)
+Sets the statement LIMIT clause in the form of
++ + "LIMIT <count>" + + e.g. |
+
QueryBuilder<V> |
+offset(Integer count)
+Sets the statement OFFSET clause in the form of
++ + "OFFSET <count>" + + e.g. |
+
QueryBuilder<V> |
+orderBy(String orderBy)
+Sets the statement ORDER BY clause in the form of
++ + "ORDER BY <property> [ASC | DESC]" + + e.g. |
+
QueryBuilder<V> |
+removeLimitAndOffset()
+Removes the limit and offset from the query.
+ |
+
QueryBuilder<V> |
+select(String columns)
+Sets the statement SELECT clause in the form of "a,b" or "*".
+ |
+
protected void |
+validateQuery()
+Checks that the query is valid.
+ |
+
QueryBuilder<V> |
+where(String conditions)
+Sets the statement WHERE clause in the form of
++ + "WHERE <condition> {[AND | OR] <condition> ...}" + + e.g. |
+
QueryBuilder<V> |
+withBindVariableValue(String key,
+ V value)
+Adds a value to the statement in the form of a
+Value. |
+
QueryBuilder<V> |
+withBindVariableValues(Map<String,V> values)
+Adds all key value mappings.
+ |
+
protected static final String SELECT+
protected static final String FROM+
protected static final String WHERE+
protected static final String LIMIT+
protected static final String OFFSET+
protected static final String ORDER_BY+
protected String select+
protected String from+
protected String where+
protected Integer limit+
protected Integer offset+
protected String orderBy+
public QueryBuilder()+
@CanIgnoreReturnValue +public QueryBuilder<V> select(String columns)+
PublisherQueryLanguageService. The "SELECT " keyword will be ignored.select in interface QueryBuilderInterface<V>columns - the statement select clause without "SELECT"@CanIgnoreReturnValue +public QueryBuilder<V> from(String table)+
PublisherQueryLanguageService. The "FROM " keyword will be ignored.from in interface QueryBuilderInterface<V>table - the statement from clause without "FROM"@CanIgnoreReturnValue +public QueryBuilder<V> where(String conditions)+
"WHERE <condition> {[AND | OR] <condition> ...}" where in interface QueryBuilderInterface<V>conditions - the statement query without "WHERE"@CanIgnoreReturnValue +public QueryBuilder<V> limit(Integer count)+
"LIMIT <count>" limit in interface QueryBuilderInterface<V>count - the statement limit@CanIgnoreReturnValue +public QueryBuilder<V> offset(Integer count)+
"OFFSET <count>" offset in interface QueryBuilderInterface<V>count - the statement offset@CanIgnoreReturnValue +public QueryBuilder<V> increaseOffsetBy(Integer amount)+
amount.increaseOffsetBy in interface QueryBuilderInterface<V>amount - the amount to increase the offsetpublic Integer getOffset()+
getOffset in interface QueryBuilderInterface<V>@CanIgnoreReturnValue +public QueryBuilder<V> removeLimitAndOffset()+
removeLimitAndOffset in interface QueryBuilderInterface<V>@CanIgnoreReturnValue +public QueryBuilder<V> orderBy(String orderBy)+
"ORDER BY <property> [ASC | DESC]" orderBy in interface QueryBuilderInterface<V>orderBy - the statement order by without "ORDER BY"@CanIgnoreReturnValue +public QueryBuilder<V> withBindVariableValue(String key, + V value)+
Value.withBindVariableValue in interface QueryBuilderInterface<V>key - the value keyvalue - the value@CanIgnoreReturnValue +public QueryBuilder<V> withBindVariableValues(Map<String,V> values)+
values - the mappings of key to value of type public Map<String,V> getBindVariableMap()+
getBindVariableMap in interface QueryBuilderInterface<V>protected void validateQuery()+
public String buildQuery()+
buildQuery in interface QueryBuilderInterface<V>Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/QueryBuilderInterface.html b/5.3.0/com/google/api/ads/admanager/lib/utils/QueryBuilderInterface.html new file mode 100644 index 0000000000..d8f0ca6ae3 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/QueryBuilderInterface.html @@ -0,0 +1,500 @@ + + + + + + +V - the type of the API Valuepublic interface QueryBuilderInterface<V>
+QueryBuilderInterface allows for queries to be constructed in parts.| Modifier and Type | +Method and Description | +
|---|---|
String |
+buildQuery()
+Builds the query from the clauses.
+ |
+
QueryBuilderInterface<V> |
+from(String table)
+Sets the statement FROM clause in the form of "table".
+ |
+
Map<String,V> |
+getBindVariableMap()
+Gets an unmodifiable key-value map.
+ |
+
Integer |
+getOffset()
+Gets the current offset.
+ |
+
QueryBuilderInterface<V> |
+increaseOffsetBy(Integer amount)
+Increases the offset by the
+amount. |
+
QueryBuilderInterface<V> |
+limit(Integer count)
+Sets the statement LIMIT clause in the form of
++ "LIMIT <count>"
+ + e.g. |
+
QueryBuilderInterface<V> |
+offset(Integer count)
+Sets the statement OFFSET clause in the form of
++ "OFFSET <count>"
+ + e.g. |
+
QueryBuilderInterface<V> |
+orderBy(String orderBy)
+Sets the statement ORDER BY clause in the form of
++ "ORDER BY <property> [ASC | DESC]"
+ + e.g. |
+
QueryBuilderInterface<V> |
+removeLimitAndOffset()
+Removes the limit and offset from the query.
+ |
+
QueryBuilderInterface<V> |
+select(String columns)
+Sets the statement SELECT clause in the form of "a,b" or "*".
+ |
+
QueryBuilderInterface<V> |
+where(String conditions)
+Sets the statement WHERE clause in the form of
++ "WHERE <condition> {[AND | OR] <condition> ...}"
+ + e.g. |
+
QueryBuilderInterface<V> |
+withBindVariableValue(String key,
+ V value)
+Puts a key-value into the bind variables.
+ |
+
QueryBuilderInterface<V> select(String columns)+
PublisherQueryLanguageService. The "SELECT " keyword will be
+ ignored.columns - the statement select clause without "SELECT"QueryBuilderInterface<V> from(String table)+
PublisherQueryLanguageService. The "FROM " keyword will be
+ ignored.table - the statement from clause without "FROM"QueryBuilderInterface<V> where(String conditions)+
"WHERE <condition> {[AND | OR] <condition> ...}"
+ conditions - the statement query without "WHERE"QueryBuilderInterface<V> limit(Integer count)+
"LIMIT <count>"
+ count - the statement limitQueryBuilderInterface<V> offset(Integer count)+
"OFFSET <count>"
+ count - the statement offsetQueryBuilderInterface<V> increaseOffsetBy(Integer amount)+
amount.amount - the amount to increase the offsetInteger getOffset()+
QueryBuilderInterface<V> removeLimitAndOffset()+
QueryBuilderInterface<V> orderBy(String orderBy)+
"ORDER BY <property> [ASC | DESC]"
+ orderBy - the statement order by without "ORDER BY"QueryBuilderInterface<V> withBindVariableValue(String key, + V value)+
String buildQuery()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/ReportCallback.html b/5.3.0/com/google/api/ads/admanager/lib/utils/ReportCallback.html new file mode 100644 index 0000000000..f3f4b8647e --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/ReportCallback.html @@ -0,0 +1,283 @@ + + + + + + +public interface ReportCallback
+ReportCallback is called on the completion of asynchronous report
+ downloads. It is either called with ReportCallback#onSuccess or with
+ ReportCallback#onError(Exception)) if there was an exception.| Modifier and Type | +Method and Description | +
|---|---|
void |
+onException(Exception e)
+Called when there was an exception preventing the completion of the
+ asynchronous request.
+ |
+
void |
+onFailure()
+Called when there has been a failure due to server-side processing.
+ |
+
void |
+onInterruption()
+Called when the wait thread is interrupted.
+ |
+
void |
+onSuccess()
+Called when the asynchronous call has completed successfully.
+ |
+
void onSuccess()+
void onFailure()+
void onInterruption()+
void onException(Exception e)+
e - the exception representing the cause of failureCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/AdManagerInternals.html b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/AdManagerInternals.html new file mode 100644 index 0000000000..fb1d95d643 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/AdManagerInternals.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/DateTimesHelper.html b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/DateTimesHelper.html new file mode 100644 index 0000000000..cf2fbd04f7 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/DateTimesHelper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/QueryBuilder.html b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/QueryBuilder.html new file mode 100644 index 0000000000..fb460b0f86 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/QueryBuilder.html @@ -0,0 +1,239 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.utils | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
QueryBuilder<V> |
+QueryBuilder.from(String table)
+Sets the statement FROM clause in the form of "table".
+ |
+
QueryBuilder<V> |
+QueryBuilder.increaseOffsetBy(Integer amount)
+Increases the offset by the
+amount. |
+
QueryBuilder<V> |
+QueryBuilder.limit(Integer count)
+Sets the statement LIMIT clause in the form of
++ + "LIMIT <count>" + + e.g. |
+
QueryBuilder<V> |
+QueryBuilder.offset(Integer count)
+Sets the statement OFFSET clause in the form of
++ + "OFFSET <count>" + + e.g. |
+
QueryBuilder<V> |
+QueryBuilder.orderBy(String orderBy)
+Sets the statement ORDER BY clause in the form of
++ + "ORDER BY <property> [ASC | DESC]" + + e.g. |
+
QueryBuilder<V> |
+QueryBuilder.removeLimitAndOffset()
+Removes the limit and offset from the query.
+ |
+
QueryBuilder<V> |
+QueryBuilder.select(String columns)
+Sets the statement SELECT clause in the form of "a,b" or "*".
+ |
+
QueryBuilder<V> |
+QueryBuilder.where(String conditions)
+Sets the statement WHERE clause in the form of
++ + "WHERE <condition> {[AND | OR] <condition> ...}" + + e.g. |
+
QueryBuilder<V> |
+QueryBuilder.withBindVariableValue(String key,
+ V value)
+Adds a value to the statement in the form of a
+Value. |
+
QueryBuilder<V> |
+QueryBuilder.withBindVariableValues(Map<String,V> values)
+Adds all key value mappings.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/QueryBuilderInterface.html b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/QueryBuilderInterface.html new file mode 100644 index 0000000000..942ff8c894 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/QueryBuilderInterface.html @@ -0,0 +1,244 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.utils | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+QueryBuilder<V>
+QueryBuilder allows for queries to be constructed in parts. |
+
| Modifier and Type | +Method and Description | +
|---|---|
QueryBuilderInterface<V> |
+QueryBuilderInterface.from(String table)
+Sets the statement FROM clause in the form of "table".
+ |
+
QueryBuilderInterface<V> |
+QueryBuilderInterface.increaseOffsetBy(Integer amount)
+Increases the offset by the
+amount. |
+
QueryBuilderInterface<V> |
+QueryBuilderInterface.limit(Integer count)
+Sets the statement LIMIT clause in the form of
++ "LIMIT <count>"
+ + e.g. |
+
QueryBuilderInterface<V> |
+QueryBuilderInterface.offset(Integer count)
+Sets the statement OFFSET clause in the form of
++ "OFFSET <count>"
+ + e.g. |
+
QueryBuilderInterface<V> |
+QueryBuilderInterface.orderBy(String orderBy)
+Sets the statement ORDER BY clause in the form of
++ "ORDER BY <property> [ASC | DESC]"
+ + e.g. |
+
QueryBuilderInterface<V> |
+QueryBuilderInterface.removeLimitAndOffset()
+Removes the limit and offset from the query.
+ |
+
QueryBuilderInterface<V> |
+QueryBuilderInterface.select(String columns)
+Sets the statement SELECT clause in the form of "a,b" or "*".
+ |
+
QueryBuilderInterface<V> |
+QueryBuilderInterface.where(String conditions)
+Sets the statement WHERE clause in the form of
++ "WHERE <condition> {[AND | OR] <condition> ...}"
+ + e.g. |
+
QueryBuilderInterface<V> |
+QueryBuilderInterface.withBindVariableValue(String key,
+ V value)
+Puts a key-value into the bind variables.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/ReportCallback.html b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/ReportCallback.html new file mode 100644 index 0000000000..faca09a24d --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/class-use/ReportCallback.html @@ -0,0 +1,400 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis.utils.v202302 | ++ |
| com.google.api.ads.admanager.axis.utils.v202305 | ++ |
| com.google.api.ads.admanager.axis.utils.v202308 | ++ |
| com.google.api.ads.admanager.axis.utils.v202311 | ++ |
| com.google.api.ads.admanager.jaxws.utils.v202302 | ++ |
| com.google.api.ads.admanager.jaxws.utils.v202305 | ++ |
| com.google.api.ads.admanager.jaxws.utils.v202308 | ++ |
| com.google.api.ads.admanager.jaxws.utils.v202311 | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Thread |
+ReportDownloader.whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+onSuccess() for a successful scheduling
+ onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ onInterruption() if the wait thread is interrupted
+ onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Thread |
+ReportDownloader.whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+onSuccess() for a successful scheduling
+ onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ onInterruption() if the wait thread is interrupted
+ onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Thread |
+ReportDownloader.whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+onSuccess() for a successful scheduling
+ onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ onInterruption() if the wait thread is interrupted
+ onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Thread |
+ReportDownloader.whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+onSuccess() for a successful scheduling
+ onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ onInterruption() if the wait thread is interrupted
+ onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Thread |
+ReportDownloader.whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+onSuccess() for a successful scheduling
+ onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ onInterruption() if the wait thread is interrupted
+ onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Thread |
+ReportDownloader.whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+onSuccess() for a successful scheduling
+ onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ onInterruption() if the wait thread is interrupted
+ onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Thread |
+ReportDownloader.whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+onSuccess() for a successful scheduling
+ onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ onInterruption() if the wait thread is interrupted
+ onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Thread |
+ReportDownloader.whenReportReady(ReportCallback callback)
+Waits for the report to be ready and then calls:
+
+
+
+onSuccess() for a successful scheduling
+ onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ onInterruption() if the wait thread is interrupted
+ onException(Exception) if there was an exception while waiting for
+ the report to finish
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/examples/ArgumentNames.html b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/ArgumentNames.html new file mode 100644 index 0000000000..d7082b2e59 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/ArgumentNames.html @@ -0,0 +1,1504 @@ + + + + + + +public final class ArgumentNames +extends Object+
| Constructor and Description | +
|---|
ArgumentNames() |
+
public static final String ACTIVITY_ID+
public static final String ACTIVITY_GROUP_ID+
public static final String AD_UNIT_ID+
public static final String ADVERTISER_COMPANY_ID+
public static final String ADVERTISER_ID+
public static final String AGENCY_ID+
public static final String ADJUSTMENT_ID+
public static final String AUDIENCE_SEGMENT_ID+
public static final String BASE_RATE_ID+
public static final String BUYER_ID+
public static final String CHILD_NETWORK_CODE+
public static final String CMS_METADATA_VALUE_ID+
public static final String CMS_METADATA_KEY_NAME+
public static final String CMS_METADATA_KEY_ID+
public static final String COMPANION_CREATIVE_ID+
public static final String COMPANY_ID+
public static final String CONTACT_ID+
public static final String CONTENT_ID+
public static final String CONTENT_BUNDLE_ID+
public static final String CREATIVE_ID+
public static final String CREATIVE_SET_ID+
public static final String CREATIVE_WRAPPER_ID+
public static final String CURRENCY_CODE+
public static final String CUSTOM_DIMENSION_KEY_ID+
public static final String CUSTOM_FIELD_ID+
public static final String EMAIL_ADDRESS+
public static final String EXCHANGE_RATE_ID+
public static final String FIELD_OPTION_ID+
public static final String HIERARCHY_LEVEL_ONE_KEY_ID+
public static final String HIERARCHY_LEVEL_TWO_KEY_ID+
public static final String LABEL_ID+
public static final String LINE_ITEM_ID+
public static final String LINKED_DEVICE_ID+
public static final String MASTER_CREATIVE_ID+
public static final String NAME+
public static final String NUMBER_CUSTOM_FIELD_ID+
public static final String NUM_REQUESTS+
public static final String ORDER_ID+
public static final String PACKAGE_ID+
public static final String PARENT_AD_UNIT_ID+
public static final String PLACEMENT_ID+
public static final String PREMIUM_RATE_ID+
public static final String PRIMARY_SALESPERSON_ID+
public static final String PRIMARY_TRAFFICKER_ID+
public static final String PRODUCT_ID+
public static final String PRODUCT_PACKAGE_ID+
public static final String PRODUCT_PACKAGE_ITEM_ID+
public static final String PRODUCT_TEMPLATE_ID+
public static final String PROGRAMMATIC_BUYER_ID+
public static final String PROPOSAL_ID+
public static final String PROPOSAL_LINE_ITEM_ID+
public static final String RATE_CARD_ID+
public static final String RECONCILIATION_LINE_ITEM_REPORT_ID+
public static final String RECONCILIATION_ORDER_REPORT_ID+
public static final String RECONCILIATION_REPORT_ID+
public static final String RECONCILIATION_REPORT_ROW_ID+
public static final String SAVED_QUERY_ID+
public static final String SITE_ID+
public static final String SECONDARY_SALESPERSON_ID+
public static final String TARGETING_KEY_ID+
public static final String TARGETING_KEY_ID_1+
public static final String TARGETING_KEY_ID_2+
public static final String TARGETING_KEY_ID_3+
public static final String TARGETING_VALUE_ID+
public static final String TARGETING_VALUE_ID_1+
public static final String TARGETING_VALUE_IDS_2+
public static final String TARGETING_VALUE_ID_3+
public static final String TARGETED_VIDEO_AD_UNIT_ID+
public static final String TEAM_ID+
public static final String TRAFFIC_FORECAST_SEGMENT_ID+
public static final String TRAFFICKER_ID+
public static final String USER_ID+
public static final String URL+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/examples/class-use/ArgumentNames.html b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/class-use/ArgumentNames.html new file mode 100644 index 0000000000..d6dc99ce36 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/class-use/ArgumentNames.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/examples/package-frame.html b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/package-frame.html new file mode 100644 index 0000000000..d8be835128 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| ArgumentNames | +
+ Contains command line argument formats for example code.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/examples/package-tree.html b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/package-tree.html new file mode 100644 index 0000000000..10a02ebd05 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/examples/package-use.html b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/package-use.html new file mode 100644 index 0000000000..0371a56aa3 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/examples/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/package-frame.html b/5.3.0/com/google/api/ads/admanager/lib/utils/package-frame.html new file mode 100644 index 0000000000..de65002cf3 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/package-frame.html @@ -0,0 +1,28 @@ + + + + + + +| Interface | +Description | +
|---|---|
| QueryBuilderInterface<V> | +
+QueryBuilderInterface allows for queries to be constructed in parts. |
+
| ReportCallback | +
+ReportCallback is called on the completion of asynchronous report
+ downloads. |
+
| Class | +Description | +
|---|---|
| AdManagerInternals | +
+ Provides access to some internal guice-injected objects.
+ |
+
| DateTimesHelper<T,D> | +
+ A utility class for handling
+DateTime objects. |
+
| QueryBuilder<V> | +
+QueryBuilder allows for queries to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/package-tree.html b/5.3.0/com/google/api/ads/admanager/lib/utils/package-tree.html new file mode 100644 index 0000000000..27876c5b83 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/package-tree.html @@ -0,0 +1,146 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/admanager/lib/utils/package-use.html b/5.3.0/com/google/api/ads/admanager/lib/utils/package-use.html new file mode 100644 index 0000000000..c8d8b59729 --- /dev/null +++ b/5.3.0/com/google/api/ads/admanager/lib/utils/package-use.html @@ -0,0 +1,188 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.utils.v202302 | ++ |
| com.google.api.ads.admanager.lib.utils | ++ |
| Class and Description | +
|---|
ReportCallback
+ReportCallback is called on the completion of asynchronous report
+ downloads. |
+
| Class and Description | +
|---|
QueryBuilder
+QueryBuilder allows for queries to be constructed in parts. |
+
QueryBuilderInterface
+QueryBuilderInterface allows for queries to be constructed in parts. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/AdsModule.html b/5.3.0/com/google/api/ads/common/lib/AdsModule.html new file mode 100644 index 0000000000..c92fc4144a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/AdsModule.html @@ -0,0 +1,321 @@ + + + + + + +public abstract class AdsModule
+extends com.google.inject.AbstractModule
+| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure()
+Configure common Guice bindings.
+ |
+
protected void |
+configureLogging(String loggerPrefix)
+Configures the loggers given the prefix.
+ |
+
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingprotected void configure()+
configure in class com.google.inject.AbstractModuleprotected void configureLogging(String loggerPrefix)+
loggerPrefix - the logger prefixCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/AdsSoapModule.html b/5.3.0/com/google/api/ads/common/lib/AdsSoapModule.html new file mode 100644 index 0000000000..84e22aa960 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/AdsSoapModule.html @@ -0,0 +1,346 @@ + + + + + + +C - the subclass of AdsServiceClientD - the subclass of AdsServiceDescriptorS - the subclass of AdsSessionpublic class AdsSoapModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession>
+extends com.google.inject.AbstractModule
+| Constructor and Description | +
|---|
AdsSoapModule() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure() |
+
protected <H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>> |
+configureFactories(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral,
+ com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral,
+ Class<H> adsServiceClientFactoryHelperClass,
+ Class<F> baseAdsServiceClientFactoryClass)
+Configures the factories.
+ |
+
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingprotected void configure()+
configure in class com.google.inject.AbstractModuleprotected <H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>> void configureFactories(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral, + com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral, + com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral, + com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral, + Class<H> adsServiceClientFactoryHelperClass, + Class<F> baseAdsServiceClientFactoryClass)+
H - the subclass of AdsServiceClientFactoryHelperF - the subclass of BaseAdsServiceClientFactoryadsServiceClientFactoryTypeLiteral - the factory type literal which
+ contains a FactoryModule.AdsServiceClientFactoryInterfaceadsServiceDescriptorFactoryTypeLiteral - the factory type literal
+ which contains a FactoryModule.AdsServiceDescriptorFactoryInterfaceadsServiceClientTypeLiteral - the ads service client literal which
+ contains a AdsServiceClientadsServiceDescriptorTypeLiteral - the ads service descriptor literal
+ which contains a AdsServiceDescriptoradsServiceClientFactoryHelperClass - the AdsServiceClientFactoryHelper classbaseAdsServiceClientFactoryClass - the BaseAdsServiceClientFactory classCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/AuthModule.html b/5.3.0/com/google/api/ads/common/lib/auth/AuthModule.html new file mode 100644 index 0000000000..a7e0ace9c6 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/AuthModule.html @@ -0,0 +1,333 @@ + + + + + + +public class AuthModule
+extends com.google.inject.AbstractModule
+| Modifier and Type | +Field and Description | +
|---|---|
static Long |
+DEFAULT_OAUTH2_REFRESH_WINDOW |
+
| Constructor and Description | +
|---|
AuthModule()
+Default constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure() |
+
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/AuthorizationHeaderProvider.html b/5.3.0/com/google/api/ads/common/lib/auth/AuthorizationHeaderProvider.html new file mode 100644 index 0000000000..7a5f4641cc --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/AuthorizationHeaderProvider.html @@ -0,0 +1,312 @@ + + + + + + +public class AuthorizationHeaderProvider +extends Object+
AdsSession.| Constructor and Description | +
|---|
AuthorizationHeaderProvider(OAuth2AuthorizationHeaderProvider oAuth2AuthorizationHeaderProvider,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ OAuth2Helper oAuth2Helper)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getAuthorizationHeader(AdsSession adsSession,
+ String endpointUrl)
+Gets a header value that can be set to the
+Authorization HTTP
+ header. |
+
@Inject +public AuthorizationHeaderProvider(OAuth2AuthorizationHeaderProvider oAuth2AuthorizationHeaderProvider, + com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration, + OAuth2Helper oAuth2Helper)+
oAuth2AuthorizationHeaderProvider - the OAuth2 header provideradsLibConfiguration - the library configurationoAuth2Helper - the OAuth2 helperpublic String getAuthorizationHeader(AdsSession adsSession, + @Nullable + String endpointUrl) + throws AuthenticationException+
Authorization HTTP
+ header. The endpoint URL can be null if it's not needed for the
+ authentication mechanism (i.e. OAuth2).adsSession - the session to pull authentication information fromendpointUrl - the endpoint URL used for authentication mechanisms like
+ OAuth.AuthenticationException - if the authorization header could not be
+ createdIllegalArgumentException - if no valid authentication information
+ exists within the session.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/GoogleClientSecretsBuilder.Api.html b/5.3.0/com/google/api/ads/common/lib/auth/GoogleClientSecretsBuilder.Api.html new file mode 100644 index 0000000000..847806e1e5 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/GoogleClientSecretsBuilder.Api.html @@ -0,0 +1,364 @@ + + + + + + +public static enum GoogleClientSecretsBuilder.Api +extends Enum<GoogleClientSecretsBuilder.Api>+
| Enum Constant and Description | +
|---|
AD_MANAGER |
+
ADWORDS |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getPropKeyPrefix()
+Gets the property key prefix.
+ |
+
static GoogleClientSecretsBuilder.Api |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static GoogleClientSecretsBuilder.Api[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final GoogleClientSecretsBuilder.Api ADWORDS+
public static final GoogleClientSecretsBuilder.Api AD_MANAGER+
public static GoogleClientSecretsBuilder.Api[] values()+
+for (GoogleClientSecretsBuilder.Api c : GoogleClientSecretsBuilder.Api.values()) + System.out.println(c); +
public static GoogleClientSecretsBuilder.Api valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String getPropKeyPrefix()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.html b/5.3.0/com/google/api/ads/common/lib/auth/GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.html new file mode 100644 index 0000000000..efbbcebbe7 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.html @@ -0,0 +1,462 @@ + + + + + + +public static class GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder +extends Object +implements Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>+
GoogleClientSecrets.DEFAULT_CONFIGURATION_FILENAME| Modifier and Type | +Method and Description | +
|---|---|
com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets |
+build()
+Constructs this object.
+ |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+from(org.apache.commons.configuration.Configuration config)
+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 |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+fromFile()
+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
+ |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+fromFile(File path)
+Populates this builder from a properties file from a specified path.
+ |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+fromFile(String path)
+Populates this builder from a properties file from a specified path.
+ |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+fromFile(URL path)
+Populates this builder from a properties file from a specified path.
+ |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+withClientSecrets(String clientId,
+ String clientSecret)
+Sets the client ID & secret to create the OAuth2 Credential with.
+ |
+
@CanIgnoreReturnValue +public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder withClientSecrets(String clientId, + String clientSecret)+
public com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets build() + throws ValidationException+
Builderbuild in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>ValidationException - if the provided data is not valid.@CanIgnoreReturnValue +public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder from(org.apache.commons.configuration.Configuration config)+
Configuration object api.adwords.clientIdpublic GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder fromFile(String path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>path - the path to try first as a resource, then as a filecom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder fromFile(File path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>path - the path to load properties fromcom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder fromFile(URL path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>path - the path to try first as a resource, then as a filecom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder fromFile() + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/GoogleClientSecretsBuilder.html b/5.3.0/com/google/api/ads/common/lib/auth/GoogleClientSecretsBuilder.html new file mode 100644 index 0000000000..a47e7c16d1 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/GoogleClientSecretsBuilder.html @@ -0,0 +1,309 @@ + + + + + + +public class GoogleClientSecretsBuilder +extends Object+
GoogleClientSecrets.| Modifier and Type | +Class and Description | +
|---|---|
static class |
+GoogleClientSecretsBuilder.Api
+Enum representing the API that GoogleClientSecretsBuilder can be used for.
+ |
+
static class |
+GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder
+Builder for
+GoogleClientSecrets. |
+
| Constructor and Description | +
|---|
GoogleClientSecretsBuilder()
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+forApi(GoogleClientSecretsBuilder.Api api)
+Specifies which
+GoogleClientSecretsBuilder.Api should this GoogleClientSecrets be
+ generated for. |
+
public GoogleClientSecretsBuilder()+
public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder forApi(GoogleClientSecretsBuilder.Api api)+
GoogleClientSecretsBuilder.Api should this GoogleClientSecrets be
+ generated for. Should be called first before any other builder methods.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/OAuth2AuthorizationHeaderProvider.html b/5.3.0/com/google/api/ads/common/lib/auth/OAuth2AuthorizationHeaderProvider.html new file mode 100644 index 0000000000..df74089ef0 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/OAuth2AuthorizationHeaderProvider.html @@ -0,0 +1,286 @@ + + + + + + +public class OAuth2AuthorizationHeaderProvider +extends Object+
| Constructor and Description | +
|---|
OAuth2AuthorizationHeaderProvider()
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getOAuth2AuthorizationHeader(OAuth2Compatible oAuth2Compatible)
+Gets the OAuth2 authorization header for the parameters and request URL.
+ |
+
public OAuth2AuthorizationHeaderProvider()+
public String getOAuth2AuthorizationHeader(OAuth2Compatible oAuth2Compatible)+
oAuth2Compatible - exposes the OAuth2 credentialsAuthorization header value to setCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/OAuth2Compatible.html b/5.3.0/com/google/api/ads/common/lib/auth/OAuth2Compatible.html new file mode 100644 index 0000000000..d425496181 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/OAuth2Compatible.html @@ -0,0 +1,231 @@ + + + + + + +public interface OAuth2Compatible
+| Modifier and Type | +Method and Description | +
|---|---|
com.google.api.client.auth.oauth2.Credential |
+getOAuth2Credential()
+Gets the OAuth parameters.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/OAuth2Helper.html b/5.3.0/com/google/api/ads/common/lib/auth/OAuth2Helper.html new file mode 100644 index 0000000000..65b14e512b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/OAuth2Helper.html @@ -0,0 +1,293 @@ + + + + + + +public class OAuth2Helper +extends Object+
| Constructor and Description | +
|---|
OAuth2Helper(org.slf4j.Logger libLogger,
+ Long refreshWindowSeconds)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
com.google.api.client.auth.oauth2.Credential |
+refreshCredential(com.google.api.client.auth.oauth2.Credential credential)
+Refreshes the credential if within the refresh window.
+ |
+
@Inject +public OAuth2Helper(org.slf4j.Logger libLogger, + Long refreshWindowSeconds)+
libLogger - the lib loggerrefreshWindowSeconds - the refresh window in secondspublic com.google.api.client.auth.oauth2.Credential refreshCredential(com.google.api.client.auth.oauth2.Credential credential) + throws IOException+
IOException - if there was an problem refreshing the tokenCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.Api.html b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.Api.html new file mode 100644 index 0000000000..6de1ced2ca --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.Api.html @@ -0,0 +1,401 @@ + + + + + + +public static enum OfflineCredentials.Api +extends Enum<OfflineCredentials.Api> +implements OfflineCredentials.OAuthConfig+
| Enum Constant and Description | +
|---|
AD_MANAGER |
+
| Modifier and Type | +Method and Description | +
|---|---|
Internals |
+getInternals()
+Returns the internals object for the API that has the OAuth helper.
+ |
+
String |
+getPropertyKeyPrefix()
+Returns the property key prefix.
+ |
+
String |
+getScope()
+Returns the API OAuth scope.
+ |
+
static OfflineCredentials.Api |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static OfflineCredentials.Api[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final OfflineCredentials.Api AD_MANAGER+
public static OfflineCredentials.Api[] values()+
+for (OfflineCredentials.Api c : OfflineCredentials.Api.values()) + System.out.println(c); +
public static OfflineCredentials.Api valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String getPropertyKeyPrefix()+
OfflineCredentials.OAuthConfiggetPropertyKeyPrefix in interface OfflineCredentials.OAuthConfigpublic String getScope()+
OfflineCredentials.OAuthConfiggetScope in interface OfflineCredentials.OAuthConfigpublic Internals getInternals()+
OfflineCredentials.OAuthConfiggetInternals in interface OfflineCredentials.OAuthConfigCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.Builder.html b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.Builder.html new file mode 100644 index 0000000000..55e1bb9f68 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.Builder.html @@ -0,0 +1,286 @@ + + + + + + +public static class OfflineCredentials.Builder +extends Object+
| Constructor and Description | +
|---|
Builder()
+Default constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
OfflineCredentials.ForApiBuilder |
+forApi(OfflineCredentials.OAuthConfig oAuthConfig)
+Specifies which
+OfflineCredentials.OAuthConfig should this OfflineCredentials be
+ used for. |
+
public OfflineCredentials.ForApiBuilder forApi(OfflineCredentials.OAuthConfig oAuthConfig)+
OfflineCredentials.OAuthConfig should this OfflineCredentials be
+ used for. Should be called first before any other builder methods.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.CustomOAuthConfig.html b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.CustomOAuthConfig.html new file mode 100644 index 0000000000..c636d3f3c2 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.CustomOAuthConfig.html @@ -0,0 +1,339 @@ + + + + + + +public static class OfflineCredentials.CustomOAuthConfig +extends Object +implements OfflineCredentials.OAuthConfig+
| Constructor and Description | +
|---|
CustomOAuthConfig(String propKeyPrefix,
+ String scope,
+ Internals internals) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Internals |
+getInternals()
+Returns the internals object for the API that has the OAuth helper.
+ |
+
String |
+getPropertyKeyPrefix()
+Returns the property key prefix.
+ |
+
String |
+getScope()
+Returns the API OAuth scope.
+ |
+
public String getPropertyKeyPrefix()+
OfflineCredentials.OAuthConfiggetPropertyKeyPrefix in interface OfflineCredentials.OAuthConfigpublic String getScope()+
OfflineCredentials.OAuthConfiggetScope in interface OfflineCredentials.OAuthConfigpublic Internals getInternals()+
OfflineCredentials.OAuthConfiggetInternals in interface OfflineCredentials.OAuthConfigCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.ForApiBuilder.html b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.ForApiBuilder.html new file mode 100644 index 0000000000..0407e1790d --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.ForApiBuilder.html @@ -0,0 +1,586 @@ + + + + + + +public static class OfflineCredentials.ForApiBuilder +extends Object +implements Builder<OfflineCredentials>+
DEFAULT_CONFIGURATION_FILENAME| Modifier and Type | +Method and Description | +
|---|---|
OfflineCredentials |
+build()
+Constructs this object.
+ |
+
OfflineCredentials.ForApiBuilder |
+from(org.apache.commons.configuration.Configuration config)
+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 |
+
OfflineCredentials.ForApiBuilder |
+fromFile()
+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
+ |
+
OfflineCredentials.ForApiBuilder |
+fromFile(File path)
+Populates this builder from a properties file from a specified path.
+ |
+
OfflineCredentials.ForApiBuilder |
+fromFile(String path)
+Populates this builder from a properties file from a specified path.
+ |
+
OfflineCredentials.ForApiBuilder |
+fromFile(URL path)
+Populates this builder from a properties file from a specified path.
+ |
+
OfflineCredentials.ForApiBuilder |
+withClientSecrets(String clientId,
+ String clientSecret)
+Sets the client ID & secret to create the OAuth2 Credential with.
+ |
+
OfflineCredentials.ForApiBuilder |
+withHttpTransport(com.google.api.client.http.HttpTransport httpTransport)
+Sets the
+HttpTransport to be used to make the request. |
+
OfflineCredentials.ForApiBuilder |
+withJsonKeyFilePath(String jsonKeyFilePath)
+Sets the path to a JSON key file for authenticating with a service account.
+ |
+
OfflineCredentials.ForApiBuilder |
+withRefreshToken(String refreshToken)
+Sets the refresh token to create the OAuth2 Credential with.
+ |
+
OfflineCredentials.ForApiBuilder |
+withScopes(List<String> scopes)
+Optionally sets scopes for authenticating with a service account.
+ |
+
OfflineCredentials.ForApiBuilder |
+withServiceAccountUser(String serviceAccountUser)
+Sets the service account user to impersonate.
+ |
+
OfflineCredentials.ForApiBuilder |
+withTokenUrlServer(String tokenServerUrl)
+Sets the token server URL.
+ |
+
public OfflineCredentials.ForApiBuilder fromFile(String path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<OfflineCredentials>path - the path to try first as a resource, then as a filecom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.public OfflineCredentials.ForApiBuilder fromFile(File path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<OfflineCredentials>path - the path to load properties fromcom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.public OfflineCredentials.ForApiBuilder fromFile(URL path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<OfflineCredentials>path - the path to try first as a resource, then as a filecom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.public OfflineCredentials.ForApiBuilder fromFile() + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
BuilderfromFile in interface Builder<OfflineCredentials>com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.@CanIgnoreReturnValue +public OfflineCredentials.ForApiBuilder from(org.apache.commons.configuration.Configuration config)+
Configuration object
+ api.admanager.refreshTokenfrom in interface Builder<OfflineCredentials>config - the configuration@CanIgnoreReturnValue +public OfflineCredentials.ForApiBuilder withClientSecrets(String clientId, + String clientSecret)+
@CanIgnoreReturnValue +public OfflineCredentials.ForApiBuilder withRefreshToken(String refreshToken)+
@CanIgnoreReturnValue +public OfflineCredentials.ForApiBuilder withJsonKeyFilePath(String jsonKeyFilePath)+
@CanIgnoreReturnValue +public OfflineCredentials.ForApiBuilder withServiceAccountUser(String serviceAccountUser)+
See https://support.google.com/a/answer/162106 for details.
serviceAccountUser - the email address of the account to impersonate.@CanIgnoreReturnValue +public OfflineCredentials.ForApiBuilder withScopes(List<String> scopes)+
OfflineCredentials.Api. If you are using a refresh token, the scope is set at the
+ time the refresh token is generated, and this function is a no-op.@CanIgnoreReturnValue +public OfflineCredentials.ForApiBuilder withHttpTransport(com.google.api.client.http.HttpTransport httpTransport)+
HttpTransport to be used to make the request. By default, NetHttpTransport will be used, but due to some environment restrictions, you may want to use
+ a different transport, such as UrlFetchTransport for AppEngine.@CanIgnoreReturnValue +public OfflineCredentials.ForApiBuilder withTokenUrlServer(String tokenServerUrl)+
public OfflineCredentials build() + throws ValidationException+
Builderbuild in interface Builder<OfflineCredentials>ValidationException - if the provided data is not valid.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.OAuthConfig.html b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.OAuthConfig.html new file mode 100644 index 0000000000..6c4dd55a8f --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.OAuthConfig.html @@ -0,0 +1,268 @@ + + + + + + +public static interface OfflineCredentials.OAuthConfig
+| Modifier and Type | +Method and Description | +
|---|---|
Internals |
+getInternals()
+Returns the internals object for the API that has the OAuth helper.
+ |
+
String |
+getPropertyKeyPrefix()
+Returns the property key prefix.
+ |
+
String |
+getScope()
+Returns the API OAuth scope.
+ |
+
String getPropertyKeyPrefix()+
String getScope()+
Internals getInternals()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.html b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.html new file mode 100644 index 0000000000..3ed066fffb --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/OfflineCredentials.html @@ -0,0 +1,398 @@ + + + + + + +public class OfflineCredentials +extends Object+
+ Credential credential = new OfflineCredentials.Builder()
+ .forApi(OfflineCredentials.Api.AD_MANAGER)
+ .fromFile()
+ .build()
+ .generateCredential();
+ | Modifier and Type | +Class and Description | +
|---|---|
static class |
+OfflineCredentials.Api
+Enum representing the API that OfflineCredentials can be used for.
+ |
+
static class |
+OfflineCredentials.Builder
+Pre-builder for OfflineCredentials.
+ |
+
static class |
+OfflineCredentials.CustomOAuthConfig
+A class defining a custom OAuth config.
+ |
+
static class |
+OfflineCredentials.ForApiBuilder
+Builder for OfflineCredentials.
+ |
+
static interface |
+OfflineCredentials.OAuthConfig
+Interface outlining the values required for OAuth configuration.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
com.google.api.client.auth.oauth2.Credential |
+generateCredential()
+Generates a new offline credential and immediately refreshes it.
+ |
+
String |
+getClientId()
+Gets the client ID that will be used to
+ generate a
+Credential. |
+
String |
+getClientSecret()
+Gets the client secret that will be used to
+ generate a
+Credential. |
+
com.google.api.client.http.HttpTransport |
+getHttpTransport()
+Gets the
+HttpTransport that will be used when
+ generating a Credential. |
+
String |
+getJsonKeyFilePath()
+Gets the file path to a JSON key file that will be used to
+ generate a service account
+Credential. |
+
String |
+getRefreshToken()
+Gets the refresh token that will be used to
+ generate a
+Credential. |
+
public com.google.api.client.http.HttpTransport getHttpTransport()+
HttpTransport that will be used when
+ generating a Credential.public String getRefreshToken()+
Credential.public String getClientId()+
Credential.public String getClientSecret()+
Credential.public String getJsonKeyFilePath()+
Credential.public com.google.api.client.auth.oauth2.Credential generateCredential() + throws OAuthException+
OAuthException - if the credential could not be refreshed.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/AuthModule.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/AuthModule.html new file mode 100644 index 0000000000..77c5b8740a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/AuthModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/AuthorizationHeaderProvider.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/AuthorizationHeaderProvider.html new file mode 100644 index 0000000000..2728eced9f --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/AuthorizationHeaderProvider.html @@ -0,0 +1,210 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Constructor and Description | +
|---|
AuthorizationHeaderHandler(SoapClientHandlerInterface soapClientHandler,
+ AuthorizationHeaderProvider authorizationHeaderProvider)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
AuthorizationHeaderProvider |
+Internals.getAuthorizationHeaderProvider()
+Obtains the Authorization header value.
+ |
+
| Constructor and Description | +
|---|
Internals(AuthorizationHeaderProvider authorizationHeaderProvider,
+ UserAgentCombiner userAgentCombiner,
+ com.google.api.client.http.HttpTransport httpTransport,
+ AdsServiceLoggers adsServiceLoggers,
+ OAuth2Helper oAuth2Helper,
+ AdsUtilityRegistry adsUtilityRegistry,
+ XmlFieldExtractor xmlFieldExtractor)
+Constructor to be injected by guice.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/GoogleClientSecretsBuilder.Api.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/GoogleClientSecretsBuilder.Api.html new file mode 100644 index 0000000000..98261e7f76 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/GoogleClientSecretsBuilder.Api.html @@ -0,0 +1,191 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.auth | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static GoogleClientSecretsBuilder.Api |
+GoogleClientSecretsBuilder.Api.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static GoogleClientSecretsBuilder.Api[] |
+GoogleClientSecretsBuilder.Api.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+GoogleClientSecretsBuilder.forApi(GoogleClientSecretsBuilder.Api api)
+Specifies which
+GoogleClientSecretsBuilder.Api should this GoogleClientSecrets be
+ generated for. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.html new file mode 100644 index 0000000000..1d107740c4 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.html @@ -0,0 +1,209 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.auth | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+GoogleClientSecretsBuilder.forApi(GoogleClientSecretsBuilder.Api api)
+Specifies which
+GoogleClientSecretsBuilder.Api should this GoogleClientSecrets be
+ generated for. |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.from(org.apache.commons.configuration.Configuration config)
+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 |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.fromFile() |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.fromFile(File path) |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.fromFile(String path) |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.fromFile(URL path) |
+
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder |
+GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.withClientSecrets(String clientId,
+ String clientSecret)
+Sets the client ID & secret to create the OAuth2 Credential with.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/GoogleClientSecretsBuilder.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/GoogleClientSecretsBuilder.html new file mode 100644 index 0000000000..8334609a9b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/GoogleClientSecretsBuilder.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/OAuth2AuthorizationHeaderProvider.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OAuth2AuthorizationHeaderProvider.html new file mode 100644 index 0000000000..dcf69ccceb --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OAuth2AuthorizationHeaderProvider.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.auth | ++ |
| Constructor and Description | +
|---|
AuthorizationHeaderProvider(OAuth2AuthorizationHeaderProvider oAuth2AuthorizationHeaderProvider,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ OAuth2Helper oAuth2Helper)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/OAuth2Compatible.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OAuth2Compatible.html new file mode 100644 index 0000000000..9e24e69bbb --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OAuth2Compatible.html @@ -0,0 +1,198 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerSession
+A
+AdManagerSession represents a single session of Ad Manager use. |
+
static class |
+AdManagerSession.ImmutableAdManagerSession
+Immutable, thread-safe implementation of AdManagerSession.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+OAuth2AuthorizationHeaderProvider.getOAuth2AuthorizationHeader(OAuth2Compatible oAuth2Compatible)
+Gets the OAuth2 authorization header for the parameters and request URL.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/OAuth2Helper.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OAuth2Helper.html new file mode 100644 index 0000000000..2ef0470dd8 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OAuth2Helper.html @@ -0,0 +1,211 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Constructor and Description | +
|---|
AuthorizationHeaderProvider(OAuth2AuthorizationHeaderProvider oAuth2AuthorizationHeaderProvider,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ OAuth2Helper oAuth2Helper)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
OAuth2Helper |
+Internals.getOAuth2Helper()
+Gets the OAuth2 helper.
+ |
+
| Constructor and Description | +
|---|
Internals(AuthorizationHeaderProvider authorizationHeaderProvider,
+ UserAgentCombiner userAgentCombiner,
+ com.google.api.client.http.HttpTransport httpTransport,
+ AdsServiceLoggers adsServiceLoggers,
+ OAuth2Helper oAuth2Helper,
+ AdsUtilityRegistry adsUtilityRegistry,
+ XmlFieldExtractor xmlFieldExtractor)
+Constructor to be injected by guice.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.Api.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.Api.html new file mode 100644 index 0000000000..9f98d18108 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.Api.html @@ -0,0 +1,175 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.auth | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static OfflineCredentials.Api |
+OfflineCredentials.Api.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static OfflineCredentials.Api[] |
+OfflineCredentials.Api.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.Builder.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.Builder.html new file mode 100644 index 0000000000..4890e3219a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.Builder.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.CustomOAuthConfig.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.CustomOAuthConfig.html new file mode 100644 index 0000000000..db7ef9e602 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.CustomOAuthConfig.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.ForApiBuilder.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.ForApiBuilder.html new file mode 100644 index 0000000000..ecf4d06fce --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.ForApiBuilder.html @@ -0,0 +1,248 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.auth | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.Builder.forApi(OfflineCredentials.OAuthConfig oAuthConfig)
+Specifies which
+OfflineCredentials.OAuthConfig should this OfflineCredentials be
+ used for. |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.from(org.apache.commons.configuration.Configuration config)
+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 |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.fromFile() |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.fromFile(File path) |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.fromFile(String path) |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.fromFile(URL path) |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.withClientSecrets(String clientId,
+ String clientSecret)
+Sets the client ID & secret to create the OAuth2 Credential with.
+ |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.withHttpTransport(com.google.api.client.http.HttpTransport httpTransport)
+Sets the
+HttpTransport to be used to make the request. |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.withJsonKeyFilePath(String jsonKeyFilePath)
+Sets the path to a JSON key file for authenticating with a service account.
+ |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.withRefreshToken(String refreshToken)
+Sets the refresh token to create the OAuth2 Credential with.
+ |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.withScopes(List<String> scopes)
+Optionally sets scopes for authenticating with a service account.
+ |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.withServiceAccountUser(String serviceAccountUser)
+Sets the service account user to impersonate.
+ |
+
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.ForApiBuilder.withTokenUrlServer(String tokenServerUrl)
+Sets the token server URL.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.OAuthConfig.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.OAuthConfig.html new file mode 100644 index 0000000000..32cd903f56 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.OAuthConfig.html @@ -0,0 +1,190 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.auth | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+OfflineCredentials.Api
+Enum representing the API that OfflineCredentials can be used for.
+ |
+
static class |
+OfflineCredentials.CustomOAuthConfig
+A class defining a custom OAuth config.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
OfflineCredentials.ForApiBuilder |
+OfflineCredentials.Builder.forApi(OfflineCredentials.OAuthConfig oAuthConfig)
+Specifies which
+OfflineCredentials.OAuthConfig should this OfflineCredentials be
+ used for. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.html b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.html new file mode 100644 index 0000000000..d9bc7eb5da --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/class-use/OfflineCredentials.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.auth | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
OfflineCredentials |
+OfflineCredentials.ForApiBuilder.build() |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/package-frame.html b/5.3.0/com/google/api/ads/common/lib/auth/package-frame.html new file mode 100644 index 0000000000..141ecaa476 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/package-frame.html @@ -0,0 +1,40 @@ + + + + + + +| Interface | +Description | +
|---|---|
| OAuth2Compatible | +
+ Interface for a user to be compatible with OAuth2.
+ |
+
| OfflineCredentials.OAuthConfig | +
+ Interface outlining the values required for OAuth configuration.
+ |
+
| Class | +Description | +
|---|---|
| AuthModule | +
+ Module for authentication.
+ |
+
| AuthorizationHeaderProvider | +
+ Authorization header provider that can delegate between different
+ authentication mechanisms depending on the
+AdsSession. |
+
| GoogleClientSecretsBuilder | +
+ Builder for
+GoogleClientSecrets. |
+
| GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder | +
+ Builder for
+GoogleClientSecrets. |
+
| OAuth2AuthorizationHeaderProvider | +
+ OAuth2 authorization header provider.
+ |
+
| OAuth2Helper | +
+ OAuth2 helper functions.
+ |
+
| OfflineCredentials | +
+ OfflineCredentials offline OAuth2 provider.
++ + Example usage: |
+
| OfflineCredentials.Builder | +
+ Pre-builder for OfflineCredentials.
+ |
+
| OfflineCredentials.CustomOAuthConfig | +
+ A class defining a custom OAuth config.
+ |
+
| OfflineCredentials.ForApiBuilder | +
+ Builder for OfflineCredentials.
+ |
+
| Enum | +Description | +
|---|---|
| GoogleClientSecretsBuilder.Api | +
+ Enum representing the API that GoogleClientSecretsBuilder can be used for.
+ |
+
| OfflineCredentials.Api | +
+ Enum representing the API that OfflineCredentials can be used for.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/package-tree.html b/5.3.0/com/google/api/ads/common/lib/auth/package-tree.html new file mode 100644 index 0000000000..c988249748 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/package-tree.html @@ -0,0 +1,170 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/auth/package-use.html b/5.3.0/com/google/api/ads/common/lib/auth/package-use.html new file mode 100644 index 0000000000..11d04faf66 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/auth/package-use.html @@ -0,0 +1,273 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Class and Description | +
|---|
| OAuth2Compatible
+ Interface for a user to be compatible with OAuth2.
+ |
+
| Class and Description | +
|---|
| GoogleClientSecretsBuilder.Api
+ Enum representing the API that GoogleClientSecretsBuilder can be used for.
+ |
+
| GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder
+ Builder for
+GoogleClientSecrets. |
+
| OAuth2AuthorizationHeaderProvider
+ OAuth2 authorization header provider.
+ |
+
| OAuth2Compatible
+ Interface for a user to be compatible with OAuth2.
+ |
+
| OAuth2Helper
+ OAuth2 helper functions.
+ |
+
| OfflineCredentials
+ OfflineCredentials offline OAuth2 provider.
++ + Example usage: |
+
| OfflineCredentials.Api
+ Enum representing the API that OfflineCredentials can be used for.
+ |
+
| OfflineCredentials.ForApiBuilder
+ Builder for OfflineCredentials.
+ |
+
| OfflineCredentials.OAuthConfig
+ Interface outlining the values required for OAuth configuration.
+ |
+
| Class and Description | +
|---|
| AuthorizationHeaderProvider
+ Authorization header provider that can delegate between different
+ authentication mechanisms depending on the
+AdsSession. |
+
| Class and Description | +
|---|
| AuthorizationHeaderProvider
+ Authorization header provider that can delegate between different
+ authentication mechanisms depending on the
+AdsSession. |
+
| OAuth2Helper
+ OAuth2 helper functions.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/class-use/AdsModule.html b/5.3.0/com/google/api/ads/common/lib/class-use/AdsModule.html new file mode 100644 index 0000000000..47f6577cf4 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/class-use/AdsModule.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerModule
+Guice module for Ad Manager bindings.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/class-use/AdsSoapModule.html b/5.3.0/com/google/api/ads/common/lib/class-use/AdsSoapModule.html new file mode 100644 index 0000000000..7b3d5636a9 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/class-use/AdsSoapModule.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerSoapModule
+Guice module for Ad Manager SOAP bindings.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/AdsServiceClient.html b/5.3.0/com/google/api/ads/common/lib/client/AdsServiceClient.html new file mode 100644 index 0000000000..d0954a33be --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/AdsServiceClient.html @@ -0,0 +1,428 @@ + + + + + + +S - the type of AdsSessionD - the type of AdsServiceDescriptorpublic abstract class AdsServiceClient<S extends AdsSession,D extends AdsServiceDescriptor> +extends SoapServiceClient<Object>+
+ This class connects the user, handler, and underlying service client. It + fulfills: +
| Constructor and Description | +
|---|
AdsServiceClient(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor,
+ SoapClientHandlerInterface<Object> soapClientHandler,
+ HeaderHandler<S,D> headerHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
D |
+getAdsServiceDescriptor()
+Gets the ads service descriptor for this client.
+ |
+
S |
+getAdsSession()
+Gets the ads session for this client.
+ |
+
protected void |
+logSoapCall(RemoteCallReturn remoteCallReturn)
+Logs a SOAP call.
+ |
+
void |
+setAdsSession(S session)
+Sets the ads session for this client.
+ |
+
protected void |
+setHeaders()
+Sets the headers for the service client.
+ |
+
callSoapClient, createSoapCall, getSoapClient, getSoapClientHandler, handleException, invoke, setEndpointAddress, unwrapRemoteCallReturnpublic AdsServiceClient(Object soapClient, + S adsSession, + D adsServiceDescriptor, + SoapClientHandlerInterface<Object> soapClientHandler, + HeaderHandler<S,D> headerHandler, + AdsServiceLoggers adsServiceLoggers)+
soapClient - the SOAP clientadsSession - the sessionadsServiceDescriptor - the service descriptorsoapClientHandler - the SOAP client handlerheaderHandler - the header handleradsServiceLoggers - the loggerspublic S getAdsSession()+
public D getAdsServiceDescriptor()+
public void setAdsSession(S session)+
session - the ads session to set for this clientprotected void logSoapCall(RemoteCallReturn remoteCallReturn)+
SoapServiceClientlogSoapCall in class SoapServiceClient<Object>protected void setHeaders() + throws ServiceException, + AuthenticationException+
SoapServiceClientsetHeaders in class SoapServiceClient<Object>ServiceException - if there was a problem setting the headersAuthenticationException - if there was a problem authenticating while
+ setting headersCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/AdsServiceDescriptor.html b/5.3.0/com/google/api/ads/common/lib/client/AdsServiceDescriptor.html new file mode 100644 index 0000000000..1094cd9376 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/AdsServiceDescriptor.html @@ -0,0 +1,288 @@ + + + + + + +public interface AdsServiceDescriptor +extends SoapServiceDescriptor+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getEndpointAddress(String endpointServer)
+Gets the endpoint address for this service and server.
+ |
+
Class<?> |
+getInterfaceClass()
+Gets the class representing the RPC interface of the service.
+ |
+
String |
+getVersion()
+Gets the version for this service.
+ |
+
Class<?> getInterfaceClass() + throws ServiceException+
getInterfaceClass in interface SoapServiceDescriptorServiceException - if the interface could not be retrieved.String getEndpointAddress(String endpointServer) + throws MalformedURLException+
getEndpointAddress in interface SoapServiceDescriptorMalformedURLExceptionString getVersion()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/AdsSession.html b/5.3.0/com/google/api/ads/common/lib/client/AdsSession.html new file mode 100644 index 0000000000..74f381b656 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/AdsSession.html @@ -0,0 +1,231 @@ + + + + + + +public interface AdsSession
+| Modifier and Type | +Method and Description | +
|---|---|
String |
+getEndpoint()
+Returns the server endpoint to make requests against.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/Endpoint.html b/5.3.0/com/google/api/ads/common/lib/client/Endpoint.html new file mode 100644 index 0000000000..f7b805e3bd --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/Endpoint.html @@ -0,0 +1,227 @@ + + + + + + +public interface Endpoint
+| Modifier and Type | +Method and Description | +
|---|---|
String |
+getEndpoint()
+Returns the endpoint to use.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/HeaderHandler.NoOpHeaderHandler.html b/5.3.0/com/google/api/ads/common/lib/client/HeaderHandler.NoOpHeaderHandler.html new file mode 100644 index 0000000000..bfd2acf8f3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/HeaderHandler.NoOpHeaderHandler.html @@ -0,0 +1,322 @@ + + + + + + +public static class HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor> +extends Object +implements HeaderHandler<S,D>+
HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>| Constructor and Description | +
|---|
NoOpHeaderHandler() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+setHeaders(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor)
+Sets the headers on the SOAP client using the session and descriptor.
+ |
+
public void setHeaders(Object soapClient, + S adsSession, + D adsServiceDescriptor) + throws ServiceException, + AuthenticationException+
HeaderHandlersetHeaders in interface HeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>soapClient - the SOAP clientadsSession - the ads sessionadsServiceDescriptor - the ads service descriptorServiceException - if there was a problem setting the headersAuthenticationException - if there was a problem authenticating the
+ sessionCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/HeaderHandler.html b/5.3.0/com/google/api/ads/common/lib/client/HeaderHandler.html new file mode 100644 index 0000000000..0d93950bd9 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/HeaderHandler.html @@ -0,0 +1,270 @@ + + + + + + +public interface HeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>
+| Modifier and Type | +Interface and Description | +
|---|---|
static class |
+HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>
+No-op implementation of HeaderHandler
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+setHeaders(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor)
+Sets the headers on the SOAP client using the session and descriptor.
+ |
+
void setHeaders(Object soapClient, + S adsSession, + D adsServiceDescriptor) + throws ServiceException, + AuthenticationException+
soapClient - the SOAP clientadsSession - the ads sessionadsServiceDescriptor - the ads service descriptorServiceException - if there was a problem setting the headersAuthenticationException - if there was a problem authenticating the
+ sessionCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/RemoteCallReturn.Builder.html b/5.3.0/com/google/api/ads/common/lib/client/RemoteCallReturn.Builder.html new file mode 100644 index 0000000000..2c47c006b3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/RemoteCallReturn.Builder.html @@ -0,0 +1,380 @@ + + + + + + +public static class RemoteCallReturn.Builder +extends Object+
RemoteCallReturn objects.| Constructor and Description | +
|---|
Builder()
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RemoteCallReturn |
+build()
+Returns the RemoteCallReturn this Builder has been constructing.
+ |
+
RemoteCallReturn.Builder |
+withException(Throwable exception)
+Adds an exception to the RemoteCallReturn under construction.
+ |
+
RemoteCallReturn.Builder |
+withRequestInfo(RequestInfo requestInfo)
+Adds a request info to the RemoteCallReturn under construction.
+ |
+
RemoteCallReturn.Builder |
+withResponseInfo(ResponseInfo responseInfo)
+Adds a response info to the RemoteCallReturn under construction.
+ |
+
RemoteCallReturn.Builder |
+withReturnValue(Object returnValue)
+Adds a return value to the RemoteCallReturn under construction.
+ |
+
@CanIgnoreReturnValue +public RemoteCallReturn.Builder withReturnValue(Object returnValue)+
returnValue - the return value to add to the RemoteCallReturn@CanIgnoreReturnValue +public RemoteCallReturn.Builder withResponseInfo(ResponseInfo responseInfo)+
responseInfo - the response info to add to the RemoteCallReturn@CanIgnoreReturnValue +public RemoteCallReturn.Builder withRequestInfo(RequestInfo requestInfo)+
requestInfo - the request info to add to the RemoteCallReturn@CanIgnoreReturnValue +public RemoteCallReturn.Builder withException(Throwable exception)+
exception - the exception to add to the RemoteCallReturnpublic RemoteCallReturn build()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/RemoteCallReturn.html b/5.3.0/com/google/api/ads/common/lib/client/RemoteCallReturn.html new file mode 100644 index 0000000000..ed3e3511b3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/RemoteCallReturn.html @@ -0,0 +1,323 @@ + + + + + + +public class RemoteCallReturn +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+RemoteCallReturn.Builder
+Builder for
+RemoteCallReturn objects. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Throwable |
+getException()
+Gets the exception from the remote call that was made if one occurred.
+ |
+
RequestInfo |
+getRequestInfo()
+Gets the request info from the remote call that was made.
+ |
+
ResponseInfo |
+getResponseInfo()
+Gets the response info from the remote call that was made.
+ |
+
Object |
+getReturnValue()
+Gets the return value from the remote call that was made.
+ |
+
public Object getReturnValue()+
null
+ if there was an exceptionpublic RequestInfo getRequestInfo()+
public ResponseInfo getResponseInfo()+
public Throwable getException()+
null
+ if there was no exceptionCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/RequestInfo.Builder.html b/5.3.0/com/google/api/ads/common/lib/client/RequestInfo.Builder.html new file mode 100644 index 0000000000..982a2b774e --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/RequestInfo.Builder.html @@ -0,0 +1,403 @@ + + + + + + +public static class RequestInfo.Builder +extends Object+
RequestInfo objects.| Modifier and Type | +Method and Description | +
|---|---|
RequestInfo |
+build()
+Returns the RequestInfo this Builder has been constructing.
+ |
+
RequestInfo.Builder |
+withContext(String contextName,
+ String contextValue)
+Adds the name/value pair for the context of this request.
+ |
+
RequestInfo.Builder |
+withMethodName(String methodName)
+Adds a method name to the RequestInfo under construction.
+ |
+
RequestInfo.Builder |
+withPayload(String payload)
+Adds the request payload to the RequestInfo under construction.
+ |
+
RequestInfo.Builder |
+withServiceName(String serviceName)
+Adds a service name to the RequestInfo under construction.
+ |
+
RequestInfo.Builder |
+withUrl(String url)
+Adds the target URL to the RequestInfo under construction.
+ |
+
@CanIgnoreReturnValue +public RequestInfo.Builder withMethodName(String methodName)+
methodName - the method name to add to the RequestInfo@CanIgnoreReturnValue +public RequestInfo.Builder withServiceName(String serviceName)+
serviceName - the service name to add to the RequestInfo@CanIgnoreReturnValue +public RequestInfo.Builder withPayload(String payload)+
payload - the raw request string to add to the RequestInfo@CanIgnoreReturnValue +public RequestInfo.Builder withUrl(String url)+
url - the URL that the request was made to@CanIgnoreReturnValue +public RequestInfo.Builder withContext(String contextName, + String contextValue)+
contextName - name for the valuecontextValue - the valuepublic RequestInfo build()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/RequestInfo.html b/5.3.0/com/google/api/ads/common/lib/client/RequestInfo.html new file mode 100644 index 0000000000..e334cbc302 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/RequestInfo.html @@ -0,0 +1,364 @@ + + + + + + +public class RequestInfo +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+RequestInfo.Builder
+Builder for
+RequestInfo objects. |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getContextName()
+Gets the name corresponding to
+getContextValue(). |
+
String |
+getContextValue()
+Returns the context value, such as the clientCustomerId for AdWords, or the networkCode for
+ Ad Manager.
+ |
+
String |
+getMethodName()
+Gets the method name.
+ |
+
String |
+getPayload()
+Gets the SOAP request XML.
+ |
+
String |
+getServiceName()
+Gets the service name.
+ |
+
String |
+getUrl()
+Gets the URL the request was made to.
+ |
+
String |
+toString() |
+
public String getPayload()+
public String getServiceName()+
public String getMethodName()+
public String getUrl()+
public String getContextName()+
getContextValue(). For example,
+ clientCustomerId for AdWords, or networkCode for Ad Manager.public String getContextValue()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/ResponseInfo.Builder.html b/5.3.0/com/google/api/ads/common/lib/client/ResponseInfo.Builder.html new file mode 100644 index 0000000000..618dba3fbe --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/ResponseInfo.Builder.html @@ -0,0 +1,357 @@ + + + + + + +public static class ResponseInfo.Builder +extends Object+
ResponseInfo objects.| Modifier and Type | +Method and Description | +
|---|---|
ResponseInfo |
+build()
+Returns the ResponseInfo this Builder has been constructing.
+ |
+
ResponseInfo.Builder |
+withOperationsCount(Long operationsCount) |
+
ResponseInfo.Builder |
+withPayload(String payload)
+Adds the response payload to the ResponseInfo under construction.
+ |
+
ResponseInfo.Builder |
+withRequestId(String requestId)
+Adds the SOAP response request ID to the ResponseInfo under construction.
+ |
+
ResponseInfo.Builder |
+withResponseTimeMillis(Long responseTimeMillis) |
+
@CanIgnoreReturnValue +public ResponseInfo.Builder withPayload(String payload)+
@CanIgnoreReturnValue +public ResponseInfo.Builder withRequestId(String requestId)+
@CanIgnoreReturnValue +public ResponseInfo.Builder withOperationsCount(@Nullable + Long operationsCount)+
@CanIgnoreReturnValue +public ResponseInfo.Builder withResponseTimeMillis(@Nullable + Long responseTimeMillis)+
public ResponseInfo build()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/ResponseInfo.html b/5.3.0/com/google/api/ads/common/lib/client/ResponseInfo.html new file mode 100644 index 0000000000..f3af61101d --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/ResponseInfo.html @@ -0,0 +1,331 @@ + + + + + + +public class ResponseInfo +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+ResponseInfo.Builder
+Builder for
+ResponseInfo objects. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Long |
+getOperationsCount()
+Returns the number of operationsCount from the response.
+ |
+
String |
+getPayload()
+Gets the response payload (e.g., XML, HTTP request).
+ |
+
String |
+getRequestId()
+Gets the SOAP response request ID.
+ |
+
Long |
+getResponseTime()
+Returns the response time in milliseconds.
+ |
+
String |
+toString() |
+
public String getPayload()+
public String getRequestId()+
@Nullable +public Long getOperationsCount()+
@Nullable +public Long getResponseTime()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/AdsServiceClient.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/AdsServiceClient.html new file mode 100644 index 0000000000..7f00d97af6 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/AdsServiceClient.html @@ -0,0 +1,271 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServiceClient
+Wrapper of underlying SOAP client which allows access for setting headers retrieved from the
+ session.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsSoapModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession>
+Guice module for common bindings.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Factory which creates ads service clients.
+ |
+
class |
+BaseAdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Base factory which creates service clients.
+ |
+
class |
+BaseServices<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Base for a utility class which creates service clients.
+ |
+
class |
+FactoryModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession,H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>>
+Module for factories.
+ |
+
static interface |
+FactoryModule.AdsServiceClientFactoryInterface<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Factory interface class to create
+AdsServiceClient. |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Interface for helpers of factories which creates ads service clients.
+ |
+
class |
+BaseAdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Abstract helper for
+AdsServiceClientFactoryHelper. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/AdsServiceDescriptor.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/AdsServiceDescriptor.html new file mode 100644 index 0000000000..6a327b8f11 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/AdsServiceDescriptor.html @@ -0,0 +1,337 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServiceDescriptor
+AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsSoapModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession>
+Guice module for common bindings.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsServiceClient<S extends AdsSession,D extends AdsServiceDescriptor>
+The base class for all AdsServiceClients.
+ |
+
interface |
+HeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>
+Interface for handling headers.
+ |
+
static class |
+HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>
+No-op implementation of HeaderHandler
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Factory which creates ads service clients.
+ |
+
class |
+BaseAdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Base factory which creates service clients.
+ |
+
class |
+BaseServices<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Base for a utility class which creates service clients.
+ |
+
class |
+FactoryModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession,H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>>
+Module for factories.
+ |
+
static interface |
+FactoryModule.AdsServiceClientFactoryInterface<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Factory interface class to create
+AdsServiceClient. |
+
static interface |
+FactoryModule.AdsServiceDescriptorFactoryInterface<D extends AdsServiceDescriptor>
+Factory interface class to create
+AdsServiceDescriptor. |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Interface for helpers of factories which creates ads service clients.
+ |
+
class |
+BaseAdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Abstract helper for
+AdsServiceClientFactoryHelper. |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AxisSoapHeaderFactory<D extends AdsServiceDescriptor>
+Factory for creating Axis soap headers.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/AdsSession.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/AdsSession.html new file mode 100644 index 0000000000..6e92098480 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/AdsSession.html @@ -0,0 +1,369 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerSession
+A
+AdManagerSession represents a single session of Ad Manager use. |
+
static class |
+AdManagerSession.ImmutableAdManagerSession
+Immutable, thread-safe implementation of AdManagerSession.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsSoapModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession>
+Guice module for common bindings.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+AuthorizationHeaderProvider.getAuthorizationHeader(AdsSession adsSession,
+ String endpointUrl)
+Gets a header value that can be set to the
+Authorization HTTP
+ header. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsServiceClient<S extends AdsSession,D extends AdsServiceDescriptor>
+The base class for all AdsServiceClients.
+ |
+
interface |
+HeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>
+Interface for handling headers.
+ |
+
static class |
+HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>
+No-op implementation of HeaderHandler
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Factory which creates ads service clients.
+ |
+
interface |
+AdsServicesInterface<S extends AdsSession>
+Service factory for an ads product.
+ |
+
class |
+BaseAdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Base factory which creates service clients.
+ |
+
class |
+BaseServices<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Base for a utility class which creates service clients.
+ |
+
class |
+FactoryModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession,H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>>
+Module for factories.
+ |
+
static interface |
+FactoryModule.AdsServiceClientFactoryInterface<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Factory interface class to create
+AdsServiceClient. |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Interface for helpers of factories which creates ads service clients.
+ |
+
class |
+BaseAdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Abstract helper for
+AdsServiceClientFactoryHelper. |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AuthorizationHeaderHandler.setAuthorization(Object soapClient,
+ AdsSession adsSession)
+Sets the authorization header created from the session on the soap client.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/Endpoint.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/Endpoint.html new file mode 100644 index 0000000000..87c387ea4a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/Endpoint.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/HeaderHandler.NoOpHeaderHandler.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/HeaderHandler.NoOpHeaderHandler.html new file mode 100644 index 0000000000..1147a62718 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/HeaderHandler.NoOpHeaderHandler.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/HeaderHandler.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/HeaderHandler.html new file mode 100644 index 0000000000..1d10e90dab --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/HeaderHandler.html @@ -0,0 +1,261 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.client | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerAxisHeaderHandler
+Ad Manager implementation of
+HeaderHandler. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerJaxWsHeaderHandler
+Ad Manager implementation of
+HeaderHandler for JAX-WS. |
+
| Constructor and Description | +
|---|
AdManagerServiceClient(Object soapClient,
+ AdManagerServiceDescriptor adManagerServiceDescriptor,
+ AdManagerSession adManagerSession,
+ SoapClientHandlerInterface soapClientHandler,
+ HeaderHandler<AdManagerSession,AdManagerServiceDescriptor> adManagerHeaderHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor>
+No-op implementation of HeaderHandler
+ |
+
| Constructor and Description | +
|---|
AdsServiceClient(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor,
+ SoapClientHandlerInterface<Object> soapClientHandler,
+ HeaderHandler<S,D> headerHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/RemoteCallReturn.Builder.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/RemoteCallReturn.Builder.html new file mode 100644 index 0000000000..711951c25b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/RemoteCallReturn.Builder.html @@ -0,0 +1,186 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
RemoteCallReturn.Builder |
+RemoteCallReturn.Builder.withException(Throwable exception)
+Adds an exception to the RemoteCallReturn under construction.
+ |
+
RemoteCallReturn.Builder |
+RemoteCallReturn.Builder.withRequestInfo(RequestInfo requestInfo)
+Adds a request info to the RemoteCallReturn under construction.
+ |
+
RemoteCallReturn.Builder |
+RemoteCallReturn.Builder.withResponseInfo(ResponseInfo responseInfo)
+Adds a response info to the RemoteCallReturn under construction.
+ |
+
RemoteCallReturn.Builder |
+RemoteCallReturn.Builder.withReturnValue(Object returnValue)
+Adds a return value to the RemoteCallReturn under construction.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/RemoteCallReturn.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/RemoteCallReturn.html new file mode 100644 index 0000000000..d023f8c3f0 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/RemoteCallReturn.html @@ -0,0 +1,316 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| com.google.api.ads.common.lib.utils.logging | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
RemoteCallReturn |
+RemoteCallReturn.Builder.build()
+Returns the RemoteCallReturn this Builder has been constructing.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+AdsServiceClient.logSoapCall(RemoteCallReturn remoteCallReturn) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected RemoteCallReturn |
+SoapServiceClient.callSoapClient(SoapCall<T> soapCall)
+Called from
+SoapServiceClient.invoke(Object, Method, Object[]) if the method is
+ intended for the SOAP client. |
+
RemoteCallReturn |
+SoapClientHandlerInterface.invokeSoapCall(SoapCall<T> soapCall)
+Executes the
+SoapCall, which has a reference to a
+ SoapClientHandlerInterface. |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected abstract void |
+SoapServiceClient.logSoapCall(RemoteCallReturn remoteCallReturn)
+Logs a SOAP call.
+ |
+
protected Object |
+SoapServiceClient.unwrapRemoteCallReturn(RemoteCallReturn remoteCallReturn)
+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.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RemoteCallReturn |
+AxisHandler.invokeSoapCall(SoapCall<org.apache.axis.client.Stub> soapCall)
+Invoke a SOAP call.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RemoteCallReturn |
+JaxWsHandler.invokeSoapCall(SoapCall<BindingProvider> soapCall)
+Invoke a SOAP call.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdsServiceLoggers.logRequest(RemoteCallReturn remoteCallReturn)
+Logs basic information on a SOAP request.
+ |
+
void |
+RemoteCallLoggerDelegate.logRequestDetails(RemoteCallReturn remoteCallReturn) |
+
void |
+RemoteCallLoggerDelegate.logRequestSummary(RemoteCallReturn remoteCallReturn) |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/RequestInfo.Builder.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/RequestInfo.Builder.html new file mode 100644 index 0000000000..0439802254 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/RequestInfo.Builder.html @@ -0,0 +1,254 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
RequestInfo.Builder |
+RequestInfo.Builder.withContext(String contextName,
+ String contextValue)
+Adds the name/value pair for the context of this request.
+ |
+
RequestInfo.Builder |
+RequestInfo.Builder.withMethodName(String methodName)
+Adds a method name to the RequestInfo under construction.
+ |
+
RequestInfo.Builder |
+RequestInfo.Builder.withPayload(String payload)
+Adds the request payload to the RequestInfo under construction.
+ |
+
RequestInfo.Builder |
+RequestInfo.Builder.withServiceName(String serviceName)
+Adds a service name to the RequestInfo under construction.
+ |
+
RequestInfo.Builder |
+RequestInfo.Builder.withUrl(String url)
+Adds the target URL to the RequestInfo under construction.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RequestInfo.Builder |
+RequestInfoXPathSet.parseMessage(RequestInfo.Builder builder,
+ SOAPMessage soapMessage) |
+
| Modifier and Type | +Method and Description | +
|---|---|
RequestInfo.Builder |
+RequestInfoXPathSet.parseMessage(RequestInfo.Builder builder,
+ SOAPMessage soapMessage) |
+
| Modifier and Type | +Method and Description | +
|---|---|
RequestInfo.Builder |
+JaxWsSoapContextHandler.getLastRequestInfoBuilder()
+Returns info for the last SOAP request.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/RequestInfo.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/RequestInfo.html new file mode 100644 index 0000000000..3f795b241c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/RequestInfo.html @@ -0,0 +1,189 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
RequestInfo |
+RequestInfo.Builder.build()
+Returns the RequestInfo this Builder has been constructing.
+ |
+
RequestInfo |
+RemoteCallReturn.getRequestInfo()
+Gets the request info from the remote call that was made.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RemoteCallReturn.Builder |
+RemoteCallReturn.Builder.withRequestInfo(RequestInfo requestInfo)
+Adds a request info to the RemoteCallReturn under construction.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/ResponseInfo.Builder.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/ResponseInfo.Builder.html new file mode 100644 index 0000000000..24b4fd43ab --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/ResponseInfo.Builder.html @@ -0,0 +1,243 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ResponseInfo.Builder |
+ResponseInfo.Builder.withOperationsCount(Long operationsCount) |
+
ResponseInfo.Builder |
+ResponseInfo.Builder.withPayload(String payload)
+Adds the response payload to the ResponseInfo under construction.
+ |
+
ResponseInfo.Builder |
+ResponseInfo.Builder.withRequestId(String requestId)
+Adds the SOAP response request ID to the ResponseInfo under construction.
+ |
+
ResponseInfo.Builder |
+ResponseInfo.Builder.withResponseTimeMillis(Long responseTimeMillis) |
+
| Modifier and Type | +Method and Description | +
|---|---|
ResponseInfo.Builder |
+ResponseInfoXPathSet.parseMessage(ResponseInfo.Builder builder,
+ SOAPMessage soapMessage) |
+
| Modifier and Type | +Method and Description | +
|---|---|
ResponseInfo.Builder |
+ResponseInfoXPathSet.parseMessage(ResponseInfo.Builder builder,
+ SOAPMessage soapMessage) |
+
| Modifier and Type | +Method and Description | +
|---|---|
ResponseInfo.Builder |
+JaxWsSoapContextHandler.getLastResponseInfoBuilder()
+Returns info for the last SOAP response.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/class-use/ResponseInfo.html b/5.3.0/com/google/api/ads/common/lib/client/class-use/ResponseInfo.html new file mode 100644 index 0000000000..1886805ee0 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/class-use/ResponseInfo.html @@ -0,0 +1,189 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ResponseInfo |
+ResponseInfo.Builder.build()
+Returns the ResponseInfo this Builder has been constructing.
+ |
+
ResponseInfo |
+RemoteCallReturn.getResponseInfo()
+Gets the response info from the remote call that was made.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RemoteCallReturn.Builder |
+RemoteCallReturn.Builder.withResponseInfo(ResponseInfo responseInfo)
+Adds a response info to the RemoteCallReturn under construction.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/package-frame.html b/5.3.0/com/google/api/ads/common/lib/client/package-frame.html new file mode 100644 index 0000000000..28a6914b82 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/package-frame.html @@ -0,0 +1,35 @@ + + + + + + +| Interface | +Description | +
|---|---|
| AdsServiceDescriptor | +
+ Interface for ads service descriptors.
+ |
+
| AdsSession | +
+ Interface for an ads session.
+ |
+
| Endpoint | +
+ Marker interface for Environments to implement.
+ |
+
| HeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor> | +
+ Interface for handling headers.
+ |
+
| Class | +Description | +
|---|---|
| AdsServiceClient<S extends AdsSession,D extends AdsServiceDescriptor> | +
+ The base class for all AdsServiceClients.
+ |
+
| HeaderHandler.NoOpHeaderHandler<S extends AdsSession,D extends AdsServiceDescriptor> | +
+ No-op implementation of HeaderHandler
+ |
+
| RemoteCallReturn | +
+ Used to package a remote call's return.
+ |
+
| RemoteCallReturn.Builder | +
+ Builder for
+RemoteCallReturn objects. |
+
| RequestInfo | +
+ Contains information about the request that was made.
+ |
+
| RequestInfo.Builder | +
+ Builder for
+RequestInfo objects. |
+
| ResponseInfo | +
+ Contains information about the response from the request that was made.
+ |
+
| ResponseInfo.Builder | +
+ Builder for
+ResponseInfo objects. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/package-tree.html b/5.3.0/com/google/api/ads/common/lib/client/package-tree.html new file mode 100644 index 0000000000..4470d221e3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/package-tree.html @@ -0,0 +1,161 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/client/package-use.html b/5.3.0/com/google/api/ads/common/lib/client/package-use.html new file mode 100644 index 0000000000..0644c3009e --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/client/package-use.html @@ -0,0 +1,507 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| com.google.api.ads.common.lib.utils.logging | ++ |
| Class and Description | +
|---|
| HeaderHandler
+ Interface for handling headers.
+ |
+
| Class and Description | +
|---|
| HeaderHandler
+ Interface for handling headers.
+ |
+
| Class and Description | +
|---|
| AdsServiceClient
+ The base class for all AdsServiceClients.
+ |
+
| AdsServiceDescriptor
+ Interface for ads service descriptors.
+ |
+
| AdsSession
+ Interface for an ads session.
+ |
+
| HeaderHandler
+ Interface for handling headers.
+ |
+
| Class and Description | +
|---|
| AdsServiceClient
+ The base class for all AdsServiceClients.
+ |
+
| AdsServiceDescriptor
+ Interface for ads service descriptors.
+ |
+
| AdsSession
+ Interface for an ads session.
+ |
+
| Class and Description | +
|---|
| AdsSession
+ Interface for an ads session.
+ |
+
| Class and Description | +
|---|
| AdsServiceDescriptor
+ Interface for ads service descriptors.
+ |
+
| AdsSession
+ Interface for an ads session.
+ |
+
| HeaderHandler
+ Interface for handling headers.
+ |
+
| RemoteCallReturn
+ Used to package a remote call's return.
+ |
+
| RemoteCallReturn.Builder
+ Builder for
+RemoteCallReturn objects. |
+
| RequestInfo
+ Contains information about the request that was made.
+ |
+
| RequestInfo.Builder
+ Builder for
+RequestInfo objects. |
+
| ResponseInfo
+ Contains information about the response from the request that was made.
+ |
+
| ResponseInfo.Builder
+ Builder for
+ResponseInfo objects. |
+
| Class and Description | +
|---|
| AdsServiceClient
+ The base class for all AdsServiceClients.
+ |
+
| AdsServiceDescriptor
+ Interface for ads service descriptors.
+ |
+
| AdsSession
+ Interface for an ads session.
+ |
+
| Class and Description | +
|---|
| AdsServiceClient
+ The base class for all AdsServiceClients.
+ |
+
| AdsServiceDescriptor
+ Interface for ads service descriptors.
+ |
+
| AdsSession
+ Interface for an ads session.
+ |
+
| Class and Description | +
|---|
| AdsSession
+ Interface for an ads session.
+ |
+
| RemoteCallReturn
+ Used to package a remote call's return.
+ |
+
| RequestInfo.Builder
+ Builder for
+RequestInfo objects. |
+
| ResponseInfo.Builder
+ Builder for
+ResponseInfo objects. |
+
| Class and Description | +
|---|
| AdsServiceDescriptor
+ Interface for ads service descriptors.
+ |
+
| RemoteCallReturn
+ Used to package a remote call's return.
+ |
+
| Class and Description | +
|---|
| RemoteCallReturn
+ Used to package a remote call's return.
+ |
+
| RequestInfo.Builder
+ Builder for
+RequestInfo objects. |
+
| ResponseInfo.Builder
+ Builder for
+ResponseInfo objects. |
+
| Class and Description | +
|---|
| RemoteCallReturn
+ Used to package a remote call's return.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/AuthenticationException.html b/5.3.0/com/google/api/ads/common/lib/exception/AuthenticationException.html new file mode 100644 index 0000000000..0c21cc7599 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/AuthenticationException.html @@ -0,0 +1,299 @@ + + + + + + +public abstract class AuthenticationException +extends Exception+
| Constructor and Description | +
|---|
AuthenticationException(String message)
+Constructor.
+ |
+
AuthenticationException(String message,
+ Throwable cause)
+Constructor.
+ |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/OAuthException.html b/5.3.0/com/google/api/ads/common/lib/exception/OAuthException.html new file mode 100644 index 0000000000..efa7b94581 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/OAuthException.html @@ -0,0 +1,299 @@ + + + + + + +public class OAuthException +extends AuthenticationException+
| Constructor and Description | +
|---|
OAuthException(String message)
+Constructor.
+ |
+
OAuthException(String message,
+ Throwable cause)
+Constructor.
+ |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/ServiceException.html b/5.3.0/com/google/api/ads/common/lib/exception/ServiceException.html new file mode 100644 index 0000000000..b45154fc27 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/ServiceException.html @@ -0,0 +1,299 @@ + + + + + + +public class ServiceException +extends RuntimeException+
| Constructor and Description | +
|---|
ServiceException(String message)
+Constructor.
+ |
+
ServiceException(String message,
+ Throwable exception)
+Constructor.
+ |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic ServiceException(String message, + Throwable exception)+
message - the exception messageexception - the underlying exceptionpublic ServiceException(String message)+
message - the exception messageCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/ValidationException.html b/5.3.0/com/google/api/ads/common/lib/exception/ValidationException.html new file mode 100644 index 0000000000..88d6bccd3a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/ValidationException.html @@ -0,0 +1,351 @@ + + + + + + +public class ValidationException +extends Exception+
| Constructor and Description | +
|---|
ValidationException(String message,
+ String trigger)
+Constructor.
+ |
+
ValidationException(String message,
+ String trigger,
+ Throwable cause)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getTrigger() |
+
String |
+toString() |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTraceCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/class-use/AuthenticationException.html b/5.3.0/com/google/api/ads/common/lib/exception/class-use/AuthenticationException.html new file mode 100644 index 0000000000..efb9a18f2f --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/class-use/AuthenticationException.html @@ -0,0 +1,309 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.exception | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdManagerAxisHeaderHandler.setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdManagerJaxWsHeaderHandler.setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+AuthorizationHeaderProvider.getAuthorizationHeader(AdsSession adsSession,
+ String endpointUrl)
+Gets a header value that can be set to the
+Authorization HTTP
+ header. |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+AdsServiceClient.setHeaders() |
+
void |
+HeaderHandler.setHeaders(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor)
+Sets the headers on the SOAP client using the session and descriptor.
+ |
+
void |
+HeaderHandler.NoOpHeaderHandler.setHeaders(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+OAuthException
+An exception thrown when OAuth could not be used correctly.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AuthorizationHeaderHandler.setAuthorization(Object soapClient,
+ AdsSession adsSession)
+Sets the authorization header created from the session on the soap client.
+ |
+
protected abstract void |
+SoapServiceClient.setHeaders()
+Sets the headers for the service client.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/class-use/OAuthException.html b/5.3.0/com/google/api/ads/common/lib/exception/class-use/OAuthException.html new file mode 100644 index 0000000000..daa02f8393 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/class-use/OAuthException.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.auth | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
com.google.api.client.auth.oauth2.Credential |
+OfflineCredentials.generateCredential()
+Generates a new offline credential and immediately refreshes it.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/class-use/ServiceException.html b/5.3.0/com/google/api/ads/common/lib/exception/class-use/ServiceException.html new file mode 100644 index 0000000000..bf55e10bd6 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/class-use/ServiceException.html @@ -0,0 +1,430 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdManagerAxisHeaderHandler.setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdManagerJaxWsHeaderHandler.setHeaders(Object soapClient,
+ AdManagerSession adManagerSession,
+ AdManagerServiceDescriptor adManagerServiceDescriptor) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Class<?> |
+AdManagerServiceDescriptor.getInterfaceClass() |
+
| Modifier and Type | +Method and Description | +
|---|---|
Class<?> |
+AdsServiceDescriptor.getInterfaceClass()
+Gets the class representing the RPC interface of the service.
+ |
+
protected void |
+AdsServiceClient.setHeaders() |
+
void |
+HeaderHandler.setHeaders(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor)
+Sets the headers on the SOAP client using the session and descriptor.
+ |
+
void |
+HeaderHandler.NoOpHeaderHandler.setHeaders(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor) |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> T |
+AdsServiceClientFactory.getServiceClient(S adsSession,
+ Class<T> interfaceClass)
+Gets a client given a session and the class of the desired stub interface.
+ |
+
<T> T |
+BaseAdsServiceClientFactory.getServiceClientAsInterface(S adsSession,
+ Class<T> interfaceClass)
+Gets a client given a session and the class of the desired stub interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+BaseAdsServiceClientFactoryHelper.checkServiceClientPreconditions(S adsSession,
+ Class<?> interfaceClass)
+Default implementation of passing service client preconditions.
+ |
+
void |
+AdsServiceClientFactoryHelper.checkServiceClientPreconditions(S adsSession,
+ Class<?> interfaceClass)
+Checks preconditions of the session and interface and throws an exception
+ if the client cannot be generated.
+ |
+
C |
+BaseAdsServiceClientFactoryHelper.createAdsServiceClient(D adsServiceDescriptor,
+ S adsSession)
+
+ |
+
C |
+AdsServiceClientFactoryHelper.createAdsServiceClient(D adsServiceDescriptor,
+ S adsSession)
+Creates an
+AdsServiceClient for the descriptor, session, and
+ endpoint. |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+SoapClientHandlerInterface.createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
+Creates a SOAP client using the
+soapServiceDescriptor. |
+
Class<?> |
+SoapServiceDescriptor.getInterfaceClass()
+Gets the class representing the RPC interface of the service.
+ |
+
void |
+SoapClientHandlerInterface.setHeader(T soapClient,
+ String namespace,
+ String headerName,
+ Object headerValue)
+Sets a header on the SOAP client.
+ |
+
protected abstract void |
+SoapServiceClient.setHeaders()
+Sets the headers for the service client.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
org.apache.axis.client.Stub |
+AxisHandler.createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
+Creates a SOAP client using a SOAP service descriptor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
BindingProvider |
+JaxWsHandler.createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
+Creates a SOAP client using a SOAP service descriptor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/class-use/ValidationException.html b/5.3.0/com/google/api/ads/common/lib/exception/class-use/ValidationException.html new file mode 100644 index 0000000000..3d9fdcdd26 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/class-use/ValidationException.html @@ -0,0 +1,224 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
AdManagerSession |
+AdManagerSession.Builder.build()
+Builds the
+AdManagerSession. |
+
AdManagerSession.ImmutableAdManagerSession |
+AdManagerSession.Builder.buildImmutable()
+Builds a thread-safe
+AdManagerSession.ImmutableAdManagerSession. |
+
| Modifier and Type | +Method and Description | +
|---|---|
OfflineCredentials |
+OfflineCredentials.ForApiBuilder.build() |
+
com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets |
+GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder.build() |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+Builder.build()
+Constructs this object.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/package-frame.html b/5.3.0/com/google/api/ads/common/lib/exception/package-frame.html new file mode 100644 index 0000000000..018f381880 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Exception | +Description | +
|---|---|
| AuthenticationException | +
+ Base exception for all authentication exceptions.
+ |
+
| OAuthException | +
+ An exception thrown when OAuth could not be used correctly.
+ |
+
| ServiceException | +
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| ValidationException | +
+ Exception for validation errors.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/package-tree.html b/5.3.0/com/google/api/ads/common/lib/exception/package-tree.html new file mode 100644 index 0000000000..e53aa2f2d8 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/exception/package-use.html b/5.3.0/com/google/api/ads/common/lib/exception/package-use.html new file mode 100644 index 0000000000..6ecd0ed7f5 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/exception/package-use.html @@ -0,0 +1,427 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.exception | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Class and Description | +
|---|
| AuthenticationException
+ Base exception for all authentication exceptions.
+ |
+
| ServiceException
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| Class and Description | +
|---|
| AuthenticationException
+ Base exception for all authentication exceptions.
+ |
+
| ServiceException
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| Class and Description | +
|---|
| ServiceException
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| ValidationException
+ Exception for validation errors.
+ |
+
| Class and Description | +
|---|
| AuthenticationException
+ Base exception for all authentication exceptions.
+ |
+
| OAuthException
+ An exception thrown when OAuth could not be used correctly.
+ |
+
| ValidationException
+ Exception for validation errors.
+ |
+
| Class and Description | +
|---|
| AuthenticationException
+ Base exception for all authentication exceptions.
+ |
+
| ServiceException
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| Class and Description | +
|---|
| AuthenticationException
+ Base exception for all authentication exceptions.
+ |
+
| Class and Description | +
|---|
| ServiceException
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| Class and Description | +
|---|
| ServiceException
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| Class and Description | +
|---|
| AuthenticationException
+ Base exception for all authentication exceptions.
+ |
+
| ServiceException
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| Class and Description | +
|---|
| ServiceException
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| Class and Description | +
|---|
| ServiceException
+ A runtime service exception that usually cannot be recovered from.
+ |
+
| Class and Description | +
|---|
| ValidationException
+ Exception for validation errors.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/AdsServiceClientFactory.html b/5.3.0/com/google/api/ads/common/lib/factory/AdsServiceClientFactory.html new file mode 100644 index 0000000000..5974e7d887 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/AdsServiceClientFactory.html @@ -0,0 +1,308 @@ + + + + + + +C - the type of AdsServiceClientS - the type of AdsSessionD - the type of AdsServiceDescriptorpublic class AdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> +extends Object+
| Constructor and Description | +
|---|
AdsServiceClientFactory(AdsServiceClientFactoryHelper adsServiceClientFactoryHelper)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> T |
+getServiceClient(S adsSession,
+ Class<T> interfaceClass)
+Gets a client given a session and the class of the desired stub interface.
+ |
+
@Inject +public AdsServiceClientFactory(AdsServiceClientFactoryHelper adsServiceClientFactoryHelper)+
adsServiceClientFactoryHelper - the ads service client factory helper.public <T> T getServiceClient(S adsSession, + Class<T> interfaceClass) + throws ServiceException+
T - the service typeadsSession - the session associated with the desired
+ clientinterfaceClass - the class type of the desired clientServiceException - if the service client could not be createdCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/AdsServicesInterface.html b/5.3.0/com/google/api/ads/common/lib/factory/AdsServicesInterface.html new file mode 100644 index 0000000000..5719f43921 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/AdsServicesInterface.html @@ -0,0 +1,250 @@ + + + + + + +public interface AdsServicesInterface<S extends AdsSession>
+| Modifier and Type | +Method and Description | +
|---|---|
<T> T |
+get(S session,
+ Class<T> interfaceClass)
+Gets a client for the service represented by the interface with a reference to the session.
+ |
+
<T> T get(S session, + Class<T> interfaceClass)+
There is no guarantee that the objects returned by this method are thread-safe.
T - the service typesession - your current sessioninterfaceClass - the service interface class representing a SOAP serviceCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/BaseAdsServiceClientFactory.html b/5.3.0/com/google/api/ads/common/lib/factory/BaseAdsServiceClientFactory.html new file mode 100644 index 0000000000..ddce7499b7 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/BaseAdsServiceClientFactory.html @@ -0,0 +1,351 @@ + + + + + + +C - the type of AdsServiceClientS - the type of AdsSessionD - the type of AdsServiceDescriptorpublic abstract class BaseAdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> +extends Object+
| Modifier | +Constructor and Description | +
|---|---|
protected |
+BaseAdsServiceClientFactory(com.google.inject.AbstractModule module)
+Constructor.
+ |
+
protected |
+BaseAdsServiceClientFactory(AdsServiceClientFactory<C,S,D> adsServiceClientFactory)
+Constructor.
+ |
+
protected |
+BaseAdsServiceClientFactory(com.google.inject.Injector injector)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> T |
+getServiceClientAsInterface(S adsSession,
+ Class<T> interfaceClass)
+Gets a client given a session and the class of the desired stub interface.
+ |
+
protected BaseAdsServiceClientFactory(AdsServiceClientFactory<C,S,D> adsServiceClientFactory)+
adsServiceClientFactory - the ads service client factoryprotected BaseAdsServiceClientFactory(com.google.inject.AbstractModule module)+
module - the module used for injectionprotected BaseAdsServiceClientFactory(com.google.inject.Injector injector)+
injector - the injector used for injectionpublic <T> T getServiceClientAsInterface(S adsSession, + Class<T> interfaceClass) + throws ServiceException+
adsSession - the session associated with the desired
+ clientinterfaceClass - the class type of the desired clientServiceExceptionCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/BaseServices.html b/5.3.0/com/google/api/ads/common/lib/factory/BaseServices.html new file mode 100644 index 0000000000..9c1dabff09 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/BaseServices.html @@ -0,0 +1,319 @@ + + + + + + +C - the type of AdsServiceClientS - the type of AdsSessionD - the type of AdsServiceDescriptorpublic abstract class BaseServices<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> +extends Object +implements AdsServicesInterface<S>+
| Modifier | +Constructor and Description | +
|---|---|
protected |
+BaseServices(BaseAdsServiceClientFactory<C,S,D> factory)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> T |
+get(S session,
+ Class<T> interfaceClass)
+Gets a client for the service represented by the interface with a reference to the session.
+ |
+
protected BaseServices(BaseAdsServiceClientFactory<C,S,D> factory)+
factory - a factory capable of instantiating service clientspublic <T> T get(S session, + Class<T> interfaceClass)+
AdsServicesInterfaceThere is no guarantee that the objects returned by this method are thread-safe.
get in interface AdsServicesInterface<S extends AdsSession>T - the service typesession - your current sessioninterfaceClass - the service interface class representing a SOAP serviceCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/FactoryModule.AdsServiceClientFactoryInterface.html b/5.3.0/com/google/api/ads/common/lib/factory/FactoryModule.AdsServiceClientFactoryInterface.html new file mode 100644 index 0000000000..8ea2055be7 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/FactoryModule.AdsServiceClientFactoryInterface.html @@ -0,0 +1,253 @@ + + + + + + +C - the subclass of AdsServiceClientS - the subclass of AdsSessionD - the subclass of AdsServiceDescriptorpublic static interface FactoryModule.AdsServiceClientFactoryInterface<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+AdsServiceClient.| Modifier and Type | +Method and Description | +
|---|---|
C |
+create(Object soapClient,
+ D adsServiceDescriptor,
+ S adsSession)
+Creates an
+AdsServiceClient given a SOAP client and an
+ AdsServiceDescriptor descriptor. |
+
C create(Object soapClient, + D adsServiceDescriptor, + S adsSession)+
AdsServiceClient given a SOAP client and an
+ AdsServiceDescriptor descriptor.soapClient - the SOAP client underlying this service clientadsServiceDescriptor - the service to get the client foradsSession - the ads sessionCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/FactoryModule.AdsServiceDescriptorFactoryInterface.html b/5.3.0/com/google/api/ads/common/lib/factory/FactoryModule.AdsServiceDescriptorFactoryInterface.html new file mode 100644 index 0000000000..f71176fef4 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/FactoryModule.AdsServiceDescriptorFactoryInterface.html @@ -0,0 +1,244 @@ + + + + + + +D - the subclass of AdsServiceDescriptorpublic static interface FactoryModule.AdsServiceDescriptorFactoryInterface<D extends AdsServiceDescriptor>
+AdsServiceDescriptor.| Modifier and Type | +Method and Description | +
|---|---|
D |
+create(Class<?> interfaceClass,
+ String version)
+Creates an ads service descriptor given an interface class.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/FactoryModule.html b/5.3.0/com/google/api/ads/common/lib/factory/FactoryModule.html new file mode 100644 index 0000000000..eace02b926 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/FactoryModule.html @@ -0,0 +1,355 @@ + + + + + + +C - the subclass of AdsServiceClientD - the subclass of AdsServiceDescriptorS - the subclass of AdsSessionH - the subclass of AdsServiceClientFactoryHelperF - the subclass of BaseAdsServiceClientFactorypublic class FactoryModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession,H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>>
+extends com.google.inject.AbstractModule
+| Modifier and Type | +Class and Description | +
|---|---|
static interface |
+FactoryModule.AdsServiceClientFactoryInterface<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Factory interface class to create
+AdsServiceClient. |
+
static interface |
+FactoryModule.AdsServiceDescriptorFactoryInterface<D extends AdsServiceDescriptor>
+Factory interface class to create
+AdsServiceDescriptor. |
+
| Constructor and Description | +
|---|
FactoryModule(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral,
+ com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral,
+ Class<H> adsServiceClientFactoryHelperClass,
+ Class<F> baseAdsServiceClientFactoryClass)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure() |
+
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingpublic FactoryModule(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral, + com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral, + com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral, + com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral, + Class<H> adsServiceClientFactoryHelperClass, + Class<F> baseAdsServiceClientFactoryClass)+
adsServiceClientFactoryTypeLiteral - the factory type literal which
+ contains a FactoryModule.AdsServiceClientFactoryInterfaceadsServiceDescriptorFactoryTypeLiteral - the factory type literal
+ which contains a FactoryModule.AdsServiceDescriptorFactoryInterfaceadsServiceClientTypeLiteral - the ads service client literal which
+ contains a AdsServiceClientadsServiceDescriptorTypeLiteral - the ads service descriptor literal
+ which contains a AdsServiceDescriptoradsServiceClientFactoryHelperClass - the AdsServiceClientFactoryHelper classbaseAdsServiceClientFactoryClass - the BaseAdsServiceClientFactory classCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/class-use/AdsServiceClientFactory.html b/5.3.0/com/google/api/ads/common/lib/factory/class-use/AdsServiceClientFactory.html new file mode 100644 index 0000000000..3f321bb24c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/class-use/AdsServiceClientFactory.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.factory | ++ |
| Constructor and Description | +
|---|
BaseAdsServiceClientFactory(AdsServiceClientFactory<C,S,D> adsServiceClientFactory)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/class-use/AdsServicesInterface.html b/5.3.0/com/google/api/ads/common/lib/factory/class-use/AdsServicesInterface.html new file mode 100644 index 0000000000..16b1021c34 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/class-use/AdsServicesInterface.html @@ -0,0 +1,231 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.factory | ++ |
| com.google.api.ads.admanager.lib.factory | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServices
+Utility class to create Ad Manager service clients.
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AdManagerServicesInterface
+Factory for Ad Manager API services.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BaseAdManagerServices
+Base for a utility class which creates Ad Manager service clients.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BaseServices<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Base for a utility class which creates service clients.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/class-use/BaseAdsServiceClientFactory.html b/5.3.0/com/google/api/ads/common/lib/factory/class-use/BaseAdsServiceClientFactory.html new file mode 100644 index 0000000000..d363506804 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/class-use/BaseAdsServiceClientFactory.html @@ -0,0 +1,234 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.factory | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServiceClientFactory
+Factory which creates Ad Manager service clients.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected <H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>> |
+AdsSoapModule.configureFactories(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral,
+ com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral,
+ Class<H> adsServiceClientFactoryHelperClass,
+ Class<F> baseAdsServiceClientFactoryClass)
+Configures the factories.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FactoryModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession,H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>>
+Module for factories.
+ |
+
| Constructor and Description | +
|---|
BaseServices(BaseAdsServiceClientFactory<C,S,D> factory)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/class-use/BaseServices.html b/5.3.0/com/google/api/ads/common/lib/factory/class-use/BaseServices.html new file mode 100644 index 0000000000..a0ff90969d --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/class-use/BaseServices.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.factory | ++ |
| com.google.api.ads.admanager.lib.factory | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServices
+Utility class to create Ad Manager service clients.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BaseAdManagerServices
+Base for a utility class which creates Ad Manager service clients.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/class-use/FactoryModule.AdsServiceClientFactoryInterface.html b/5.3.0/com/google/api/ads/common/lib/factory/class-use/FactoryModule.AdsServiceClientFactoryInterface.html new file mode 100644 index 0000000000..04fb5376cd --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/class-use/FactoryModule.AdsServiceClientFactoryInterface.html @@ -0,0 +1,249 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| Constructor and Description | +
|---|
AdManagerServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<AdManagerServiceDescriptor> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface soapClientHandler,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected <H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>> |
+AdsSoapModule.configureFactories(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral,
+ com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral,
+ Class<H> adsServiceClientFactoryHelperClass,
+ Class<F> baseAdsServiceClientFactoryClass)
+Configures the factories.
+ |
+
| Constructor and Description | +
|---|
FactoryModule(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral,
+ com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral,
+ Class<H> adsServiceClientFactoryHelperClass,
+ Class<F> baseAdsServiceClientFactoryClass)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
BaseAdsServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<C,S,D> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<D> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface<?> soapClientHandler)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/class-use/FactoryModule.AdsServiceDescriptorFactoryInterface.html b/5.3.0/com/google/api/ads/common/lib/factory/class-use/FactoryModule.AdsServiceDescriptorFactoryInterface.html new file mode 100644 index 0000000000..1c1bdf177c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/class-use/FactoryModule.AdsServiceDescriptorFactoryInterface.html @@ -0,0 +1,249 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| Constructor and Description | +
|---|
AdManagerServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<AdManagerServiceDescriptor> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface soapClientHandler,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected <H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>> |
+AdsSoapModule.configureFactories(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral,
+ com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral,
+ Class<H> adsServiceClientFactoryHelperClass,
+ Class<F> baseAdsServiceClientFactoryClass)
+Configures the factories.
+ |
+
| Constructor and Description | +
|---|
FactoryModule(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral,
+ com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral,
+ Class<H> adsServiceClientFactoryHelperClass,
+ Class<F> baseAdsServiceClientFactoryClass)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
BaseAdsServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<C,S,D> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<D> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface<?> soapClientHandler)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/class-use/FactoryModule.html b/5.3.0/com/google/api/ads/common/lib/factory/class-use/FactoryModule.html new file mode 100644 index 0000000000..486600f8f9 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/class-use/FactoryModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/helper/AdsServiceClientFactoryHelper.html b/5.3.0/com/google/api/ads/common/lib/factory/helper/AdsServiceClientFactoryHelper.html new file mode 100644 index 0000000000..52569982b0 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/helper/AdsServiceClientFactoryHelper.html @@ -0,0 +1,331 @@ + + + + + + +C - the subclass of AdsServiceClientS - the subclass of AdsSessionD - the subclass of AdsServiceDescriptorpublic interface AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+| Modifier and Type | +Method and Description | +
|---|---|
void |
+checkServiceClientPreconditions(S adsSession,
+ Class<?> interfaceClass)
+Checks preconditions of the session and interface and throws an exception
+ if the client cannot be generated.
+ |
+
C |
+createAdsServiceClient(D adsServiceDescriptor,
+ S adsSession)
+Creates an
+AdsServiceClient for the descriptor, session, and
+ endpoint. |
+
D |
+createServiceDescriptor(Class<?> interfaceClass,
+ String version)
+Creates an
+AdsServiceDescriptor for a specified service. |
+
String |
+determineVersion(Class<?> interfaceClass)
+Determines what API version an ads service belongs to.
+ |
+
D createServiceDescriptor(Class<?> interfaceClass, + String version)+
AdsServiceDescriptor for a specified service.interfaceClass - the ads service that we want a descriptor forversion - of the serviceC createAdsServiceClient(D adsServiceDescriptor, + S adsSession) + throws ServiceException+
AdsServiceClient for the descriptor, session, and
+ endpoint.adsServiceDescriptor - the ads service descriptoradsSession - the sessionServiceException - if there was a problem creating the clientString determineVersion(Class<?> interfaceClass)+
interfaceClass - the interface class of the servicevoid checkServiceClientPreconditions(S adsSession, + Class<?> interfaceClass) + throws ServiceException+
adsSession - the session containing the authentication methodinterfaceClass - the ads service that a client is being generated forServiceException - if the preconditions are not met for service client
+ creationCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/helper/BaseAdsServiceClientFactoryHelper.html b/5.3.0/com/google/api/ads/common/lib/factory/helper/BaseAdsServiceClientFactoryHelper.html new file mode 100644 index 0000000000..8312335c9d --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/helper/BaseAdsServiceClientFactoryHelper.html @@ -0,0 +1,387 @@ + + + + + + +C - the type of AdsServiceClientS - the type of AdsSessionD - the type of AdsServiceDescriptorpublic abstract class BaseAdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> +extends Object +implements AdsServiceClientFactoryHelper<C,S,D>+
AdsServiceClientFactoryHelper.| Constructor and Description | +
|---|
BaseAdsServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<C,S,D> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<D> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface<?> soapClientHandler)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+checkServiceClientPreconditions(S adsSession,
+ Class<?> interfaceClass)
+Default implementation of passing service client preconditions.
+ |
+
C |
+createAdsServiceClient(D adsServiceDescriptor,
+ S adsSession)
+
+ |
+
D |
+createServiceDescriptor(Class<?> interfaceClass,
+ String version)
+Creates an
+AdsServiceDescriptor for a specified service. |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdetermineVersionpublic BaseAdsServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<C,S,D> adsServiceClientFactory, + FactoryModule.AdsServiceDescriptorFactoryInterface<D> adsServiceDescriptorFactory, + SoapClientHandlerInterface<?> soapClientHandler)+
adsServiceClientFactory - the Guice service client factory.public C createAdsServiceClient(D adsServiceDescriptor, + S adsSession) + throws ServiceException+ +
createAdsServiceClient in interface AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>adsServiceDescriptor - descriptor with information on ads serviceadsSession - the session associated with the desired
+ clientAdsServiceClientServiceException - if the ads service client could not be createdpublic D createServiceDescriptor(Class<?> interfaceClass, + String version)+
AdsServiceDescriptor for a specified service.createServiceDescriptor in interface AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>interfaceClass - the ads service that we want a descriptor forversion - the version of the servicepublic void checkServiceClientPreconditions(S adsSession, + Class<?> interfaceClass) + throws ServiceException+
checkServiceClientPreconditions in interface AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>adsSession - the session containing the authentication methodinterfaceClass - the ads service that a client is being generated forServiceException - if the preconditions are not met for service client
+ creationCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/helper/class-use/AdsServiceClientFactoryHelper.html b/5.3.0/com/google/api/ads/common/lib/factory/helper/class-use/AdsServiceClientFactoryHelper.html new file mode 100644 index 0000000000..7fcc20fe1b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/helper/class-use/AdsServiceClientFactoryHelper.html @@ -0,0 +1,258 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServiceClientFactoryHelper
+Factory helper for Ad Manager.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected <H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>> |
+AdsSoapModule.configureFactories(com.google.inject.TypeLiteral<FactoryModule.AdsServiceClientFactoryInterface<C,S,D>> adsServiceClientFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<FactoryModule.AdsServiceDescriptorFactoryInterface<D>> adsServiceDescriptorFactoryTypeLiteral,
+ com.google.inject.TypeLiteral<C> adsServiceClientTypeLiteral,
+ com.google.inject.TypeLiteral<D> adsServiceDescriptorTypeLiteral,
+ Class<H> adsServiceClientFactoryHelperClass,
+ Class<F> baseAdsServiceClientFactoryClass)
+Configures the factories.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FactoryModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession,H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>>
+Module for factories.
+ |
+
| Constructor and Description | +
|---|
AdsServiceClientFactory(AdsServiceClientFactoryHelper adsServiceClientFactoryHelper)
+Constructor.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BaseAdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
+Abstract helper for
+AdsServiceClientFactoryHelper. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/helper/class-use/BaseAdsServiceClientFactoryHelper.html b/5.3.0/com/google/api/ads/common/lib/factory/helper/class-use/BaseAdsServiceClientFactoryHelper.html new file mode 100644 index 0000000000..da9d485e0b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/helper/class-use/BaseAdsServiceClientFactoryHelper.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServiceClientFactoryHelper
+Factory helper for Ad Manager.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/helper/package-frame.html b/5.3.0/com/google/api/ads/common/lib/factory/helper/package-frame.html new file mode 100644 index 0000000000..ed55fb4df3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/helper/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +| Interface | +Description | +
|---|---|
| AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> | +
+ Interface for helpers of factories which creates ads service clients.
+ |
+
| Class | +Description | +
|---|---|
| BaseAdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> | +
+ Abstract helper for
+AdsServiceClientFactoryHelper. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/helper/package-tree.html b/5.3.0/com/google/api/ads/common/lib/factory/helper/package-tree.html new file mode 100644 index 0000000000..e2eddee888 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/helper/package-tree.html @@ -0,0 +1,143 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/helper/package-use.html b/5.3.0/com/google/api/ads/common/lib/factory/helper/package-use.html new file mode 100644 index 0000000000..5ba5a1ee9c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/helper/package-use.html @@ -0,0 +1,229 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| Class and Description | +
|---|
| AdsServiceClientFactoryHelper
+ Interface for helpers of factories which creates ads service clients.
+ |
+
| BaseAdsServiceClientFactoryHelper
+ Abstract helper for
+AdsServiceClientFactoryHelper. |
+
| Class and Description | +
|---|
| AdsServiceClientFactoryHelper
+ Interface for helpers of factories which creates ads service clients.
+ |
+
| Class and Description | +
|---|
| AdsServiceClientFactoryHelper
+ Interface for helpers of factories which creates ads service clients.
+ |
+
| Class and Description | +
|---|
| AdsServiceClientFactoryHelper
+ Interface for helpers of factories which creates ads service clients.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/package-frame.html b/5.3.0/com/google/api/ads/common/lib/factory/package-frame.html new file mode 100644 index 0000000000..a31d527aa1 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/package-frame.html @@ -0,0 +1,30 @@ + + + + + + +| Interface | +Description | +
|---|---|
| AdsServicesInterface<S extends AdsSession> | +
+ Service factory for an ads product.
+ |
+
| FactoryModule.AdsServiceClientFactoryInterface<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> | +
+ Factory interface class to create
+AdsServiceClient. |
+
| FactoryModule.AdsServiceDescriptorFactoryInterface<D extends AdsServiceDescriptor> | +
+ Factory interface class to create
+AdsServiceDescriptor. |
+
| Class | +Description | +
|---|---|
| AdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> | +
+ Factory which creates ads service clients.
+ |
+
| BaseAdsServiceClientFactory<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> | +
+ Base factory which creates service clients.
+ |
+
| BaseServices<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor> | +
+ Base for a utility class which creates service clients.
+ |
+
| FactoryModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession,H extends AdsServiceClientFactoryHelper<C,S,D>,F extends BaseAdsServiceClientFactory<C,S,D>> | +
+ Module for factories.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/package-tree.html b/5.3.0/com/google/api/ads/common/lib/factory/package-tree.html new file mode 100644 index 0000000000..71c4bd00dd --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/factory/package-use.html b/5.3.0/com/google/api/ads/common/lib/factory/package-use.html new file mode 100644 index 0000000000..4017f42777 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/factory/package-use.html @@ -0,0 +1,321 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws.factory | ++ |
| com.google.api.ads.admanager.lib.factory | ++ |
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| Class and Description | +
|---|
| AdsServicesInterface
+ Service factory for an ads product.
+ |
+
| BaseServices
+ Base for a utility class which creates service clients.
+ |
+
| Class and Description | +
|---|
| AdsServicesInterface
+ Service factory for an ads product.
+ |
+
| BaseAdsServiceClientFactory
+ Base factory which creates service clients.
+ |
+
| BaseServices
+ Base for a utility class which creates service clients.
+ |
+
| Class and Description | +
|---|
| FactoryModule.AdsServiceClientFactoryInterface
+ Factory interface class to create
+AdsServiceClient. |
+
| FactoryModule.AdsServiceDescriptorFactoryInterface
+ Factory interface class to create
+AdsServiceDescriptor. |
+
| Class and Description | +
|---|
| BaseAdsServiceClientFactory
+ Base factory which creates service clients.
+ |
+
| FactoryModule.AdsServiceClientFactoryInterface
+ Factory interface class to create
+AdsServiceClient. |
+
| FactoryModule.AdsServiceDescriptorFactoryInterface
+ Factory interface class to create
+AdsServiceDescriptor. |
+
| Class and Description | +
|---|
| AdsServiceClientFactory
+ Factory which creates ads service clients.
+ |
+
| AdsServicesInterface
+ Service factory for an ads product.
+ |
+
| BaseAdsServiceClientFactory
+ Base factory which creates service clients.
+ |
+
| FactoryModule.AdsServiceClientFactoryInterface
+ Factory interface class to create
+AdsServiceClient. |
+
| FactoryModule.AdsServiceDescriptorFactoryInterface
+ Factory interface class to create
+AdsServiceDescriptor. |
+
| Class and Description | +
|---|
| FactoryModule.AdsServiceClientFactoryInterface
+ Factory interface class to create
+AdsServiceClient. |
+
| FactoryModule.AdsServiceDescriptorFactoryInterface
+ Factory interface class to create
+AdsServiceDescriptor. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/package-frame.html b/5.3.0/com/google/api/ads/common/lib/package-frame.html new file mode 100644 index 0000000000..f01df6da44 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Class | +Description | +
|---|---|
| AdsModule | +
+ Guice module for common bindings.
+ |
+
| AdsSoapModule<C extends AdsServiceClient<S,D>,D extends AdsServiceDescriptor,S extends AdsSession> | +
+ Guice module for common bindings.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/package-tree.html b/5.3.0/com/google/api/ads/common/lib/package-tree.html new file mode 100644 index 0000000000..a4f37059f8 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/package-tree.html @@ -0,0 +1,144 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/package-use.html b/5.3.0/com/google/api/ads/common/lib/package-use.html new file mode 100644 index 0000000000..e41f3eeade --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/package-use.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib | ++ |
| Class and Description | +
|---|
| AdsModule
+ Guice module for common bindings.
+ |
+
| AdsSoapModule
+ Guice module for common bindings.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/AuthorizationHeaderHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/AuthorizationHeaderHandler.html new file mode 100644 index 0000000000..9556f87d92 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/AuthorizationHeaderHandler.html @@ -0,0 +1,300 @@ + + + + + + +public class AuthorizationHeaderHandler +extends Object+
Authorization headers that can be set on the SOAP
+ client.| Constructor and Description | +
|---|
AuthorizationHeaderHandler(SoapClientHandlerInterface soapClientHandler,
+ AuthorizationHeaderProvider authorizationHeaderProvider)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+setAuthorization(Object soapClient,
+ AdsSession adsSession)
+Sets the authorization header created from the session on the soap client.
+ |
+
@Inject +public AuthorizationHeaderHandler(SoapClientHandlerInterface soapClientHandler, + AuthorizationHeaderProvider authorizationHeaderProvider)+
soapClientHandler - the SOAP client handlerauthorizationHeaderProvider - the authorization header providerpublic void setAuthorization(Object soapClient, + AdsSession adsSession) + throws AuthenticationException+
soapClient - the SOAP client to set the HTTP header onadsSession - the sessionAuthenticationException - if the authorization header could not be
+ createdCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/ProductFrameworkModule.html b/5.3.0/com/google/api/ads/common/lib/soap/ProductFrameworkModule.html new file mode 100644 index 0000000000..95d8595e54 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/ProductFrameworkModule.html @@ -0,0 +1,311 @@ + + + + + + +public class ProductFrameworkModule
+extends com.google.inject.AbstractModule
+| Constructor and Description | +
|---|
ProductFrameworkModule() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure() |
+
protected void |
+configureConfigurations(URL propertiesUrl) |
+
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/RequestInfoXPathSet.html b/5.3.0/com/google/api/ads/common/lib/soap/RequestInfoXPathSet.html new file mode 100644 index 0000000000..87cb24843b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/RequestInfoXPathSet.html @@ -0,0 +1,326 @@ + + + + + + +public class RequestInfoXPathSet +extends Object+
| Constructor and Description | +
|---|
RequestInfoXPathSet(com.google.api.ads.common.lib.conf.AdsApiConfiguration apiConfig,
+ NodeExtractor nodeExtractor,
+ com.google.common.base.Supplier<Transformer> transformerSupplier,
+ org.slf4j.Logger libLogger) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getContextName() |
+
IterableXPath |
+getContextXPath() |
+
RequestInfo.Builder |
+parseMessage(RequestInfo.Builder builder,
+ SOAPMessage soapMessage) |
+
String |
+toString() |
+
@Inject +public RequestInfoXPathSet(com.google.api.ads.common.lib.conf.AdsApiConfiguration apiConfig, + NodeExtractor nodeExtractor, + com.google.common.base.Supplier<Transformer> transformerSupplier, + org.slf4j.Logger libLogger)+
public IterableXPath getContextXPath()+
public String getContextName()+
public RequestInfo.Builder parseMessage(RequestInfo.Builder builder, + SOAPMessage soapMessage)+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/ResponseInfoXPathSet.html b/5.3.0/com/google/api/ads/common/lib/soap/ResponseInfoXPathSet.html new file mode 100644 index 0000000000..edc2ee010b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/ResponseInfoXPathSet.html @@ -0,0 +1,335 @@ + + + + + + +public class ResponseInfoXPathSet +extends Object+
| Constructor and Description | +
|---|
ResponseInfoXPathSet(com.google.api.ads.common.lib.conf.AdsApiConfiguration apiConfig,
+ NodeExtractor nodeExtractor) |
+
| Modifier and Type | +Method and Description | +
|---|---|
IterableXPath |
+getOperationsCountXPath() |
+
IterableXPath |
+getRequestIdXPath() |
+
IterableXPath |
+getResponseTimeXPath() |
+
ResponseInfo.Builder |
+parseMessage(ResponseInfo.Builder builder,
+ SOAPMessage soapMessage) |
+
String |
+toString() |
+
@Inject +public ResponseInfoXPathSet(com.google.api.ads.common.lib.conf.AdsApiConfiguration apiConfig, + NodeExtractor nodeExtractor)+
public IterableXPath getRequestIdXPath()+
public IterableXPath getResponseTimeXPath()+
public IterableXPath getOperationsCountXPath()+
public ResponseInfo.Builder parseMessage(ResponseInfo.Builder builder, + SOAPMessage soapMessage)+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/SoapCall.html b/5.3.0/com/google/api/ads/common/lib/soap/SoapCall.html new file mode 100644 index 0000000000..1aa041985c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/SoapCall.html @@ -0,0 +1,366 @@ + + + + + + +T - the SOAP client typepublic class SoapCall<T> +extends Object+
| Constructor and Description | +
|---|
SoapCall(Method soapClientMethod,
+ T soapClient,
+ Object[] soapArgs)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
Object[] |
+getSoapArgs()
+Returns the arguments that will be passed into the SOAP call.
+ |
+
T |
+getSoapClient()
+Returns the underlying SOAP client that call will be made on.
+ |
+
Method |
+getSoapClientMethod()
+Returns the method to invoke on the underlying SOAP client.
+ |
+
int |
+hashCode() |
+
public SoapCall(Method soapClientMethod, + T soapClient, + Object[] soapArgs)+
soapClientMethod - the SOAP client method to invoke on the underlying SOAP client.soapClient - the underlying SOAP client that the call will be made onsoapArgs - the arguments that will be passed into the SOAP call.public Method getSoapClientMethod()+
public T getSoapClient()+
public Object[] getSoapArgs()+
public boolean equals(Object obj)+
equals in class ObjectObject.equals(java.lang.Object)public int hashCode()+
hashCode in class ObjectObject.hashCode()Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/SoapClientHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/SoapClientHandler.html new file mode 100644 index 0000000000..d8ce5f9f72 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/SoapClientHandler.html @@ -0,0 +1,393 @@ + + + + + + +T - the SOAP client typepublic abstract class SoapClientHandler<T> +extends Object +implements SoapClientHandlerInterface<T>+
invoke(SoapCall) will
+ perform the method retrieved from SoapCall.getSoapClientMethod() on
+ the SoapCall.getSoapClient() with the arguments retrieved from
+ SoapCall.getSoapArgs().SoapClientHandlerInterface| Modifier | +Constructor and Description | +
|---|---|
protected |
+SoapClientHandler()
+Default constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Method |
+getSoapClientMethod(T soapClient,
+ Method method)
+Gets the method from the SOAP client that matches the supplied method.
+ |
+
protected Object |
+invoke(SoapCall<T> soapCall)
+Takes a
+SoapCall object and invokes the method by reflection. |
+
protected Object[] |
+processSoapArguments(Method soapClientMethod,
+ Object[] args)
+Processes the arguments such that they will be ready to be passed into the
+ supplied SOAP client method.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclearHeaders, createSoapClient, createSoapHeaderElement, getEndpointAddress, getHeader, invokeSoapCall, putAllHttpHeaders, setCompression, setEndpointAddress, setHeader, setRequestTimeoutprotected SoapClientHandler()+
protected Object[] processSoapArguments(Method soapClientMethod, + Object[] args)+
+ In the default implementation of processing arguments, if the number of
+ arguments is too small, the argument list will be padded with null.
+ If args is null, null will be returned.
+
soapClientMethod - the SOAP client method that will be called with the
+ argsargs - the arguments that will be processedsoapClientMethod.public Method getSoapClientMethod(T soapClient, + Method method) + throws NoSuchMethodException+
+ In the default implementation, only the method name and return type + will be matched. +
getSoapClientMethod in interface SoapClientHandlerInterface<T>soapClient - the SOAP client within which to search for the methodmethod - the method to matchNoSuchMethodException - thrown if the SOAP client does not contain
+ the requested method.
+
+ TODO(api.arogal): Needs to check parameter types as well as name/return.protected Object invoke(SoapCall<T> soapCall) + throws Exception+
SoapCall object and invokes the method by reflection.soapCall - contains the SOAP method, SOAP client, and args to be
+ calledException - thrown if calling the operation on the remote service
+ failsCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/SoapClientHandlerInterface.html b/5.3.0/com/google/api/ads/common/lib/soap/SoapClientHandlerInterface.html new file mode 100644 index 0000000000..6c1b42623c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/SoapClientHandlerInterface.html @@ -0,0 +1,520 @@ + + + + + + +T - the client type for the SOAP toolkit, e.g., Stub
+ for Axis, BindingProvider for JAX-WS, etc.public interface SoapClientHandlerInterface<T>
+SoapServiceClient
+ use this handlers implementing these methods to interact with SOAP clients
+ from different frameworks. There is separate handler for each framework
+ that implements this interface.| Modifier and Type | +Method and Description | +
|---|---|
void |
+clearHeaders(T soapClient)
+Clears the headers of the SOAP client.
+ |
+
T |
+createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
+Creates a SOAP client using the
+soapServiceDescriptor. |
+
SOAPHeaderElement |
+createSoapHeaderElement(QName qName)
+Creates a SOAP header element object specific to the framework that this
+ handler works with.
+ |
+
String |
+getEndpointAddress(T soapClient)
+Gets the endpoint address on the SOAP client.
+ |
+
Object |
+getHeader(T soapClient,
+ String headerName)
+Gets the value of a header given the SOAP client and the header name.
+ |
+
Method |
+getSoapClientMethod(T soapClient,
+ Method method)
+Gets the method from the SOAP client that matches the supplied method.
+ |
+
RemoteCallReturn |
+invokeSoapCall(SoapCall<T> soapCall)
+Executes the
+SoapCall, which has a reference to a
+ SoapClientHandlerInterface. |
+
void |
+putAllHttpHeaders(T soapClient,
+ Map<String,String> headersMap)
+Puts all headers into the existing HTTP headers of the SOAP client,
+ overwriting any existing header keys.
+ |
+
void |
+setCompression(T soapClient,
+ boolean compress)
+Sets if the SOAP client should use compression.
+ |
+
void |
+setEndpointAddress(T soapClient,
+ String endpointAddress)
+Sets the endpoint address on the SOAP client.
+ |
+
void |
+setHeader(T soapClient,
+ String namespace,
+ String headerName,
+ Object headerValue)
+Sets a header on the SOAP client.
+ |
+
void |
+setRequestTimeout(T soapClient,
+ int timeout)
+Sets the read timeout of the given SOAP client.
+ |
+
T createSoapClient(SoapServiceDescriptor soapServiceDescriptor) + throws ServiceException+
soapServiceDescriptor.soapServiceDescriptor - the service descriptor describing the service
+ that the SOAP client will be stubbed againstServiceException - if there as a problem creating the SOAP clientRemoteCallReturn invokeSoapCall(SoapCall<T> soapCall)+
SoapCall, which has a reference to a
+ SoapClientHandlerInterface.soapCall - the SoapCall to executevoid setEndpointAddress(T soapClient, + String endpointAddress)+
String getEndpointAddress(T soapClient)+
void clearHeaders(T soapClient)+
SOAPHeaderElement createSoapHeaderElement(QName qName)+
qName - qualified name of the header elementvoid setHeader(T soapClient, + String namespace, + String headerName, + Object headerValue) + throws ServiceException+
soapClient - the SOAP client to set the header ofnamespace - the namespace of the headerheaderName - the name of the headerheaderValue - the value of the headerServiceException - if there was a problem setting the headervoid putAllHttpHeaders(T soapClient, + Map<String,String> headersMap)+
soapClient - the SOAP client to set the headers onheadersMap - the map of headers in the form of header name to valueObject getHeader(T soapClient, + String headerName)+
void setCompression(T soapClient, + boolean compress)+
void setRequestTimeout(T soapClient, + int timeout)+
soapClient - the SOAP client to set the read timeout fortimeout - the timeout in millisecondsMethod getSoapClientMethod(T soapClient, + Method method) + throws NoSuchMethodException+
+ In the default implementation, only the method name and return type + will be matched. +
soapClient - the SOAP client within which to search for the methodmethod - the method to matchNoSuchMethodException - thrown if the SOAP client does not contain
+ the requested method.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/SoapServiceClient.html b/5.3.0/com/google/api/ads/common/lib/soap/SoapServiceClient.html new file mode 100644 index 0000000000..34a2c325cf --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/SoapServiceClient.html @@ -0,0 +1,532 @@ + + + + + + +T - the type of SOAP clientpublic abstract class SoapServiceClient<T> +extends Object +implements InvocationHandler+
SoapServiceClient class pairs together the soapClient and
+ soapClientHandler so that calls made through the
+ invoke(Object, Method, Object[]) method can be dispatched and
+ handled correctly in the SOAP layer. This class is not aware of what API it
+ uses and relies on the soapClientHandler to determine how the SOAP
+ framework should be used.| Modifier | +Constructor and Description | +
|---|---|
protected |
+SoapServiceClient(SoapClientHandlerInterface<T> soapClientHandler,
+ T soapClient)
+Protected constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected RemoteCallReturn |
+callSoapClient(SoapCall<T> soapCall)
+Called from
+invoke(Object, Method, Object[]) if the method is
+ intended for the SOAP client. |
+
protected SoapCall<T> |
+createSoapCall(Method soapClientMethod,
+ Object[] args)
+
+ |
+
Object |
+getSoapClient()
+Returns the underlying SOAP client.
+ |
+
protected SoapClientHandlerInterface<T> |
+getSoapClientHandler()
+Returns the SOAP client handler.
+ |
+
protected Throwable |
+handleException(Throwable e)
+Handles the exception.
+ |
+
Object |
+invoke(Object proxy,
+ Method method,
+ Object[] args)
+Wraps the underlying SOAP RPC such that first the method, by its name,
+ is applied to the runtime class.
+ |
+
protected abstract void |
+logSoapCall(RemoteCallReturn remoteCallReturn)
+Logs a SOAP call.
+ |
+
void |
+setEndpointAddress(String endpointAddress)
+Sets the endpoint address of the underlying SOAP client.
+ |
+
protected abstract void |
+setHeaders()
+Sets the headers for the service client.
+ |
+
protected Object |
+unwrapRemoteCallReturn(RemoteCallReturn remoteCallReturn)
+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.
+ |
+
protected SoapServiceClient(SoapClientHandlerInterface<T> soapClientHandler, + T soapClient)+
soapClientHandler - the SOAP client handlersoapClient - the SOAP clientprotected RemoteCallReturn callSoapClient(SoapCall<T> soapCall)+
invoke(Object, Method, Object[]) if the method is
+ intended for the SOAP client. Extending classes should override this method
+ if they wish to wrap the call, such in cases of reauthentication or
+ exception handling. The actual SOAP call is synchronized on the SOAP client
+ so that only one request to the SOAP client can be made with without
+ interruption, useful for logging and exception handling.soapCall - the call to send to the SOAP clientsoapCallpublic Object invoke(Object proxy, + Method method, + Object[] args) + throws Throwable+
invoke in interface InvocationHandlerproxy - the proxy class that invoke was called onmethod - the method to apply to the proxy class or the underlying SOAP
+ clientargs - the method argumentsSoapServiceClient or a
+ RemoteCallReturn object containing the result from the SOAP callThrowable - thrown if the SOAP call passed into this method results
+ in an exception. The exception thrown will be not be wrapped - it will
+ adhere to the "throws" clause of the passed in Method.InvocationHandler.invoke(Object, Method, Object[])protected SoapCall<T> createSoapCall(Method soapClientMethod, + Object[] args)+ +
public void setEndpointAddress(String endpointAddress)+
public Object getSoapClient()+
protected SoapClientHandlerInterface<T> getSoapClientHandler()+
protected abstract void logSoapCall(RemoteCallReturn remoteCallReturn)+
remoteCallReturn - protected abstract void setHeaders() + throws ServiceException, + AuthenticationException+
ServiceException - if there was a problem setting the headersAuthenticationException - if there was a problem authenticating while
+ setting headersprotected Throwable handleException(Throwable e)+
+ Default behavior is to return the exception unchanged. +
e - the exception to handleprotected Object unwrapRemoteCallReturn(RemoteCallReturn remoteCallReturn) + throws Throwable+
remoteCallReturn - the RemoteCallReturn to unwrapRemoteCallReturn.getReturnValue() if the call was
+ successfulThrowable - the exception captured in the
+ RemoteCallReturn.getException() if presentCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/SoapServiceDescriptor.html b/5.3.0/com/google/api/ads/common/lib/soap/SoapServiceDescriptor.html new file mode 100644 index 0000000000..dbcd4153cd --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/SoapServiceDescriptor.html @@ -0,0 +1,263 @@ + + + + + + +public interface SoapServiceDescriptor
+| Modifier and Type | +Method and Description | +
|---|---|
String |
+getEndpointAddress(String endpointServer)
+Gets the endpoint address for this service and server.
+ |
+
Class<?> |
+getInterfaceClass()
+Gets the class representing the RPC interface of the service.
+ |
+
Class<?> getInterfaceClass() + throws ServiceException+
ServiceException - if the interface could not be retrieved.String getEndpointAddress(String endpointServer) + throws MalformedURLException+
MalformedURLException - if the URL cannot be createdCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisFrameworkUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisFrameworkUserAgentProvider.html new file mode 100644 index 0000000000..cb5de955b3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisFrameworkUserAgentProvider.html @@ -0,0 +1,295 @@ + + + + + + +public class AxisFrameworkUserAgentProvider +extends Object +implements FrameworkUserAgentProvider+
| Constructor and Description | +
|---|
AxisFrameworkUserAgentProvider(org.apache.commons.configuration.Configuration configuration)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent()
+Gets a user agent.
+ |
+
@Inject +public AxisFrameworkUserAgentProvider(org.apache.commons.configuration.Configuration configuration)+
configuration - the axis resources configurationpublic String getUserAgent()+
UserAgentProvidergetUserAgent in interface UserAgentProviderCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisHandler.html new file mode 100644 index 0000000000..a16c98778c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisHandler.html @@ -0,0 +1,584 @@ + + + + + + +public class AxisHandler +extends SoapClientHandler<org.apache.axis.client.Stub>+
| Constructor and Description | +
|---|
AxisHandler(org.apache.axis.EngineConfigurationFactory engineConfigurationFactory,
+ RequestInfoXPathSet requestInfoXPathSet,
+ ResponseInfoXPathSet responseInfoXPathSet) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+clearHeaders(org.apache.axis.client.Stub soapClient)
+Clears all of the SOAP headers from the given SOAP client.
+ |
+
org.apache.axis.client.Stub |
+createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
+Creates a SOAP client using a SOAP service descriptor.
+ |
+
SOAPHeaderElement |
+createSoapHeaderElement(QName qName)
+Creates a SOAP header element object specific to the framework that this
+ handler works with.
+ |
+
String |
+getEndpointAddress(org.apache.axis.client.Stub soapClient)
+Gets the endpoint address on the SOAP client.
+ |
+
Object |
+getHeader(org.apache.axis.client.Stub soapClient,
+ String headerName)
+Returns a SOAP header from the given SOAP client, if it exists.
+ |
+
RemoteCallReturn |
+invokeSoapCall(SoapCall<org.apache.axis.client.Stub> soapCall)
+Invoke a SOAP call.
+ |
+
void |
+putAllHttpHeaders(org.apache.axis.client.Stub soapClient,
+ Map<String,String> headersMap)
+Puts all headers into the existing HTTP headers of the SOAP client,
+ overwriting any existing header keys.
+ |
+
void |
+setCompression(org.apache.axis.client.Stub soapClient,
+ boolean compress)
+Set whether SOAP requests should use compression.
+ |
+
void |
+setEndpointAddress(org.apache.axis.client.Stub soapClient,
+ String endpointAddress)
+Sets the endpoint address of the given SOAP client.
+ |
+
void |
+setHeader(org.apache.axis.client.Stub soapClient,
+ String namespace,
+ String headerName,
+ Object headerValue)
+Sets a header on the SOAP client.
+ |
+
void |
+setHeaderChild(org.apache.axis.client.Stub soapClient,
+ String parentHeaderName,
+ String childName,
+ Object childValue)
+Updates the child attribute of headerName named childName to childValue.
+ |
+
void |
+setRequestTimeout(org.apache.axis.client.Stub soapClient,
+ int timeout)
+Sets the read timeout of the given SOAP client.
+ |
+
getSoapClientMethod, invoke, processSoapArguments@Inject +public AxisHandler(org.apache.axis.EngineConfigurationFactory engineConfigurationFactory, + RequestInfoXPathSet requestInfoXPathSet, + ResponseInfoXPathSet responseInfoXPathSet)+
public void setEndpointAddress(org.apache.axis.client.Stub soapClient, + String endpointAddress)+
soapClient - the SOAP client to set the endpoint address forendpointAddress - the target endpoint addresspublic void setRequestTimeout(org.apache.axis.client.Stub soapClient, + int timeout)+
soapClient - the SOAP client to set the read timeout fortimeout - the timeout in millisecondspublic Object getHeader(org.apache.axis.client.Stub soapClient, + String headerName)+
soapClient - the SOAP client to check for the given headerheaderName - the name of the header being looked forpublic void clearHeaders(org.apache.axis.client.Stub soapClient)+
soapClient - the client to remove the headers frompublic void setHeader(org.apache.axis.client.Stub soapClient, + String namespace, + String headerName, + Object headerValue)+
SoapClientHandlerInterfacesoapClient - the SOAP client to set the header ofnamespace - the namespace of the headerheaderName - the name of the headerheaderValue - the value of the headerSoapClientHandlerInterface.setHeader(Object, String, String, Object)public void setHeaderChild(org.apache.axis.client.Stub soapClient, + String parentHeaderName, + String childName, + Object childValue)+
soapClient - the stubparentHeaderName - the name of the parent headerchildName - the name of the childchildValue - the value for the childNullPointerException - if no header exists named parentHeaderNamepublic void putAllHttpHeaders(org.apache.axis.client.Stub soapClient, + Map<String,String> headersMap)+
SoapClientHandlerInterfacesoapClient - the SOAP client to set the headers onheadersMap - the map of headers in the form of header name to valueSoapClientHandlerInterface.putAllHttpHeaders(Object, Map)public void setCompression(org.apache.axis.client.Stub soapClient, + boolean compress)+
soapClient - the client to set compression settings forcompress - whether or not to use compressionpublic org.apache.axis.client.Stub createSoapClient(SoapServiceDescriptor soapServiceDescriptor) + throws ServiceException+
soapServiceDescriptor - the descriptor to use for creating a clientServiceException - thrown if the SOAP client cannot be createdpublic RemoteCallReturn invokeSoapCall(SoapCall<org.apache.axis.client.Stub> soapCall)+
soapCall - the call to make to a SOAP web servicepublic String getEndpointAddress(org.apache.axis.client.Stub soapClient)+
SoapClientHandlerInterfaceSoapClientHandlerInterface.getEndpointAddress(Object)public SOAPHeaderElement createSoapHeaderElement(QName qName)+
SoapClientHandlerInterfaceqName - qualified name of the header elementSoapClientHandlerInterface.createSoapHeaderElement(QName)Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisModule.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisModule.html new file mode 100644 index 0000000000..08a3e88731 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisModule.html @@ -0,0 +1,297 @@ + + + + + + +public class AxisModule
+extends com.google.inject.AbstractModule
+| Constructor and Description | +
|---|
AxisModule()
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure() |
+
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisSoapHeaderFactory.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisSoapHeaderFactory.html new file mode 100644 index 0000000000..d40ac73ec2 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/AxisSoapHeaderFactory.html @@ -0,0 +1,239 @@ + + + + + + +public interface AxisSoapHeaderFactory<D extends AdsServiceDescriptor>
+| Modifier and Type | +Method and Description | +
|---|---|
Object |
+createSoapHeader(D adsServiceDescriptor) |
+
Object createSoapHeader(D adsServiceDescriptor) + throws ClassNotFoundException, + InvocationTargetException, + NoSuchMethodException, + IllegalAccessException, + InstantiationException+ +
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/HttpHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/HttpHandler.html new file mode 100644 index 0000000000..a7c20d28cc --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/HttpHandler.html @@ -0,0 +1,340 @@ + + + + + + +public class HttpHandler
+extends org.apache.axis.handlers.BasicHandler
+implements com.google.api.client.http.HttpRequestInitializer
+makeLockable, name, options| Constructor and Description | +
|---|
HttpHandler() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+initialize(com.google.api.client.http.HttpRequest httpRequest)
+Sets attributes of the request that are common to all requests for this handler.
+ |
+
void |
+invoke(org.apache.axis.MessageContext msgContext) |
+
canHandleBlock, cleanup, generateWSDL, getDeploymentData, getName, getOption, getOptions, getUnderstoodHeaders, init, initHashtable, onFault, setName, setOption, setOptionDefault, setOptions, setOptionsLockablepublic void invoke(org.apache.axis.MessageContext msgContext) + throws org.apache.axis.AxisFault+
invoke in interface org.apache.axis.Handlerorg.apache.axis.AxisFaultpublic void initialize(com.google.api.client.http.HttpRequest httpRequest) + throws IOException+
initialize in interface com.google.api.client.http.HttpRequestInitializerIOExceptionCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisFrameworkUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisFrameworkUserAgentProvider.html new file mode 100644 index 0000000000..b09438900a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisFrameworkUserAgentProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisHandler.html new file mode 100644 index 0000000000..fefbc01cb6 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisHandler.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| Constructor and Description | +
|---|
AdManagerAxisHeaderHandler(AxisHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisModule.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisModule.html new file mode 100644 index 0000000000..88d0698a24 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisSoapHeaderFactory.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisSoapHeaderFactory.html new file mode 100644 index 0000000000..8c714c56ad --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/AxisSoapHeaderFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/HttpHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/HttpHandler.html new file mode 100644 index 0000000000..3f819fba67 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/class-use/HttpHandler.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/package-frame.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/package-frame.html new file mode 100644 index 0000000000..b0553a471b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/package-frame.html @@ -0,0 +1,28 @@ + + + + + + +| Interface | +Description | +
|---|---|
| AxisSoapHeaderFactory<D extends AdsServiceDescriptor> | +
+ Factory for creating Axis soap headers.
+ |
+
| Class | +Description | +
|---|---|
| AxisFrameworkUserAgentProvider | +
+ Provides the Axis user agent.
+ |
+
| AxisHandler | +
+ SOAP Client Handler implementation for use with Axis 1.x.
+ |
+
| AxisModule | +
+ Module for SOAP client handler.
+ |
+
| HttpHandler | +
+ Axis handler implementation that handles compression.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/package-tree.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/package-tree.html new file mode 100644 index 0000000000..85a99a07f2 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/axis/package-use.html b/5.3.0/com/google/api/ads/common/lib/soap/axis/package-use.html new file mode 100644 index 0000000000..5740e4f745 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/axis/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| Class and Description | +
|---|
| AxisHandler
+ SOAP Client Handler implementation for use with Axis 1.x.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/class-use/AuthorizationHeaderHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/class-use/AuthorizationHeaderHandler.html new file mode 100644 index 0000000000..83b9245390 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/class-use/AuthorizationHeaderHandler.html @@ -0,0 +1,198 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| Constructor and Description | +
|---|
AdManagerAxisHeaderHandler(AxisHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdManagerJaxWsHeaderHandler(JaxWsHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/class-use/ProductFrameworkModule.html b/5.3.0/com/google/api/ads/common/lib/soap/class-use/ProductFrameworkModule.html new file mode 100644 index 0000000000..5684b5ed00 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/class-use/ProductFrameworkModule.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerAxisModule
+Guice module to bind Ad Manager's SOAP header handler to an Axis-friendly implementation.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerJaxWsModule
+Guice module to bind Ad Manager's SOAP header handler to a JAX-WS-friendly implementation.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/class-use/RequestInfoXPathSet.html b/5.3.0/com/google/api/ads/common/lib/soap/class-use/RequestInfoXPathSet.html new file mode 100644 index 0000000000..12a340deac --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/class-use/RequestInfoXPathSet.html @@ -0,0 +1,187 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Constructor and Description | +
|---|
AxisHandler(org.apache.axis.EngineConfigurationFactory engineConfigurationFactory,
+ RequestInfoXPathSet requestInfoXPathSet,
+ ResponseInfoXPathSet responseInfoXPathSet) |
+
| Constructor and Description | +
|---|
JaxWsSoapContextHandler(RequestInfoXPathSet requestInfoXPathSet,
+ ResponseInfoXPathSet responseInfoXPathSet) |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/class-use/ResponseInfoXPathSet.html b/5.3.0/com/google/api/ads/common/lib/soap/class-use/ResponseInfoXPathSet.html new file mode 100644 index 0000000000..266a8e5bd6 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/class-use/ResponseInfoXPathSet.html @@ -0,0 +1,187 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Constructor and Description | +
|---|
AxisHandler(org.apache.axis.EngineConfigurationFactory engineConfigurationFactory,
+ RequestInfoXPathSet requestInfoXPathSet,
+ ResponseInfoXPathSet responseInfoXPathSet) |
+
| Constructor and Description | +
|---|
JaxWsSoapContextHandler(RequestInfoXPathSet requestInfoXPathSet,
+ ResponseInfoXPathSet responseInfoXPathSet) |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapCall.html b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapCall.html new file mode 100644 index 0000000000..4887775691 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapCall.html @@ -0,0 +1,247 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
protected SoapCall<T> |
+SoapServiceClient.createSoapCall(Method soapClientMethod,
+ Object[] args)
+
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected RemoteCallReturn |
+SoapServiceClient.callSoapClient(SoapCall<T> soapCall)
+Called from
+SoapServiceClient.invoke(Object, Method, Object[]) if the method is
+ intended for the SOAP client. |
+
protected Object |
+SoapClientHandler.invoke(SoapCall<T> soapCall)
+Takes a
+SoapCall object and invokes the method by reflection. |
+
RemoteCallReturn |
+SoapClientHandlerInterface.invokeSoapCall(SoapCall<T> soapCall)
+Executes the
+SoapCall, which has a reference to a
+ SoapClientHandlerInterface. |
+
| Modifier and Type | +Method and Description | +
|---|---|
RemoteCallReturn |
+AxisHandler.invokeSoapCall(SoapCall<org.apache.axis.client.Stub> soapCall)
+Invoke a SOAP call.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RemoteCallReturn |
+JaxWsHandler.invokeSoapCall(SoapCall<BindingProvider> soapCall)
+Invoke a SOAP call.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapClientHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapClientHandler.html new file mode 100644 index 0000000000..f440cc9fdf --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapClientHandler.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AxisHandler
+SOAP Client Handler implementation for use with Axis 1.x.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+JaxWsHandler
+SOAP Client Handler implementation for use with JAX-WS.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapClientHandlerInterface.html b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapClientHandlerInterface.html new file mode 100644 index 0000000000..922900d10a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapClientHandlerInterface.html @@ -0,0 +1,376 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| com.google.api.ads.admanager.lib.soap | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Constructor and Description | +
|---|
AdManagerServiceClient(Object soapClient,
+ AdManagerServiceDescriptor adManagerServiceDescriptor,
+ AdManagerSession adManagerSession,
+ SoapClientHandlerInterface soapClientHandler,
+ HeaderHandler<AdManagerSession,AdManagerServiceDescriptor> adManagerHeaderHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdManagerServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<AdManagerServiceClient,AdManagerSession,AdManagerServiceDescriptor> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<AdManagerServiceDescriptor> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface soapClientHandler,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdManagerHttpHeaderHandler(SoapClientHandlerInterface soapClientHandler)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdsServiceClient(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor,
+ SoapClientHandlerInterface<Object> soapClientHandler,
+ HeaderHandler<S,D> headerHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
BaseAdsServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<C,S,D> adsServiceClientFactory,
+ FactoryModule.AdsServiceDescriptorFactoryInterface<D> adsServiceDescriptorFactory,
+ SoapClientHandlerInterface<?> soapClientHandler)
+Constructor.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+SoapClientHandler<T>
+Base class for SOAP client handlers.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected SoapClientHandlerInterface<T> |
+SoapServiceClient.getSoapClientHandler()
+Returns the SOAP client handler.
+ |
+
| Constructor and Description | +
|---|
AuthorizationHeaderHandler(SoapClientHandlerInterface soapClientHandler,
+ AuthorizationHeaderProvider authorizationHeaderProvider)
+Constructor.
+ |
+
SoapServiceClient(SoapClientHandlerInterface<T> soapClientHandler,
+ T soapClient)
+Protected constructor.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AxisHandler
+SOAP Client Handler implementation for use with Axis 1.x.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+JaxWsHandler
+SOAP Client Handler implementation for use with JAX-WS.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapServiceClient.html b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapServiceClient.html new file mode 100644 index 0000000000..b5cc990d62 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapServiceClient.html @@ -0,0 +1,193 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.client | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServiceClient
+Wrapper of underlying SOAP client which allows access for setting headers retrieved from the
+ session.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsServiceClient<S extends AdsSession,D extends AdsServiceDescriptor>
+The base class for all AdsServiceClients.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapServiceDescriptor.html b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapServiceDescriptor.html new file mode 100644 index 0000000000..e42cc7cb81 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/class-use/SoapServiceDescriptor.html @@ -0,0 +1,265 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServiceDescriptor
+AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection. |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AdsServiceDescriptor
+Interface for ads service descriptors.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+SoapClientHandlerInterface.createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
+Creates a SOAP client using the
+soapServiceDescriptor. |
+
| Modifier and Type | +Method and Description | +
|---|---|
org.apache.axis.client.Stub |
+AxisHandler.createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
+Creates a SOAP client using a SOAP service descriptor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
BindingProvider |
+JaxWsHandler.createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
+Creates a SOAP client using a SOAP service descriptor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/compatability/AxisCompatible.html b/5.3.0/com/google/api/ads/common/lib/soap/compatability/AxisCompatible.html new file mode 100644 index 0000000000..861faffa64 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/compatability/AxisCompatible.html @@ -0,0 +1,241 @@ + + + + + + +public interface AxisCompatible
+AdsServiceClient to be Axis compatible, it
+ must be able to retrieve a locator class.| Modifier and Type | +Method and Description | +
|---|---|
Class<?> |
+getLocatorClass()
+Gets the Axis locator class such that it can be instantiated to create
+ an Axis service client.
+ |
+
Class<?> getLocatorClass() + throws ClassNotFoundException+
ClassNotFoundException - if no locator class can be foundCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/compatability/JaxWsCompatible.html b/5.3.0/com/google/api/ads/common/lib/soap/compatability/JaxWsCompatible.html new file mode 100644 index 0000000000..804d6a32b6 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/compatability/JaxWsCompatible.html @@ -0,0 +1,241 @@ + + + + + + +public interface JaxWsCompatible
+AdsServiceClient to be JAX-WS compatible, it
+ must be able to retrieve a service class.| Modifier and Type | +Method and Description | +
|---|---|
Class<?> |
+getServiceClass()
+Gets the JAX-WS service class such that it can be instantiated to create
+ an JAX-WS service client.
+ |
+
Class<?> getServiceClass() + throws ClassNotFoundException+
ClassNotFoundException - if no service class can be foundCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/compatability/class-use/AxisCompatible.html b/5.3.0/com/google/api/ads/common/lib/soap/compatability/class-use/AxisCompatible.html new file mode 100644 index 0000000000..062bfd2399 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/compatability/class-use/AxisCompatible.html @@ -0,0 +1,169 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServiceDescriptor
+AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/compatability/class-use/JaxWsCompatible.html b/5.3.0/com/google/api/ads/common/lib/soap/compatability/class-use/JaxWsCompatible.html new file mode 100644 index 0000000000..8167e16352 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/compatability/class-use/JaxWsCompatible.html @@ -0,0 +1,169 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdManagerServiceDescriptor
+AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/compatability/package-frame.html b/5.3.0/com/google/api/ads/common/lib/soap/compatability/package-frame.html new file mode 100644 index 0000000000..fe5c05b8a3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/compatability/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Interface | +Description | +
|---|---|
| AxisCompatible | +
+ Specifies that for the
+AdsServiceClient to be Axis compatible, it
+ must be able to retrieve a locator class. |
+
| JaxWsCompatible | +
+ Specifies that for the
+AdsServiceClient to be JAX-WS compatible, it
+ must be able to retrieve a service class. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/compatability/package-tree.html b/5.3.0/com/google/api/ads/common/lib/soap/compatability/package-tree.html new file mode 100644 index 0000000000..29d53e218e --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/compatability/package-tree.html @@ -0,0 +1,136 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/compatability/package-use.html b/5.3.0/com/google/api/ads/common/lib/soap/compatability/package-use.html new file mode 100644 index 0000000000..03541d327b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/compatability/package-use.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| Class and Description | +
|---|
| AxisCompatible
+ Specifies that for the
+AdsServiceClient to be Axis compatible, it
+ must be able to retrieve a locator class. |
+
| JaxWsCompatible
+ Specifies that for the
+AdsServiceClient to be JAX-WS compatible, it
+ must be able to retrieve a service class. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxb/JaxBDeserializer.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/JaxBDeserializer.html new file mode 100644 index 0000000000..99981d2257 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/JaxBDeserializer.html @@ -0,0 +1,294 @@ + + + + + + +T - Class we are deserializing.public class JaxBDeserializer<T> +extends Object+
| Constructor and Description | +
|---|
JaxBDeserializer(Class<T> clazz)
+Constructs a JAX-WS deserializer for the specified class.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+deserialize(Source source)
+Deserializes the object.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxb/JaxBSerializer.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/JaxBSerializer.html new file mode 100644 index 0000000000..7e952a14de --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/JaxBSerializer.html @@ -0,0 +1,324 @@ + + + + + + +T - Class we are serializing.public class JaxBSerializer<T> +extends Object+
| Constructor and Description | +
|---|
JaxBSerializer(Class<T> clazz,
+ QName qname)
+Constructs a JAX-WS serializer for the specified class.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+serialize(T object)
+Serializes the object.
+ |
+
String |
+serialize(T object,
+ boolean includeXmlDeclaration)
+Serializes the object with the option to include or exclude the XML declaration.
+ |
+
public JaxBSerializer(Class<T> clazz, + QName qname)+
clazz - Class to serialize.qname - A QName representing the local name for the class - this will be used as the root
+ tag name.org.apache.commons.lang.SerializationException - if unable to construct the serializer.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxb/class-use/JaxBDeserializer.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/class-use/JaxBDeserializer.html new file mode 100644 index 0000000000..11934ae8a3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/class-use/JaxBDeserializer.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxb/class-use/JaxBSerializer.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/class-use/JaxBSerializer.html new file mode 100644 index 0000000000..ee0a96ee82 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/class-use/JaxBSerializer.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxb/package-frame.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/package-frame.html new file mode 100644 index 0000000000..4b94e6ddd9 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Class | +Description | +
|---|---|
| JaxBDeserializer<T> | +
+ Deserializes XML to an instance of a JAX-WS generated class.
+ |
+
| JaxBSerializer<T> | +
+ Serializes a JAX-WS generated class to XML.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxb/package-tree.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/package-tree.html new file mode 100644 index 0000000000..19df85d335 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/package-tree.html @@ -0,0 +1,140 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxb/package-use.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/package-use.html new file mode 100644 index 0000000000..d63e2ac2f2 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxb/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsFrameworkUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsFrameworkUserAgentProvider.html new file mode 100644 index 0000000000..af53f7cbbb --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsFrameworkUserAgentProvider.html @@ -0,0 +1,287 @@ + + + + + + +public class JaxWsFrameworkUserAgentProvider +extends Object +implements FrameworkUserAgentProvider+
| Constructor and Description | +
|---|
JaxWsFrameworkUserAgentProvider() |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent()
+Gets a user agent.
+ |
+
public JaxWsFrameworkUserAgentProvider()+
public String getUserAgent()+
UserAgentProvidergetUserAgent in interface UserAgentProviderCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsHandler.html new file mode 100644 index 0000000000..42fc5e76dc --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsHandler.html @@ -0,0 +1,586 @@ + + + + + + +public class JaxWsHandler +extends SoapClientHandler<BindingProvider>+
| Modifier | +Constructor and Description | +
|---|---|
protected |
+JaxWsHandler(com.google.inject.Provider<JaxWsSoapContextHandler> contextHandlerProvider) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+clearHeaders(BindingProvider soapClient)
+Clears all of the SOAP headers from the given SOAP client.
+ |
+
BindingProvider |
+createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
+Creates a SOAP client using a SOAP service descriptor.
+ |
+
SOAPHeaderElement |
+createSoapHeaderElement(QName qName)
+JAX-WS does not support use of this method.
+ |
+
String |
+getEndpointAddress(BindingProvider soapClient)
+Gets the endpoint address on the SOAP client.
+ |
+
Object |
+getHeader(BindingProvider soapClient,
+ String headerName)
+Returns a SOAP header from the given SOAP client, if it exists.
+ |
+
RemoteCallReturn |
+invokeSoapCall(SoapCall<BindingProvider> soapCall)
+Invoke a SOAP call.
+ |
+
void |
+putAllHttpHeaders(BindingProvider soapClient,
+ Map<String,String> headersMap)
+Puts all headers into the existing HTTP headers of the SOAP client,
+ overwriting any existing header keys.
+ |
+
void |
+setCompression(BindingProvider soapClient,
+ boolean compress)
+Set whether SOAP requests should use compression.
+ |
+
void |
+setEndpointAddress(BindingProvider soapClient,
+ String endpointAddress)
+Sets the endpoint address of the given SOAP client.
+ |
+
void |
+setHeader(BindingProvider soapClient,
+ String namespace,
+ String headerName,
+ Object headerValue)
+Sets a header on the SOAP client.
+ |
+
void |
+setHeaderChildString(BindingProvider soapClient,
+ String headerName,
+ String childNamespace,
+ String childName,
+ String childValue)
+Adds a child text node named childName to the existing header named headerName.
+ |
+
void |
+setRequestTimeout(BindingProvider bindingProvider,
+ int timeout)
+Sets properties into the message context to alter the timeout on App Engine.
+ |
+
getSoapClientMethod, invoke, processSoapArguments@Inject +protected JaxWsHandler(com.google.inject.Provider<JaxWsSoapContextHandler> contextHandlerProvider)+
contextHandlerProvider - a provider which produces context handlerspublic void setEndpointAddress(BindingProvider soapClient, + String endpointAddress)+
soapClient - the SOAP client to set the endpoint address forendpointAddress - the target endpoint addresspublic Object getHeader(BindingProvider soapClient, + String headerName)+
soapClient - the SOAP client to check for the given headerheaderName - the name of the header being looked forpublic void clearHeaders(BindingProvider soapClient)+
soapClient - the client to remove the headers frompublic void setHeader(BindingProvider soapClient, + String namespace, + String headerName, + Object headerValue)+
SoapClientHandlerInterfacesoapClient - the SOAP client to set the header ofnamespace - the namespace of the headerheaderName - the name of the headerheaderValue - the value of the headerSoapClientHandlerInterface.setHeader(Object, String, String, Object)public void setHeaderChildString(BindingProvider soapClient, + String headerName, + String childNamespace, + String childName, + String childValue)+
soapClient - the binding providerheaderName - the name of the existing headerchildNamespace - the namespace of the new childchildName - the name of the new childchildValue - the value of the new childNullPointerException - if no header exists named headerNamepublic void putAllHttpHeaders(BindingProvider soapClient, + Map<String,String> headersMap)+
SoapClientHandlerInterfacesoapClient - the SOAP client to set the headers onheadersMap - the map of headers in the form of header name to valueSoapClientHandlerInterface.putAllHttpHeaders(Object, Map)public void setCompression(BindingProvider soapClient, + boolean compress)+
soapClient - the client to set compression settings forcompress - whether or not to use compressionpublic BindingProvider createSoapClient(SoapServiceDescriptor soapServiceDescriptor) + throws ServiceException+
soapServiceDescriptor - the descriptor to use for creating a clientServiceException - thrown if the SOAP client cannot be createdpublic void setRequestTimeout(BindingProvider bindingProvider, + int timeout)+
bindingProvider - the SOAP client to set the read timeout fortimeout - the timeout in millisecondspublic RemoteCallReturn invokeSoapCall(SoapCall<BindingProvider> soapCall)+
soapCall - the call to make to a SOAP web servicepublic String getEndpointAddress(BindingProvider soapClient)+
SoapClientHandlerInterfaceSoapClientHandlerInterface.getEndpointAddress(Object)public SOAPHeaderElement createSoapHeaderElement(QName qName)+
qName - qualified name of the header elementSoapClientHandlerInterface.createSoapHeaderElement(QName)Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsModule.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsModule.html new file mode 100644 index 0000000000..7fbb4a171a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsModule.html @@ -0,0 +1,294 @@ + + + + + + +public class JaxWsModule
+extends com.google.inject.AbstractModule
+| Constructor and Description | +
|---|
JaxWsModule() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure() |
+
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsSoapContextHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsSoapContextHandler.html new file mode 100644 index 0000000000..165155afa4 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/JaxWsSoapContextHandler.html @@ -0,0 +1,457 @@ + + + + + + +public class JaxWsSoapContextHandler +extends Object +implements SOAPHandler<SOAPMessageContext>+
| Constructor and Description | +
|---|
JaxWsSoapContextHandler(RequestInfoXPathSet requestInfoXPathSet,
+ ResponseInfoXPathSet responseInfoXPathSet) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addHeader(String namespace,
+ String headerName,
+ SOAPElement headerValue)
+Adds a header to the list of SOAP request headers.
+ |
+
void |
+clearHeaders()
+Clears all the headers set in this handler.
+ |
+
void |
+close(MessageContext messageContext) |
+
Set<SOAPElement> |
+getAddedHeaders()
+Returns the set of SOAP headers added to this handler.
+ |
+
Set<QName> |
+getHeaders() |
+
RequestInfo.Builder |
+getLastRequestInfoBuilder()
+Returns info for the last SOAP request.
+ |
+
ResponseInfo.Builder |
+getLastResponseInfoBuilder()
+Returns info for the last SOAP response.
+ |
+
boolean |
+handleFault(SOAPMessageContext context)
+Captures pertinent information from a message representing a SOAP fault.
+ |
+
boolean |
+handleMessage(SOAPMessageContext context)
+Captures pertinent information from SOAP messages exchanged by the SOAP
+ service this handler is attached to.
+ |
+
@Inject +public JaxWsSoapContextHandler(RequestInfoXPathSet requestInfoXPathSet, + ResponseInfoXPathSet responseInfoXPathSet)+
public boolean handleMessage(SOAPMessageContext context)+
handleMessage in interface Handler<SOAPMessageContext>context - the context of the SOAP message passing through this handlerHandler.handleMessage(MessageContext)public boolean handleFault(SOAPMessageContext context)+
handleFault in interface Handler<SOAPMessageContext>context - the context of the SOAP message passing through this handlerHandler.handleFault(MessageContext)public RequestInfo.Builder getLastRequestInfoBuilder()+
public ResponseInfo.Builder getLastResponseInfoBuilder()+
public void addHeader(String namespace, + String headerName, + SOAPElement headerValue)+
namespace - the namespace the header belongs toheaderName - the name of the header elementheaderValue - the value of the header elementpublic void clearHeaders()+
public Set<SOAPElement> getAddedHeaders()+
public Set<QName> getHeaders()+
getHeaders in interface SOAPHandler<SOAPMessageContext>SOAPHandler.getHeaders()public void close(MessageContext messageContext)+
close in interface Handler<SOAPMessageContext>Handler.close(MessageContext)Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsFrameworkUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsFrameworkUserAgentProvider.html new file mode 100644 index 0000000000..0bcc0f4f4c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsFrameworkUserAgentProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsHandler.html new file mode 100644 index 0000000000..7e48b4a0bc --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsHandler.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws | ++ |
| Constructor and Description | +
|---|
AdManagerJaxWsHeaderHandler(JaxWsHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsModule.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsModule.html new file mode 100644 index 0000000000..4b203421d9 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsSoapContextHandler.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsSoapContextHandler.html new file mode 100644 index 0000000000..bbe14cfab2 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/class-use/JaxWsSoapContextHandler.html @@ -0,0 +1,164 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Constructor and Description | +
|---|
JaxWsHandler(com.google.inject.Provider<JaxWsSoapContextHandler> contextHandlerProvider) |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/package-frame.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/package-frame.html new file mode 100644 index 0000000000..6dec853335 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| JaxWsFrameworkUserAgentProvider | +
+ Provides the JAX-WS user agent.
+ |
+
| JaxWsHandler | +
+ SOAP Client Handler implementation for use with JAX-WS.
+ |
+
| JaxWsModule | +
+ Module for SOAP client handler.
+ |
+
| JaxWsSoapContextHandler | +
+ SOAP Context Handler for use with JAX-WS.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/package-tree.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/package-tree.html new file mode 100644 index 0000000000..0b3886a8ea --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/package-tree.html @@ -0,0 +1,150 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/jaxws/package-use.html b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/package-use.html new file mode 100644 index 0000000000..626beec153 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/jaxws/package-use.html @@ -0,0 +1,182 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Class and Description | +
|---|
| JaxWsHandler
+ SOAP Client Handler implementation for use with JAX-WS.
+ |
+
| Class and Description | +
|---|
| JaxWsSoapContextHandler
+ SOAP Context Handler for use with JAX-WS.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/package-frame.html b/5.3.0/com/google/api/ads/common/lib/soap/package-frame.html new file mode 100644 index 0000000000..cb389773a0 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +| Interface | +Description | +
|---|---|
| SoapClientHandlerInterface<T> | +
+ Interface for SOAP client handlers.
+ |
+
| SoapServiceDescriptor | +
+ Describes a SOAP service.
+ |
+
| Class | +Description | +
|---|---|
| AuthorizationHeaderHandler | +
+ Handler for
+Authorization headers that can be set on the SOAP
+ client. |
+
| ProductFrameworkModule | +
+ Module for the product/framework.
+ |
+
| RequestInfoXPathSet | +
+ XPaths to capture from SOAP requests.
+ |
+
| ResponseInfoXPathSet | +
+ XPaths to capture from SOAP responses.
+ |
+
| SoapCall<T> | +
+ Represents a single call to the SOAP client.
+ |
+
| SoapClientHandler<T> | +
+ Base class for SOAP client handlers.
+ |
+
| SoapServiceClient<T> | +
+ 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. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/package-tree.html b/5.3.0/com/google/api/ads/common/lib/soap/package-tree.html new file mode 100644 index 0000000000..e519d5d5fb --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/package-tree.html @@ -0,0 +1,154 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/soap/package-use.html b/5.3.0/com/google/api/ads/common/lib/soap/package-use.html new file mode 100644 index 0000000000..16041d47b9 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/soap/package-use.html @@ -0,0 +1,448 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.admanager.lib.factory.helper | ++ |
| com.google.api.ads.admanager.lib.soap | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Class and Description | +
|---|
| AuthorizationHeaderHandler
+ Handler for
+Authorization headers that can be set on the SOAP
+ client. |
+
| ProductFrameworkModule
+ Module for the product/framework.
+ |
+
| Class and Description | +
|---|
| AuthorizationHeaderHandler
+ Handler for
+Authorization headers that can be set on the SOAP
+ client. |
+
| ProductFrameworkModule
+ Module for the product/framework.
+ |
+
| Class and Description | +
|---|
| SoapClientHandlerInterface
+ Interface for SOAP client handlers.
+ |
+
| SoapServiceClient
+ 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. |
+
| SoapServiceDescriptor
+ Describes a SOAP service.
+ |
+
| Class and Description | +
|---|
| SoapClientHandlerInterface
+ Interface for SOAP client handlers.
+ |
+
| Class and Description | +
|---|
| SoapClientHandlerInterface
+ Interface for SOAP client handlers.
+ |
+
| Class and Description | +
|---|
| SoapClientHandlerInterface
+ Interface for SOAP client handlers.
+ |
+
| SoapServiceClient
+ 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. |
+
| SoapServiceDescriptor
+ Describes a SOAP service.
+ |
+
| Class and Description | +
|---|
| SoapClientHandlerInterface
+ Interface for SOAP client handlers.
+ |
+
| Class and Description | +
|---|
| SoapCall
+ Represents a single call to the SOAP client.
+ |
+
| SoapClientHandlerInterface
+ Interface for SOAP client handlers.
+ |
+
| SoapServiceDescriptor
+ Describes a SOAP service.
+ |
+
| Class and Description | +
|---|
| RequestInfoXPathSet
+ XPaths to capture from SOAP requests.
+ |
+
| ResponseInfoXPathSet
+ XPaths to capture from SOAP responses.
+ |
+
| SoapCall
+ Represents a single call to the SOAP client.
+ |
+
| SoapClientHandler
+ Base class for SOAP client handlers.
+ |
+
| SoapClientHandlerInterface
+ Interface for SOAP client handlers.
+ |
+
| SoapServiceDescriptor
+ Describes a SOAP service.
+ |
+
| Class and Description | +
|---|
| RequestInfoXPathSet
+ XPaths to capture from SOAP requests.
+ |
+
| ResponseInfoXPathSet
+ XPaths to capture from SOAP responses.
+ |
+
| SoapCall
+ Represents a single call to the SOAP client.
+ |
+
| SoapClientHandler
+ Base class for SOAP client handlers.
+ |
+
| SoapClientHandlerInterface
+ Interface for SOAP client handlers.
+ |
+
| SoapServiceDescriptor
+ Describes a SOAP service.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/AdsLibraryUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/AdsLibraryUserAgentProvider.html new file mode 100644 index 0000000000..7fadb80125 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/AdsLibraryUserAgentProvider.html @@ -0,0 +1,294 @@ + + + + + + +public class AdsLibraryUserAgentProvider +extends Object +implements UserAgentProvider+
| Constructor and Description | +
|---|
AdsLibraryUserAgentProvider(com.google.api.ads.common.lib.conf.AdsBuildConfiguration buildConfiguration)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent()
+Generates the library user agent such as Common-Java/1.4
+ |
+
@Inject +public AdsLibraryUserAgentProvider(com.google.api.ads.common.lib.conf.AdsBuildConfiguration buildConfiguration)+
buildConfiguration - the build configurationpublic String getUserAgent()+
getUserAgent in interface UserAgentProviderCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/AdsUtilitiesUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/AdsUtilitiesUserAgentProvider.html new file mode 100644 index 0000000000..5c996fe042 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/AdsUtilitiesUserAgentProvider.html @@ -0,0 +1,290 @@ + + + + + + +public class AdsUtilitiesUserAgentProvider +extends Object +implements UserAgentProvider+
| Constructor and Description | +
|---|
AdsUtilitiesUserAgentProvider(AdsUtilityRegistry adsUtilityRegistry,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent()
+Gets a user agent.
+ |
+
@Inject +public AdsUtilitiesUserAgentProvider(AdsUtilityRegistry adsUtilityRegistry, + com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration)+
public String getUserAgent()+
UserAgentProvidergetUserAgent in interface UserAgentProviderCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/BuildTypeUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/BuildTypeUserAgentProvider.html new file mode 100644 index 0000000000..5898c6d5a8 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/BuildTypeUserAgentProvider.html @@ -0,0 +1,295 @@ + + + + + + +public class BuildTypeUserAgentProvider +extends Object +implements UserAgentProvider+
| Constructor and Description | +
|---|
BuildTypeUserAgentProvider(com.google.api.ads.common.lib.conf.AdsBuildConfiguration buildConfiguration)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent()
+Gets a user agent.
+ |
+
@Inject +public BuildTypeUserAgentProvider(com.google.api.ads.common.lib.conf.AdsBuildConfiguration buildConfiguration)+
buildConfiguration - the build configurationpublic String getUserAgent()+
UserAgentProvidergetUserAgent in interface UserAgentProviderCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/ExtensionUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/ExtensionUserAgentProvider.html new file mode 100644 index 0000000000..9510301b94 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/ExtensionUserAgentProvider.html @@ -0,0 +1,197 @@ + + + + + + +public interface ExtensionUserAgentProvider +extends UserAgentProvider+
UserAgentProvider for extension frameworks to decorate the user agent with additional
+ information.getUserAgentCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/FrameworkUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/FrameworkUserAgentProvider.html new file mode 100644 index 0000000000..5b83788d1a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/FrameworkUserAgentProvider.html @@ -0,0 +1,200 @@ + + + + + + +public interface FrameworkUserAgentProvider +extends UserAgentProvider+
getUserAgentCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/ProductFrameworkUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/ProductFrameworkUserAgentProvider.html new file mode 100644 index 0000000000..0dee06aae3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/ProductFrameworkUserAgentProvider.html @@ -0,0 +1,294 @@ + + + + + + +public class ProductFrameworkUserAgentProvider +extends Object +implements UserAgentProvider+
| Constructor and Description | +
|---|
ProductFrameworkUserAgentProvider(com.google.api.ads.common.lib.conf.ProductFrameworkConfiguration productFrameworkConfiguration)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent()
+Generates the framework user agent such as AdWords-Axis/1.4.
+ |
+
@Inject +public ProductFrameworkUserAgentProvider(com.google.api.ads.common.lib.conf.ProductFrameworkConfiguration productFrameworkConfiguration)+
productFrameworkConfiguration - the product/framework configuration.public String getUserAgent()+
getUserAgent in interface UserAgentProviderCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/ProductUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/ProductUserAgentProvider.html new file mode 100644 index 0000000000..8f337b2c1b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/ProductUserAgentProvider.html @@ -0,0 +1,294 @@ + + + + + + +public class ProductUserAgentProvider +extends Object +implements UserAgentProvider+
| Constructor and Description | +
|---|
ProductUserAgentProvider(com.google.api.ads.common.lib.conf.ProductConfiguration productConfiguration)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent()
+Generates the product user agent such as AwApi-Java.
+ |
+
@Inject +public ProductUserAgentProvider(com.google.api.ads.common.lib.conf.ProductConfiguration productConfiguration)+
productConfiguration - the product configuration.public String getUserAgent()+
getUserAgent in interface UserAgentProviderCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/RuntimeUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/RuntimeUserAgentProvider.html new file mode 100644 index 0000000000..386fc88a45 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/RuntimeUserAgentProvider.html @@ -0,0 +1,287 @@ + + + + + + +public class RuntimeUserAgentProvider +extends Object +implements UserAgentProvider+
| Constructor and Description | +
|---|
RuntimeUserAgentProvider() |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent()
+Gets a user agent.
+ |
+
public RuntimeUserAgentProvider()+
public String getUserAgent()+
UserAgentProvidergetUserAgent in interface UserAgentProviderCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/UserAgentCombiner.html b/5.3.0/com/google/api/ads/common/lib/useragent/UserAgentCombiner.html new file mode 100644 index 0000000000..7da79fbae0 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/UserAgentCombiner.html @@ -0,0 +1,311 @@ + + + + + + +public class UserAgentCombiner +extends Object+
| Constructor and Description | +
|---|
UserAgentCombiner(ProductUserAgentProvider productUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ProductFrameworkProviderHolder productFrameworkProviderHolder,
+ AdsLibraryUserAgentProvider adsLibraryUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.FrameworkProviderHolder frameworkProviderHolder,
+ RuntimeUserAgentProvider runtimeUserAgentProvider,
+ BuildTypeUserAgentProvider buildTypeUserAgentProvider,
+ AdsUtilitiesUserAgentProvider adsUtilitiesUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ExtensionProviderHolder extensionProviderHolder)
+Constructor that builds an instance based on a list of underlying user agent
+ providers.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent(String nonLibraryUserAgent)
+Gets the full user agent in the form of
+
+"(UserAgent1,UserAgent2,UserAgent3,...)" |
+
@Inject +public UserAgentCombiner(ProductUserAgentProvider productUserAgentProvider, + com.google.api.ads.common.lib.useragent.UserAgentCombiner.ProductFrameworkProviderHolder productFrameworkProviderHolder, + AdsLibraryUserAgentProvider adsLibraryUserAgentProvider, + com.google.api.ads.common.lib.useragent.UserAgentCombiner.FrameworkProviderHolder frameworkProviderHolder, + RuntimeUserAgentProvider runtimeUserAgentProvider, + BuildTypeUserAgentProvider buildTypeUserAgentProvider, + AdsUtilitiesUserAgentProvider adsUtilitiesUserAgentProvider, + com.google.api.ads.common.lib.useragent.UserAgentCombiner.ExtensionProviderHolder extensionProviderHolder)+
xyzHolder parameters are for user agent providers that
+ may be null in certain contexts.productUserAgentProvider - the product user agent library user agent providerproductFrameworkProviderHolder - holder for the product/framework user agent
+ provideradsLibraryUserAgentProvider - the ads library user agent providerframeworkProviderHolder - holder for the framework user agent providerruntimeUserAgentProvider - the runtime user agent providerbuildTypeUserAgentProvider - the build type user agent providerextensionProviderHolder - holder for the extension user agent providerCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/UserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/UserAgentProvider.html new file mode 100644 index 0000000000..652528a18a --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/UserAgentProvider.html @@ -0,0 +1,235 @@ + + + + + + +public interface UserAgentProvider
+| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgent()
+Gets a user agent.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/AdsLibraryUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/AdsLibraryUserAgentProvider.html new file mode 100644 index 0000000000..3db24eb6bd --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/AdsLibraryUserAgentProvider.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.useragent | ++ |
| Constructor and Description | +
|---|
UserAgentCombiner(ProductUserAgentProvider productUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ProductFrameworkProviderHolder productFrameworkProviderHolder,
+ AdsLibraryUserAgentProvider adsLibraryUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.FrameworkProviderHolder frameworkProviderHolder,
+ RuntimeUserAgentProvider runtimeUserAgentProvider,
+ BuildTypeUserAgentProvider buildTypeUserAgentProvider,
+ AdsUtilitiesUserAgentProvider adsUtilitiesUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ExtensionProviderHolder extensionProviderHolder)
+Constructor that builds an instance based on a list of underlying user agent
+ providers.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/AdsUtilitiesUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/AdsUtilitiesUserAgentProvider.html new file mode 100644 index 0000000000..3c4f28bd0f --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/AdsUtilitiesUserAgentProvider.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.useragent | ++ |
| Constructor and Description | +
|---|
UserAgentCombiner(ProductUserAgentProvider productUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ProductFrameworkProviderHolder productFrameworkProviderHolder,
+ AdsLibraryUserAgentProvider adsLibraryUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.FrameworkProviderHolder frameworkProviderHolder,
+ RuntimeUserAgentProvider runtimeUserAgentProvider,
+ BuildTypeUserAgentProvider buildTypeUserAgentProvider,
+ AdsUtilitiesUserAgentProvider adsUtilitiesUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ExtensionProviderHolder extensionProviderHolder)
+Constructor that builds an instance based on a list of underlying user agent
+ providers.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/BuildTypeUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/BuildTypeUserAgentProvider.html new file mode 100644 index 0000000000..b530a6403d --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/BuildTypeUserAgentProvider.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.useragent | ++ |
| Constructor and Description | +
|---|
UserAgentCombiner(ProductUserAgentProvider productUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ProductFrameworkProviderHolder productFrameworkProviderHolder,
+ AdsLibraryUserAgentProvider adsLibraryUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.FrameworkProviderHolder frameworkProviderHolder,
+ RuntimeUserAgentProvider runtimeUserAgentProvider,
+ BuildTypeUserAgentProvider buildTypeUserAgentProvider,
+ AdsUtilitiesUserAgentProvider adsUtilitiesUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ExtensionProviderHolder extensionProviderHolder)
+Constructor that builds an instance based on a list of underlying user agent
+ providers.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/ExtensionUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/ExtensionUserAgentProvider.html new file mode 100644 index 0000000000..450f000341 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/ExtensionUserAgentProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/FrameworkUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/FrameworkUserAgentProvider.html new file mode 100644 index 0000000000..dbedb49bdf --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/FrameworkUserAgentProvider.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AxisFrameworkUserAgentProvider
+Provides the Axis user agent.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+JaxWsFrameworkUserAgentProvider
+Provides the JAX-WS user agent.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/ProductFrameworkUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/ProductFrameworkUserAgentProvider.html new file mode 100644 index 0000000000..43e4714dc8 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/ProductFrameworkUserAgentProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/ProductUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/ProductUserAgentProvider.html new file mode 100644 index 0000000000..fde4baff75 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/ProductUserAgentProvider.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.useragent | ++ |
| Constructor and Description | +
|---|
UserAgentCombiner(ProductUserAgentProvider productUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ProductFrameworkProviderHolder productFrameworkProviderHolder,
+ AdsLibraryUserAgentProvider adsLibraryUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.FrameworkProviderHolder frameworkProviderHolder,
+ RuntimeUserAgentProvider runtimeUserAgentProvider,
+ BuildTypeUserAgentProvider buildTypeUserAgentProvider,
+ AdsUtilitiesUserAgentProvider adsUtilitiesUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ExtensionProviderHolder extensionProviderHolder)
+Constructor that builds an instance based on a list of underlying user agent
+ providers.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/RuntimeUserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/RuntimeUserAgentProvider.html new file mode 100644 index 0000000000..96a67bc8bb --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/RuntimeUserAgentProvider.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.useragent | ++ |
| Constructor and Description | +
|---|
UserAgentCombiner(ProductUserAgentProvider productUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ProductFrameworkProviderHolder productFrameworkProviderHolder,
+ AdsLibraryUserAgentProvider adsLibraryUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.FrameworkProviderHolder frameworkProviderHolder,
+ RuntimeUserAgentProvider runtimeUserAgentProvider,
+ BuildTypeUserAgentProvider buildTypeUserAgentProvider,
+ AdsUtilitiesUserAgentProvider adsUtilitiesUserAgentProvider,
+ com.google.api.ads.common.lib.useragent.UserAgentCombiner.ExtensionProviderHolder extensionProviderHolder)
+Constructor that builds an instance based on a list of underlying user agent
+ providers.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/UserAgentCombiner.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/UserAgentCombiner.html new file mode 100644 index 0000000000..4832ea8274 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/UserAgentCombiner.html @@ -0,0 +1,241 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Constructor and Description | +
|---|
AdManagerAxisHeaderHandler(AxisHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdManagerJaxWsHeaderHandler(JaxWsHandler soapClientHandler,
+ com.google.api.ads.admanager.lib.conf.AdManagerApiConfiguration adManagerApiConfiguration,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration,
+ AuthorizationHeaderHandler authorizationHeaderHandler,
+ AdManagerHttpHeaderHandler adManagerHttpHeaderHandler,
+ UserAgentCombiner userAgentCombiner)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
UserAgentCombiner |
+Internals.getUserAgentCombiner()
+Creates a verbose User-Agent header.
+ |
+
| Constructor and Description | +
|---|
Internals(AuthorizationHeaderProvider authorizationHeaderProvider,
+ UserAgentCombiner userAgentCombiner,
+ com.google.api.client.http.HttpTransport httpTransport,
+ AdsServiceLoggers adsServiceLoggers,
+ OAuth2Helper oAuth2Helper,
+ AdsUtilityRegistry adsUtilityRegistry,
+ XmlFieldExtractor xmlFieldExtractor)
+Constructor to be injected by guice.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/class-use/UserAgentProvider.html b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/UserAgentProvider.html new file mode 100644 index 0000000000..aa151620b1 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/class-use/UserAgentProvider.html @@ -0,0 +1,268 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| com.google.api.ads.common.lib.useragent | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AxisFrameworkUserAgentProvider
+Provides the Axis user agent.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+JaxWsFrameworkUserAgentProvider
+Provides the JAX-WS user agent.
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+ExtensionUserAgentProvider
+UserAgentProvider for extension frameworks to decorate the user agent with additional
+ information. |
+
interface |
+FrameworkUserAgentProvider
+Provides the framework user agent.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdsLibraryUserAgentProvider
+Provides the ads library user agent.
+ |
+
class |
+AdsUtilitiesUserAgentProvider
+Provides the ads utilities user agent.
+ |
+
class |
+BuildTypeUserAgentProvider
+Provides the build type user agent.
+ |
+
class |
+ProductFrameworkUserAgentProvider
+Provides product/framework user agent.
+ |
+
class |
+ProductUserAgentProvider
+Provides product user agent.
+ |
+
class |
+RuntimeUserAgentProvider
+Gets the runtime user agent.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/package-frame.html b/5.3.0/com/google/api/ads/common/lib/useragent/package-frame.html new file mode 100644 index 0000000000..1e00c3a332 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/package-frame.html @@ -0,0 +1,33 @@ + + + + + + +| Interface | +Description | +
|---|---|
| ExtensionUserAgentProvider | +
+UserAgentProvider for extension frameworks to decorate the user agent with additional
+ information. |
+
| FrameworkUserAgentProvider | +
+ Provides the framework user agent.
+ |
+
| UserAgentProvider | +
+ Provides a user agent.
+ |
+
| Class | +Description | +
|---|---|
| AdsLibraryUserAgentProvider | +
+ Provides the ads library user agent.
+ |
+
| AdsUtilitiesUserAgentProvider | +
+ Provides the ads utilities user agent.
+ |
+
| BuildTypeUserAgentProvider | +
+ Provides the build type user agent.
+ |
+
| ProductFrameworkUserAgentProvider | +
+ Provides product/framework user agent.
+ |
+
| ProductUserAgentProvider | +
+ Provides product user agent.
+ |
+
| RuntimeUserAgentProvider | +
+ Gets the runtime user agent.
+ |
+
| UserAgentCombiner | +
+ Combines all user agents along with a user supplied string.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/package-tree.html b/5.3.0/com/google/api/ads/common/lib/useragent/package-tree.html new file mode 100644 index 0000000000..3d9458e749 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/package-tree.html @@ -0,0 +1,154 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/useragent/package-use.html b/5.3.0/com/google/api/ads/common/lib/useragent/package-use.html new file mode 100644 index 0000000000..0cd5f3dd93 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/useragent/package-use.html @@ -0,0 +1,301 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.axis | ++ |
| com.google.api.ads.admanager.jaxws | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| com.google.api.ads.common.lib.useragent | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Class and Description | +
|---|
| UserAgentCombiner
+ Combines all user agents along with a user supplied string.
+ |
+
| Class and Description | +
|---|
| UserAgentCombiner
+ Combines all user agents along with a user supplied string.
+ |
+
| Class and Description | +
|---|
| FrameworkUserAgentProvider
+ Provides the framework user agent.
+ |
+
| UserAgentProvider
+ Provides a user agent.
+ |
+
| Class and Description | +
|---|
| FrameworkUserAgentProvider
+ Provides the framework user agent.
+ |
+
| UserAgentProvider
+ Provides a user agent.
+ |
+
| Class and Description | +
|---|
| AdsLibraryUserAgentProvider
+ Provides the ads library user agent.
+ |
+
| AdsUtilitiesUserAgentProvider
+ Provides the ads utilities user agent.
+ |
+
| BuildTypeUserAgentProvider
+ Provides the build type user agent.
+ |
+
| ProductUserAgentProvider
+ Provides product user agent.
+ |
+
| RuntimeUserAgentProvider
+ Gets the runtime user agent.
+ |
+
| UserAgentProvider
+ Provides a user agent.
+ |
+
| Class and Description | +
|---|
| UserAgentCombiner
+ Combines all user agents along with a user supplied string.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/AdsUtility.html b/5.3.0/com/google/api/ads/common/lib/utils/AdsUtility.html new file mode 100644 index 0000000000..ee141d01a2 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/AdsUtility.html @@ -0,0 +1,441 @@ + + + + + + +public enum AdsUtility +extends Enum<AdsUtility>+
| Enum Constant and Description | +
|---|
BATCH_JOB_HELPER
+AdWords BatchJobService upload/download utility
+ |
+
PRODUCT_PARTITION_TREE
+AdWords shopping utility for managing shopping product partition trees
+ |
+
REPORT_DOWNLOADER
+AdWords ReportDownloader
+ |
+
REPORT_QUERY_BUILDER
+AdWords ReportQueryBuilder
+ |
+
SELECTOR_BUILDER
+AdWords SelectorBuilder
+ |
+
SELECTOR_FIELD
+AdWords SelectorField enums
+ |
+
SERVICE_QUERY_BUILDER
+AdWords ServiceQueryBuilder
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getUserAgentIdentifier()
+Returns the String to use for this utility when generating the user agent of a request.
+ |
+
static AdsUtility |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AdsUtility[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final AdsUtility SELECTOR_BUILDER+
public static final AdsUtility REPORT_DOWNLOADER+
public static final AdsUtility SELECTOR_FIELD+
public static final AdsUtility PRODUCT_PARTITION_TREE+
public static final AdsUtility BATCH_JOB_HELPER+
public static final AdsUtility REPORT_QUERY_BUILDER+
public static final AdsUtility SERVICE_QUERY_BUILDER+
public static AdsUtility[] values()+
+for (AdsUtility c : AdsUtility.values()) + System.out.println(c); +
public static AdsUtility valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String getUserAgentIdentifier()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/AdsUtilityInvocationHandler.html b/5.3.0/com/google/api/ads/common/lib/utils/AdsUtilityInvocationHandler.html new file mode 100644 index 0000000000..4d2ba1d7b3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/AdsUtilityInvocationHandler.html @@ -0,0 +1,304 @@ + + + + + + +public class AdsUtilityInvocationHandler
+extends com.google.common.reflect.AbstractInvocationHandler
+InvocationHandler that updates the AdsUtilityRegistry when a method call on the
+ proxied interface is annotated with UsesAdsUtilities.| Constructor and Description | +
|---|
AdsUtilityInvocationHandler(Object objectToProxy,
+ AdsUtilityRegistry adsUtilityRegistry) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+handleInvocation(Object proxy,
+ Method method,
+ Object[] args) |
+
equals, hashCode, invoke, toStringpublic AdsUtilityInvocationHandler(Object objectToProxy, + AdsUtilityRegistry adsUtilityRegistry)+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/AdsUtilityRegistry.html b/5.3.0/com/google/api/ads/common/lib/utils/AdsUtilityRegistry.html new file mode 100644 index 0000000000..dbf43f5b0c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/AdsUtilityRegistry.html @@ -0,0 +1,283 @@ + + + + + + +@ThreadSafe +public final class AdsUtilityRegistry +extends Object+
ads utilities.| Modifier and Type | +Method and Description | +
|---|---|
void |
+addUtility(AdsUtility adsUtility)
+Adds the specified utility to the registry.
+ |
+
static AdsUtilityRegistry |
+getInstance()
+Returns the singleton of this class.
+ |
+
Set<AdsUtility> |
+popRegisteredUtilities()
+Returns all utilities in the registry and clears the registry.
+ |
+
public static AdsUtilityRegistry getInstance()+
public void addUtility(AdsUtility adsUtility)+
Add is performed on a best efforts basis. It is possible that another thread will + subsequently remove the utility immediately after the add.
NullPointerException - if adsUtility == nullpublic Set<AdsUtility> popRegisteredUtilities()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/Builder.html b/5.3.0/com/google/api/ads/common/lib/utils/Builder.html new file mode 100644 index 0000000000..61cbbfe21d --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/Builder.html @@ -0,0 +1,417 @@ + + + + + + +T - the builder typepublic interface Builder<T>
+| Modifier and Type | +Field and Description | +
|---|---|
static String |
+DEFAULT_CONFIGURATION_FILENAME
+The default configuration filename used when
+fromFile() is called. |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+build()
+Constructs this object.
+ |
+
Builder<T> |
+from(org.apache.commons.configuration.Configuration config)
+Populates this builder from the specified Configuration.
+ |
+
Builder<T> |
+fromFile()
+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
+ |
+
Builder<T> |
+fromFile(File path)
+Populates this builder from a properties file from a specified path.
+ |
+
Builder<T> |
+fromFile(String path)
+Populates this builder from a properties file from a specified path.
+ |
+
Builder<T> |
+fromFile(URL path)
+Populates this builder from a properties file from a specified path.
+ |
+
static final String DEFAULT_CONFIGURATION_FILENAME+
fromFile() is called.T build() + throws ValidationException+
ValidationException - if the provided data is not valid.Builder<T> from(org.apache.commons.configuration.Configuration config) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
config - Configuration to load properties fromcom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.Builder<T> fromFile() + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.Builder<T> fromFile(String path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
path - the path to try first as a resource, then as a filecom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.Builder<T> fromFile(File path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
path - the path to load properties fromcom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.Builder<T> fromFile(URL path) + throws com.google.api.ads.common.lib.conf.ConfigurationLoadException+
path - the path to try first as a resource, then as a filecom.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be
+ loaded.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/CsvFiles.html b/5.3.0/com/google/api/ads/common/lib/utils/CsvFiles.html new file mode 100644 index 0000000000..9ea9986598 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/CsvFiles.html @@ -0,0 +1,489 @@ + + + + + + +public final class CsvFiles +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static List<String[]> |
+getCsvDataArray(Reader csvReader,
+ boolean headerPresent)
+Returns a
+List<String[]> that contains all rows of the CSV file. |
+
static List<String[]> |
+getCsvDataArray(String fileName,
+ boolean headerPresent)
+Returns a
+List<String[]> that contains all rows of the CSV file. |
+
static List<String> |
+getCsvDataByColumn(String fileName,
+ int column,
+ boolean headerPresent)
+Returns a
+List<String> representing a single 0-indexed column. |
+
static List<Map<String,String>> |
+getCsvDataListMap(String fileName,
+ boolean headerPresent)
+Returns a
+List<Map<String, String>> that contains all rows with
+ a field mapping defined by the header. |
+
static Map<String,String> |
+getCsvDataMap(String fileName,
+ boolean headerPresent)
+Returns a
+Map<String, String> mapping of the first column to the
+ second column. |
+
static Map<String,String> |
+getCsvDataMap(String fileName,
+ int key,
+ int value,
+ boolean headerPresent)
+Returns a
+Map<String, String> mapping of the column designated by
+ key to the column designated by value. |
+
static Map<String,String[]> |
+getCsvDataMapArray(String fileName,
+ boolean headerPresent)
+Returns a
+Map<String, String[]> mapping of the first column to an
+ array of the rest of the columns. |
+
static void |
+writeCsv(List<String[]> csvData,
+ String fileName)
+Writes the CSV data located in
+csvData to the file located at
+ fileName. |
+
public static Map<String,String> getCsvDataMap(String fileName, + int key, + int value, + boolean headerPresent) + throws IOException+
Map<String, String> mapping of the column designated by
+ key to the column designated by value. This method also
+ ignores all columns other than the columns specified by key and
+ value.fileName - the CSV file to loadkey - the 0-indexed column number to map to the key of the returned
+ data mapvalue - the column number to map to the value of the returned data
+ mapheaderPresent - true if the fist line is the headerMap<String, String> mapping of the columns specified by
+ key and valueIOException - if there was an error while reading the fileIllegalArgumentException - if CSV file does not have the
+ columns specified by key or valuepublic static Map<String,String> getCsvDataMap(String fileName, + boolean headerPresent) + throws IOException+
Map<String, String> mapping of the first column to the
+ second column. This method also ignores all columns other than the first
+ two.fileName - the CSV file to loadheaderPresent - true if the fist line is the headerMap<String, String> mapping of the first to the second
+ columnIOException - if there was an exception reading the fileIllegalArgumentException - if CSV file has fewer than two
+ columnspublic static Map<String,String[]> getCsvDataMapArray(String fileName, + boolean headerPresent) + throws IOException+
Map<String, String[]> mapping of the first column to an
+ array of the rest of the columns.fileName - the CSV file to loadheaderPresent - true if the fist line is the headerMap<String, String[]> mapping of the first column to an
+ array of the rest of the columnsIllegalArgumentException - if there is fewer than 2 columns in
+ the CSVIOException - if there was an exception reading the filepublic static List<Map<String,String>> getCsvDataListMap(String fileName, + boolean headerPresent) + throws IOException+
List<Map<String, String>> that contains all rows with
+ a field mapping defined by the header. If no header is present,
+ then each field is the 0-indexed column number.fileName - the CSV file to loadheaderPresent - true if the first line is the headerList<Map<String, String>> that contains all rows with
+ with a field mapping defined by the header if present.IOException - if there was an exception reading the filepublic static List<String> getCsvDataByColumn(String fileName, + int column, + boolean headerPresent) + throws IOException+
List<String> representing a single 0-indexed column.fileName - the CSV file to loadcolumn - the 0-indexed column to returnheaderPresent - true if the first line is the headerList<String> representing a single columnIOException - if there was an exception reading the fileIllegalArgumentException - if the column index does not exist in
+ the CSVpublic static List<String[]> getCsvDataArray(String fileName, + boolean headerPresent) + throws IOException+
List<String[]> that contains all rows of the CSV file.
+ The header will be removed, if present.fileName - the CSV file to loadheaderPresent - true if the first line is the headerList<String[]> that contains all rows of the CSV fileIOException - if there was an exception reading the filepublic static List<String[]> getCsvDataArray(Reader csvReader, + boolean headerPresent) + throws IOException+
List<String[]> that contains all rows of the CSV file.
+ The header will be removed, if present.csvReader - reader used to read the csvheaderPresent - true if the first line is the headerList<String[]> that contains all rows of the CSV fileIOException - if there was an exception reading the filepublic static void writeCsv(List<String[]> csvData, + String fileName) + throws IOException+
csvData to the file located at
+ fileName.csvData - the CSV data including the headerfileName - the file to write the CSV data toIOException - if there was an error writing to the fileNullPointerException - if csvData == null or fileName == nullCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/Internals.html b/5.3.0/com/google/api/ads/common/lib/utils/Internals.html new file mode 100644 index 0000000000..32b2a33d59 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/Internals.html @@ -0,0 +1,386 @@ + + + + + + +public class Internals +extends Object+
| Constructor and Description | +
|---|
Internals(AuthorizationHeaderProvider authorizationHeaderProvider,
+ UserAgentCombiner userAgentCombiner,
+ com.google.api.client.http.HttpTransport httpTransport,
+ AdsServiceLoggers adsServiceLoggers,
+ OAuth2Helper oAuth2Helper,
+ AdsUtilityRegistry adsUtilityRegistry,
+ XmlFieldExtractor xmlFieldExtractor)
+Constructor to be injected by guice.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
AdsServiceLoggers |
+getAdsServiceLoggers()
+Gets the loggers.
+ |
+
AdsUtilityRegistry |
+getAdsUtilityRegistry()
+Gets the ads utility registry.
+ |
+
AuthorizationHeaderProvider |
+getAuthorizationHeaderProvider()
+Obtains the Authorization header value.
+ |
+
com.google.api.client.http.HttpTransport |
+getHttpTransport()
+Returns an HttpTransport suitable for the java environment.
+ |
+
OAuth2Helper |
+getOAuth2Helper()
+Gets the OAuth2 helper.
+ |
+
UserAgentCombiner |
+getUserAgentCombiner()
+Creates a verbose User-Agent header.
+ |
+
XmlFieldExtractor |
+getXmlFieldExtractor() |
+
@Inject +public Internals(AuthorizationHeaderProvider authorizationHeaderProvider, + UserAgentCombiner userAgentCombiner, + com.google.api.client.http.HttpTransport httpTransport, + AdsServiceLoggers adsServiceLoggers, + OAuth2Helper oAuth2Helper, + AdsUtilityRegistry adsUtilityRegistry, + XmlFieldExtractor xmlFieldExtractor)+
public UserAgentCombiner getUserAgentCombiner()+
public AuthorizationHeaderProvider getAuthorizationHeaderProvider()+
public com.google.api.client.http.HttpTransport getHttpTransport()+
public AdsServiceLoggers getAdsServiceLoggers()+
public OAuth2Helper getOAuth2Helper()+
public AdsUtilityRegistry getAdsUtilityRegistry()+
public XmlFieldExtractor getXmlFieldExtractor()+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/IterableXPath.html b/5.3.0/com/google/api/ads/common/lib/utils/IterableXPath.html new file mode 100644 index 0000000000..741c982ca3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/IterableXPath.html @@ -0,0 +1,327 @@ + + + + + + +public class IterableXPath +extends Object +implements Iterable<String>+
For example, if xPath = "Header/Request/SomeValue", then iterators returned by iterator() will return "Header", "Request", and "SomeValue", in that
+ order.
| Constructor and Description | +
|---|
IterableXPath(String xPath) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getXPath() |
+
Iterator<String> |
+iterator()
+Returns an iterator over the elements of
+getXPath(). |
+
String |
+toString() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitforEach, spliteratorpublic String getXPath()+
public Iterator<String> iterator()+
getXPath(). If getXPath() is null or empty, the returned iterator will be empty.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/Maps.html b/5.3.0/com/google/api/ads/common/lib/utils/Maps.html new file mode 100644 index 0000000000..a6704ee06c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/Maps.html @@ -0,0 +1,373 @@ + + + + + + +public final class Maps +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static <K,V,T> T[] |
+toArray(Map<K,V> map,
+ T[] entryArray)
+Generates an array of entries from a map.
+ |
+
static <K,V,T> List<T> |
+toList(Map<K,V> map,
+ Class<T> entryClass)
+Generates a list of entries from a map.
+ |
+
static <K,V,T> Map<K,V> |
+toMap(List<T> entryList)
+Generates a map from a list of entries.
+ |
+
static <K,V,T> Map<K,V> |
+toMap(T[] entryArray)
+Generates a map from an array an entries.
+ |
+
public static <K,V,T> Map<K,V> toMap(List<T> entryList) + throws IllegalArgumentException+
key and value with a name
+ typically in the form of Key_ValueMapEntry, represented here as
+ T. The generated map must have same type K as the key within Key_ValueMapEntry. The same applies for V and
+ value within Key_ValueMapEntry.K - the type of the entry keyV - the type of the entry valueT - the map entry typeentryList - the list of entries constituting a map as represented in
+ the APIK and V representing the entry arrayIllegalArgumentException - if entryArray is not compatible
+ with Map<K, V> or if entryArray == nullpublic static <K,V,T> Map<K,V> toMap(T[] entryArray) + throws IllegalArgumentException+
key and value with a name
+ typically in the form of Key_ValueMapEntry, represented here as
+ T. The generated map must have same type K as the key within Key_ValueMapEntry. The same applies for V and
+ value within Key_ValueMapEntry. If
+ entryArray == null, an emtpy map is returned.K - the type of the entry keyV - the type of the entry valueT - the map entry typeentryArray - the array of entries constituting a map as represented in
+ the APIK and V representing the entry arrayIllegalArgumentException - if entryArray is not compatible
+ with Map<K, V>.public static <K,V,T> T[] toArray(Map<K,V> map, + T[] entryArray)+
key and value with a name
+ typically in the form of Key_ValueMapEntry, represented here as
+ T. The generated array can be used in objects where List<Key_ValueMapEntry> is taken as a value. The input map must have same type
+ K as the key within Key_ValueMapEntry. The same
+ applies for V and value within Key_ValueMapEntry.K - the type of the entry keyV - the type of the entry valueT - the map entry typemap - a map of type K and V representing the entry
+ arrayentryArray - the entry array that entries will be added intopublic static <K,V,T> List<T> toList(Map<K,V> map, + Class<T> entryClass)+
key and value with a name
+ typically in the form of Key_ValueMapEntry, represented here as
+ T. The generated array can be used in objects where List<Key_ValueMapEntry> is taken as a value. The input map must have same type
+ K as the key within Key_ValueMapEntry. The same
+ applies for V and value within Key_ValueMapEntry.K - the type of the entry keyV - the type of the entry valueT - the map entry typemap - a map of type K and V representing the entry
+ arrayentryClass - the entry class of type Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/Media.html b/5.3.0/com/google/api/ads/common/lib/utils/Media.html new file mode 100644 index 0000000000..d8e67359e7 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/Media.html @@ -0,0 +1,394 @@ + + + + + + +public final class Media +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static byte[] |
+getMediaDataFromFile(File file)
+Gets the media data
+byte[] located in file. |
+
static byte[] |
+getMediaDataFromFile(String fileName)
+Gets the media data
+byte[] located in fileName. |
+
static byte[] |
+getMediaDataFromUrl(String url)
+Gets the media data
+byte[] located at url or
+ null if the media could not be loaded. |
+
static byte[] |
+getMediaDataFromUrl(URL url)
+Gets the media data
+byte[] located at url or
+ null if the media could not be loaded. |
+
static void |
+saveMediaDataToFile(byte[] mediaData,
+ File file)
+Saves media data downloaded from an API in
+byte[] format into a
+ file on the file system. |
+
static void |
+saveMediaDataToFile(byte[] mediaData,
+ String fileName)
+Saves media data downloaded from an API in
+byte[] format into a
+ file on the file system. |
+
public static byte[] getMediaDataFromFile(String fileName) + throws IOException+
byte[] located in fileName.fileName - the media file to loadbyte[] located in fileNameIOException - if the media could not be readpublic static byte[] getMediaDataFromFile(File file) + throws IOException+
byte[] located in file.file - the media file to loadbyte[] located in fileIOException - if the media could not be readpublic static byte[] getMediaDataFromUrl(String url) + throws IOException+
byte[] located at url or
+ null if the media could not be loaded.url - the media URL to loadbyte[] located at urlIOException - if the media could not be read from the URLpublic static byte[] getMediaDataFromUrl(URL url) + throws IOException+
byte[] located at url or
+ null if the media could not be loaded.url - the media URL to loadbyte[] located at urlIOException - if the media could not be read from the URLpublic static void saveMediaDataToFile(byte[] mediaData, + String fileName) + throws FileNotFoundException, + IOException+
byte[] format into a
+ file on the file system.mediaData - the media data byte[] to store on the file systemfileName - the name of the file on the file system to save the media
+ data intoFileNotFoundException - if the file exists but is a directory, does
+ not exist but cannot be created, or cannot be opened for any reasonIOException - if the file cannot be written topublic static void saveMediaDataToFile(byte[] mediaData, + File file) + throws FileNotFoundException, + IOException+
byte[] format into a
+ file on the file system.mediaData - the media data byte[] to store on the file systemfile - the file on the file system to save the media data intoFileNotFoundException - if the file exists but is a directory, does
+ not exist but cannot be created, or cannot be opened for any reasonIOException - if the file cannot be written toCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/NodeExtractor.html b/5.3.0/com/google/api/ads/common/lib/utils/NodeExtractor.html new file mode 100644 index 0000000000..8c33c2cc18 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/NodeExtractor.html @@ -0,0 +1,317 @@ + + + + + + +public class NodeExtractor +extends Object+
Node from a parent node given a list of xpaths using DOM methods,
+ not XPathExpression objects.
+
+
+ This utility exists because the Node objects produced by Axis and JAX-WS do not seem to
+ be compatible with XPathExpression.
| Constructor and Description | +
|---|
NodeExtractor() |
+
| Modifier and Type | +Method and Description | +
|---|---|
Node |
+extractNode(Node parentNode,
+ Iterable<String> xPath)
+Extracts the node specified by the xpath list.
+ |
+
String |
+extractNodeValue(Node parentNode,
+ Iterable<String> xPath)
+Convenience method for getting the value of a node, handling the case where the node does not
+ exist.
+ |
+
public String extractNodeValue(@Nullable + Node parentNode, + Iterable<String> xPath)+
xPath if it exists, else null.public Node extractNode(@Nullable + Node parentNode, + Iterable<String> xPath)+
parentNode - the node to extract the child node from.xPath - xpath elements for local names that make up the child node's xpath.Node, or null if no such child node exists.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/Streams.html b/5.3.0/com/google/api/ads/common/lib/utils/Streams.html new file mode 100644 index 0000000000..1693bd25c7 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/Streams.html @@ -0,0 +1,429 @@ + + + + + + +public final class Streams +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+copy(InputStream inputStream,
+ OutputStream outputStream)
+Copies the
+inputStream into the outputSteam and finally
+ closes the both streams. |
+
static String |
+readAll(InputStream inputStream)
+Deprecated.
+
+it is always safer to supply a charset. See
+
+readAll(InputStream, Charset). |
+
static String |
+readAll(InputStream inputStream,
+ Charset charset)
+Reads all input into memory, close the steam, and return as a String.
+ |
+
static InputStream |
+wrapString(String str)
+Deprecated.
+
+it is always safer to supply a charset. See
+
+wrapString(String, Charset). |
+
static InputStream |
+wrapString(String str,
+ Charset charset)
+Wraps the provided string into an InputStream.
+ |
+
static void |
+write(String str,
+ OutputStream outputStream)
+Deprecated.
+
+it is always safer to supply a charset. See
+
+write(String, OutputStream, Charset). |
+
static void |
+write(String str,
+ OutputStream outputStream,
+ Charset charset)
+Writes the specified string to stream with buffering and closes the stream.
+ |
+
@Deprecated +public static InputStream wrapString(String str)+
wrapString(String, Charset).str - String to wrap.public static InputStream wrapString(String str, + Charset charset)+
str - String to wrap.charset - the chareset encoding of the string@Deprecated +public static String readAll(InputStream inputStream) + throws IOException+
readAll(InputStream, Charset).inputStream - InputStream to read from.IOException - if there is an problem reading from the stream.public static String readAll(InputStream inputStream, + Charset charset) + throws IOException+
inputStream - InputStream to read from.charset - the charset to interpret the input as.IOException - if there is an problem reading from the stream.@Deprecated +public static void write(String str, + OutputStream outputStream) + throws IOException+
write(String, OutputStream, Charset).str - String to write.outputStream - Stream to write to.IOException - If there is an exception while writing.public static void write(String str, + OutputStream outputStream, + Charset charset) + throws IOException+
str - String to write.outputStream - Stream to write to.charset - The charset to write in.IOException - If there is an exception while writing.public static void copy(InputStream inputStream, + OutputStream outputStream) + throws IOException+
inputStream into the outputSteam and finally
+ closes the both streams.IOExceptionCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/UsesAdsUtilities.html b/5.3.0/com/google/api/ads/common/lib/utils/UsesAdsUtilities.html new file mode 100644 index 0000000000..7f25ad2b09 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/UsesAdsUtilities.html @@ -0,0 +1,216 @@ + + + + + + +@Retention(value=RUNTIME) + @Target(value=METHOD) +public @interface UsesAdsUtilities+
AdsUtility.| Modifier and Type | +Required Element and Description | +
|---|---|
AdsUtility[] |
+value |
+
public abstract AdsUtility[] value+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/XmlFieldExtractor.html b/5.3.0/com/google/api/ads/common/lib/utils/XmlFieldExtractor.html new file mode 100644 index 0000000000..aed17c7860 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/XmlFieldExtractor.html @@ -0,0 +1,297 @@ + + + + + + +public class XmlFieldExtractor +extends Object+
| Constructor and Description | +
|---|
XmlFieldExtractor(org.slf4j.Logger soapXmlLogger,
+ com.google.common.base.Supplier<DocumentBuilder> documentBuilderSupplier,
+ com.google.common.base.Supplier<XPath> xpathSupplier) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Map<String,String> |
+extract(InputStream xml,
+ String[] fields)
+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.
+ |
+
@Inject +public XmlFieldExtractor(org.slf4j.Logger soapXmlLogger, + com.google.common.base.Supplier<DocumentBuilder> documentBuilderSupplier, + com.google.common.base.Supplier<XPath> xpathSupplier)+
public Map<String,String> extract(InputStream xml, + String[] fields)+
For example, for the xml: <xml><bar>BAR</bar></xml></code> and
+ field "bar", this class return a map with key "bar" and value "BAR".
xml - Stream of XML to process.fields - List of fields to look for.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/AdsUtility.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/AdsUtility.html new file mode 100644 index 0000000000..87a88f9f91 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/AdsUtility.html @@ -0,0 +1,205 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.utils | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static AdsUtility |
+AdsUtility.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AdsUtility[] |
+AdsUtility.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Set<AdsUtility> |
+AdsUtilityRegistry.popRegisteredUtilities()
+Returns all utilities in the registry and clears the registry.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AdsUtilityRegistry.addUtility(AdsUtility adsUtility)
+Adds the specified utility to the registry.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/AdsUtilityInvocationHandler.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/AdsUtilityInvocationHandler.html new file mode 100644 index 0000000000..3773686682 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/AdsUtilityInvocationHandler.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/AdsUtilityRegistry.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/AdsUtilityRegistry.html new file mode 100644 index 0000000000..4f607cc4c4 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/AdsUtilityRegistry.html @@ -0,0 +1,218 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.useragent | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Constructor and Description | +
|---|
AdsUtilitiesUserAgentProvider(AdsUtilityRegistry adsUtilityRegistry,
+ com.google.api.ads.common.lib.conf.AdsLibConfiguration adsLibConfiguration) |
+
| Modifier and Type | +Method and Description | +
|---|---|
AdsUtilityRegistry |
+Internals.getAdsUtilityRegistry()
+Gets the ads utility registry.
+ |
+
static AdsUtilityRegistry |
+AdsUtilityRegistry.getInstance()
+Returns the singleton of this class.
+ |
+
| Constructor and Description | +
|---|
AdsUtilityInvocationHandler(Object objectToProxy,
+ AdsUtilityRegistry adsUtilityRegistry) |
+
Internals(AuthorizationHeaderProvider authorizationHeaderProvider,
+ UserAgentCombiner userAgentCombiner,
+ com.google.api.client.http.HttpTransport httpTransport,
+ AdsServiceLoggers adsServiceLoggers,
+ OAuth2Helper oAuth2Helper,
+ AdsUtilityRegistry adsUtilityRegistry,
+ XmlFieldExtractor xmlFieldExtractor)
+Constructor to be injected by guice.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/Builder.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Builder.html new file mode 100644 index 0000000000..6c4ba81e60 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Builder.html @@ -0,0 +1,248 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+AdManagerSession.Builder
+Builder for
+AdManagerSession. |
+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder
+Builder for
+GoogleClientSecrets. |
+
static class |
+OfflineCredentials.ForApiBuilder
+Builder for OfflineCredentials.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Builder<T> |
+Builder.from(org.apache.commons.configuration.Configuration config)
+Populates this builder from the specified Configuration.
+ |
+
Builder<T> |
+Builder.fromFile()
+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
+ |
+
Builder<T> |
+Builder.fromFile(File path)
+Populates this builder from a properties file from a specified path.
+ |
+
Builder<T> |
+Builder.fromFile(String path)
+Populates this builder from a properties file from a specified path.
+ |
+
Builder<T> |
+Builder.fromFile(URL path)
+Populates this builder from a properties file from a specified path.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/CsvFiles.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/CsvFiles.html new file mode 100644 index 0000000000..9f20ab2051 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/CsvFiles.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/Internals.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Internals.html new file mode 100644 index 0000000000..dacba0c41c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Internals.html @@ -0,0 +1,213 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.utils | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Internals |
+AdManagerInternals.getInstance()
+Returns an
+Internals configured for Ad Manager. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Internals |
+OfflineCredentials.OAuthConfig.getInternals()
+Returns the internals object for the API that has the OAuth helper.
+ |
+
Internals |
+OfflineCredentials.Api.getInternals() |
+
Internals |
+OfflineCredentials.CustomOAuthConfig.getInternals() |
+
| Constructor and Description | +
|---|
CustomOAuthConfig(String propKeyPrefix,
+ String scope,
+ Internals internals) |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/IterableXPath.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/IterableXPath.html new file mode 100644 index 0000000000..24dbcf010b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/IterableXPath.html @@ -0,0 +1,178 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
IterableXPath |
+RequestInfoXPathSet.getContextXPath() |
+
IterableXPath |
+ResponseInfoXPathSet.getOperationsCountXPath() |
+
IterableXPath |
+ResponseInfoXPathSet.getRequestIdXPath() |
+
IterableXPath |
+ResponseInfoXPathSet.getResponseTimeXPath() |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/Maps.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Maps.html new file mode 100644 index 0000000000..b98a460960 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Maps.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/Media.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Media.html new file mode 100644 index 0000000000..3a19a3e1c2 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Media.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/NodeExtractor.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/NodeExtractor.html new file mode 100644 index 0000000000..cf3c1e09a7 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/NodeExtractor.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.soap | ++ |
| Constructor and Description | +
|---|
RequestInfoXPathSet(com.google.api.ads.common.lib.conf.AdsApiConfiguration apiConfig,
+ NodeExtractor nodeExtractor,
+ com.google.common.base.Supplier<Transformer> transformerSupplier,
+ org.slf4j.Logger libLogger) |
+
ResponseInfoXPathSet(com.google.api.ads.common.lib.conf.AdsApiConfiguration apiConfig,
+ NodeExtractor nodeExtractor) |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/Streams.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Streams.html new file mode 100644 index 0000000000..d188fecb63 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/Streams.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/UsesAdsUtilities.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/UsesAdsUtilities.html new file mode 100644 index 0000000000..94da15b7f8 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/UsesAdsUtilities.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/class-use/XmlFieldExtractor.html b/5.3.0/com/google/api/ads/common/lib/utils/class-use/XmlFieldExtractor.html new file mode 100644 index 0000000000..8112b039eb --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/class-use/XmlFieldExtractor.html @@ -0,0 +1,185 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.utils | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
XmlFieldExtractor |
+Internals.getXmlFieldExtractor() |
+
| Constructor and Description | +
|---|
Internals(AuthorizationHeaderProvider authorizationHeaderProvider,
+ UserAgentCombiner userAgentCombiner,
+ com.google.api.client.http.HttpTransport httpTransport,
+ AdsServiceLoggers adsServiceLoggers,
+ OAuth2Helper oAuth2Helper,
+ AdsUtilityRegistry adsUtilityRegistry,
+ XmlFieldExtractor xmlFieldExtractor)
+Constructor to be injected by guice.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/examples/CodeSampleParams.html b/5.3.0/com/google/api/ads/common/lib/utils/examples/CodeSampleParams.html new file mode 100644 index 0000000000..12c56d5c8f --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/examples/CodeSampleParams.html @@ -0,0 +1,310 @@ + + + + + + +public abstract class CodeSampleParams +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
protected boolean |
+help |
+
| Constructor and Description | +
|---|
CodeSampleParams() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+parseArguments(String[] args) |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/examples/class-use/CodeSampleParams.html b/5.3.0/com/google/api/ads/common/lib/utils/examples/class-use/CodeSampleParams.html new file mode 100644 index 0000000000..11cb5d47f6 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/examples/class-use/CodeSampleParams.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/examples/package-frame.html b/5.3.0/com/google/api/ads/common/lib/utils/examples/package-frame.html new file mode 100644 index 0000000000..75123c4740 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/examples/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| CodeSampleParams | +
+ A base class for all code examples to handle command line argument parsing and usage printing.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/examples/package-tree.html b/5.3.0/com/google/api/ads/common/lib/utils/examples/package-tree.html new file mode 100644 index 0000000000..0fd36ceaf7 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/examples/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/examples/package-use.html b/5.3.0/com/google/api/ads/common/lib/utils/examples/package-use.html new file mode 100644 index 0000000000..bc55d326f1 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/examples/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/AdsServiceLoggers.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/AdsServiceLoggers.html new file mode 100644 index 0000000000..4ae991179b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/AdsServiceLoggers.html @@ -0,0 +1,286 @@ + + + + + + +public class AdsServiceLoggers +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static org.slf4j.Logger |
+ADS_API_LIB_LOG
+The client library logger.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+logRequest(RemoteCallReturn remoteCallReturn)
+Logs basic information on a SOAP request.
+ |
+
public static final org.slf4j.Logger ADS_API_LIB_LOG+
public void logRequest(RemoteCallReturn remoteCallReturn)+
remoteCallReturn - information on the SOAP call to be loggedCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/LoggingModule.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/LoggingModule.html new file mode 100644 index 0000000000..395c4bd19b --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/LoggingModule.html @@ -0,0 +1,316 @@ + + + + + + +public class LoggingModule
+extends com.google.inject.AbstractModule
+| Constructor and Description | +
|---|
LoggingModule(String loggerPrefix)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+configure() |
+
protected void |
+configureLogger(String prefix,
+ String name) |
+
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/PrettyPrinter.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/PrettyPrinter.html new file mode 100644 index 0000000000..8744219cc9 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/PrettyPrinter.html @@ -0,0 +1,331 @@ + + + + + + +public final class PrettyPrinter +extends Object +implements PrettyPrinterInterface+
NO_OP_PRETTY_PRINTER| Constructor and Description | +
|---|
PrettyPrinter(com.google.api.ads.common.lib.conf.AdsApiConfiguration adsApiConfiguration,
+ org.slf4j.Logger libLogger,
+ com.google.common.base.Supplier<XPath> xpathSupplier,
+ com.google.common.base.Supplier<Transformer> transformerSupplier,
+ com.google.common.base.Supplier<DocumentBuilder> documentBuilderSupplier)
+Default constructor used by Guice.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+prettyPrint(String xml)
+Transforms XML into a pretty-printed format with sensitive strings removed.
+ |
+
@Inject +public PrettyPrinter(com.google.api.ads.common.lib.conf.AdsApiConfiguration adsApiConfiguration, + org.slf4j.Logger libLogger, + com.google.common.base.Supplier<XPath> xpathSupplier, + com.google.common.base.Supplier<Transformer> transformerSupplier, + com.google.common.base.Supplier<DocumentBuilder> documentBuilderSupplier)+
Supplier instances for XPath,
+ Transformer, and DocumentBuilder because the corresponding factory objects are
+ not thread-safe. The Guice modules creating these suppliers should guarantee that the
+ Supplier is thread-safe, however.adsApiConfiguration - the API configurationlibLogger - the logger to use for errorsxpathSupplier - a thread-safe supplier of XPath objectstransformerSupplier - a thread-safe supplier of Transformer objectsdocumentBuilderSupplier - a thread-safe supplier of DocumentBuilder objectspublic String prettyPrint(String xml)+
prettyPrint in interface PrettyPrinterInterfacexml - the XML message to be pretty printedCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/PrettyPrinterInterface.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/PrettyPrinterInterface.html new file mode 100644 index 0000000000..fa932179c4 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/PrettyPrinterInterface.html @@ -0,0 +1,281 @@ + + + + + + +public interface PrettyPrinterInterface
+| Modifier and Type | +Field and Description | +
|---|---|
static PrettyPrinterInterface |
+NO_OP_PRETTY_PRINTER
+Default implementation that simply returns the message.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+prettyPrint(String message)
+Transforms the message into a pretty-printed format.
+ |
+
static final PrettyPrinterInterface NO_OP_PRETTY_PRINTER+
String prettyPrint(String message)+
REDACTED.
+ message - the message to be pretty printedCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/RemoteCallLoggerDelegate.RemoteCallType.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/RemoteCallLoggerDelegate.RemoteCallType.html new file mode 100644 index 0000000000..e73a56a726 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/RemoteCallLoggerDelegate.RemoteCallType.html @@ -0,0 +1,348 @@ + + + + + + +public static enum RemoteCallLoggerDelegate.RemoteCallType +extends Enum<RemoteCallLoggerDelegate.RemoteCallType>+
| Enum Constant and Description | +
|---|
HTTP |
+
SOAP |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RemoteCallLoggerDelegate.RemoteCallType |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static RemoteCallLoggerDelegate.RemoteCallType[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final RemoteCallLoggerDelegate.RemoteCallType SOAP+
public static final RemoteCallLoggerDelegate.RemoteCallType HTTP+
public static RemoteCallLoggerDelegate.RemoteCallType[] values()+
+for (RemoteCallLoggerDelegate.RemoteCallType c : RemoteCallLoggerDelegate.RemoteCallType.values()) + System.out.println(c); +
public static RemoteCallLoggerDelegate.RemoteCallType valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/RemoteCallLoggerDelegate.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/RemoteCallLoggerDelegate.html new file mode 100644 index 0000000000..24a3c732a1 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/RemoteCallLoggerDelegate.html @@ -0,0 +1,347 @@ + + + + + + +public class RemoteCallLoggerDelegate +extends Object+
RemoteCallReturn objects.| Modifier and Type | +Class and Description | +
|---|---|
static class |
+RemoteCallLoggerDelegate.RemoteCallType
+Type of the request or response.
+ |
+
| Constructor and Description | +
|---|
RemoteCallLoggerDelegate(org.slf4j.Logger summaryLogger,
+ org.slf4j.Logger detailLogger,
+ PrettyPrinterInterface prettyPrinter,
+ RemoteCallLoggerDelegate.RemoteCallType remoteCallType) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+isDetailsLoggable(boolean isSuccess)
+Returns true if the log level for request details and the specified result is enabled.
+ |
+
boolean |
+isSummaryLoggable(boolean isSuccess)
+Returns true if the log level for request summaries and the specified result is enabled.
+ |
+
void |
+logRequestDetails(RemoteCallReturn remoteCallReturn) |
+
void |
+logRequestSummary(RemoteCallReturn remoteCallReturn) |
+
public RemoteCallLoggerDelegate(org.slf4j.Logger summaryLogger, + org.slf4j.Logger detailLogger, + @Nullable + PrettyPrinterInterface prettyPrinter, + RemoteCallLoggerDelegate.RemoteCallType remoteCallType)+
public boolean isSummaryLoggable(boolean isSuccess)+
public boolean isDetailsLoggable(boolean isSuccess)+
public void logRequestDetails(RemoteCallReturn remoteCallReturn)+
public void logRequestSummary(RemoteCallReturn remoteCallReturn)+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/AdsServiceLoggers.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/AdsServiceLoggers.html new file mode 100644 index 0000000000..f31cecb6e8 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/AdsServiceLoggers.html @@ -0,0 +1,241 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Constructor and Description | +
|---|
AdManagerServiceClient(Object soapClient,
+ AdManagerServiceDescriptor adManagerServiceDescriptor,
+ AdManagerSession adManagerSession,
+ SoapClientHandlerInterface soapClientHandler,
+ HeaderHandler<AdManagerSession,AdManagerServiceDescriptor> adManagerHeaderHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Constructor and Description | +
|---|
AdsServiceClient(Object soapClient,
+ S adsSession,
+ D adsServiceDescriptor,
+ SoapClientHandlerInterface<Object> soapClientHandler,
+ HeaderHandler<S,D> headerHandler,
+ AdsServiceLoggers adsServiceLoggers)
+Constructor.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
AdsServiceLoggers |
+Internals.getAdsServiceLoggers()
+Gets the loggers.
+ |
+
| Constructor and Description | +
|---|
Internals(AuthorizationHeaderProvider authorizationHeaderProvider,
+ UserAgentCombiner userAgentCombiner,
+ com.google.api.client.http.HttpTransport httpTransport,
+ AdsServiceLoggers adsServiceLoggers,
+ OAuth2Helper oAuth2Helper,
+ AdsUtilityRegistry adsUtilityRegistry,
+ XmlFieldExtractor xmlFieldExtractor)
+Constructor to be injected by guice.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/LoggingModule.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/LoggingModule.html new file mode 100644 index 0000000000..0b3b683205 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/LoggingModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/PrettyPrinter.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/PrettyPrinter.html new file mode 100644 index 0000000000..7571b689dc --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/PrettyPrinter.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/PrettyPrinterInterface.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/PrettyPrinterInterface.html new file mode 100644 index 0000000000..d6600c06fa --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/PrettyPrinterInterface.html @@ -0,0 +1,197 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.utils.logging | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PrettyPrinter
+A utility class that pretty prints XML messages.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static PrettyPrinterInterface |
+PrettyPrinterInterface.NO_OP_PRETTY_PRINTER
+Default implementation that simply returns the message.
+ |
+
| Constructor and Description | +
|---|
RemoteCallLoggerDelegate(org.slf4j.Logger summaryLogger,
+ org.slf4j.Logger detailLogger,
+ PrettyPrinterInterface prettyPrinter,
+ RemoteCallLoggerDelegate.RemoteCallType remoteCallType) |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/RemoteCallLoggerDelegate.RemoteCallType.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/RemoteCallLoggerDelegate.RemoteCallType.html new file mode 100644 index 0000000000..7c15f9b6f3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/RemoteCallLoggerDelegate.RemoteCallType.html @@ -0,0 +1,189 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib.utils.logging | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static RemoteCallLoggerDelegate.RemoteCallType |
+RemoteCallLoggerDelegate.RemoteCallType.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static RemoteCallLoggerDelegate.RemoteCallType[] |
+RemoteCallLoggerDelegate.RemoteCallType.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Constructor and Description | +
|---|
RemoteCallLoggerDelegate(org.slf4j.Logger summaryLogger,
+ org.slf4j.Logger detailLogger,
+ PrettyPrinterInterface prettyPrinter,
+ RemoteCallLoggerDelegate.RemoteCallType remoteCallType) |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/RemoteCallLoggerDelegate.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/RemoteCallLoggerDelegate.html new file mode 100644 index 0000000000..380230c83c --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/class-use/RemoteCallLoggerDelegate.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/package-frame.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/package-frame.html new file mode 100644 index 0000000000..b2d3d5cd06 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +| Interface | +Description | +
|---|---|
| PrettyPrinterInterface | +
+ Interface capable of pretty printing messages (e.g., XML).
+ |
+
| Class | +Description | +
|---|---|
| AdsServiceLoggers | +
+ Allows logging of outgoing and incoming SOAP XML messages as API calls are executed.
+ |
+
| LoggingModule | +
+ Module for logging.
+ |
+
| PrettyPrinter | +
+ A utility class that pretty prints XML messages.
+ |
+
| RemoteCallLoggerDelegate | +
+ Delegate for logging
+RemoteCallReturn objects. |
+
| Enum | +Description | +
|---|---|
| RemoteCallLoggerDelegate.RemoteCallType | +
+ Type of the request or response.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/package-tree.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/package-tree.html new file mode 100644 index 0000000000..60d68d20d3 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/package-tree.html @@ -0,0 +1,162 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/logging/package-use.html b/5.3.0/com/google/api/ads/common/lib/utils/logging/package-use.html new file mode 100644 index 0000000000..bee709bef5 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/logging/package-use.html @@ -0,0 +1,229 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| com.google.api.ads.common.lib.utils.logging | ++ |
| Class and Description | +
|---|
| AdsServiceLoggers
+ Allows logging of outgoing and incoming SOAP XML messages as API calls are executed.
+ |
+
| Class and Description | +
|---|
| AdsServiceLoggers
+ Allows logging of outgoing and incoming SOAP XML messages as API calls are executed.
+ |
+
| Class and Description | +
|---|
| AdsServiceLoggers
+ Allows logging of outgoing and incoming SOAP XML messages as API calls are executed.
+ |
+
| Class and Description | +
|---|
| PrettyPrinterInterface
+ Interface capable of pretty printing messages (e.g., XML).
+ |
+
| RemoteCallLoggerDelegate.RemoteCallType
+ Type of the request or response.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/package-frame.html b/5.3.0/com/google/api/ads/common/lib/utils/package-frame.html new file mode 100644 index 0000000000..6fd8fdf947 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/package-frame.html @@ -0,0 +1,42 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Builder<T> | +
+ Builder interface.
+ |
+
| Class | +Description | +
|---|---|
| AdsUtilityInvocationHandler | +
+InvocationHandler that updates the AdsUtilityRegistry when a method call on the
+ proxied interface is annotated with UsesAdsUtilities. |
+
| AdsUtilityRegistry | +
+ A thread-safe registry for usage of
+ads utilities. |
+
| CsvFiles | +
+ A utility class for processing and handling CSV files.
+ |
+
| Internals | +
+ Provides access to internal utilities.
+ |
+
| IterableXPath | +
+ Wrapper around an XPath string that allows for iteration over the elements of the XPath.
+ |
+
| Maps | +
+ A utility class for managing maps as represented in the API.
+ |
+
| Media | +
+ A utility class for retrieving media data.
+ |
+
| NodeExtractor | +
+ Utility that extracts a
+Node from a parent node given a list of xpaths using DOM methods,
+ not XPathExpression objects. |
+
| Streams | +
+ Helper class to perform stream operations.
+ |
+
| XmlFieldExtractor | +
+ Utility class to extract fields from XML.
+ |
+
| Enum | +Description | +
|---|---|
| AdsUtility | +
+ Enumeration of utilities available in the client library.
+ |
+
| Annotation Type | +Description | +
|---|---|
| UsesAdsUtilities | +
+ Annotation for methods that represent the usage of an
+AdsUtility. |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/package-tree.html b/5.3.0/com/google/api/ads/common/lib/utils/package-tree.html new file mode 100644 index 0000000000..b232f6a196 --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/package-tree.html @@ -0,0 +1,172 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/com/google/api/ads/common/lib/utils/package-use.html b/5.3.0/com/google/api/ads/common/lib/utils/package-use.html new file mode 100644 index 0000000000..8b122aa7bb --- /dev/null +++ b/5.3.0/com/google/api/ads/common/lib/utils/package-use.html @@ -0,0 +1,292 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.google.api.ads.admanager.lib.client | ++ |
| com.google.api.ads.admanager.lib.utils | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.useragent | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| Class and Description | +
|---|
| Builder
+ Builder interface.
+ |
+
| Class and Description | +
|---|
| Internals
+ Provides access to internal utilities.
+ |
+
| Class and Description | +
|---|
| Builder
+ Builder interface.
+ |
+
| Internals
+ Provides access to internal utilities.
+ |
+
| Class and Description | +
|---|
| IterableXPath
+ Wrapper around an XPath string that allows for iteration over the elements of the XPath.
+ |
+
| NodeExtractor
+ Utility that extracts a
+Node from a parent node given a list of xpaths using DOM methods,
+ not XPathExpression objects. |
+
| Class and Description | +
|---|
| AdsUtilityRegistry
+ A thread-safe registry for usage of
+ads utilities. |
+
| Class and Description | +
|---|
| AdsUtility
+ Enumeration of utilities available in the client library.
+ |
+
| AdsUtilityRegistry
+ A thread-safe registry for usage of
+ads utilities. |
+
| Builder
+ Builder interface.
+ |
+
| XmlFieldExtractor
+ Utility class to extract fields from XML.
+ |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/constant-values.html b/5.3.0/constant-values.html new file mode 100644 index 0000000000..6cc5e28a9e --- /dev/null +++ b/5.3.0/constant-values.html @@ -0,0 +1,1077 @@ + + + + + + +| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SLEEP_TIMER |
+30000 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SUGGESTED_PAGE_LIMIT |
+500 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SLEEP_TIMER |
+30000 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SUGGESTED_PAGE_LIMIT |
+500 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SLEEP_TIMER |
+30000 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SUGGESTED_PAGE_LIMIT |
+500 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SLEEP_TIMER |
+30000 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SUGGESTED_PAGE_LIMIT |
+500 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SLEEP_TIMER |
+30000 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SUGGESTED_PAGE_LIMIT |
+500 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SLEEP_TIMER |
+30000 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SUGGESTED_PAGE_LIMIT |
+500 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SLEEP_TIMER |
+30000 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SUGGESTED_PAGE_LIMIT |
+500 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SLEEP_TIMER |
+30000 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+SUGGESTED_PAGE_LIMIT |
+500 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+DEFAULT_ENDPOINT |
+"https://ads.google.com/" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+protected static final String |
+FROM |
+"FROM" |
+
+
+protected static final String |
+LIMIT |
+"LIMIT" |
+
+
+protected static final String |
+OFFSET |
+"OFFSET" |
+
+
+protected static final String |
+ORDER_BY |
+"ORDER BY" |
+
+
+protected static final String |
+SELECT |
+"SELECT" |
+
+
+protected static final String |
+WHERE |
+"WHERE" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+ACTIVITY_GROUP_ID |
+"--activityGroupId" |
+
+
+public static final String |
+ACTIVITY_ID |
+"--activityId" |
+
+
+public static final String |
+AD_UNIT_ID |
+"--adUnitId" |
+
+
+public static final String |
+ADJUSTMENT_ID |
+"--adjustmentId" |
+
+
+public static final String |
+ADVERTISER_COMPANY_ID |
+"--advertiserCompanyId" |
+
+
+public static final String |
+ADVERTISER_ID |
+"--advertiserId" |
+
+
+public static final String |
+AGENCY_ID |
+"--agencyId" |
+
+
+public static final String |
+AUDIENCE_SEGMENT_ID |
+"--audienceSegmentId" |
+
+
+public static final String |
+BASE_RATE_ID |
+"--baseRateId" |
+
+
+public static final String |
+BUYER_ID |
+"--buyerId" |
+
+
+public static final String |
+CHILD_NETWORK_CODE |
+"--childNetworkCode" |
+
+
+public static final String |
+CMS_METADATA_KEY_ID |
+"--cmsMetadataKeyId" |
+
+
+public static final String |
+CMS_METADATA_KEY_NAME |
+"--cmsMetadataKeyName" |
+
+
+public static final String |
+CMS_METADATA_VALUE_ID |
+"--cmsMetadataValueId" |
+
+
+public static final String |
+COMPANION_CREATIVE_ID |
+"--companionCreativeId" |
+
+
+public static final String |
+COMPANY_ID |
+"--companyId" |
+
+
+public static final String |
+CONTACT_ID |
+"--contactId" |
+
+
+public static final String |
+CONTENT_BUNDLE_ID |
+"--contentBundleId" |
+
+
+public static final String |
+CONTENT_ID |
+"--contentId" |
+
+
+public static final String |
+CREATIVE_ID |
+"--creativeId" |
+
+
+public static final String |
+CREATIVE_SET_ID |
+"--creativeSetId" |
+
+
+public static final String |
+CREATIVE_WRAPPER_ID |
+"--creativeWrapperId" |
+
+
+public static final String |
+CURRENCY_CODE |
+"--currencyCode" |
+
+
+public static final String |
+CUSTOM_DIMENSION_KEY_ID |
+"--customDimensionKeyId" |
+
+
+public static final String |
+CUSTOM_FIELD_ID |
+"--customFieldId" |
+
+
+public static final String |
+EMAIL_ADDRESS |
+"--emailAddress" |
+
+
+public static final String |
+EXCHANGE_RATE_ID |
+"--exchangeRateId" |
+
+
+public static final String |
+FIELD_OPTION_ID |
+"--fieldOptionId" |
+
+
+public static final String |
+HIERARCHY_LEVEL_ONE_KEY_ID |
+"--hierarchyLevelOneKeyId" |
+
+
+public static final String |
+HIERARCHY_LEVEL_TWO_KEY_ID |
+"--hierarchyLevelTwoKeyId" |
+
+
+public static final String |
+LABEL_ID |
+"--labelId" |
+
+
+public static final String |
+LINE_ITEM_ID |
+"--lineItemId" |
+
+
+public static final String |
+LINKED_DEVICE_ID |
+"--linkedDeviceId" |
+
+
+public static final String |
+MASTER_CREATIVE_ID |
+"--masterCreativeId" |
+
+
+public static final String |
+NAME |
+"--name" |
+
+
+public static final String |
+NUM_REQUESTS |
+"--numRequests" |
+
+
+public static final String |
+NUMBER_CUSTOM_FIELD_ID |
+"--numberCustomFieldId" |
+
+
+public static final String |
+ORDER_ID |
+"--orderId" |
+
+
+public static final String |
+PACKAGE_ID |
+"--packageId" |
+
+
+public static final String |
+PARENT_AD_UNIT_ID |
+"--parentAdUnitId" |
+
+
+public static final String |
+PLACEMENT_ID |
+"--placementId" |
+
+
+public static final String |
+PREMIUM_RATE_ID |
+"--premiumRateId" |
+
+
+public static final String |
+PRIMARY_SALESPERSON_ID |
+"--primarySalespersonId" |
+
+
+public static final String |
+PRIMARY_TRAFFICKER_ID |
+"--primaryTraffickerId" |
+
+
+public static final String |
+PRODUCT_ID |
+"--productId" |
+
+
+public static final String |
+PRODUCT_PACKAGE_ID |
+"--productPackageId" |
+
+
+public static final String |
+PRODUCT_PACKAGE_ITEM_ID |
+"--productPackageItemId" |
+
+
+public static final String |
+PRODUCT_TEMPLATE_ID |
+"--productTemplateId" |
+
+
+public static final String |
+PROGRAMMATIC_BUYER_ID |
+"--programmaticBuyerId" |
+
+
+public static final String |
+PROPOSAL_ID |
+"--proposalId" |
+
+
+public static final String |
+PROPOSAL_LINE_ITEM_ID |
+"--proposalLineItemId" |
+
+
+public static final String |
+RATE_CARD_ID |
+"--rateCardId" |
+
+
+public static final String |
+RECONCILIATION_LINE_ITEM_REPORT_ID |
+"--reconciliationLineItemReportId" |
+
+
+public static final String |
+RECONCILIATION_ORDER_REPORT_ID |
+"--reconciliationOrderReportId" |
+
+
+public static final String |
+RECONCILIATION_REPORT_ID |
+"--reconciliationReportId" |
+
+
+public static final String |
+RECONCILIATION_REPORT_ROW_ID |
+"--reconciliationReportRowId" |
+
+
+public static final String |
+SAVED_QUERY_ID |
+"--savedQueryId" |
+
+
+public static final String |
+SECONDARY_SALESPERSON_ID |
+"--secondarySalespersonId" |
+
+
+public static final String |
+SITE_ID |
+"--siteId" |
+
+
+public static final String |
+TARGETED_VIDEO_AD_UNIT_ID |
+"--targetedVideoAdUnitId" |
+
+
+public static final String |
+TARGETING_KEY_ID |
+"--targetingKeyId" |
+
+
+public static final String |
+TARGETING_KEY_ID_1 |
+"--targetingKeyId1" |
+
+
+public static final String |
+TARGETING_KEY_ID_2 |
+"--targetingKeyId2" |
+
+
+public static final String |
+TARGETING_KEY_ID_3 |
+"--targetingKeyId3" |
+
+
+public static final String |
+TARGETING_VALUE_ID |
+"--targetingValueId" |
+
+
+public static final String |
+TARGETING_VALUE_ID_1 |
+"--targetingValueId1" |
+
+
+public static final String |
+TARGETING_VALUE_ID_3 |
+"--targetingValueId3" |
+
+
+public static final String |
+TARGETING_VALUE_IDS_2 |
+"--targetingValueId2" |
+
+
+public static final String |
+TEAM_ID |
+"--teamId" |
+
+
+public static final String |
+TRAFFIC_FORECAST_SEGMENT_ID |
+"--trafficForecastSegmentId" |
+
+
+public static final String |
+TRAFFICKER_ID |
+"--traffickerId" |
+
+
+public static final String |
+URL |
+"--url" |
+
+
+public static final String |
+USER_ID |
+"--userId" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+DEFAULT_CONFIGURATION_FILENAME |
+"ads.properties" |
+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/deprecated-list.html b/5.3.0/deprecated-list.html new file mode 100644 index 0000000000..60ba83587f --- /dev/null +++ b/5.3.0/deprecated-list.html @@ -0,0 +1,184 @@ + + + + + + +| Method and Description | +
|---|
| com.google.api.ads.common.lib.utils.Streams.readAll(InputStream)
+ it is always safer to supply a charset. See
+
+Streams.readAll(InputStream, Charset). |
+
| com.google.api.ads.common.lib.utils.Streams.wrapString(String)
+ it is always safer to supply a charset. See
+
+Streams.wrapString(String, Charset). |
+
| com.google.api.ads.common.lib.utils.Streams.write(String, OutputStream)
+ it is always safer to supply a charset. See
+
+Streams.write(String, OutputStream, Charset). |
+
| Constructor and Description | +
|---|
| com.google.api.ads.admanager.lib.factory.AdManagerServiceClientFactory(AbstractModule) + + | +
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/help-doc.html b/5.3.0/help-doc.html new file mode 100644 index 0000000000..0903cb1e1d --- /dev/null +++ b/5.3.0/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/index-all.html b/5.3.0/index-all.html new file mode 100644 index 0000000000..e178386ca4 --- /dev/null +++ b/5.3.0/index-all.html @@ -0,0 +1,4082 @@ + + + + + + +HeaderHandler.HeaderHandler for JAX-WS.AdManagerServiceDescriptor provides a class which defines a service that can be
+ instantiated through reflection.AdManagerSession represents a single session of Ad Manager use.AdManagerSession.InvocationHandler that updates the AdsUtilityRegistry when a method call on the
+ proxied interface is annotated with UsesAdsUtilities.ads utilities.Authorization headers that can be set on the SOAP
+ client.AdsSession.AdsServiceClient to be Axis compatible, it
+ must be able to retrieve a locator class.AdsServiceClientFactoryHelper.AdManagerSession.AdManagerSession.ImmutableAdManagerSession.SoapServiceClient.invoke(Object, Method, Object[]) if the method is
+ intended for the SOAP client.inputStream into the outputSteam and finally
+ closes the both streams.AdsServiceClient given a SOAP client and an
+ AdsServiceDescriptor descriptor.AdsServiceClient for the descriptor, session, and
+ endpoint.AdsServiceDescriptor for a specified service.AdsServiceDescriptor for a specified service.soapServiceDescriptor.Value from the value i.e.Value from the value i.e.Value from the value i.e.Value from the value i.e.Value from the value i.e.Value from the value i.e.Value from the value i.e.Value from the value i.e.DateTime objects.DateTime objects.DateTime objects.DateTime objects.DateTime objects.DateTime objects.DateTime objects.DateTime objects.DateTime objects.Builder.fromFile() is called.UserAgentProvider for extension frameworks to decorate the user agent with additional
+ information.AdsServiceClient.AdsServiceDescriptor.GoogleClientSecretsBuilder.Api should this GoogleClientSecrets be
+ generated for.OfflineCredentials.OAuthConfig should this OfflineCredentials be
+ used for.Configuration object.Configuration object api.adwords.clientIdConfiguration object
+ api.admanager.refreshTokenValue object that's comparable to what would be
+ returned in any other API object (i.e.Value object that's comparable to what would be
+ returned in any other API object (i.e.Value object that's comparable to what would be
+ returned in any other API object (i.e.Value object that's comparable to what would be
+ returned in any other API object (i.e.Value object that's comparable to what would be
+ returned in any other API object (i.e.Value object that's comparable to what would be
+ returned in any other API object (i.e.Value object that's comparable to what would be
+ returned in any other API object (i.e.Value object that's comparable to what would be
+ returned in any other API object (i.e.Authorization HTTP
+ header.Credential.Credential.RequestInfo.getContextValue().List<String[]> that contains all rows of the CSV file.List<String[]> that contains all rows of the CSV file.List<String> representing a single 0-indexed column.List<Map<String, String>> that contains all rows with
+ a field mapping defined by the header.Map<String, String> mapping of the column designated by
+ key to the column designated by value.Map<String, String> mapping of the first column to the
+ second column.Map<String, String[]> mapping of the first column to an
+ array of the rest of the columns.Value object that should be used for CSV conversion
+ (i.e.Value object that should be used for CSV conversion
+ (i.e.Value object that should be used for CSV conversion
+ (i.e.Value object that should be used for CSV conversion
+ (i.e.Value object that should be used for CSV conversion
+ (i.e.Value object that should be used for CSV conversion
+ (i.e.Value object that should be used for CSV conversion
+ (i.e.Value object that should be used for CSV conversion
+ (i.e.HttpTransport that will be used when
+ generating a Credential.Internals configured for Ad Manager.Credential.byte[] located in fileName.byte[] located in file.byte[] located at url or
+ null if the media could not be loaded.byte[] located at url or
+ null if the media could not be loaded.Value object that's considered native to Java (i.e.Value object that's considered native to Java (i.e.Value object that's considered native to Java (i.e.Value object that's considered native to Java (i.e.Value object that's considered native to Java (i.e.Value object that's considered native to Java (i.e.Value object that's considered native to Java (i.e.Value object that's considered native to Java (i.e.Credential.ReportDownloadOptions.ReportDownloadOptions.ReportDownloadOptions.ReportDownloadOptions.ReportDownloadOptions.ReportDownloadOptions.ReportDownloadOptions.ReportDownloadOptions."(UserAgent1,UserAgent2,UserAgent3,...)"GoogleClientSecrets.GoogleClientSecrets.amount.amount.SoapCall object and invokes the method by reflection.SoapCall, which has a reference to a
+ SoapClientHandlerInterface.IterableXPath.getXPath().AdsServiceClient to be JAX-WS compatible, it
+ must be able to retrieve a service class."LIMIT <count>" "LIMIT <count>"
+ AdManagerSession.Builder with all settings copied from this session.Node from a parent node given a list of xpaths using DOM methods,
+ not XPathExpression objects."OFFSET <count>" "OFFSET <count>"
+ "ORDER BY <property> [ASC | DESC]" "ORDER BY <property> [ASC | DESC]"
+ QueryBuilder allows for queries to be constructed in parts.QueryBuilderInterface allows for queries to be constructed in parts.Streams.readAll(InputStream, Charset).RemoteCallReturn objects.RemoteCallReturn objects.ReportCallback is called on the completion of asynchronous report
+ downloads.ReportServiceInterface.ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.ReportServiceInterface.ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.ReportServiceInterface.ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.ReportServiceInterface.ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.ReportServiceInterface.ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.ReportServiceInterface.ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.ReportServiceInterface.ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.ReportServiceInterface.ReportDownloader object for a ReportServiceInterface and a report
+ job id that the class works on.RequestInfo objects.ResponseInfo objects.CsvFiles such asCsvFiles such asCsvFiles such asCsvFiles such asCsvFiles such asCsvFiles such asCsvFiles such asCsvFiles such asbyte[] format into a
+ file on the file system.byte[] format into a
+ file on the file system.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.StatementBuilder allows for statements to be constructed in parts.StatementBuilder allows for statements to be constructed in parts.StatementBuilder allows for statements to be constructed in parts.StatementBuilder allows for statements to be constructed in parts.StatementBuilder allows for statements to be constructed in parts.StatementBuilder allows for statements to be constructed in parts.StatementBuilder allows for statements to be constructed in parts.StatementBuilder allows for statements to be constructed in parts.DateTime using the default locale, i.e.DateTime in the supplied locale.DateTime using the default locale, i.e.DateTime in the supplied locale.DateTime using the default locale, i.e.DateTime in the supplied locale.DateTime using the default locale, i.e.DateTime in the supplied locale.DateTime using the default locale, i.e.DateTime in the supplied locale.DateTime using the default locale, i.e.DateTime in the supplied locale.DateTime using the default locale, i.e.DateTime in the supplied locale.DateTime using the default locale, i.e.DateTime in the supplied locale.DateTime using the default locale, i.e.DateTime in the supplied locale.Calendar object to an API date time preserving the time zone.Instant object to an API date time in the time zone supplied.DateTime object to an API date time preserving the time zone.yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.DateTime preserving the time zone.Calendar object to an API date time preserving the time zone.Instant object to an API date time in the time zone supplied.DateTime object to an API date time preserving the time zone.yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.DateTime preserving the time zone.Calendar object to an API date time preserving the time zone.Instant object to an API date time in the time zone supplied.DateTime object to an API date time preserving the time zone.yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.DateTime preserving the time zone.Calendar object to an API date time preserving the time zone.Instant object to an API date time in the time zone supplied.DateTime object to an API date time preserving the time zone.yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.DateTime preserving the time zone.Calendar object to an API date time preserving the time zone.Instant object to an API date time in the time zone supplied.DateTime object to an API date time preserving the time zone.yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.DateTime preserving the time zone.Calendar object to an API date time preserving the time zone.Instant object to an API date time in the time zone supplied.DateTime object to an API date time preserving the time zone.yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.DateTime preserving the time zone.Calendar object to an API date time preserving the time zone.Instant object to an API date time in the time zone supplied.DateTime object to an API date time preserving the time zone.yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.DateTime preserving the time zone.Calendar object to an API date time preserving the time zone.Instant object to an API date time in the time zone supplied.DateTime object to an API date time preserving the time zone.yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.DateTime preserving the time zone.Calendar object to an API date time preserving the time zone.Instant object to an API date time in the time zone supplied.DateTime object to an API date time preserving the time zone.yyyy-MM-dd'T'HH:mm:ss to an API date time in the time
+ zone supplied.DateTime preserving the time zone.yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.yyyy-MM-dd'T'HH:mm:ss±HH:mm, or yyyy-MM-dd'T'HH:mm:ssZ for Etc/GMT, to an API date time in the time zone supplied.yyyy-MM-dd'T'HH:mm:ss±HH:mm to an API date time in the
+ time zone supplied.Statement representing the state of this statement builder.Statement representing the state of this statement builder.Statement representing the state of this statement builder.Statement representing the state of this statement builder.Statement representing the state of this statement builder.Statement representing the state of this statement builder.Statement representing the state of this statement builder.Statement representing the state of this statement builder.AdsUtility.ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ ReportCallback.onSuccess() for a successful scheduling
+ ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
+ ReportCallback.onInterruption() if the wait thread is interrupted
+ ReportCallback.onException(Exception) if there was an exception while waiting for
+ the report to finish
+ "WHERE <condition> {[AND | OR] <condition> ...}" "WHERE <condition> {[AND | OR] <condition> ...}"
+ Value.HttpTransport to be used to make the request.Streams.wrapString(String, Charset).Streams.write(String, OutputStream, Charset).csvData to the file located at
+ fileName.Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/index.html b/5.3.0/index.html new file mode 100644 index 0000000000..9740a43af9 --- /dev/null +++ b/5.3.0/index.html @@ -0,0 +1,76 @@ + + + + + + ++ + diff --git a/5.3.0/overview-summary.html b/5.3.0/overview-summary.html new file mode 100644 index 0000000000..eeba43f3ca --- /dev/null +++ b/5.3.0/overview-summary.html @@ -0,0 +1,283 @@ + + + + + + +
| Package | +Description | +
|---|---|
| com.google.api.ads.common.lib | ++ |
| com.google.api.ads.common.lib.auth | ++ |
| com.google.api.ads.common.lib.client | ++ |
| com.google.api.ads.common.lib.exception | ++ |
| com.google.api.ads.common.lib.factory | ++ |
| com.google.api.ads.common.lib.factory.helper | ++ |
| com.google.api.ads.common.lib.soap | ++ |
| com.google.api.ads.common.lib.soap.axis | ++ |
| com.google.api.ads.common.lib.soap.compatability | ++ |
| com.google.api.ads.common.lib.soap.jaxb | ++ |
| com.google.api.ads.common.lib.soap.jaxws | ++ |
| com.google.api.ads.common.lib.useragent | ++ |
| com.google.api.ads.common.lib.utils | ++ |
| com.google.api.ads.common.lib.utils.examples | ++ |
| com.google.api.ads.common.lib.utils.logging | ++ |
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/overview-tree.html b/5.3.0/overview-tree.html new file mode 100644 index 0000000000..1f5822e27e --- /dev/null +++ b/5.3.0/overview-tree.html @@ -0,0 +1,407 @@ + + + + + + +Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/package-list b/5.3.0/package-list new file mode 100644 index 0000000000..b859ef6c8a --- /dev/null +++ b/5.3.0/package-list @@ -0,0 +1,34 @@ +com.google.api.ads.admanager.axis +com.google.api.ads.admanager.axis.factory +com.google.api.ads.admanager.axis.utils.v202302 +com.google.api.ads.admanager.axis.utils.v202305 +com.google.api.ads.admanager.axis.utils.v202308 +com.google.api.ads.admanager.axis.utils.v202311 +com.google.api.ads.admanager.jaxws +com.google.api.ads.admanager.jaxws.factory +com.google.api.ads.admanager.jaxws.utils.v202302 +com.google.api.ads.admanager.jaxws.utils.v202305 +com.google.api.ads.admanager.jaxws.utils.v202308 +com.google.api.ads.admanager.jaxws.utils.v202311 +com.google.api.ads.admanager.lib +com.google.api.ads.admanager.lib.client +com.google.api.ads.admanager.lib.factory +com.google.api.ads.admanager.lib.factory.helper +com.google.api.ads.admanager.lib.soap +com.google.api.ads.admanager.lib.utils +com.google.api.ads.admanager.lib.utils.examples +com.google.api.ads.common.lib +com.google.api.ads.common.lib.auth +com.google.api.ads.common.lib.client +com.google.api.ads.common.lib.exception +com.google.api.ads.common.lib.factory +com.google.api.ads.common.lib.factory.helper +com.google.api.ads.common.lib.soap +com.google.api.ads.common.lib.soap.axis +com.google.api.ads.common.lib.soap.compatability +com.google.api.ads.common.lib.soap.jaxb +com.google.api.ads.common.lib.soap.jaxws +com.google.api.ads.common.lib.useragent +com.google.api.ads.common.lib.utils +com.google.api.ads.common.lib.utils.examples +com.google.api.ads.common.lib.utils.logging diff --git a/5.3.0/script.js b/5.3.0/script.js new file mode 100644 index 0000000000..b346356931 --- /dev/null +++ b/5.3.0/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/5.3.0/serialized-form.html b/5.3.0/serialized-form.html new file mode 100644 index 0000000000..757b4739f9 --- /dev/null +++ b/5.3.0/serialized-form.html @@ -0,0 +1,190 @@ + + + + + + +String trigger+
com.google.api.client.http.HttpRequestFactory requestFactory+
com.google.api.ads.common.lib.soap.axis.HttpHandler.InputStreamEventListener inputStreamEventListener+
Copyright © 2023. All Rights Reserved.
+ + diff --git a/5.3.0/stylesheet.css b/5.3.0/stylesheet.css new file mode 100644 index 0000000000..98055b22d6 --- /dev/null +++ b/5.3.0/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/index.html b/index.html index 83aece49bc..34fad8cd52 100644 --- a/index.html +++ b/index.html @@ -1 +1 @@ - +