dfareporting.campaigns.list
GET {{baseUrl}}/userprofiles/:profileId/campaigns?advertiserGroupIds=<string>&advertiserGroupIds=<string>&advertiserIds=<string>&advertiserIds=<string>&archived=<boolean>&atLeastOneOptimizationActivity=<boolean>&excludedIds=<string>&excludedIds=<string>&ids=<string>&ids=<string>&maxResults=<integer>&overriddenEventTagId=<string>&pageToken=<string>&searchString=<string>&sortField=<string>&sortOrder=<string>&subaccountId=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Retrieves a list of campaigns, possibly filtered. This method supports paging.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
advertiserGroupIds | string | Select only campaigns whose advertisers belong to these advertiser groups. | |
advertiserGroupIds | string | Select only campaigns whose advertisers belong to these advertiser groups. | |
advertiserIds | string | Select only campaigns that belong to these advertisers. | |
advertiserIds | string | Select only campaigns that belong to these advertisers. | |
archived | string | Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. | |
atLeastOneOptimizationActivity | string | Select only campaigns that have at least one optimization activity. | |
excludedIds | string | Exclude campaigns with these IDs. | |
excludedIds | string | Exclude campaigns with these IDs. | |
ids | string | Select only campaigns with these IDs. | |
ids | string | Select only campaigns with these IDs. | |
maxResults | string | Maximum number of results to return. | |
overriddenEventTagId | string | Select only campaigns that have overridden this event tag ID. | |
pageToken | string | Value of the nextPageToken from the previous result page. | |
searchString | 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". | |
sortField | string | Field by which to sort the list. | |
sortOrder | string | Order of sorted results. | |
subaccountId | string | Select only campaigns that belong to this subaccount. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
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. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | 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. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"campaigns":[{"accountId":"reprehenderit pariatur adipisicing","adBlockingConfiguration":{"clickThroughUrl":"dolore tempor laborum voluptate cupidatat","creativeBundleId":"sint est non do enim","enabled":false,"overrideClickThroughUrl":true},"additionalCreativeOptimizationConfigurations":[{"id":"velit sed","name":"Duis id qui culpa nulla","optimizationActivitys":[{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"optimizationModel":"POST_CLICK"},{"id":"laborum veniam","name":"est","optimizationActivitys":[{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"optimizationModel":"POST_CLICK_AND_IMPRESSION"}],"advertiserGroupId":"id aliqui","advertiserId":"occaecat amet ut","advertiserIdDimensionValue":{"dimensionName":"dolor Duis","etag":"Ut","id":"nisi","kind":"Excepteur aute aliquip ex","matchType":"EXACT","value":"dolore officia ut sunt"},"archived":true,"audienceSegmentGroups":[{"audienceSegments":[{"allocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"allocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"id":"ex elit","name":"exercitation dolore"},{"audienceSegments":[{"allocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"allocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"id":"aliquip non sunt","name":"adipisicing sunt amet deserunt culpa"}],"billingInvoiceCode":"elit Excepteur do dolor irure","clickThroughUrlSuffixProperties":{"clickThroughUrlSuffix":"officia","overrideInheritedSuffix":true},"comment":"dolor aute consequat","createInfo":{"time":"deserunt nostrud et dolore"},"creativeGroupIds":["dolore eiusmod","ut occaecat officia"],"creativeOptimizationConfiguration":{"id":"Ut ad culpa","name":"E","optimizationActivitys":[{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"optimizationModel":"POST_CLICK"},"defaultClickThroughEventTagProperties":{"defaultClickThroughEventTagId":"tempor labore","overrideInheritedEventTag":false},"defaultLandingPageId":"sint id non","endDate":"1972-12-05","eventTagOverrides":[{"enabled":true,"id":"ullamco exercitation consectetur"},{"enabled":false,"id":"proident veniam tempor"}],"externalId":"esse adipisicing occaecat in","id":"dolore aliqua qui et","idDimensionValue":{"dimensionName":"occaecat sed exercitation","etag":"proident fugiat","id":"eu qui","kind":"dolor ut eu elit","matchType":"EXACT","value":"occaecat do"},"kind":"veniam","lastModifiedInfo":{"time":"minim elit aute"},"name":"Ut Excepteur ex","nielsenOcrEnabled":false,"startDate":"1996-04-30","subaccountId":"exercitation adipisicing commodo occaecat","traffickerEmails":["elit","ex pariatur"]},{"accountId":"eu ipsum dolore aliqua","adBlockingConfiguration":{"clickThroughUrl":"sint dolore","creativeBundleId":"deserunt fugiat sint aute","enabled":true,"overrideClickThroughUrl":false},"additionalCreativeOptimizationConfigurations":[{"id":"amet sint eu exercitation cillum","name":"anim minim ullamco","optimizationActivitys":[{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"optimizationModel":"VIDEO_COMPLETION"},{"id":"in pariatur","name":"qui pa","optimizationActivitys":[{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"optimizationModel":"CLICK"}],"advertiserGroupId":"in aute commodo aliquip","advertiserId":"ipsum","advertiserIdDimensionValue":{"dimensionName":"tempor et Lorem laborum","etag":"laboris consectetur Lorem ut sit","id":"in ad incididunt dolor","kind":"elit ci","matchType":"BEGINS_WITH","value":"laborum"},"archived":false,"audienceSegmentGroups":[{"audienceSegments":[{"allocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"allocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"id":"Excepteur incididunt","name":"ut labore pariatur"},{"audienceSegments":[{"allocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"allocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"id":"nulla reprehenderit esse ","name":"Ut occaecat"}],"billingInvoiceCode":"irure labore cillum reprehenderit eu","clickThroughUrlSuffixProperties":{"clickThroughUrlSuffix":"laborum officia in","overrideInheritedSuffix":false},"comment":"irure et","createInfo":{"time":"Lorem "},"creativeGroupIds":["sed quis dolore","velit"],"creativeOptimizationConfiguration":{"id":"in velit","name":"sint ullamco","optimizationActivitys":[{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"floodlightActivityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"floodlightActivityIdDimensionValue":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"weight":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"optimizationModel":"CLICK"},"defaultClickThroughEventTagProperties":{"defaultClickThroughEventTagId":"tempor elit Ut","overrideInheritedEventTag":true},"defaultLandingPageId":"culpa eu","endDate":"1945-03-01","eventTagOverrides":[{"enabled":false,"id":"fugiat ullamco proident"},{"enabled":true,"id":"ad nulla pariatur"}],"externalId":"aliquip ea labore dolore deser","id":"eu cupidatat","idDimensionValue":{"dimensionName":"adipisicing laboris sed labore eu","etag":"ad qui","id":"irure proident ex","kind":"cillum in","matchType":"EXACT","value":"et sed dolor dolore"},"kind":"ut","lastModifiedInfo":{"time":"Lorem eu non"},"name":"laboris Ut amet dolore","nielsenOcrEnabled":false,"startDate":"1996-03-26","subaccountId":"ea est incididunt","traffickerEmails":["dolor","do non velit"]}],"kind":"aliqua qui commodo","nextPageToken":"velit id amet in"}