GOgoogle
advertisers

GET /userprofiles/{userprofilesId}/advertisers

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

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Query parameters

advertiserGroupIdsstring[]

Select only advertisers with these advertiser group IDs.

floodlightConfigurationIdsstring[]

Select only advertisers with these floodlight configuration IDs.

idsstring[]

Select only advertisers with these IDs.

includeAdvertisersWithoutGroupsOnlyboolean

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

maxResultsinteger

Maximum number of results to return.

onlyParentboolean

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

pageTokenstring

Value of the nextPageToken from the previous result page.

searchStringstring

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

sortField'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

status'APPROVED' | 'ON_HOLD'

Select only advertisers with the specified status.

subaccountIdstring int64

Select only advertisers with these subaccount IDs.

Response

Successful response

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".

nextPageTokenstring

Pagination token to be used for the next list operation.

Changes

No recorded changes to this operation across all 5 revisions of this API.