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

Data AdvertisersList

Show AdvertisersList

Generic AdvertisersList

GoogleRequest AdvertisersList

type Rep 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.