- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists campaigns in an advertiser.
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
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
advertiserId |
The ID of the advertiser to list campaigns for. |
Query parameters
Parameters | |
---|---|
pageSize |
Requested page size. Must be between |
pageToken |
A token identifying a page of results the server should return. Typically, this is the value of |
orderBy |
Field by which to sort the list. Acceptable values are:
The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: |
filter |
Allows filtering by campaign fields. Supported syntax:
Supported fields:
Examples:
The length of this field should be no more than 500 characters. Reference our filter |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"campaigns": [
{
object ( |
Fields | |
---|---|
campaigns[] |
The list of campaigns. This list will be absent if empty. |
nextPageToken |
A token to retrieve the next page of results. Pass this value in the |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning
For more information, see the OAuth 2.0 Overview.