Network.Google.Resource.GAN.Links.List

Retrieves all links that match the query parameters.

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

REST Resource

type LinksListResource = "gan" :> ("v1beta1" :> (Capture "role" LinksListRole :> (Capture "roleId" Text :> ("links" :> (QueryParam "createDateMax" Text :> (QueryParam "authorship" LinksListAuthorship :> (QueryParams "assetSize" Text :> (QueryParam "relationshipStatus" LinksListRelationshipStatus :> (QueryParams "advertiserId" (Textual Int64) :> (QueryParam "searchText" Text :> (QueryParams "promotionType" LinksListPromotionType :> (QueryParam "createDateMin" Text :> (QueryParam "linkType" LinksListLinkType :> (QueryParam "pageToken" Text :> (QueryParam "startDateMax" Text :> (QueryParam "startDateMin" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Links))))))))))))))))))

A resource alias for gan.links.list method which the LinksList request conforms to.

Creating a Request

linksList

Arguments

:: Text

llRoleId

-> LinksListRole

llRole

-> LinksList

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

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

• llCreateDateMax
• llAuthorship
• llAssetSize
• llRelationshipStatus
• llAdvertiserId
• llSearchText
• llPromotionType
• llRoleId
• llRole
• llCreateDateMin
• llLinkType
• llPageToken
• llStartDateMax
• llStartDateMin
• llMaxResults

data LinksList

Retrieves all links that match the query parameters.

See: linksList smart constructor.

Instances

Eq LinksList

Methods

(==) :: LinksList -> LinksList -> Bool

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

Data LinksList

Methods

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

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

toConstr :: LinksList -> Constr

dataTypeOf :: LinksList -> DataType

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

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

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

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

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

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

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

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

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

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

Show LinksList

Methods

showsPrec :: Int -> LinksList -> ShowS

show :: LinksList -> String

showList :: [LinksList] -> ShowS

Generic LinksList

Associated Types

type Rep LinksList :: * -> *

Methods

from :: LinksList -> Rep LinksList x

to :: Rep LinksList x -> LinksList

GoogleRequest LinksList

Associated Types

type Rs LinksList :: *

type Scopes LinksList :: [Symbol]

Methods

requestClient :: LinksList -> Client (Rs LinksList)

type Rep LinksList

type Rep LinksList = D1 (MetaData "LinksList" "Network.Google.Resource.GAN.Links.List" "gogol-affiliates-0.1.0-EELWRm603D91l5oHHz5uXe" False) (C1 (MetaCons "LinksList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_llCreateDateMax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_llAuthorship") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LinksListAuthorship))) (S1 (MetaSel (Just Symbol "_llAssetSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_llRelationshipStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LinksListRelationshipStatus))) (S1 (MetaSel (Just Symbol "_llAdvertiserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) ((:*:) (S1 (MetaSel (Just Symbol "_llSearchText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_llPromotionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [LinksListPromotionType])))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_llRoleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_llRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LinksListRole))) ((:*:) (S1 (MetaSel (Just Symbol "_llCreateDateMin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_llLinkType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LinksListLinkType))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_llPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_llStartDateMax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_llStartDateMin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_llMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))))))

type Scopes LinksList

type Scopes LinksList = [] Symbol

type Rs LinksList

type Rs LinksList = Links

Request Lenses

llCreateDateMax :: Lens' LinksList (Maybe Text)

The end of the create date range.

llAuthorship :: Lens' LinksList (Maybe LinksListAuthorship)

The role of the author of the link.

llAssetSize :: Lens' LinksList [Text]

The size of the given asset.

llRelationshipStatus :: Lens' LinksList (Maybe LinksListRelationshipStatus)

The status of the relationship.

llAdvertiserId :: Lens' LinksList [Int64]

Limits the resulting links to the ones belonging to the listed advertisers.

llSearchText :: Lens' LinksList (Maybe Text)

Field for full text search across title and merchandising text, supports link id search.

llPromotionType :: Lens' LinksList [LinksListPromotionType]

The promotion type.

llRoleId :: Lens' LinksList Text

The ID of the requesting advertiser or publisher.

llRole :: Lens' LinksList LinksListRole

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

llCreateDateMin :: Lens' LinksList (Maybe Text)

The beginning of the create date range.

llLinkType :: Lens' LinksList (Maybe LinksListLinkType)

The type of the link.

llPageToken :: Lens' LinksList (Maybe Text)

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

llStartDateMax :: Lens' LinksList (Maybe Text)

The end of the start date range.

llStartDateMin :: Lens' LinksList (Maybe Text)

The beginning of the start date range.

llMaxResults :: Lens' LinksList (Maybe Word32)

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