Network.Google.Resource.GAN.Publishers.List

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

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

REST Resource

type PublishersListResource = "gan" :> ("v1beta1" :> (Capture "role" PublishersListRole :> (Capture "roleId" Text :> ("publishers" :> (QueryParam "relationshipStatus" PublishersListRelationshipStatus :> (QueryParam "minSevenDayEpc" (Textual Double) :> (QueryParam "minNinetyDayEpc" (Textual Double) :> (QueryParam "minPayoutRank" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "publisherCategory" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Publishers))))))))))))

A resource alias for gan.publishers.list method which the PublishersList request conforms to.

Creating a Request

publishersList

Arguments

:: Text

plRoleId

-> PublishersListRole

plRole

-> PublishersList

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

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

• plRelationshipStatus
• plMinSevenDayEpc
• plRoleId
• plMinNinetyDayEpc
• plRole
• plMinPayoutRank
• plPageToken
• plPublisherCategory
• plMaxResults

data PublishersList

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

See: publishersList smart constructor.

Instances

Eq PublishersList

Methods

(==) :: PublishersList -> PublishersList -> Bool

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

Data PublishersList

Methods

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

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

toConstr :: PublishersList -> Constr

dataTypeOf :: PublishersList -> DataType

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

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

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

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

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

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

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

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

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

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

Show PublishersList

Methods

showsPrec :: Int -> PublishersList -> ShowS

show :: PublishersList -> String

showList :: [PublishersList] -> ShowS

Generic PublishersList

Associated Types

type Rep PublishersList :: * -> *

Methods

from :: PublishersList -> Rep PublishersList x

to :: Rep PublishersList x -> PublishersList

GoogleRequest PublishersList

Associated Types

type Rs PublishersList :: *

type Scopes PublishersList :: [Symbol]

Methods

requestClient :: PublishersList -> Client (Rs PublishersList)

type Rep PublishersList

type Rep PublishersList = D1 (MetaData "PublishersList" "Network.Google.Resource.GAN.Publishers.List" "gogol-affiliates-0.3.0-JnD32GtQi0c8cNZneHyDCL" False) (C1 (MetaCons "PublishersList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_plRelationshipStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PublishersListRelationshipStatus))) (S1 (MetaSel (Just Symbol "_plMinSevenDayEpc") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))))) ((:*:) (S1 (MetaSel (Just Symbol "_plRoleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_plMinNinetyDayEpc") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_plRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PublishersListRole)) (S1 (MetaSel (Just Symbol "_plMinPayoutRank") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))) ((:*:) (S1 (MetaSel (Just Symbol "_plPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_plPublisherCategory") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_plMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))))))

type Scopes PublishersList

type Scopes PublishersList = [] Symbol

type Rs PublishersList

type Rs PublishersList = Publishers

Request Lenses

plRelationshipStatus :: Lens' PublishersList (Maybe PublishersListRelationshipStatus)

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

plMinSevenDayEpc :: Lens' PublishersList (Maybe Double)

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

plRoleId :: Lens' PublishersList Text

The ID of the requesting advertiser or publisher.

plMinNinetyDayEpc :: Lens' PublishersList (Maybe Double)

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

plRole :: Lens' PublishersList PublishersListRole

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

plMinPayoutRank :: Lens' PublishersList (Maybe Int32)

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

plPageToken :: Lens' PublishersList (Maybe Text)

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

plPublisherCategory :: Lens' PublishersList (Maybe Text)

Caret(^) delimted list of publisher categories. Valid categories: (unclassified|community_and_content|shopping_and_promotion|loyalty_and_rewards|network|search_specialist|comparison_shopping|email). Filters out all publishers not in one of the given advertiser categories. Optional.

plMaxResults :: Lens' PublishersList (Maybe Word32)

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