FloodlightActivity (Campaign Manager 360 API v4-rev20230918-2.0.0)

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.FloodlightActivity

All Implemented Interfaces:

Cloneable, Map<String,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 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/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

FloodlightActivity()

Constructors
Constructor and Description
`FloodlightActivity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FloodlightActivity`	`clone()`
`Long`	`getAccountId()` Account ID of this floodlight activity.
`Long`	`getAdvertiserId()` Advertiser ID of this floodlight activity.
`DimensionValue`	`getAdvertiserIdDimensionValue()` Dimension value for the ID of the advertiser.
`Boolean`	`getAttributionEnabled()` Whether the activity is enabled for attribution.
`String`	`getCacheBustingType()` Code type used for cache busting in the generated tag.
`String`	`getCountingMethod()` Counting method for conversions for this floodlight activity.
`List<FloodlightActivityDynamicTag>`	`getDefaultTags()` Dynamic floodlight tags.
`String`	`getExpectedUrl()` URL where this tag will be deployed.
`Long`	`getFloodlightActivityGroupId()` Floodlight activity group ID of this floodlight activity.
`String`	`getFloodlightActivityGroupName()` Name of the associated floodlight activity group.
`String`	`getFloodlightActivityGroupTagString()` Tag string of the associated floodlight activity group.
`String`	`getFloodlightActivityGroupType()` Type of the associated floodlight activity group.
`Long`	`getFloodlightConfigurationId()` Floodlight configuration ID of this floodlight activity.
`DimensionValue`	`getFloodlightConfigurationIdDimensionValue()` Dimension value for the ID of the floodlight configuration.
`String`	`getFloodlightTagType()` The type of Floodlight tag this activity will generate.
`Long`	`getId()` ID of this floodlight activity.
`DimensionValue`	`getIdDimensionValue()` Dimension value for the ID of this floodlight activity.
`String`	`getKind()` Identifies what kind of resource this is.
`String`	`getName()` Name of this floodlight activity.
`String`	`getNotes()` General notes or implementation instructions for the tag.
`List<FloodlightActivityPublisherDynamicTag>`	`getPublisherTags()` Publisher dynamic floodlight tags.
`Boolean`	`getSecure()` Whether this tag should use SSL.
`Boolean`	`getSslCompliant()` Whether the floodlight activity is SSL-compliant.
`Boolean`	`getSslRequired()` Whether this floodlight activity must be SSL-compliant.
`String`	`getStatus()` The status of the activity.
`Long`	`getSubaccountId()` Subaccount ID of this floodlight activity.
`String`	`getTagFormat()` Tag format type for the floodlight activity.
`String`	`getTagString()` Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity.
`List<String>`	`getUserDefinedVariableTypes()` List of the user-defined variables used by this conversion tag.
`FloodlightActivity`	`set(String fieldName, Object value)`
`FloodlightActivity`	`setAccountId(Long accountId)` Account ID of this floodlight activity.
`FloodlightActivity`	`setAdvertiserId(Long advertiserId)` Advertiser ID of this floodlight activity.
`FloodlightActivity`	`setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue)` Dimension value for the ID of the advertiser.
`FloodlightActivity`	`setAttributionEnabled(Boolean attributionEnabled)` Whether the activity is enabled for attribution.
`FloodlightActivity`	`setCacheBustingType(String cacheBustingType)` Code type used for cache busting in the generated tag.
`FloodlightActivity`	`setCountingMethod(String countingMethod)` Counting method for conversions for this floodlight activity.
`FloodlightActivity`	`setDefaultTags(List<FloodlightActivityDynamicTag> defaultTags)` Dynamic floodlight tags.
`FloodlightActivity`	`setExpectedUrl(String expectedUrl)` URL where this tag will be deployed.
`FloodlightActivity`	`setFloodlightActivityGroupId(Long floodlightActivityGroupId)` Floodlight activity group ID of this floodlight activity.
`FloodlightActivity`	`setFloodlightActivityGroupName(String floodlightActivityGroupName)` Name of the associated floodlight activity group.
`FloodlightActivity`	`setFloodlightActivityGroupTagString(String floodlightActivityGroupTagString)` Tag string of the associated floodlight activity group.
`FloodlightActivity`	`setFloodlightActivityGroupType(String floodlightActivityGroupType)` Type of the associated floodlight activity group.
`FloodlightActivity`	`setFloodlightConfigurationId(Long floodlightConfigurationId)` Floodlight configuration ID of this floodlight activity.
`FloodlightActivity`	`setFloodlightConfigurationIdDimensionValue(DimensionValue floodlightConfigurationIdDimensionValue)` Dimension value for the ID of the floodlight configuration.
`FloodlightActivity`	`setFloodlightTagType(String floodlightTagType)` The type of Floodlight tag this activity will generate.
`FloodlightActivity`	`setId(Long id)` ID of this floodlight activity.
`FloodlightActivity`	`setIdDimensionValue(DimensionValue idDimensionValue)` Dimension value for the ID of this floodlight activity.
`FloodlightActivity`	`setKind(String kind)` Identifies what kind of resource this is.
`FloodlightActivity`	`setName(String name)` Name of this floodlight activity.
`FloodlightActivity`	`setNotes(String notes)` General notes or implementation instructions for the tag.
`FloodlightActivity`	`setPublisherTags(List<FloodlightActivityPublisherDynamicTag> publisherTags)` Publisher dynamic floodlight tags.
`FloodlightActivity`	`setSecure(Boolean secure)` Whether this tag should use SSL.
`FloodlightActivity`	`setSslCompliant(Boolean sslCompliant)` Whether the floodlight activity is SSL-compliant.
`FloodlightActivity`	`setSslRequired(Boolean sslRequired)` Whether this floodlight activity must be SSL-compliant.
`FloodlightActivity`	`setStatus(String status)` The status of the activity.
`FloodlightActivity`	`setSubaccountId(Long subaccountId)` Subaccount ID of this floodlight activity.
`FloodlightActivity`	`setTagFormat(String tagFormat)` Tag format type for the floodlight activity.
`FloodlightActivity`	`setTagString(String tagString)` Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity.
`FloodlightActivity`	`setUserDefinedVariableTypes(List<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, 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
  - FloodlightActivity
```
public FloodlightActivity()
```
- Method Detail
  - getAccountId
```
public 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(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 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(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
  - getAttributionEnabled
```
public Boolean getAttributionEnabled()
```
    Whether the activity is enabled for attribution.
    
    Returns:
    
    value or null for none
  - setAttributionEnabled
```
public FloodlightActivity setAttributionEnabled(Boolean attributionEnabled)
```
    Whether the activity is enabled for attribution.
    
    Parameters:
    
    attributionEnabled - attributionEnabled or null for none
  - getCacheBustingType
```
public 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(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 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(String countingMethod)
```
    Counting method for conversions for this floodlight activity. This is a required field.
    
    Parameters:
    
    countingMethod - countingMethod or null for none
  - getDefaultTags
```
public List<FloodlightActivityDynamicTag> getDefaultTags()
```
    Dynamic floodlight tags.
    
    Returns:
    
    value or null for none
  - setDefaultTags
```
public FloodlightActivity setDefaultTags(List<FloodlightActivityDynamicTag> defaultTags)
```
    Dynamic floodlight tags.
    
    Parameters:
    
    defaultTags - defaultTags or null for none
  - getExpectedUrl
```
public 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(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 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(Long floodlightActivityGroupId)
```
    Floodlight activity group ID of this floodlight activity. This is a required field.
    
    Parameters:
    
    floodlightActivityGroupId - floodlightActivityGroupId or null for none
  - getFloodlightActivityGroupName
```
public 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(String floodlightActivityGroupName)
```
    Name of the associated floodlight activity group. This is a read-only field.
    
    Parameters:
    
    floodlightActivityGroupName - floodlightActivityGroupName or null for none
  - getFloodlightActivityGroupTagString
```
public 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(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 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(String floodlightActivityGroupType)
```
    Type of the associated floodlight activity group. This is a read-only field.
    
    Parameters:
    
    floodlightActivityGroupType - floodlightActivityGroupType or null for none
  - getFloodlightConfigurationId
```
public 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(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 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(String floodlightTagType)
```
    The type of Floodlight tag this activity will generate. This is a required field.
    
    Parameters:
    
    floodlightTagType - floodlightTagType or null for none
  - getId
```
public 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(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 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(String kind)
```
    Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public 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(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 String getNotes()
```
    General notes or implementation instructions for the tag.
    
    Returns:
    
    value or null for none
  - setNotes
```
public FloodlightActivity setNotes(String notes)
```
    General notes or implementation instructions for the tag.
    
    Parameters:
    
    notes - notes or null for none
  - getPublisherTags
```
public List<FloodlightActivityPublisherDynamicTag> getPublisherTags()
```
    Publisher dynamic floodlight tags.
    
    Returns:
    
    value or null for none
  - setPublisherTags
```
public FloodlightActivity setPublisherTags(List<FloodlightActivityPublisherDynamicTag> publisherTags)
```
    Publisher dynamic floodlight tags.
    
    Parameters:
    
    publisherTags - publisherTags or null for none
  - getSecure
```
public Boolean getSecure()
```
    Whether this tag should use SSL.
    
    Returns:
    
    value or null for none
  - setSecure
```
public FloodlightActivity setSecure(Boolean secure)
```
    Whether this tag should use SSL.
    
    Parameters:
    
    secure - secure or null for none
  - getSslCompliant
```
public 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(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 Boolean getSslRequired()
```
    Whether this floodlight activity must be SSL-compliant.
    
    Returns:
    
    value or null for none
  - setSslRequired
```
public FloodlightActivity setSslRequired(Boolean sslRequired)
```
    Whether this floodlight activity must be SSL-compliant.
    
    Parameters:
    
    sslRequired - sslRequired or null for none
  - getStatus
```
public String getStatus()
```
    The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
    
    Returns:
    
    value or null for none
  - setStatus
```
public FloodlightActivity setStatus(String status)
```
    The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
    
    Parameters:
    
    status - status or null for none
  - getSubaccountId
```
public 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(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 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(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 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-z0-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(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-z0-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 List<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(List<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(String fieldName,
                              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

Class FloodlightActivity

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

FloodlightActivity

Method Detail

getAccountId

setAccountId

getAdvertiserId

setAdvertiserId

getAdvertiserIdDimensionValue

setAdvertiserIdDimensionValue

getAttributionEnabled

setAttributionEnabled

getCacheBustingType

setCacheBustingType

getCountingMethod

setCountingMethod

getDefaultTags

setDefaultTags

getExpectedUrl

setExpectedUrl

getFloodlightActivityGroupId

setFloodlightActivityGroupId

getFloodlightActivityGroupName

setFloodlightActivityGroupName

getFloodlightActivityGroupTagString

setFloodlightActivityGroupTagString

getFloodlightActivityGroupType

setFloodlightActivityGroupType

getFloodlightConfigurationId

setFloodlightConfigurationId

getFloodlightConfigurationIdDimensionValue

setFloodlightConfigurationIdDimensionValue

getFloodlightTagType

setFloodlightTagType

getId

setId

getIdDimensionValue

setIdDimensionValue

getKind

setKind

getName

setName

getNotes

setNotes

getPublisherTags

setPublisherTags

getSecure

setSecure

getSslCompliant

setSslCompliant

getSslRequired

setSslRequired

getStatus

setStatus

getSubaccountId

setSubaccountId

getTagFormat

setTagFormat

getTagString

setTagString

getUserDefinedVariableTypes

setUserDefinedVariableTypes

set

clone