Method: advertisers.campaigns.list
Stay organized with collections
Save and categorize content based on your preferences.
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/v1beta2/advertisers/{advertiserId}/campaigns
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
advertiserId |
string (int64 format)
The ID of the advertiser to list campaigns for.
|
Query parameters
Parameters |
pageSize |
integer
Requested page size. Must be between 1 and 100 . 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 properties. 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 operator used on
updateTime must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) .
- The operator must be
EQUALS (=) .
- 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.
|
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 (Campaign )
}
],
"nextPageToken": string
} |
Fields |
campaigns[] |
object (Campaign )
The list of campaigns. This list will be absent if empty.
|
nextPageToken |
string
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.
|
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.
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-09-18 UTC.
[[["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-09-18 UTC."],[[["Lists campaigns associated with a specific advertiser, excluding archived campaigns by default."],["Allows filtering and sorting of campaigns by parameters like displayName, entityStatus, and updateTime."],["Results are paginated, and a nextPageToken is provided for retrieving subsequent pages."],["Requires authorization with specific OAuth scopes for access."],["Uses a GET request with the advertiser ID as a path parameter and optional query parameters for filtering and sorting."]]],[]]