Qodex.ai

dfareporting.advertisers.list

GET {{baseUrl}}/userprofiles/:profileId/advertisers?advertiserGroupIds=<string>&advertiserGroupIds=<string>&floodlightConfigurationIds=<string>&floodlightConfigurationIds=<string>&ids=<string>&ids=<string>&includeAdvertisersWithoutGroupsOnly=<boolean>&maxResults=<integer>&onlyParent=<boolean>&pageToken=<string>&searchString=<string>&sortField=<string>&sortOrder=<string>&status=<string>&subaccountId=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

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

Request Params

KeyDatatypeRequiredDescription
advertiserGroupIdsstringSelect only advertisers with these advertiser group IDs.
advertiserGroupIdsstringSelect only advertisers with these advertiser group IDs.
floodlightConfigurationIdsstringSelect only advertisers with these floodlight configuration IDs.
floodlightConfigurationIdsstringSelect only advertisers with these floodlight configuration IDs.
idsstringSelect only advertisers with these IDs.
idsstringSelect only advertisers with these IDs.
includeAdvertisersWithoutGroupsOnlystringSelect only advertisers which do not belong to any advertiser group.
maxResultsstringMaximum number of results to return.
onlyParentstringSelect only advertisers which use another advertiser's floodlight configuration.
pageTokenstringValue of the nextPageToken from the previous result page.
searchStringstringAllows 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" .
sortFieldstringField by which to sort the list.
sortOrderstringOrder of sorted results.
statusstringSelect only advertisers with the specified status.
subaccountIdstringSelect only advertisers with these subaccount IDs.
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI 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_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable 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_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

RESPONSES

status: OK

{&quot;advertisers&quot;:[{&quot;accountId&quot;:&quot;nostrud ea&quot;,&quot;advertiserGroupId&quot;:&quot;ea deserunt pariatur&quot;,&quot;clickThroughUrlSuffix&quot;:&quot;tempor consectetur aliquip reprehenderit ex&quot;,&quot;defaultClickThroughEventTagId&quot;:&quot;reprehenderit sed voluptate&quot;,&quot;defaultEmail&quot;:&quot;in Excepteur eu aute non&quot;,&quot;floodlightConfigurationId&quot;:&quot;i&quot;,&quot;floodlightConfigurationIdDimensionValue&quot;:{&quot;dimensionName&quot;:&quot;enim cupidatat esse&quot;,&quot;etag&quot;:&quot;eu ut amet&quot;,&quot;id&quot;:&quot;veniam tempor magna&quot;,&quot;kind&quot;:&quot;ut amet&quot;,&quot;matchType&quot;:&quot;WILDCARD_EXPRESSION&quot;,&quot;value&quot;:&quot;nulla aute laboris do&quot;},&quot;id&quot;:&quot;Lorem cillum magna&quot;,&quot;idDimensionValue&quot;:{&quot;dimensionName&quot;:&quot;consequat&quot;,&quot;etag&quot;:&quot;sit&quot;,&quot;id&quot;:&quot;incididunt nulla ex&quot;,&quot;kind&quot;:&quot;D&quot;,&quot;matchType&quot;:&quot;WILDCARD_EXPRESSION&quot;,&quot;value&quot;:&quot;id aliquip pariatur&quot;},&quot;kind&quot;:&quot;do reprehenderit&quot;,&quot;name&quot;:&quot;aliqua adipisicing est irure&quot;,&quot;originalFloodlightConfigurationId&quot;:&quot;nostrud ipsum&quot;,&quot;status&quot;:&quot;APPROVED&quot;,&quot;subaccountId&quot;:&quot;fugiat esse consequat pariatur&quot;,&quot;suspended&quot;:true},{&quot;accountId&quot;:&quot;consectetur cillum&quot;,&quot;advertiserGroupId&quot;:&quot;sunt nisi consectetur&quot;,&quot;clickThroughUrlSuffix&quot;:&quot;eiusmod&quot;,&quot;defaultClickThroughEventTagId&quot;:&quot;et id reprehenderit&quot;,&quot;defaultEmail&quot;:&quot;qui cupidatat&quot;,&quot;floodlightConfigurationId&quot;:&quot;ullamco&quot;,&quot;floodlightConfigurationIdDimensionValue&quot;:{&quot;dimensionName&quot;:&quot;in qui aute Ut&quot;,&quot;etag&quot;:&quot;nisi sit&quot;,&quot;id&quot;:&quot;consequat commodo ut sed&quot;,&quot;kind&quot;:&quot;ex&quot;,&quot;matchType&quot;:&quot;CONTAINS&quot;,&quot;value&quot;:&quot;amet velit voluptate Lorem&quot;},&quot;id&quot;:&quot;proident ut&quot;,&quot;idDimensionValue&quot;:{&quot;dimensionName&quot;:&quot;qui ipsum&quot;,&quot;etag&quot;:&quot;Duis Ut culpa&quot;,&quot;id&quot;:&quot;occaecat Lorem magna ad&quot;,&quot;kind&quot;:&quot;dolore voluptate aliquip&quot;,&quot;matchType&quot;:&quot;WILDCARD_EXPRESSION&quot;,&quot;value&quot;:&quot;dolore in irure officia dolore&quot;},&quot;kind&quot;:&quot;do incididunt&quot;,&quot;name&quot;:&quot;occaecat aliqua mollit&quot;,&quot;originalFloodlightConfigurationId&quot;:&quot;est mollit ea sunt Duis&quot;,&quot;status&quot;:&quot;ON_HOLD&quot;,&quot;subaccountId&quot;:&quot;Ut&quot;,&quot;suspended&quot;:false}],&quot;kind&quot;:&quot;in quis&quot;,&quot;nextPageToken&quot;:&quot;proident&quot;}