Retrieves a list of advertisers, 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: dfareporting3d3 --scope <scope> advertisers 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 advertiser-group-ids=string

    • Select only advertisers with these advertiser group IDs.

  • -p floodlight-configuration-ids=string

    • Select only advertisers with these floodlight configuration IDs.

  • -p ids=string

    • Select only advertisers with these IDs.

  • -p include-advertisers-without-groups-only=boolean

    • Select only advertisers which do not belong to any advertiser group.

  • -p max-results=integer

    • Maximum number of results to return.

  • -p only-parent=boolean

    • Select only advertisers which use another advertiser's floodlight configuration.

  • -p page-token=string

    • Value of the nextPageToken from the previous result page.

  • -p search-string=string

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

  • -p sort-field=string

    • Field by which to sort the list.

  • -p sort-order=string

    • Order of sorted results.

  • -p status=string

    • Select only advertisers with the specified status.

  • -p subaccount-id=string

    • Select only advertisers with these subaccount IDs.

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