- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Retrieves a list of ads, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/ads
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profileId |
User profile ID associated with this request. |
Query parameters
Parameters | |
---|---|
ids[] |
Select only ads with these IDs. |
active |
Select only active ads. |
archived |
Select only archived ads. |
campaignIds[] |
Select only ads with these campaign IDs. |
advertiserId |
Select only ads with this advertiser ID. |
type[] |
Select only ads with these types. |
dynamicClickTracker |
Select only dynamic click trackers. Applicable when
is
. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. |
compatibility |
Select default ads with the specified compatibility. Applicable when
is
.
and
refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively.
and
are for rendering in mobile apps.
refers to rendering an in-stream video ads developed with the VAST standard. |
sizeIds[] |
Select only ads with these size IDs. |
landingPageIds[] |
Select only ads with these landing page IDs. |
maxResults |
Maximum number of results to return. |
creativeIds[] |
Select only ads with these creative IDs assigned. |
placementIds[] |
Select only ads with these placement IDs assigned. |
remarketingListIds[] |
Select only ads whose list targeting expression use these remarketing list IDs. |
audienceSegmentIds[] |
Select only ads with these audience segment IDs. |
overriddenEventTagId |
Select only ads with this event tag override ID. |
sslRequired |
Select only ads that require SSL. |
sslCompliant |
Select only ads that are SSL-compliant. |
creativeOptimizationConfigurationIds[] |
Select only ads with these creative optimization configuration IDs. |
pageToken |
Value of the
from the previous result page. |
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
. |
sortField |
Field by which to sort the list. |
sortOrder |
Order of sorted results. |
Request body
The request body must be empty.
Response body
Ad ads.list Response
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"kind": string,
"nextPageToken": string,
"ads": [
{
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. |
ads[] |
Ad collection. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking