Update
|
|||||
|
|
||||
Updates an existing floodlight activity group
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 31 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
accountId |
INTEGER |
Account ID of this floodlight activity group. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group'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 |
floodlightConfigurationId |
INTEGER |
Floodlight configuration ID of this floodlight activity group. This is a required field |
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 |
id |
INTEGER |
ID of this floodlight activity group. 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#floodlightActivityGroup" |
name |
STRING |
Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes |
subaccountId |
INTEGER |
Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank |
tagString |
STRING |
Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. 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 activity groups of the same floodlight configuration. This field is read-only after insertion |
type |
ENUMERATION |
Type of the floodlight activity group. This is a required field that is read-only after insertion |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
accountId INTEGER Account ID of this floodlight activity group. This is a read-only field that can be left blank |
|
advertiserId INTEGER Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group'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 |
|
floodlightConfigurationId INTEGER Floodlight configuration ID of this floodlight activity group. This is a required field |
|
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 |
|
id INTEGER ID of this floodlight activity group. 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#floodlightActivityGroup" |
|
name STRING Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes |
|
subaccountId INTEGER Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank |
|
tagString STRING Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. 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 activity groups of the same floodlight configuration. This field is read-only after insertion |
|
type ENUMERATION Type of the floodlight activity group. This is a required field that is read-only after insertion |
Output
This building block provides 30 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this floodlight activity group. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group'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 |
floodlightConfigurationId |
INTEGER |
Floodlight configuration ID of this floodlight activity group. This is a required field |
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 |
id |
INTEGER |
ID of this floodlight activity group. 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#floodlightActivityGroup" |
name |
STRING |
Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes |
subaccountId |
INTEGER |
Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank |
tagString |
STRING |
Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. 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 activity groups of the same floodlight configuration. This field is read-only after insertion |
type |
ENUMERATION |
Type of the floodlight activity group. This is a required field that is read-only after insertion |
= Parameter name
= Format
|
accountId INTEGER Account ID of this floodlight activity group. This is a read-only field that can be left blank |
|
advertiserId INTEGER Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group'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 |
|
floodlightConfigurationId INTEGER Floodlight configuration ID of this floodlight activity group. This is a required field |
|
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 |
|
id INTEGER ID of this floodlight activity group. 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#floodlightActivityGroup" |
|
name STRING Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes |
|
subaccountId INTEGER Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank |
|
tagString STRING Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. 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 activity groups of the same floodlight configuration. This field is read-only after insertion |
|
type ENUMERATION Type of the floodlight activity group. This is a required field that is read-only after insertion |