com.google.api.services.doubleclickbidmanager.model

Class QueryMetadata

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.doubleclickbidmanager.model.QueryMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The metadata of the query.

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 DoubleClick Bid Manager 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/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
QueryMetadata()

Method Summary

Modifier and Type	Method and Description
QueryMetadata	clone()
DataRange	getDataRange() The date range the report generated by the query will report on.
String	getFormat() The format of the report generated by the query.
Boolean	getSendNotification() Whether an email notification is sent to the query creator when a report generated by the query is ready.
List<String>	getShareEmailAddress() List of additional email addresses with which to share the query.
String	getTitle() The display name of the query.
QueryMetadata	set(String fieldName, Object value)
QueryMetadata	setDataRange(DataRange dataRange) The date range the report generated by the query will report on.
QueryMetadata	setFormat(String format) The format of the report generated by the query.
QueryMetadata	setSendNotification(Boolean sendNotification) Whether an email notification is sent to the query creator when a report generated by the query is ready.
QueryMetadata	setShareEmailAddress(List<String> shareEmailAddress) List of additional email addresses with which to share the query.
QueryMetadata	setTitle(String title) The display name of the query.

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

QueryMetadata

public QueryMetadata()

Method Detail

getDataRange

public DataRange getDataRange()

The date range the report generated by the query will report on. This date range will be defined by the time zone as used by the advertiser.

Returns:

value or null for none

setDataRange

public QueryMetadata setDataRange(DataRange dataRange)

The date range the report generated by the query will report on. This date range will be defined by the time zone as used by the advertiser.

Parameters:

dataRange - dataRange or null for none

getFormat

public String getFormat()

The format of the report generated by the query.

Returns:

value or null for none

setFormat

public QueryMetadata setFormat(String format)

The format of the report generated by the query.

Parameters:

format - format or null for none

getSendNotification

public Boolean getSendNotification()

Whether an email notification is sent to the query creator when a report generated by the query is ready. This value is `false` by default.

Returns:

value or null for none

setSendNotification

public QueryMetadata setSendNotification(Boolean sendNotification)

Whether an email notification is sent to the query creator when a report generated by the query is ready. This value is `false` by default.

Parameters:

sendNotification - sendNotification or null for none

getShareEmailAddress

public List<String> getShareEmailAddress()

List of additional email addresses with which to share the query. If send_notification is `true`, these email addresses will receive a notification when a report generated by the query is ready. If these email addresses are connected to Display & Video 360 users, the query will be available to them in the Display & Video 360 interface.

Returns:

value or null for none

setShareEmailAddress

public QueryMetadata setShareEmailAddress(List<String> shareEmailAddress)

List of additional email addresses with which to share the query. If send_notification is `true`, these email addresses will receive a notification when a report generated by the query is ready. If these email addresses are connected to Display & Video 360 users, the query will be available to them in the Display & Video 360 interface.

Parameters:

shareEmailAddress - shareEmailAddress or null for none

getTitle

public String getTitle()

The display name of the query. This value will be used in the file name of reports generated by the query.

Returns:

value or null for none

setTitle

public QueryMetadata setTitle(String title)

The display name of the query. This value will be used in the file name of reports generated by the query.

Parameters:

title - title or null for none

set

public QueryMetadata set(String fieldName,
                         Object value)

Overrides:

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

clone

public QueryMetadata clone()

Overrides:

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