Patch
|
|||||
|
|
||||
Updates an existing creative field. 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 15 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
id Required |
INTEGER |
Creative Field ID |
accountId |
INTEGER |
Account ID of this creative field. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
Advertiser ID of this creative field. This is a required field 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 |
id |
INTEGER |
ID of this creative field. This is a read-only, auto-generated field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField" |
name |
STRING |
Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser |
subaccountId |
INTEGER |
Subaccount ID of this creative field. This is a read-only field that can be left blank |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
id INTEGER Required Creative Field ID |
|
accountId INTEGER Account ID of this creative field. This is a read-only field that can be left blank |
|
advertiserId INTEGER Advertiser ID of this creative field. This is a required field 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 |
|
id INTEGER ID of this creative field. This is a read-only, auto-generated field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField" |
|
name STRING Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser |
|
subaccountId INTEGER Subaccount ID of this creative field. This is a read-only field that can be left blank |
Output
This building block provides 13 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this creative field. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
Advertiser ID of this creative field. This is a required field 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 |
id |
INTEGER |
ID of this creative field. This is a read-only, auto-generated field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField" |
name |
STRING |
Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser |
subaccountId |
INTEGER |
Subaccount ID of this creative field. This is a read-only field that can be left blank |
= Parameter name
= Format
|
accountId INTEGER Account ID of this creative field. This is a read-only field that can be left blank |
|
advertiserId INTEGER Advertiser ID of this creative field. This is a required field 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 |
|
id INTEGER ID of this creative field. This is a read-only, auto-generated field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField" |
|
name STRING Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser |
|
subaccountId INTEGER Subaccount ID of this creative field. This is a read-only field that can be left blank |