Insert
|
|||||
|
|
||||
Inserts a new floodlight activity
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 65 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
accountId |
INTEGER |
Account ID of this floodlight activity. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
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 |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertiserIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
cacheBustingType |
ENUMERATION |
Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING |
countingMethod |
ENUMERATION |
Counting method for conversions for this floodlight activity. This is a required field |
defaultTags[] |
OBJECT |
Dynamic Tag |
defaultTags[].id |
INTEGER |
ID of this dynamic tag. This is a read-only, auto-generated field |
defaultTags[].name |
STRING |
Name of this tag |
defaultTags[].tag |
STRING |
Tag code |
expectedUrl |
STRING |
URL where this tag will be deployed. If specified, must be less than 256 characters long |
floodlightActivityGroupId |
INTEGER |
Floodlight activity group ID of this floodlight activity. This is a required field |
floodlightActivityGroupName |
STRING |
Name of the associated floodlight activity group. This is a read-only field |
floodlightActivityGroupTagString |
STRING |
Tag string of the associated floodlight activity group. This is a read-only field |
floodlightActivityGroupType |
ENUMERATION |
Type of the associated floodlight activity group. This is a read-only field |
floodlightConfigurationId |
INTEGER |
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 |
floodlightConfigurationIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
floodlightConfigurationIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
floodlightConfigurationIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
floodlightConfigurationIdDimensionValue.id |
STRING |
The ID associated with the value if available |
floodlightConfigurationIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
floodlightConfigurationIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
floodlightConfigurationIdDimensionValue.value |
STRING |
The value of the dimension |
floodlightTagType |
ENUMERATION |
The type of Floodlight tag this activity will generate. This is a required field |
hidden |
BOOLEAN |
Whether this activity is archived |
id |
INTEGER |
ID of this floodlight activity. This is a read-only, auto-generated field |
idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
idDimensionValue.dimensionName |
STRING |
The name of the dimension |
idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
idDimensionValue.id |
STRING |
The ID associated with the value if available |
idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
idDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
idDimensionValue.value |
STRING |
The value of the dimension |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity" |
name |
STRING |
Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes |
notes |
STRING |
General notes or implementation instructions for the tag |
publisherTags[] |
OBJECT |
Publisher Dynamic Tag |
publisherTags[].clickThrough |
BOOLEAN |
Whether this tag is applicable only for click-throughs |
publisherTags[].directorySiteId |
INTEGER |
Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated |
publisherTags[].dynamicTag |
OBJECT |
Dynamic Tag |
publisherTags[].dynamicTag.id |
INTEGER |
ID of this dynamic tag. This is a read-only, auto-generated field |
publisherTags[].dynamicTag.name |
STRING |
Name of this tag |
publisherTags[].dynamicTag.tag |
STRING |
Tag code |
publisherTags[].siteId |
INTEGER |
Site ID of this dynamic tag |
publisherTags[].siteIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
publisherTags[].siteIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
publisherTags[].siteIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
publisherTags[].siteIdDimensionValue.id |
STRING |
The ID associated with the value if available |
publisherTags[].siteIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
publisherTags[].siteIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
publisherTags[].siteIdDimensionValue.value |
STRING |
The value of the dimension |
publisherTags[].viewThrough |
BOOLEAN |
Whether this tag is applicable only for view-throughs |
secure |
BOOLEAN |
Whether this tag should use SSL |
sslCompliant |
BOOLEAN |
Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags |
sslRequired |
BOOLEAN |
Whether this floodlight activity must be SSL-compliant |
subaccountId |
INTEGER |
Subaccount ID of this floodlight activity. This is a read-only field that can be left blank |
tagFormat |
ENUMERATION |
Tag format type for the floodlight activity. If left blank, the tag format will default to HTML |
tagString |
STRING |
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 |
userDefinedVariableTypes[] |
ENUMERATION |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
accountId INTEGER Account ID of this floodlight activity. This is a read-only field that can be left blank |
|
advertiserId INTEGER 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 |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
advertiserIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
cacheBustingType ENUMERATION Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING |
|
countingMethod ENUMERATION Counting method for conversions for this floodlight activity. This is a required field |
|
defaultTags[] OBJECT Dynamic Tag |
|
defaultTags[].id INTEGER ID of this dynamic tag. This is a read-only, auto-generated field |
|
defaultTags[].name STRING Name of this tag |
|
defaultTags[].tag STRING Tag code |
|
expectedUrl STRING URL where this tag will be deployed. If specified, must be less than 256 characters long |
|
floodlightActivityGroupId INTEGER Floodlight activity group ID of this floodlight activity. This is a required field |
|
floodlightActivityGroupName STRING Name of the associated floodlight activity group. This is a read-only field |
|
floodlightActivityGroupTagString STRING Tag string of the associated floodlight activity group. This is a read-only field |
|
floodlightActivityGroupType ENUMERATION Type of the associated floodlight activity group. This is a read-only field |
|
floodlightConfigurationId INTEGER 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 |
|
floodlightConfigurationIdDimensionValue OBJECT Represents a DimensionValue resource |
|
floodlightConfigurationIdDimensionValue.dimensionName STRING The name of the dimension |
|
floodlightConfigurationIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
floodlightConfigurationIdDimensionValue.id STRING The ID associated with the value if available |
|
floodlightConfigurationIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
floodlightConfigurationIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
floodlightConfigurationIdDimensionValue.value STRING The value of the dimension |
|
floodlightTagType ENUMERATION The type of Floodlight tag this activity will generate. This is a required field |
|
hidden BOOLEAN Whether this activity is archived |
|
id INTEGER ID of this floodlight activity. This is a read-only, auto-generated field |
|
idDimensionValue OBJECT Represents a DimensionValue resource |
|
idDimensionValue.dimensionName STRING The name of the dimension |
|
idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
idDimensionValue.id STRING The ID associated with the value if available |
|
idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
idDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
idDimensionValue.value STRING The value of the dimension |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity" |
|
name STRING Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes |
|
notes STRING General notes or implementation instructions for the tag |
|
publisherTags[] OBJECT Publisher Dynamic Tag |
|
publisherTags[].clickThrough BOOLEAN Whether this tag is applicable only for click-throughs |
|
publisherTags[].directorySiteId INTEGER Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated |
|
publisherTags[].dynamicTag OBJECT Dynamic Tag |
|
publisherTags[].dynamicTag.id INTEGER ID of this dynamic tag. This is a read-only, auto-generated field |
|
publisherTags[].dynamicTag.name STRING Name of this tag |
|
publisherTags[].dynamicTag.tag STRING Tag code |
|
publisherTags[].siteId INTEGER Site ID of this dynamic tag |
|
publisherTags[].siteIdDimensionValue OBJECT Represents a DimensionValue resource |
|
publisherTags[].siteIdDimensionValue.dimensionName STRING The name of the dimension |
|
publisherTags[].siteIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
publisherTags[].siteIdDimensionValue.id STRING The ID associated with the value if available |
|
publisherTags[].siteIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
publisherTags[].siteIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
publisherTags[].siteIdDimensionValue.value STRING The value of the dimension |
|
publisherTags[].viewThrough BOOLEAN Whether this tag is applicable only for view-throughs |
|
secure BOOLEAN Whether this tag should use SSL |
|
sslCompliant BOOLEAN Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags |
|
sslRequired BOOLEAN Whether this floodlight activity must be SSL-compliant |
|
subaccountId INTEGER Subaccount ID of this floodlight activity. This is a read-only field that can be left blank |
|
tagFormat ENUMERATION Tag format type for the floodlight activity. If left blank, the tag format will default to HTML |
|
tagString STRING 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 |
|
userDefinedVariableTypes[] ENUMERATION |
Output
This building block provides 64 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this floodlight activity. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
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 |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertiserIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
cacheBustingType |
ENUMERATION |
Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING |
countingMethod |
ENUMERATION |
Counting method for conversions for this floodlight activity. This is a required field |
defaultTags[] |
OBJECT |
Dynamic Tag |
defaultTags[].id |
INTEGER |
ID of this dynamic tag. This is a read-only, auto-generated field |
defaultTags[].name |
STRING |
Name of this tag |
defaultTags[].tag |
STRING |
Tag code |
expectedUrl |
STRING |
URL where this tag will be deployed. If specified, must be less than 256 characters long |
floodlightActivityGroupId |
INTEGER |
Floodlight activity group ID of this floodlight activity. This is a required field |
floodlightActivityGroupName |
STRING |
Name of the associated floodlight activity group. This is a read-only field |
floodlightActivityGroupTagString |
STRING |
Tag string of the associated floodlight activity group. This is a read-only field |
floodlightActivityGroupType |
ENUMERATION |
Type of the associated floodlight activity group. This is a read-only field |
floodlightConfigurationId |
INTEGER |
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 |
floodlightConfigurationIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
floodlightConfigurationIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
floodlightConfigurationIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
floodlightConfigurationIdDimensionValue.id |
STRING |
The ID associated with the value if available |
floodlightConfigurationIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
floodlightConfigurationIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
floodlightConfigurationIdDimensionValue.value |
STRING |
The value of the dimension |
floodlightTagType |
ENUMERATION |
The type of Floodlight tag this activity will generate. This is a required field |
hidden |
BOOLEAN |
Whether this activity is archived |
id |
INTEGER |
ID of this floodlight activity. This is a read-only, auto-generated field |
idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
idDimensionValue.dimensionName |
STRING |
The name of the dimension |
idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
idDimensionValue.id |
STRING |
The ID associated with the value if available |
idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
idDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
idDimensionValue.value |
STRING |
The value of the dimension |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity" |
name |
STRING |
Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes |
notes |
STRING |
General notes or implementation instructions for the tag |
publisherTags[] |
OBJECT |
Publisher Dynamic Tag |
publisherTags[].clickThrough |
BOOLEAN |
Whether this tag is applicable only for click-throughs |
publisherTags[].directorySiteId |
INTEGER |
Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated |
publisherTags[].dynamicTag |
OBJECT |
Dynamic Tag |
publisherTags[].dynamicTag.id |
INTEGER |
ID of this dynamic tag. This is a read-only, auto-generated field |
publisherTags[].dynamicTag.name |
STRING |
Name of this tag |
publisherTags[].dynamicTag.tag |
STRING |
Tag code |
publisherTags[].siteId |
INTEGER |
Site ID of this dynamic tag |
publisherTags[].siteIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
publisherTags[].siteIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
publisherTags[].siteIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
publisherTags[].siteIdDimensionValue.id |
STRING |
The ID associated with the value if available |
publisherTags[].siteIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
publisherTags[].siteIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
publisherTags[].siteIdDimensionValue.value |
STRING |
The value of the dimension |
publisherTags[].viewThrough |
BOOLEAN |
Whether this tag is applicable only for view-throughs |
secure |
BOOLEAN |
Whether this tag should use SSL |
sslCompliant |
BOOLEAN |
Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags |
sslRequired |
BOOLEAN |
Whether this floodlight activity must be SSL-compliant |
subaccountId |
INTEGER |
Subaccount ID of this floodlight activity. This is a read-only field that can be left blank |
tagFormat |
ENUMERATION |
Tag format type for the floodlight activity. If left blank, the tag format will default to HTML |
tagString |
STRING |
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 |
userDefinedVariableTypes[] |
ENUMERATION |
= Parameter name
= Format
|
accountId INTEGER Account ID of this floodlight activity. This is a read-only field that can be left blank |
|
advertiserId INTEGER 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 |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
advertiserIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
cacheBustingType ENUMERATION Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING |
|
countingMethod ENUMERATION Counting method for conversions for this floodlight activity. This is a required field |
|
defaultTags[] OBJECT Dynamic Tag |
|
defaultTags[].id INTEGER ID of this dynamic tag. This is a read-only, auto-generated field |
|
defaultTags[].name STRING Name of this tag |
|
defaultTags[].tag STRING Tag code |
|
expectedUrl STRING URL where this tag will be deployed. If specified, must be less than 256 characters long |
|
floodlightActivityGroupId INTEGER Floodlight activity group ID of this floodlight activity. This is a required field |
|
floodlightActivityGroupName STRING Name of the associated floodlight activity group. This is a read-only field |
|
floodlightActivityGroupTagString STRING Tag string of the associated floodlight activity group. This is a read-only field |
|
floodlightActivityGroupType ENUMERATION Type of the associated floodlight activity group. This is a read-only field |
|
floodlightConfigurationId INTEGER 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 |
|
floodlightConfigurationIdDimensionValue OBJECT Represents a DimensionValue resource |
|
floodlightConfigurationIdDimensionValue.dimensionName STRING The name of the dimension |
|
floodlightConfigurationIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
floodlightConfigurationIdDimensionValue.id STRING The ID associated with the value if available |
|
floodlightConfigurationIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
floodlightConfigurationIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
floodlightConfigurationIdDimensionValue.value STRING The value of the dimension |
|
floodlightTagType ENUMERATION The type of Floodlight tag this activity will generate. This is a required field |
|
hidden BOOLEAN Whether this activity is archived |
|
id INTEGER ID of this floodlight activity. This is a read-only, auto-generated field |
|
idDimensionValue OBJECT Represents a DimensionValue resource |
|
idDimensionValue.dimensionName STRING The name of the dimension |
|
idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
idDimensionValue.id STRING The ID associated with the value if available |
|
idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
idDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
idDimensionValue.value STRING The value of the dimension |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity" |
|
name STRING Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes |
|
notes STRING General notes or implementation instructions for the tag |
|
publisherTags[] OBJECT Publisher Dynamic Tag |
|
publisherTags[].clickThrough BOOLEAN Whether this tag is applicable only for click-throughs |
|
publisherTags[].directorySiteId INTEGER Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated |
|
publisherTags[].dynamicTag OBJECT Dynamic Tag |
|
publisherTags[].dynamicTag.id INTEGER ID of this dynamic tag. This is a read-only, auto-generated field |
|
publisherTags[].dynamicTag.name STRING Name of this tag |
|
publisherTags[].dynamicTag.tag STRING Tag code |
|
publisherTags[].siteId INTEGER Site ID of this dynamic tag |
|
publisherTags[].siteIdDimensionValue OBJECT Represents a DimensionValue resource |
|
publisherTags[].siteIdDimensionValue.dimensionName STRING The name of the dimension |
|
publisherTags[].siteIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
publisherTags[].siteIdDimensionValue.id STRING The ID associated with the value if available |
|
publisherTags[].siteIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
publisherTags[].siteIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
publisherTags[].siteIdDimensionValue.value STRING The value of the dimension |
|
publisherTags[].viewThrough BOOLEAN Whether this tag is applicable only for view-throughs |
|
secure BOOLEAN Whether this tag should use SSL |
|
sslCompliant BOOLEAN Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags |
|
sslRequired BOOLEAN Whether this floodlight activity must be SSL-compliant |
|
subaccountId INTEGER Subaccount ID of this floodlight activity. This is a read-only field that can be left blank |
|
tagFormat ENUMERATION Tag format type for the floodlight activity. If left blank, the tag format will default to HTML |
|
tagString STRING 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 |
|
userDefinedVariableTypes[] ENUMERATION |