com.google.api.ads.dfp.jaxws.v201711

Enum QuotaErrorReason

java.lang.Object

java.lang.Enum<QuotaErrorReason>

com.google.api.ads.dfp.jaxws.v201711.QuotaErrorReason

All Implemented Interfaces:

Serializable, Comparable<QuotaErrorReason>

public enum QuotaErrorReason
extends Enum<QuotaErrorReason>

Java class for QuotaError.Reason.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="QuotaError.Reason">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="EXCEEDED_QUOTA"/>
     <enumeration value="UNKNOWN"/>
     <enumeration value="REPORT_JOB_LIMIT"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEEDED_QUOTA The number of requests made per second is too high and has exceeded the allowable limit.
REPORT_JOB_LIMIT This user has exceeded the allowed number of new report requests per hour (this includes both reports run via the UI and reports run via ReportService#runReportJob).
UNKNOWN The value returned if the actual value is not exposed by the requested API version.

Method Summary

Modifier and Type	Method and Description
static QuotaErrorReason	fromValue(String v)
String	value()
static QuotaErrorReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static QuotaErrorReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXCEEDED_QUOTA

public static final QuotaErrorReason EXCEEDED_QUOTA

The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.

Another way to mitigate this error is to limit requests to 2 per second for Small Business networks, or 8 per second for Premium networks. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.

UNKNOWN

public static final QuotaErrorReason UNKNOWN

The value returned if the actual value is not exposed by the requested API version.

REPORT_JOB_LIMIT

public static final QuotaErrorReason REPORT_JOB_LIMIT

This user has exceeded the allowed number of new report requests per hour (this includes both reports run via the UI and reports run via ReportService#runReportJob). The recommended approach to handle this error is to wait about 10 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.

Another way to mitigate this error is to limit the number of new report requests to 250 per hour per user. Once again, this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.

Method Detail

values

public static QuotaErrorReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QuotaErrorReason c : QuotaErrorReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static QuotaErrorReason valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static QuotaErrorReason fromValue(String v)