com.google.api.services.dfareporting.model

Class Report

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.Report

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Report
extends com.google.api.client.json.GenericJson

Represents a Report resource.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Campaign Manager 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Report.Criteria The report criteria for a report of type "STANDARD".
static class	Report.CrossMediaReachCriteria Optional.
static class	Report.Delivery The report's email delivery settings.
static class	Report.FloodlightCriteria The report criteria for a report of type "FLOODLIGHT".
static class	Report.PathToConversionCriteria The report criteria for a report of type "PATH_TO_CONVERSION".
static class	Report.ReachCriteria The report criteria for a report of type "REACH".
static class	Report.Schedule The report's schedule.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Report()

Method Summary

Modifier and Type	Method and Description
Report	clone()
Long	getAccountId() The account ID to which this report belongs.
Report.Criteria	getCriteria() The report criteria for a report of type "STANDARD".
Report.CrossMediaReachCriteria	getCrossMediaReachCriteria() Optional.
Report.Delivery	getDelivery() The report's email delivery settings.
String	getEtag() The eTag of this response for caching purposes.
String	getFileName() The filename used when generating report files for this report.
Report.FloodlightCriteria	getFloodlightCriteria() The report criteria for a report of type "FLOODLIGHT".
String	getFormat() The output format of the report.
Long	getId() The unique ID identifying this report resource.
String	getKind() The kind of resource this is, in this case dfareporting#report.
BigInteger	getLastModifiedTime() The timestamp (in milliseconds since epoch) of when this report was last modified.
String	getName() The name of the report.
Long	getOwnerProfileId() The user profile id of the owner of this report.
Report.PathToConversionCriteria	getPathToConversionCriteria() The report criteria for a report of type "PATH_TO_CONVERSION".
Report.ReachCriteria	getReachCriteria() The report criteria for a report of type "REACH".
Report.Schedule	getSchedule() The report's schedule.
Long	getSubAccountId() The subaccount ID to which this report belongs if applicable.
String	getType() The type of the report.
Report	set(String fieldName, Object value)
Report	setAccountId(Long accountId) The account ID to which this report belongs.
Report	setCriteria(Report.Criteria criteria) The report criteria for a report of type "STANDARD".
Report	setCrossMediaReachCriteria(Report.CrossMediaReachCriteria crossMediaReachCriteria) Optional.
Report	setDelivery(Report.Delivery delivery) The report's email delivery settings.
Report	setEtag(String etag) The eTag of this response for caching purposes.
Report	setFileName(String fileName) The filename used when generating report files for this report.
Report	setFloodlightCriteria(Report.FloodlightCriteria floodlightCriteria) The report criteria for a report of type "FLOODLIGHT".
Report	setFormat(String format) The output format of the report.
Report	setId(Long id) The unique ID identifying this report resource.
Report	setKind(String kind) The kind of resource this is, in this case dfareporting#report.
Report	setLastModifiedTime(BigInteger lastModifiedTime) The timestamp (in milliseconds since epoch) of when this report was last modified.
Report	setName(String name) The name of the report.
Report	setOwnerProfileId(Long ownerProfileId) The user profile id of the owner of this report.
Report	setPathToConversionCriteria(Report.PathToConversionCriteria pathToConversionCriteria) The report criteria for a report of type "PATH_TO_CONVERSION".
Report	setReachCriteria(Report.ReachCriteria reachCriteria) The report criteria for a report of type "REACH".
Report	setSchedule(Report.Schedule schedule) The report's schedule.
Report	setSubAccountId(Long subAccountId) The subaccount ID to which this report belongs if applicable.
Report	setType(String type) The type of the report.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Report

public Report()

Method Detail

getAccountId

public Long getAccountId()

The account ID to which this report belongs.

Returns:

value or null for none

setAccountId

public Report setAccountId(Long accountId)

The account ID to which this report belongs.

Parameters:

accountId - accountId or null for none

getCriteria

public Report.Criteria getCriteria()

The report criteria for a report of type "STANDARD".

Returns:

value or null for none

setCriteria

public Report setCriteria(Report.Criteria criteria)

The report criteria for a report of type "STANDARD".

Parameters:

criteria - criteria or null for none

getCrossMediaReachCriteria

public Report.CrossMediaReachCriteria getCrossMediaReachCriteria()

Optional. The report criteria for a report of type "CROSS_MEDIA_REACH".

Returns:

value or null for none

setCrossMediaReachCriteria

public Report setCrossMediaReachCriteria(Report.CrossMediaReachCriteria crossMediaReachCriteria)

Optional. The report criteria for a report of type "CROSS_MEDIA_REACH".

Parameters:

crossMediaReachCriteria - crossMediaReachCriteria or null for none

getDelivery

public Report.Delivery getDelivery()

The report's email delivery settings.

Returns:

value or null for none

setDelivery

public Report setDelivery(Report.Delivery delivery)

The report's email delivery settings.

Parameters:

delivery - delivery or null for none

getEtag

public String getEtag()

The eTag of this response for caching purposes.

Returns:

value or null for none

setEtag

public Report setEtag(String etag)

The eTag of this response for caching purposes.

Parameters:

etag - etag or null for none

getFileName

public String getFileName()

The filename used when generating report files for this report.

Returns:

value or null for none

setFileName

public Report setFileName(String fileName)

The filename used when generating report files for this report.

Parameters:

fileName - fileName or null for none

getFloodlightCriteria

public Report.FloodlightCriteria getFloodlightCriteria()

The report criteria for a report of type "FLOODLIGHT".

Returns:

value or null for none

setFloodlightCriteria

public Report setFloodlightCriteria(Report.FloodlightCriteria floodlightCriteria)

The report criteria for a report of type "FLOODLIGHT".

Parameters:

floodlightCriteria - floodlightCriteria or null for none

getFormat

public String getFormat()

The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.

Returns:

value or null for none

setFormat

public Report setFormat(String format)

The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.

Parameters:

format - format or null for none

getId

public Long getId()

The unique ID identifying this report resource.

Returns:

value or null for none

setId

public Report setId(Long id)

The unique ID identifying this report resource.

Parameters:

id - id or null for none

getKind

public String getKind()

The kind of resource this is, in this case dfareporting#report.

Returns:

value or null for none

setKind

public Report setKind(String kind)

The kind of resource this is, in this case dfareporting#report.

Parameters:

kind - kind or null for none

getLastModifiedTime

public BigInteger getLastModifiedTime()

The timestamp (in milliseconds since epoch) of when this report was last modified.

Returns:

value or null for none

setLastModifiedTime

public Report setLastModifiedTime(BigInteger lastModifiedTime)

The timestamp (in milliseconds since epoch) of when this report was last modified.

Parameters:

lastModifiedTime - lastModifiedTime or null for none

getName

public String getName()

The name of the report.

Returns:

value or null for none

setName

public Report setName(String name)

The name of the report.

Parameters:

name - name or null for none

getOwnerProfileId

public Long getOwnerProfileId()

The user profile id of the owner of this report.

Returns:

value or null for none

setOwnerProfileId

public Report setOwnerProfileId(Long ownerProfileId)

The user profile id of the owner of this report.

Parameters:

ownerProfileId - ownerProfileId or null for none

getPathToConversionCriteria

public Report.PathToConversionCriteria getPathToConversionCriteria()

The report criteria for a report of type "PATH_TO_CONVERSION".

Returns:

value or null for none

setPathToConversionCriteria

public Report setPathToConversionCriteria(Report.PathToConversionCriteria pathToConversionCriteria)

The report criteria for a report of type "PATH_TO_CONVERSION".

Parameters:

pathToConversionCriteria - pathToConversionCriteria or null for none

getReachCriteria

public Report.ReachCriteria getReachCriteria()

The report criteria for a report of type "REACH".

Returns:

value or null for none

setReachCriteria

public Report setReachCriteria(Report.ReachCriteria reachCriteria)

The report criteria for a report of type "REACH".

Parameters:

reachCriteria - reachCriteria or null for none

getSchedule

public Report.Schedule getSchedule()

The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".

Returns:

value or null for none

setSchedule

public Report setSchedule(Report.Schedule schedule)

The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".

Parameters:

schedule - schedule or null for none

getSubAccountId

public Long getSubAccountId()

The subaccount ID to which this report belongs if applicable.

Returns:

value or null for none

setSubAccountId

public Report setSubAccountId(Long subAccountId)

The subaccount ID to which this report belongs if applicable.

Parameters:

subAccountId - subAccountId or null for none

getType

public String getType()

The type of the report.

Returns:

value or null for none

setType

public Report setType(String type)

The type of the report.

Parameters:

type - type or null for none

set

public Report set(String fieldName,
                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Report clone()

Overrides:

clone in class com.google.api.client.json.GenericJson