The order is defined by the orderBy parameter. If a filter by entityStatus is not specified, campaigns with ENTITY_STATUS_ARCHIVED will not be included in the results.
HTTP request
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns
Requested page size. Must be between 1 and 200. If unspecified will default to 100.
pageToken
string
A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to campaigns.list method. If not specified, the first page of results will be returned.
orderBy
string
Field by which to sort the list. Acceptable values are:
displayName (default)
entityStatus
updateTime
The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.
filter
string
Allows filtering by campaign fields.
Supported syntax:
Filter expressions are made up of one or more restrictions.
Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
A restriction has the form of {field} {operator} {value}.
The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators.
All other fields must use the EQUALS (=) operator.
Supported fields:
campaignId
displayName
entityStatus
updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ)
Examples:
All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED campaigns under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED")
All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z"
The length of this field should be no more than 500 characters.
A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to campaigns.list method to retrieve the next page of results.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-06 UTC."],[[["Lists campaigns within a specified advertiser, allowing for filtering and sorting."],["Retrieves paginated results, with options to control page size and navigate through pages."],["Supports filtering by campaign attributes such as ID, display name, entity status, and update time."],["Requires authorization with specific OAuth scopes for access."],["Returns a list of campaigns with details and a token for retrieving subsequent pages if available."]]],[]]