com.google.api.services.dfareporting.model

Class FloodlightActivity

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.FloodlightActivity

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Contains properties of a Floodlight activity.

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 DCM/DFA Reporting And Trafficking 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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
FloodlightActivity()

Method Summary

Methods

Modifier and Type	Method and Description
FloodlightActivity	clone()
java.lang.Long	getAccountId() Account ID of this floodlight activity.
java.lang.Long	getAdvertiserId() Advertiser ID of this floodlight activity.
DimensionValue	getAdvertiserIdDimensionValue() Dimension value for the ID of the advertiser.
java.lang.String	getCacheBustingType() Code type used for cache busting in the generated tag.
java.lang.String	getCountingMethod() Counting method for conversions for this floodlight activity.
java.util.List<FloodlightActivityDynamicTag>	getDefaultTags() Dynamic floodlight tags.
java.lang.String	getExpectedUrl() URL where this tag will be deployed.
java.lang.Long	getFloodlightActivityGroupId() Floodlight activity group ID of this floodlight activity.
java.lang.String	getFloodlightActivityGroupName() Name of the associated floodlight activity group.
java.lang.String	getFloodlightActivityGroupTagString() Tag string of the associated floodlight activity group.
java.lang.String	getFloodlightActivityGroupType() Type of the associated floodlight activity group.
java.lang.Long	getFloodlightConfigurationId() Floodlight configuration ID of this floodlight activity.
DimensionValue	getFloodlightConfigurationIdDimensionValue() Dimension value for the ID of the floodlight configuration.
java.lang.String	getFloodlightTagType() The type of Floodlight tag this activity will generate.
java.lang.Boolean	getHidden() Whether this activity is archived.
java.lang.Long	getId() ID of this floodlight activity.
DimensionValue	getIdDimensionValue() Dimension value for the ID of this floodlight activity.
java.lang.String	getKind() Identifies what kind of resource this is.
java.lang.String	getName() Name of this floodlight activity.
java.lang.String	getNotes() General notes or implementation instructions for the tag.
java.util.List<FloodlightActivityPublisherDynamicTag>	getPublisherTags() Publisher dynamic floodlight tags.
java.lang.Boolean	getSecure() Whether this tag should use SSL.
java.lang.Boolean	getSslCompliant() Whether the floodlight activity is SSL-compliant.
java.lang.Boolean	getSslRequired() Whether this floodlight activity must be SSL-compliant.
java.lang.Long	getSubaccountId() Subaccount ID of this floodlight activity.
java.lang.String	getTagFormat() Tag format type for the floodlight activity.
java.lang.String	getTagString() Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity.
java.util.List<java.lang.String>	getUserDefinedVariableTypes() List of the user-defined variables used by this conversion tag.
FloodlightActivity	set(java.lang.String fieldName, java.lang.Object value)
FloodlightActivity	setAccountId(java.lang.Long accountId) Account ID of this floodlight activity.
FloodlightActivity	setAdvertiserId(java.lang.Long advertiserId) Advertiser ID of this floodlight activity.
FloodlightActivity	setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue) Dimension value for the ID of the advertiser.
FloodlightActivity	setCacheBustingType(java.lang.String cacheBustingType) Code type used for cache busting in the generated tag.
FloodlightActivity	setCountingMethod(java.lang.String countingMethod) Counting method for conversions for this floodlight activity.
FloodlightActivity	setDefaultTags(java.util.List<FloodlightActivityDynamicTag> defaultTags) Dynamic floodlight tags.
FloodlightActivity	setExpectedUrl(java.lang.String expectedUrl) URL where this tag will be deployed.
FloodlightActivity	setFloodlightActivityGroupId(java.lang.Long floodlightActivityGroupId) Floodlight activity group ID of this floodlight activity.
FloodlightActivity	setFloodlightActivityGroupName(java.lang.String floodlightActivityGroupName) Name of the associated floodlight activity group.
FloodlightActivity	setFloodlightActivityGroupTagString(java.lang.String floodlightActivityGroupTagString) Tag string of the associated floodlight activity group.
FloodlightActivity	setFloodlightActivityGroupType(java.lang.String floodlightActivityGroupType) Type of the associated floodlight activity group.
FloodlightActivity	setFloodlightConfigurationId(java.lang.Long floodlightConfigurationId) Floodlight configuration ID of this floodlight activity.
FloodlightActivity	setFloodlightConfigurationIdDimensionValue(DimensionValue floodlightConfigurationIdDimensionValue) Dimension value for the ID of the floodlight configuration.
FloodlightActivity	setFloodlightTagType(java.lang.String floodlightTagType) The type of Floodlight tag this activity will generate.
FloodlightActivity	setHidden(java.lang.Boolean hidden) Whether this activity is archived.
FloodlightActivity	setId(java.lang.Long id) ID of this floodlight activity.
FloodlightActivity	setIdDimensionValue(DimensionValue idDimensionValue) Dimension value for the ID of this floodlight activity.
FloodlightActivity	setKind(java.lang.String kind) Identifies what kind of resource this is.
FloodlightActivity	setName(java.lang.String name) Name of this floodlight activity.
FloodlightActivity	setNotes(java.lang.String notes) General notes or implementation instructions for the tag.
FloodlightActivity	setPublisherTags(java.util.List<FloodlightActivityPublisherDynamicTag> publisherTags) Publisher dynamic floodlight tags.
FloodlightActivity	setSecure(java.lang.Boolean secure) Whether this tag should use SSL.
FloodlightActivity	setSslCompliant(java.lang.Boolean sslCompliant) Whether the floodlight activity is SSL-compliant.
FloodlightActivity	setSslRequired(java.lang.Boolean sslRequired) Whether this floodlight activity must be SSL-compliant.
FloodlightActivity	setSubaccountId(java.lang.Long subaccountId) Subaccount ID of this floodlight activity.
FloodlightActivity	setTagFormat(java.lang.String tagFormat) Tag format type for the floodlight activity.
FloodlightActivity	setTagString(java.lang.String tagString) Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity.
FloodlightActivity	setUserDefinedVariableTypes(java.util.List<java.lang.String> userDefinedVariableTypes) List of the user-defined variables used by this conversion tag.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FloodlightActivity

public FloodlightActivity()

Method Detail

getAccountId

public java.lang.Long getAccountId()

Account ID of this floodlight activity. This is a read-only field that can be left blank.

Returns:

value or null for none

setAccountId

public FloodlightActivity setAccountId(java.lang.Long accountId)

Account ID of this floodlight activity. This is a read-only field that can be left blank.

Parameters:

accountId - accountId or null for none

getAdvertiserId

public java.lang.Long getAdvertiserId()

Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.

Returns:

value or null for none

setAdvertiserId

public FloodlightActivity setAdvertiserId(java.lang.Long advertiserId)

Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.

Parameters:

advertiserId - advertiserId or null for none

getAdvertiserIdDimensionValue

public DimensionValue getAdvertiserIdDimensionValue()

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

Returns:

value or null for none

setAdvertiserIdDimensionValue

public FloodlightActivity setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue)

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

Parameters:

advertiserIdDimensionValue - advertiserIdDimensionValue or null for none

getCacheBustingType

public java.lang.String getCacheBustingType()

Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.

Returns:

value or null for none

setCacheBustingType

public FloodlightActivity setCacheBustingType(java.lang.String cacheBustingType)

Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.

Parameters:

cacheBustingType - cacheBustingType or null for none

getCountingMethod

public java.lang.String getCountingMethod()

Counting method for conversions for this floodlight activity. This is a required field.

Returns:

value or null for none

setCountingMethod

public FloodlightActivity setCountingMethod(java.lang.String countingMethod)

Counting method for conversions for this floodlight activity. This is a required field.

Parameters:

countingMethod - countingMethod or null for none

getDefaultTags

public java.util.List<FloodlightActivityDynamicTag> getDefaultTags()

Dynamic floodlight tags.

Returns:

value or null for none

setDefaultTags

public FloodlightActivity setDefaultTags(java.util.List<FloodlightActivityDynamicTag> defaultTags)

Dynamic floodlight tags.

Parameters:

defaultTags - defaultTags or null for none

getExpectedUrl

public java.lang.String getExpectedUrl()

URL where this tag will be deployed. If specified, must be less than 256 characters long.

Returns:

value or null for none

setExpectedUrl

public FloodlightActivity setExpectedUrl(java.lang.String expectedUrl)

URL where this tag will be deployed. If specified, must be less than 256 characters long.

Parameters:

expectedUrl - expectedUrl or null for none

getFloodlightActivityGroupId

public java.lang.Long getFloodlightActivityGroupId()

Floodlight activity group ID of this floodlight activity. This is a required field.

Returns:

value or null for none

setFloodlightActivityGroupId

public FloodlightActivity setFloodlightActivityGroupId(java.lang.Long floodlightActivityGroupId)

Floodlight activity group ID of this floodlight activity. This is a required field.

Parameters:

floodlightActivityGroupId - floodlightActivityGroupId or null for none

getFloodlightActivityGroupName

public java.lang.String getFloodlightActivityGroupName()

Name of the associated floodlight activity group. This is a read-only field.

Returns:

value or null for none

setFloodlightActivityGroupName

public FloodlightActivity setFloodlightActivityGroupName(java.lang.String floodlightActivityGroupName)

Name of the associated floodlight activity group. This is a read-only field.

Parameters:

floodlightActivityGroupName - floodlightActivityGroupName or null for none

getFloodlightActivityGroupTagString

public java.lang.String getFloodlightActivityGroupTagString()

Tag string of the associated floodlight activity group. This is a read-only field.

Returns:

value or null for none

setFloodlightActivityGroupTagString

public FloodlightActivity setFloodlightActivityGroupTagString(java.lang.String floodlightActivityGroupTagString)

Tag string of the associated floodlight activity group. This is a read-only field.

Parameters:

floodlightActivityGroupTagString - floodlightActivityGroupTagString or null for none

getFloodlightActivityGroupType

public java.lang.String getFloodlightActivityGroupType()

Type of the associated floodlight activity group. This is a read-only field.

Returns:

value or null for none

setFloodlightActivityGroupType

public FloodlightActivity setFloodlightActivityGroupType(java.lang.String floodlightActivityGroupType)

Type of the associated floodlight activity group. This is a read-only field.

Parameters:

floodlightActivityGroupType - floodlightActivityGroupType or null for none

getFloodlightConfigurationId

public java.lang.Long getFloodlightConfigurationId()

Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.

Returns:

value or null for none

setFloodlightConfigurationId

public FloodlightActivity setFloodlightConfigurationId(java.lang.Long floodlightConfigurationId)

Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.

Parameters:

floodlightConfigurationId - floodlightConfigurationId or null for none

getFloodlightConfigurationIdDimensionValue

public DimensionValue getFloodlightConfigurationIdDimensionValue()

Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.

Returns:

value or null for none

setFloodlightConfigurationIdDimensionValue

public FloodlightActivity setFloodlightConfigurationIdDimensionValue(DimensionValue floodlightConfigurationIdDimensionValue)

Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.

Parameters:

floodlightConfigurationIdDimensionValue - floodlightConfigurationIdDimensionValue or null for none

getFloodlightTagType

public java.lang.String getFloodlightTagType()

The type of Floodlight tag this activity will generate. This is a required field.

Returns:

value or null for none

setFloodlightTagType

public FloodlightActivity setFloodlightTagType(java.lang.String floodlightTagType)

The type of Floodlight tag this activity will generate. This is a required field.

Parameters:

floodlightTagType - floodlightTagType or null for none

getHidden

public java.lang.Boolean getHidden()

Whether this activity is archived.

Returns:

value or null for none

setHidden

public FloodlightActivity setHidden(java.lang.Boolean hidden)

Whether this activity is archived.

Parameters:

hidden - hidden or null for none

getId

public java.lang.Long getId()

ID of this floodlight activity. This is a read-only, auto-generated field.

Returns:

value or null for none

setId

public FloodlightActivity setId(java.lang.Long id)

ID of this floodlight activity. This is a read-only, auto-generated field.

Parameters:

id - id or null for none

getIdDimensionValue

public DimensionValue getIdDimensionValue()

Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.

Returns:

value or null for none

setIdDimensionValue

public FloodlightActivity setIdDimensionValue(DimensionValue idDimensionValue)

Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.

Parameters:

idDimensionValue - idDimensionValue or null for none

getKind

public java.lang.String getKind()

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".

Returns:

value or null for none

setKind

public FloodlightActivity setKind(java.lang.String kind)

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".

Parameters:

kind - kind or null for none

getName

public java.lang.String getName()

Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.

Returns:

value or null for none

setName

public FloodlightActivity setName(java.lang.String name)

Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.

Parameters:

name - name or null for none

getNotes

public java.lang.String getNotes()

General notes or implementation instructions for the tag.

Returns:

value or null for none

setNotes

public FloodlightActivity setNotes(java.lang.String notes)

General notes or implementation instructions for the tag.

Parameters:

notes - notes or null for none

getPublisherTags

public java.util.List<FloodlightActivityPublisherDynamicTag> getPublisherTags()

Publisher dynamic floodlight tags.

Returns:

value or null for none

setPublisherTags

public FloodlightActivity setPublisherTags(java.util.List<FloodlightActivityPublisherDynamicTag> publisherTags)

Publisher dynamic floodlight tags.

Parameters:

publisherTags - publisherTags or null for none

getSecure

public java.lang.Boolean getSecure()

Whether this tag should use SSL.

Returns:

value or null for none

setSecure

public FloodlightActivity setSecure(java.lang.Boolean secure)

Whether this tag should use SSL.

Parameters:

secure - secure or null for none

getSslCompliant

public java.lang.Boolean getSslCompliant()

Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.

Returns:

value or null for none

setSslCompliant

public FloodlightActivity setSslCompliant(java.lang.Boolean sslCompliant)

Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.

Parameters:

sslCompliant - sslCompliant or null for none

getSslRequired

public java.lang.Boolean getSslRequired()

Whether this floodlight activity must be SSL-compliant.

Returns:

value or null for none

setSslRequired

public FloodlightActivity setSslRequired(java.lang.Boolean sslRequired)

Whether this floodlight activity must be SSL-compliant.

Parameters:

sslRequired - sslRequired or null for none

getSubaccountId

public java.lang.Long getSubaccountId()

Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.

Returns:

value or null for none

setSubaccountId

public FloodlightActivity setSubaccountId(java.lang.Long subaccountId)

Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.

Parameters:

subaccountId - subaccountId or null for none

getTagFormat

public java.lang.String getTagFormat()

Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.

Returns:

value or null for none

setTagFormat

public FloodlightActivity setTagFormat(java.lang.String tagFormat)

Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.

Parameters:

tagFormat - tagFormat or null for none

getTagString

public java.lang.String getTagString()

Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.

Returns:

value or null for none

setTagString

public FloodlightActivity setTagString(java.lang.String tagString)

Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.

Parameters:

tagString - tagString or null for none

getUserDefinedVariableTypes

public java.util.List<java.lang.String> getUserDefinedVariableTypes()

List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.

Returns:

value or null for none

setUserDefinedVariableTypes

public FloodlightActivity setUserDefinedVariableTypes(java.util.List<java.lang.String> userDefinedVariableTypes)

List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.

Parameters:

userDefinedVariableTypes - userDefinedVariableTypes or null for none

set

public FloodlightActivity set(java.lang.String fieldName,
                     java.lang.Object value)

Overrides:

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

clone

public FloodlightActivity clone()

Overrides:

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