Patch
|
|||||
|
|
||||
Updates an existing event tag. This method supports patch semantics
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 32 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
id Required |
INTEGER |
Event tag ID |
accountId |
INTEGER |
Account ID of this event tag. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
Advertiser ID of this event tag. This field or the campaignId field is required on insertion |
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 |
campaignId |
INTEGER |
Campaign ID of this event tag. This field or the advertiserId field is required on insertion |
campaignIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
campaignIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
campaignIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
campaignIdDimensionValue.id |
STRING |
The ID associated with the value if available |
campaignIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
campaignIdDimensionValue.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 |
campaignIdDimensionValue.value |
STRING |
The value of the dimension |
enabledByDefault |
BOOLEAN |
Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads |
excludeFromAdxRequests |
BOOLEAN |
Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network |
id |
INTEGER |
ID of this event tag. This is a read-only, auto-generated field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag" |
name |
STRING |
Name of this event tag. This is a required field and must be less than 256 characters long |
siteFilterType |
ENUMERATION |
Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites |
siteIds[] |
INTEGER |
|
sslCompliant |
BOOLEAN |
Whether this tag is SSL-compliant or not. This is a read-only field |
status |
ENUMERATION |
Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field |
subaccountId |
INTEGER |
Subaccount ID of this event tag. This is a read-only field that can be left blank |
type |
ENUMERATION |
Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field |
url |
STRING |
Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion |
urlEscapeLevels |
INTEGER |
Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
id INTEGER Required Event tag ID |
|
accountId INTEGER Account ID of this event tag. This is a read-only field that can be left blank |
|
advertiserId INTEGER Advertiser ID of this event tag. This field or the campaignId field is required on insertion |
|
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 |
|
campaignId INTEGER Campaign ID of this event tag. This field or the advertiserId field is required on insertion |
|
campaignIdDimensionValue OBJECT Represents a DimensionValue resource |
|
campaignIdDimensionValue.dimensionName STRING The name of the dimension |
|
campaignIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
campaignIdDimensionValue.id STRING The ID associated with the value if available |
|
campaignIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
campaignIdDimensionValue.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 |
|
campaignIdDimensionValue.value STRING The value of the dimension |
|
enabledByDefault BOOLEAN Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads |
|
excludeFromAdxRequests BOOLEAN Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network |
|
id INTEGER ID of this event tag. This is a read-only, auto-generated field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag" |
|
name STRING Name of this event tag. This is a required field and must be less than 256 characters long |
|
siteFilterType ENUMERATION Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites |
|
siteIds[] INTEGER |
|
sslCompliant BOOLEAN Whether this tag is SSL-compliant or not. This is a read-only field |
|
status ENUMERATION Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field |
|
subaccountId INTEGER Subaccount ID of this event tag. This is a read-only field that can be left blank |
|
type ENUMERATION Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field |
|
url STRING Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion |
|
urlEscapeLevels INTEGER Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type |
Output
This building block provides 30 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this event tag. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
Advertiser ID of this event tag. This field or the campaignId field is required on insertion |
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 |
campaignId |
INTEGER |
Campaign ID of this event tag. This field or the advertiserId field is required on insertion |
campaignIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
campaignIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
campaignIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
campaignIdDimensionValue.id |
STRING |
The ID associated with the value if available |
campaignIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
campaignIdDimensionValue.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 |
campaignIdDimensionValue.value |
STRING |
The value of the dimension |
enabledByDefault |
BOOLEAN |
Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads |
excludeFromAdxRequests |
BOOLEAN |
Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network |
id |
INTEGER |
ID of this event tag. This is a read-only, auto-generated field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag" |
name |
STRING |
Name of this event tag. This is a required field and must be less than 256 characters long |
siteFilterType |
ENUMERATION |
Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites |
siteIds[] |
INTEGER |
|
sslCompliant |
BOOLEAN |
Whether this tag is SSL-compliant or not. This is a read-only field |
status |
ENUMERATION |
Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field |
subaccountId |
INTEGER |
Subaccount ID of this event tag. This is a read-only field that can be left blank |
type |
ENUMERATION |
Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field |
url |
STRING |
Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion |
urlEscapeLevels |
INTEGER |
Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type |
= Parameter name
= Format
|
accountId INTEGER Account ID of this event tag. This is a read-only field that can be left blank |
|
advertiserId INTEGER Advertiser ID of this event tag. This field or the campaignId field is required on insertion |
|
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 |
|
campaignId INTEGER Campaign ID of this event tag. This field or the advertiserId field is required on insertion |
|
campaignIdDimensionValue OBJECT Represents a DimensionValue resource |
|
campaignIdDimensionValue.dimensionName STRING The name of the dimension |
|
campaignIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
campaignIdDimensionValue.id STRING The ID associated with the value if available |
|
campaignIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
campaignIdDimensionValue.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 |
|
campaignIdDimensionValue.value STRING The value of the dimension |
|
enabledByDefault BOOLEAN Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads |
|
excludeFromAdxRequests BOOLEAN Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network |
|
id INTEGER ID of this event tag. This is a read-only, auto-generated field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag" |
|
name STRING Name of this event tag. This is a required field and must be less than 256 characters long |
|
siteFilterType ENUMERATION Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites |
|
siteIds[] INTEGER |
|
sslCompliant BOOLEAN Whether this tag is SSL-compliant or not. This is a read-only field |
|
status ENUMERATION Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field |
|
subaccountId INTEGER Subaccount ID of this event tag. This is a read-only field that can be left blank |
|
type ENUMERATION Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field |
|
url STRING Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion |
|
urlEscapeLevels INTEGER Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type |