com.google.api.services.doubleclicksearch.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.doubleclicksearch.model.Report

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A DoubleClick Search report. This object contains the report request, some report metadata such as currency code, and the generated report rows or report files.

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 Search Ads 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.Files Model definition for ReportFiles.

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()
List<Report.Files>	getFiles() Asynchronous report only.
String	getId() Asynchronous report only.
Boolean	getIsReportReady() Asynchronous report only.
String	getKind() Identifies this as a Report resource.
ReportRequest	getRequest() The request that created the report.
Integer	getRowCount() The number of report rows generated by the report, not including headers.
List<Map<String,Object>>	getRows() Synchronous report only.
String	getStatisticsCurrencyCode() The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue).
String	getStatisticsTimeZone() If all statistics of the report are sourced from the same time zone, this would be it.
Report	set(String fieldName, Object value)
Report	setFiles(List<Report.Files> files) Asynchronous report only.
Report	setId(String id) Asynchronous report only.
Report	setIsReportReady(Boolean isReportReady) Asynchronous report only.
Report	setKind(String kind) Identifies this as a Report resource.
Report	setRequest(ReportRequest request) The request that created the report.
Report	setRowCount(Integer rowCount) The number of report rows generated by the report, not including headers.
Report	setRows(List<Map<String,Object>> rows) Synchronous report only.
Report	setStatisticsCurrencyCode(String statisticsCurrencyCode) The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue).
Report	setStatisticsTimeZone(String statisticsTimeZone) If all statistics of the report are sourced from the same time zone, this would be it.

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

getFiles

public List<Report.Files> getFiles()

Asynchronous report only. Contains a list of generated report files once the report has successfully completed.

Returns:

value or null for none

setFiles

public Report setFiles(List<Report.Files> files)

Asynchronous report only. Contains a list of generated report files once the report has successfully completed.

Parameters:

files - files or null for none

getId

public String getId()

Asynchronous report only. Id of the report.

Returns:

value or null for none

setId

public Report setId(String id)

Asynchronous report only. Id of the report.

Parameters:

id - id or null for none

getIsReportReady

public Boolean getIsReportReady()

Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.

Returns:

value or null for none

setIsReportReady

public Report setIsReportReady(Boolean isReportReady)

Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.

Parameters:

isReportReady - isReportReady or null for none

getKind

public String getKind()

Identifies this as a Report resource. Value: the fixed string `doubleclicksearch#report`.

Returns:

value or null for none

setKind

public Report setKind(String kind)

Identifies this as a Report resource. Value: the fixed string `doubleclicksearch#report`.

Parameters:

kind - kind or null for none

getRequest

public ReportRequest getRequest()

The request that created the report. Optional fields not specified in the original request are filled with default values.

Returns:

value or null for none

setRequest

public Report setRequest(ReportRequest request)

The request that created the report. Optional fields not specified in the original request are filled with default values.

Parameters:

request - request or null for none

getRowCount

public Integer getRowCount()

The number of report rows generated by the report, not including headers.

Returns:

value or null for none

setRowCount

public Report setRowCount(Integer rowCount)

The number of report rows generated by the report, not including headers.

Parameters:

rowCount - rowCount or null for none

getRows

public List<Map<String,Object>> getRows()

Synchronous report only. Generated report rows.

Returns:

value or null for none

setRows

public Report setRows(List<Map<String,Object>> rows)

Synchronous report only. Generated report rows.

Parameters:

rows - rows or null for none

getStatisticsCurrencyCode

public String getStatisticsCurrencyCode()

The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the `statisticsCurrency` field of the report request.

Returns:

value or null for none

setStatisticsCurrencyCode

public Report setStatisticsCurrencyCode(String statisticsCurrencyCode)

The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the `statisticsCurrency` field of the report request.

Parameters:

statisticsCurrencyCode - statisticsCurrencyCode or null for none

getStatisticsTimeZone

public String getStatisticsTimeZone()

If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.

Returns:

value or null for none

setStatisticsTimeZone

public Report setStatisticsTimeZone(String statisticsTimeZone)

If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.

Parameters:

statisticsTimeZone - statisticsTimeZone 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