Retrieves a list of ads, possibly filtered. This method supports paging.

Scopes

You will need authorization for the https://www.googleapis.com/auth/dfatrafficking scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/dfatrafficking. You can set the scope for this method like this: dfareporting3d4 --scope <scope> ads list ...

Required Scalar Argument

  • <profile-id> (string)
    • User profile ID associated with this request.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p active=boolean

    • Select only active ads.

  • -p advertiser-id=string

    • Select only ads with this advertiser ID.

  • -p archived=boolean

    • Select only archived ads.

  • -p audience-segment-ids=string

    • Select only ads with these audience segment IDs.

  • -p campaign-ids=string

    • Select only ads with these campaign IDs.

  • -p compatibility=string

    • 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.

  • -p creative-ids=string

    • Select only ads with these creative IDs assigned.

  • -p creative-optimization-configuration-ids=string

    • Select only ads with these creative optimization configuration IDs.

  • -p dynamic-click-tracker=boolean

    • 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.

  • -p ids=string

    • Select only ads with these IDs.

  • -p landing-page-ids=string

    • Select only ads with these landing page IDs.

  • -p max-results=integer

    • Maximum number of results to return.

  • -p overridden-event-tag-id=string

    • Select only ads with this event tag override ID.

  • -p page-token=string

    • Value of the nextPageToken from the previous result page.

  • -p placement-ids=string

    • Select only ads with these placement IDs assigned.

  • -p remarketing-list-ids=string

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

  • -p search-string=string

    • 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".

  • -p size-ids=string

    • Select only ads with these size IDs.

  • -p sort-field=string

    • Field by which to sort the list.

  • -p sort-order=string

    • Order of sorted results.

  • -p ssl-compliant=boolean

    • Select only ads that are SSL-compliant.

  • -p ssl-required=boolean

    • Select only ads that require SSL.

  • -p type=string

    • Select only ads with these types.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").