Network.Google.Resource.GAN.Advertisers.List

Retrieves data about all advertisers that the requesting advertiser/publisher has access to.

See: Google Affiliate Network API Reference for gan.advertisers.list.

REST Resource

type AdvertisersListResource = "gan" :> ("v1beta1" :> (Capture "role" AdvertisersListRole :> (Capture "roleId" Text :> ("advertisers" :> (QueryParam "relationshipStatus" AdvertisersListRelationshipStatus :> (QueryParam "minSevenDayEpc" (Textual Double) :> (QueryParam "minNinetyDayEpc" (Textual Double) :> (QueryParam "minPayoutRank" (Textual Int32) :> (QueryParam "advertiserCategory" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Advertisers))))))))))))

A resource alias for gan.advertisers.list method which the AdvertisersList request conforms to.

Creating a Request

advertisersList

Arguments

:: Text

alRoleId

-> AdvertisersListRole

alRole

-> AdvertisersList

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

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

• alRelationshipStatus
• alMinSevenDayEpc
• alRoleId
• alMinNinetyDayEpc
• alRole
• alMinPayoutRank
• alAdvertiserCategory
• alPageToken
• alMaxResults

data AdvertisersList

Retrieves data about all advertisers that the requesting advertiser/publisher has access to.

See: advertisersList smart constructor.

Instances

Eq AdvertisersList

Methods

(==) :: AdvertisersList -> AdvertisersList -> Bool

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

Data AdvertisersList

Methods

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

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

toConstr :: AdvertisersList -> Constr

dataTypeOf :: AdvertisersList -> DataType

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

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

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

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

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

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

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

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

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

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

Show AdvertisersList

Methods

showsPrec :: Int -> AdvertisersList -> ShowS

show :: AdvertisersList -> String

showList :: [AdvertisersList] -> ShowS

Generic AdvertisersList

Associated Types

type Rep AdvertisersList :: * -> *

Methods

from :: AdvertisersList -> Rep AdvertisersList x

to :: Rep AdvertisersList x -> AdvertisersList

GoogleRequest AdvertisersList

Associated Types

type Rs AdvertisersList :: *

type Scopes AdvertisersList :: [Symbol]

Methods

requestClient :: AdvertisersList -> Client (Rs AdvertisersList)

type Rep AdvertisersList

type Rep AdvertisersList = D1 (MetaData "AdvertisersList" "Network.Google.Resource.GAN.Advertisers.List" "gogol-affiliates-0.1.1-Fxbr1pfiDZSDHf2HoAp3U" False) (C1 (MetaCons "AdvertisersList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_alRelationshipStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AdvertisersListRelationshipStatus))) (S1 (MetaSel (Just Symbol "_alMinSevenDayEpc") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))))) ((:*:) (S1 (MetaSel (Just Symbol "_alRoleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_alMinNinetyDayEpc") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_alRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AdvertisersListRole)) (S1 (MetaSel (Just Symbol "_alMinPayoutRank") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))) ((:*:) (S1 (MetaSel (Just Symbol "_alAdvertiserCategory") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_alPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_alMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))))))

type Scopes AdvertisersList

type Scopes AdvertisersList = [] Symbol

type Rs AdvertisersList

type Rs AdvertisersList = Advertisers

Request Lenses

alRelationshipStatus :: Lens' AdvertisersList (Maybe AdvertisersListRelationshipStatus)

Filters out all advertisers for which do not have the given relationship status with the requesting publisher.

alMinSevenDayEpc :: Lens' AdvertisersList (Maybe Double)

Filters out all advertisers that have a seven day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.

alRoleId :: Lens' AdvertisersList Text

The ID of the requesting advertiser or publisher.

alMinNinetyDayEpc :: Lens' AdvertisersList (Maybe Double)

Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.

alRole :: Lens' AdvertisersList AdvertisersListRole

The role of the requester. Valid values: 'advertisers' or 'publishers'.

alMinPayoutRank :: Lens' AdvertisersList (Maybe Int32)

A value between 1 and 4, where 1 represents the quartile of advertisers with the lowest ranks and 4 represents the quartile of advertisers with the highest ranks. Filters out all advertisers with a lower rank than the given quartile. For example if a 2 was given only advertisers with a payout rank of 25 or higher would be included. Optional.

alAdvertiserCategory :: Lens' AdvertisersList (Maybe Text)

Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.

alPageToken :: Lens' AdvertisersList (Maybe Text)

The value of 'nextPageToken' from the previous page. Optional.

alMaxResults :: Lens' AdvertisersList (Maybe Word32)

Max number of items to return in this page. Optional. Defaults to 20.