Method: campaigns.list

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

    HTTP request

    GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/campaigns

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    profileId

    string ( int64 format)

    User profile ID associated with this request.

    Query parameters

    Parameters
    ids[]

    string ( int64 format)

    Select only campaigns with these IDs.
    advertiserIds[]

    string ( int64 format)

    Select only campaigns that belong to these advertisers.
    advertiserGroupIds[]

    string ( int64 format)

    Select only campaigns whose advertisers belong to these advertiser groups.
    archived

    boolean

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

    string ( int64 format)

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

    string ( int64 format)

    Select only campaigns that belong to this subaccount.
    atLeastOneOptimizationActivity

    boolean

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

    string

    Allows searching for campaigns by name or ID. Wildcards (

    *

    ) are allowed. For example,

    "campaign*2015"

    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"

    .
    excludedIds[]

    string ( int64 format)

    Exclude campaigns with these IDs.
    maxResults

    integer

    Maximum number of results to return.
    pageToken

    string

    Value of the

    nextPageToken

    from the previous result page.
    sortField

    enum ( SortField )

    Field by which to sort the list.
    sortOrder

    enum ( SortOrder )

    Order of sorted results.

    Request body

    The request body must be empty.

    Response body

    Campaign campaigns.list Response

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "campaigns" 
 : 
 [ 
 { 
 object (  Campaign 
 
) 
 } 
 ] 
 }
    Fields
    kind

    string

    Identifies what kind of resource this is. Value: the fixed string

    "dfareporting#campaignsListResponse"

    .
    nextPageToken

    string

    Pagination token to be used for the next list operation.
    campaigns[]

    object ( Campaign )

    Campaign collection.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/dfatrafficking
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: