Network.Google.Resource.DFAReporting.Cities.List

Retrieves a list of cities, possibly filtered.

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

REST Resource

type CitiesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("cities" :> (QueryParams "regionDartIds" (Textual Int64) :> (QueryParam "namePrefix" Text :> (QueryParams "countryDartIds" (Textual Int64) :> (QueryParams "dartIds" (Textual Int64) :> (QueryParam "alt" AltJSON :> Get '[JSON] CitiesListResponse)))))))))

A resource alias for dfareporting.cities.list method which the CitiesList request conforms to.

Creating a Request

citiesList

Arguments

:: Int64

citProFileId

-> CitiesList

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

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

• citRegionDartIds
• citProFileId
• citNamePrefix
• citCountryDartIds
• citDartIds

data CitiesList

Retrieves a list of cities, possibly filtered.

See: citiesList smart constructor.

Instances

Eq CitiesList

Defined in Network.Google.Resource.DFAReporting.Cities.List

Methods

(==) :: CitiesList -> CitiesList -> Bool

(/=) :: CitiesList -> CitiesList -> Bool

Data CitiesList

Defined in Network.Google.Resource.DFAReporting.Cities.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CitiesList -> c CitiesList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CitiesList

toConstr :: CitiesList -> Constr

dataTypeOf :: CitiesList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CitiesList)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CitiesList)

gmapT :: (forall b. Data b => b -> b) -> CitiesList -> CitiesList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CitiesList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CitiesList -> r

gmapQ :: (forall d. Data d => d -> u) -> CitiesList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CitiesList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CitiesList -> m CitiesList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CitiesList -> m CitiesList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CitiesList -> m CitiesList

Show CitiesList

Defined in Network.Google.Resource.DFAReporting.Cities.List

Methods

showsPrec :: Int -> CitiesList -> ShowS

show :: CitiesList -> String

showList :: [CitiesList] -> ShowS

Generic CitiesList

Defined in Network.Google.Resource.DFAReporting.Cities.List

Associated Types

type Rep CitiesList :: Type -> Type

Methods

from :: CitiesList -> Rep CitiesList x

to :: Rep CitiesList x -> CitiesList

GoogleRequest CitiesList

Defined in Network.Google.Resource.DFAReporting.Cities.List

Associated Types

type Rs CitiesList :: Type

type Scopes CitiesList :: [Symbol]

Methods

requestClient :: CitiesList -> GClient (Rs CitiesList)

type Rep CitiesList

Defined in Network.Google.Resource.DFAReporting.Cities.List

type Rep CitiesList = D1 (MetaData "CitiesList" "Network.Google.Resource.DFAReporting.Cities.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "CitiesList'" PrefixI True) ((S1 (MetaSel (Just "_citRegionDartIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_citProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))) :*: (S1 (MetaSel (Just "_citNamePrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_citCountryDartIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_citDartIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))))))

type Scopes CitiesList

Defined in Network.Google.Resource.DFAReporting.Cities.List

type Scopes CitiesList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])

type Rs CitiesList

Defined in Network.Google.Resource.DFAReporting.Cities.List

type Rs CitiesList = CitiesListResponse

Request Lenses

citRegionDartIds :: Lens' CitiesList [Int64]

Select only cities from these regions.

citProFileId :: Lens' CitiesList Int64

User profile ID associated with this request.

citNamePrefix :: Lens' CitiesList (Maybe Text)

Select only cities with names starting with this prefix.

citCountryDartIds :: Lens' CitiesList [Int64]

Select only cities from these countries.

citDartIds :: Lens' CitiesList [Int64]

Select only cities with these DART IDs.