com.google.api.ads.dfp.jaxws.v201802

Enum TimeZoneType

java.lang.Object

java.lang.Enum<TimeZoneType>

com.google.api.ads.dfp.jaxws.v201802.TimeZoneType

All Implemented Interfaces:

Serializable, Comparable<TimeZoneType>

public enum TimeZoneType
extends Enum<TimeZoneType>

Java class for TimeZoneType.

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

 <simpleType name="TimeZoneType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="UNKNOWN"/>
     <enumeration value="PROPOSAL_LOCAL"/>
     <enumeration value="PUBLISHER"/>
     <enumeration value="AD_EXCHANGE"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
AD_EXCHANGE Use the Ad Exchange time zone (Pacific Time Zone).
PROPOSAL_LOCAL Use the proposal or proposal line item time zone.
PUBLISHER Use the publisher's time zone.
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 TimeZoneType	fromValue(String v)
String	value()
static TimeZoneType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeZoneType[]	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

UNKNOWN

public static final TimeZoneType UNKNOWN

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

PROPOSAL_LOCAL

public static final TimeZoneType PROPOSAL_LOCAL

Use the proposal or proposal line item time zone. This time zone is only compatible with sales metrics and attributes.

For example, if com.google.ads.publisher.api.service.reports.Column#SALES_CONTRACT_CONTRACTED_CLICKS is included in a report with this flag set to true, then it will be calculated using the ProposalLineItem.timeZoneId of the proposal line item the metric is for. If com.google.ads.publisher.api.service.reports.DimensionAttribute#PROPOSAL_CREATION_DATE_TIME is included in a report with this flag set to true, then a proposal's creation date time will be formatted in Proposal.timeZoneId of that proposal.

PUBLISHER

public static final TimeZoneType PUBLISHER

Use the publisher's time zone. For DFP reports, this time zone is compatible with all metrics. For Ad Exchange reports, this time zone is not compatible with "Bids" and "Deals" metrics.

Note: if your report includes "time unit" dimensions, only the DFP "time unit" dimensions are compatible with this timezone, e.g.:

• com.google.ads.publisher.api.service.reports.Dimension.DATE
• com.google.ads.publisher.api.service.reports.Dimension.WEEK
• com.google.ads.publisher.api.service.reports.Dimension.MONTH_AND_YEAR

AD_EXCHANGE

public static final TimeZoneType AD_EXCHANGE

Use the Ad Exchange time zone (Pacific Time Zone). This time zone is only compatible with Ad Exchange metrics.

Note: if your report includes "time unit" dimensions, only the Ad Exchange "time unit" dimensions are compatible with this timezone, e.g.:

• com.google.ads.publisher.api.service.reports.Dimension.AD_EXCHANGE_DATE
• com.google.ads.publisher.api.service.reports.Dimension.AD_EXCHANGE_WEEK
• com.google.ads.publisher.api.service.reports.Dimension.AD_EXCHANGE_MONTH

Method Detail

values

public static TimeZoneType[] 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 (TimeZoneType c : TimeZoneType.values())
    System.out.println(c);

Returns:

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

valueOf

public static TimeZoneType 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 TimeZoneType fromValue(String v)