Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Partners.Leads.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists advertiser leads for a user's associated company. Should only be called within the context of an authorized logged in user.

See: Google Partners API Reference for partners.leads.list.

Synopsis

type LeadsListResource = "v2" :> ("leads" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "requestMetadata.locale" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "pageToken" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListLeadsResponse)))))))))))))))))
leadsList :: LeadsList
data LeadsList
llXgafv :: Lens' LeadsList (Maybe Xgafv)
llUploadProtocol :: Lens' LeadsList (Maybe Text)
llOrderBy :: Lens' LeadsList (Maybe Text)
llAccessToken :: Lens' LeadsList (Maybe Text)
llUploadType :: Lens' LeadsList (Maybe Text)
llRequestMetadataPartnersSessionId :: Lens' LeadsList (Maybe Text)
llRequestMetadataLocale :: Lens' LeadsList (Maybe Text)
llRequestMetadataExperimentIds :: Lens' LeadsList [Text]
llRequestMetadataUserOverridesIPAddress :: Lens' LeadsList (Maybe Text)
llPageToken :: Lens' LeadsList (Maybe Text)
llRequestMetadataTrafficSourceTrafficSubId :: Lens' LeadsList (Maybe Text)
llPageSize :: Lens' LeadsList (Maybe Int32)
llRequestMetadataUserOverridesUserId :: Lens' LeadsList (Maybe Text)
llRequestMetadataTrafficSourceTrafficSourceId :: Lens' LeadsList (Maybe Text)
llCallback :: Lens' LeadsList (Maybe Text)

REST Resource

type LeadsListResource = "v2" :> ("leads" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "requestMetadata.locale" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "pageToken" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListLeadsResponse))))))))))))))))) Source #

A resource alias for partners.leads.list method which the LeadsList request conforms to.

Creating a Request

leadsList :: LeadsList Source #

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

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

data LeadsList Source #

Lists advertiser leads for a user's associated company. Should only be called within the context of an authorized logged in user.

See: leadsList smart constructor.

Instances

Eq LeadsList Source #
Instance details Defined in Network.Google.Resource.Partners.Leads.List Methods (==) :: LeadsList -> LeadsList -> Bool # (/=) :: LeadsList -> LeadsList -> Bool #
Data LeadsList Source #
Instance details Defined in Network.Google.Resource.Partners.Leads.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LeadsList -> c LeadsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LeadsList # toConstr :: LeadsList -> Constr # dataTypeOf :: LeadsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LeadsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LeadsList) # gmapT :: (forall b. Data b => b -> b) -> LeadsList -> LeadsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LeadsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LeadsList -> r # gmapQ :: (forall d. Data d => d -> u) -> LeadsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> LeadsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> LeadsList -> m LeadsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LeadsList -> m LeadsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LeadsList -> m LeadsList #
Show LeadsList Source #
Instance details Defined in Network.Google.Resource.Partners.Leads.List Methods showsPrec :: Int -> LeadsList -> ShowS # show :: LeadsList -> String # showList :: [LeadsList] -> ShowS #
Generic LeadsList Source #
Instance details Defined in Network.Google.Resource.Partners.Leads.List Associated Types type Rep LeadsList :: Type -> Type # Methods from :: LeadsList -> Rep LeadsList x # to :: Rep LeadsList x -> LeadsList #
GoogleRequest LeadsList Source #
Instance details Defined in Network.Google.Resource.Partners.Leads.List Associated Types type Rs LeadsList :: Type # type Scopes LeadsList :: [Symbol] # Methods requestClient :: LeadsList -> GClient (Rs LeadsList) #
type Rep LeadsList Source #
Instance details Defined in Network.Google.Resource.Partners.Leads.List type Rep LeadsList = D1 (MetaData "LeadsList" "Network.Google.Resource.Partners.Leads.List" "gogol-partners-0.4.0-39sg3ZvEDoCEu9a3s5sq6U" False) (C1 (MetaCons "LeadsList'" PrefixI True) (((S1 (MetaSel (Just "_llXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_llUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_llOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_llAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_llUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_llRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_llRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 (MetaSel (Just "_llRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_llRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_llPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_llRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_llPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :: S1 (MetaSel (Just "_llRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_llRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_llCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes LeadsList Source #
Instance details Defined in Network.Google.Resource.Partners.Leads.List type Scopes LeadsList = ([] :: [Symbol])
type Rs LeadsList Source #
Instance details Defined in Network.Google.Resource.Partners.Leads.List type Rs LeadsList = ListLeadsResponse

Request Lenses

llXgafv :: Lens' LeadsList (Maybe Xgafv) Source #

V1 error format.

llUploadProtocol :: Lens' LeadsList (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

llOrderBy :: Lens' LeadsList (Maybe Text) Source #

How to order Leads. Currently, only `create_time` and `create_time desc` are supported

llAccessToken :: Lens' LeadsList (Maybe Text) Source #

OAuth access token.

llUploadType :: Lens' LeadsList (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

llRequestMetadataPartnersSessionId :: Lens' LeadsList (Maybe Text) Source #

Google Partners session ID.

llRequestMetadataLocale :: Lens' LeadsList (Maybe Text) Source #

Locale to use for the current request.

llRequestMetadataExperimentIds :: Lens' LeadsList [Text] Source #

Experiment IDs the current request belongs to.

llRequestMetadataUserOverridesIPAddress :: Lens' LeadsList (Maybe Text) Source #

IP address to use instead of the user's geo-located IP address.

llPageToken :: Lens' LeadsList (Maybe Text) Source #

A token identifying a page of results that the server returns. Typically, this is the value of `ListLeadsResponse.next_page_token` returned from the previous call to ListLeads.

llRequestMetadataTrafficSourceTrafficSubId :: Lens' LeadsList (Maybe Text) Source #

Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

llPageSize :: Lens' LeadsList (Maybe Int32) Source #

Requested page size. Server may return fewer leads than requested. If unspecified, server picks an appropriate default.

llRequestMetadataUserOverridesUserId :: Lens' LeadsList (Maybe Text) Source #

Logged-in user ID to impersonate instead of the user's ID.

llRequestMetadataTrafficSourceTrafficSourceId :: Lens' LeadsList (Maybe Text) Source #

Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

llCallback :: Lens' LeadsList (Maybe Text) Source #

JSONP