GOgoogle
creatives

GET /userprofiles/{userprofilesId}/creatives

Retrieves a list of creatives, possibly filtered. This method supports paging.

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Query parameters

activeboolean

Select only active creatives. Leave blank to select active and inactive creatives.

advertiserIdstring int64

Select only creatives with this advertiser ID.

archivedboolean

Select only archived creatives. Leave blank to select archived and unarchived creatives.

campaignIdstring int64

Select only creatives with this campaign ID.

companionCreativeIdsstring[]

Select only in-stream video creatives with these companion IDs.

creativeFieldIdsstring[]

Select only creatives with these creative field IDs.

idsstring[]

Select only creatives with these IDs.

maxResultsinteger

Maximum number of results to return.

pageTokenstring

Value of the nextPageToken from the previous result page.

renderingIdsstring[]

Select only creatives with these rendering IDs.

searchStringstring

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "creative2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".

sizeIdsstring[]

Select only creatives with these size IDs.

sortField'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

studioCreativeIdstring int64

Select only creatives corresponding to this Studio creative ID.

typesstring[]

Select only creatives with these creative types.

Response

Successful response

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".

nextPageTokenstring

Pagination token to be used for the next list operation.

Changes

No recorded changes to this operation across all 5 revisions of this API.