- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Retrieves a list of creatives, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/creatives
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profileId |
User profile ID associated with this request. |
Query parameters
Parameters | |
---|---|
ids[] |
Select only creatives with these IDs. |
searchString |
Allows searching for objects by name or ID. Wildcards (
) are allowed. For example,
will return objects with names like
,
, or simply
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
will match objects with name
,
, or simply
. |
active |
Select only active creatives. Leave blank to select active and inactive creatives. |
archived |
Select only archived creatives. Leave blank to select archived and unarchived creatives. |
sizeIds[] |
Select only creatives with these size IDs. |
types[] |
Select only creatives with these creative types. |
campaignId |
Select only creatives with this campaign ID. |
studioCreativeId |
Select only creatives corresponding to this Studio creative ID. |
creativeFieldIds[] |
Select only creatives with these creative field IDs. |
renderingIds[] |
Select only creatives with these rendering IDs. |
companionCreativeIds[] |
Select only in-stream video creatives with these companion IDs. |
advertiserId |
Select only creatives with this advertiser ID. |
maxResults |
Maximum number of results to return. |
pageToken |
Value of the
from the previous result page. |
sortField |
Field by which to sort the list. |
sortOrder |
Order of sorted results. |
Request body
The request body must be empty.
Response body
Creative creatives.list Response
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"kind": string,
"nextPageToken": string,
"creatives": [
{
object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
nextPageToken |
Pagination token to be used for the next list operation. |
creatives[] |
Creative collection. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking