com.google.api.ads.adwords.v201109.info
Class InfoSelector

java.lang.Object
  com.google.api.ads.adwords.v201109.info.InfoSelector

All Implemented Interfaces:

Serializable

public class InfoSelector
extends Object
implements Serializable

Specifies the type of API usage information to be returned. API usage information returned is based on the API usage type specified. All returned values are specific to the developer token being used to call InfoService.get.

For each of the apiUsageType values, other InfoSelector fields must also be set as described below:

• FREE_USAGE_API_UNITS_PER_MONTH : Returns the number of allocated free API units for this entire month. Specify only the apiUsageType parameter.
• TOTAL_USAGE_API_UNITS_PER_MONTH : Returns the total number of allocated API units for this entire month. Includes both free and paid API units. Specify only the apiUsageType parameter.
• OPERATION_COUNT : Returns the number of operations recorded over the given date range. The given dates are inclusive; to get the operation count for a single day, supply it as both the start and end date. Specify the apiUsageType and dateRange parameters.
• UNIT_COUNT : Returns the number of API units recorded.
  • Specify the apiUsageType and dateRange parameters to retrieve the units recorded over the given date range.
  • Specify the apiUsageType, serviceName, methodName and dateRange to retrieve the units recorded over the given date range for a specified method.
• UNIT_COUNT_FOR_CLIENTS : Returns the number of API units recorded for a subset of clients over the given date range. The given dates are inclusive; to get the unit count for a single day, supply it as both the start and end date. Specify the apiUsageType, dateRange and clientEmails parameters.
• METHOD_COST : Returns the cost, in API units per operation, of the given method on a specific date. Methods default to a cost of 1. Specify the apiUsageType, dateRange (start date and end date should be the same), serviceName, methodName, operator parameters.

See Also:

Serialized Form

Constructor Summary

InfoSelector()

InfoSelector(String serviceName, String methodName, Operator operator, DateRange dateRange, String[] clientEmails, long[] clientCustomerIds, Boolean includeSubAccounts, ApiUsageType apiUsageType)

Method Summary

boolean	equals(Object obj)
ApiUsageType	getApiUsageType() Gets the apiUsageType value for this InfoSelector.
long[]	getClientCustomerIds() Gets the clientCustomerIds value for this InfoSelector.
long	getClientCustomerIds(int i)
String[]	getClientEmails() Gets the clientEmails value for this InfoSelector.
String	getClientEmails(int i)
DateRange	getDateRange() Gets the dateRange value for this InfoSelector.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Boolean	getIncludeSubAccounts() Gets the includeSubAccounts value for this InfoSelector.
String	getMethodName() Gets the methodName value for this InfoSelector.
Operator	getOperator() Gets the operator value for this InfoSelector.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
String	getServiceName() Gets the serviceName value for this InfoSelector.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setApiUsageType(ApiUsageType apiUsageType) Sets the apiUsageType value for this InfoSelector.
void	setClientCustomerIds(int i, long _value)
void	setClientCustomerIds(long[] clientCustomerIds) Sets the clientCustomerIds value for this InfoSelector.
void	setClientEmails(int i, String _value)
void	setClientEmails(String[] clientEmails) Sets the clientEmails value for this InfoSelector.
void	setDateRange(DateRange dateRange) Sets the dateRange value for this InfoSelector.
void	setIncludeSubAccounts(Boolean includeSubAccounts) Sets the includeSubAccounts value for this InfoSelector.
void	setMethodName(String methodName) Sets the methodName value for this InfoSelector.
void	setOperator(Operator operator) Sets the operator value for this InfoSelector.
void	setServiceName(String serviceName) Sets the serviceName value for this InfoSelector.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InfoSelector

public InfoSelector()

InfoSelector

public InfoSelector(String serviceName,
                    String methodName,
                    Operator operator,
                    DateRange dateRange,
                    String[] clientEmails,
                    long[] clientCustomerIds,
                    Boolean includeSubAccounts,
                    ApiUsageType apiUsageType)

Method Detail

getServiceName

public String getServiceName()

Gets the serviceName value for this InfoSelector.

Returns:

serviceName * The name of the service.

setServiceName

public void setServiceName(String serviceName)

Sets the serviceName value for this InfoSelector.

Parameters:

serviceName - * The name of the service.

getMethodName

public String getMethodName()

Gets the methodName value for this InfoSelector.

Returns:

methodName * The method whose cost has been queried.

setMethodName

public void setMethodName(String methodName)

Sets the methodName value for this InfoSelector.

Parameters:

methodName - * The method whose cost has been queried.

getOperator

public Operator getOperator()

Gets the operator value for this InfoSelector.

Returns:

operator * Specifies the operator. This is applicable when the method is a "mutate" method.

setOperator

public void setOperator(Operator operator)

Sets the operator value for this InfoSelector.

Parameters:

operator - * Specifies the operator. This is applicable when the method is a "mutate" method.

getDateRange

public DateRange getDateRange()

Gets the dateRange value for this InfoSelector.

Returns:

dateRange * Date range to get the API usage for. The given dates are inclusive; to get the usage information for a single day, supply it as both the start and end date.

setDateRange

public void setDateRange(DateRange dateRange)

Sets the dateRange value for this InfoSelector.

Parameters:

dateRange - * Date range to get the API usage for. The given dates are inclusive; to get the usage information for a single day, supply it as both the start and end date.

getClientEmails

public String[] getClientEmails()

Gets the clientEmails value for this InfoSelector.

Returns:

clientEmails * List of login emails used to identify the clients to retrieve the API usage for. If the list is null or empty, return the API usage for all clients. NOTE: Only one of clientEmails or clientCustomerIds may be specified at once.

setClientEmails

public void setClientEmails(String[] clientEmails)

Sets the clientEmails value for this InfoSelector.

Parameters:

clientEmails - * List of login emails used to identify the clients to retrieve the API usage for. If the list is null or empty, return the API usage for all clients. NOTE: Only one of clientEmails or clientCustomerIds may be specified at once.

getClientEmails

public String getClientEmails(int i)

setClientEmails

public void setClientEmails(int i,
                            String _value)

getClientCustomerIds

public long[] getClientCustomerIds()

Gets the clientCustomerIds value for this InfoSelector.

Returns:

clientCustomerIds * List of login customer IDs used to identify the clients to retrieve the API usage for. If the list is null or empty, return the API usage for all clients. NOTE: Only one of clientEmails or clientCustomerIds may be specified at once.

setClientCustomerIds

public void setClientCustomerIds(long[] clientCustomerIds)

Sets the clientCustomerIds value for this InfoSelector.

Parameters:

clientCustomerIds - * List of login customer IDs used to identify the clients to retrieve the API usage for. If the list is null or empty, return the API usage for all clients. NOTE: Only one of clientEmails or clientCustomerIds may be specified at once.

getClientCustomerIds

public long getClientCustomerIds(int i)

setClientCustomerIds

public void setClientCustomerIds(int i,
                                 long _value)

getIncludeSubAccounts

public Boolean getIncludeSubAccounts()

Gets the includeSubAccounts value for this InfoSelector.

Returns:

includeSubAccounts * If true, include child accounts of the MCC in the search.

setIncludeSubAccounts

public void setIncludeSubAccounts(Boolean includeSubAccounts)

Sets the includeSubAccounts value for this InfoSelector.

Parameters:

includeSubAccounts - * If true, include child accounts of the MCC in the search.

getApiUsageType

public ApiUsageType getApiUsageType()

Gets the apiUsageType value for this InfoSelector.

Returns:

apiUsageType * The API usage type information that needs to be fetched. This field is required and should not be null.

setApiUsageType

public void setApiUsageType(ApiUsageType apiUsageType)

Sets the apiUsageType value for this InfoSelector.

Parameters:

apiUsageType - * The API usage type information that needs to be fetched. This field is required and should not be null.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer