GOgoogle
ads

GET /userprofiles/{userprofilesId}/ads

Retrieves a list of ads, 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 ads.

advertiserIdstring int64

Select only ads with this advertiser ID.

archivedboolean

Select only archived ads.

audienceSegmentIdsstring[]

Select only ads with these audience segment IDs.

campaignIdsstring[]

Select only ads with these campaign IDs.

compatibility'DISPLAY' | 'DISPLAY_INTERSTITIAL' | 'APP' | 'APP_INTERSTITIAL' | 'IN_STREAM_VIDEO' | 'IN_STREAM_AUDIO'

Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.

creativeIdsstring[]

Select only ads with these creative IDs assigned.

creativeOptimizationConfigurationIdsstring[]

Select only ads with these creative optimization configuration IDs.

dynamicClickTrackerboolean

Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

idsstring[]

Select only ads with these IDs.

landingPageIdsstring[]

Select only ads with these landing page IDs.

maxResultsinteger

Maximum number of results to return.

overriddenEventTagIdstring int64

Select only ads with this event tag override ID.

pageTokenstring

Value of the nextPageToken from the previous result page.

placementIdsstring[]

Select only ads with these placement IDs assigned.

remarketingListIdsstring[]

Select only ads whose list targeting expression use these remarketing list IDs.

searchStringstring

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "ad2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 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 "ad" will match objects with name "my ad", "ad 2015", or simply "ad".

sizeIdsstring[]

Select only ads with these size IDs.

sortField'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

sslCompliantboolean

Select only ads that are SSL-compliant.

sslRequiredboolean

Select only ads that require SSL.

typestring[]

Select only ads with these types.

Response

Successful response

kindstring

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

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.