List
|
|||||
|
|
||||
Retrieves a list of creative field values, possibly filtered. This method supports paging
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 8 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
creativeFieldId Required |
INTEGER |
Creative field ID for this creative field value |
ids |
INTEGER |
Select only creative field values with these IDs |
maxResults |
INTEGER |
Maximum number of results to return |
pageToken |
STRING |
Value of the nextPageToken from the previous result page |
searchString |
STRING |
Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed |
sortField |
ENUMERATION |
Field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
creativeFieldId INTEGER Required Creative field ID for this creative field value |
|
ids INTEGER Select only creative field values with these IDs |
|
maxResults INTEGER Maximum number of results to return |
|
pageToken STRING Value of the nextPageToken from the previous result page |
|
searchString STRING Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed |
|
sortField ENUMERATION Field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
Output
This building block provides 6 output parameters
| Name | Format | Description |
|---|---|---|
creativeFieldValues[] |
OBJECT |
Contains properties of a creative field value |
creativeFieldValues[].id |
INTEGER |
ID of this creative field value. This is a read-only, auto-generated field |
creativeFieldValues[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue" |
creativeFieldValues[].value |
STRING |
Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
= Parameter name
= Format
|
creativeFieldValues[] OBJECT Contains properties of a creative field value |
|
creativeFieldValues[].id INTEGER ID of this creative field value. This is a read-only, auto-generated field |
|
creativeFieldValues[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue" |
|
creativeFieldValues[].value STRING Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse" |
|
nextPageToken STRING Pagination token to be used for the next list operation |