Network.Google.Resource.DFAReporting.Accounts.List

Retrieves the list of accounts, possibly filtered.

See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.accounts.list.

REST Resource

type AccountsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("accounts" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AccountsListSortOrder :> (QueryParam "active" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AccountsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` AccountsListResponse))))))))))))

A resource alias for dfareporting.accounts.list method which the AccountsList request conforms to.

Creating a Request

accountsList

Arguments

:: Int64

accProFileId

-> AccountsList

Creates a value of AccountsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• accSearchString
• accIds
• accProFileId
• accSortOrder
• accActive
• accPageToken
• accSortField
• accMaxResults

data AccountsList

Retrieves the list of accounts, possibly filtered.

See: accountsList smart constructor.

Instances

Eq AccountsList

Data AccountsList

Show AccountsList

Generic AccountsList

GoogleRequest AccountsList

type Rep AccountsList

type Rs AccountsList = AccountsListResponse

Request Lenses

accSearchString :: Lens' AccountsList (Maybe Text)

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

accIds :: Lens' AccountsList [Int64]

Select only accounts with these IDs.

accProFileId :: Lens' AccountsList Int64

User profile ID associated with this request.

accSortOrder :: Lens' AccountsList (Maybe AccountsListSortOrder)

Order of sorted results, default is ASCENDING.

accActive :: Lens' AccountsList (Maybe Bool)

Select only active accounts. Don't set this field to select both active and non-active accounts.

accPageToken :: Lens' AccountsList (Maybe Text)

Value of the nextPageToken from the previous result page.

accSortField :: Lens' AccountsList (Maybe AccountsListSortField)

Field by which to sort the list.

accMaxResults :: Lens' AccountsList (Maybe Int32)

Maximum number of results to return.