Method: creativeFieldValues.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of creative field values, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
creativeFieldId |
string (int64 format)
Creative field ID for this creative field value.
|
Query parameters
Parameters |
maxResults |
integer
Maximum number of results to return.
|
searchString |
string
Allows searching for creative field values by their values. Wildcards (e.g.
*
) are not allowed.
|
ids[] |
string (int64 format)
Select only creative field values with these IDs.
|
pageToken |
string
Value of the
nextPageToken
from the previous result page.
|
sortField |
enum (SortField )
Field by which to sort the list.
|
sortOrder |
enum (SortOrder )
Order of sorted results.
|
Request body
The request body must be empty.
Response body
Creative Field Value creativeFieldValues.list Response
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"nextPageToken": string,
"creativeFieldValues": [
{
object (CreativeFieldValue )
}
]
} |
Fields |
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.
|
creativeFieldValues[] |
object (CreativeFieldValue )
Creative field value collection.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a paginated list of creative field values, filtered by optional parameters like search string and IDs.\u003c/p\u003e\n"],["\u003cp\u003eAllows sorting the results by ID or value, and specifying the sort order.\u003c/p\u003e\n"],["\u003cp\u003eRequest is made via HTTP GET to a specific endpoint with profile ID and creative field ID as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of creative field values and a pagination token for retrieving further results.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003edfatrafficking\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: creativeFieldValues.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CreativeFieldValuesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [SortField](#SortField)\n- [Try it!](#try-it)\n\nRetrieves a list of creative field values, possibly filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n| `creative``Field``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Creative field ID for this creative field value. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `max``Results` | `integer` Maximum number of results to return. |\n| `search``String` | `string` Allows searching for creative field values by their values. Wildcards (e.g. `*` ) are not allowed. |\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only creative field values with these IDs. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/creativeFieldValues/list#SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nCreative Field Value creativeFieldValues.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"creativeFieldValues\": [ { object (/doubleclick-advertisers/rest/v4/creativeFieldValues#CreativeFieldValue) } ] } ``` |\n\n| Fields ||\n|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#creativeFieldValuesListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `creative``Field``Values[]` | `object (`[CreativeFieldValue](/doubleclick-advertisers/rest/v4/creativeFieldValues#CreativeFieldValue)`)` Creative field value collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`\n\nSortField\n---------\n\n| Enums ||\n|---------|---|\n| `ID` | |\n| `VALUE` | |"]]