Retrieves a list of campaigns, 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> campaigns 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 campaigns whose advertisers belong to these advertiser groups.

  • -p advertiser-ids=string

    • Select only campaigns that belong to these advertisers.

  • -p archived=boolean

    • Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.

  • -p at-least-one-optimization-activity=boolean

    • Select only campaigns that have at least one optimization activity.

  • -p excluded-ids=string

    • Exclude campaigns with these IDs.

  • -p ids=string

    • Select only campaigns with these IDs.

  • -p max-results=integer

    • Maximum number of results to return.

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

    • Select only campaigns that have overridden this event tag ID.

  • -p page-token=string

    • Value of the nextPageToken from the previous result page.

  • -p search-string=string

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

  • -p sort-field=string

    • Field by which to sort the list.

  • -p sort-order=string

    • Order of sorted results.

  • -p subaccount-id=string

    • Select only campaigns that belong to this subaccount.

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