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.Offers.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists the Offers available for the current user

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

Synopsis

type OffersListResource = "v2" :> ("offers" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" 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 "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListOffersResponse))))))))))))))
offersList :: OffersList
data OffersList
olXgafv :: Lens' OffersList (Maybe Xgafv)
olUploadProtocol :: Lens' OffersList (Maybe Text)
olAccessToken :: Lens' OffersList (Maybe Text)
olUploadType :: Lens' OffersList (Maybe Text)
olRequestMetadataPartnersSessionId :: Lens' OffersList (Maybe Text)
olRequestMetadataLocale :: Lens' OffersList (Maybe Text)
olRequestMetadataExperimentIds :: Lens' OffersList [Text]
olRequestMetadataUserOverridesIPAddress :: Lens' OffersList (Maybe Text)
olRequestMetadataTrafficSourceTrafficSubId :: Lens' OffersList (Maybe Text)
olRequestMetadataUserOverridesUserId :: Lens' OffersList (Maybe Text)
olRequestMetadataTrafficSourceTrafficSourceId :: Lens' OffersList (Maybe Text)
olCallback :: Lens' OffersList (Maybe Text)

REST Resource

type OffersListResource = "v2" :> ("offers" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" 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 "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListOffersResponse)))))))))))))) Source #

A resource alias for partners.offers.list method which the OffersList request conforms to.

Creating a Request

offersList :: OffersList Source #

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

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

data OffersList Source #

Lists the Offers available for the current user

See: offersList smart constructor.

Instances

Eq OffersList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.List Methods (==) :: OffersList -> OffersList -> Bool # (/=) :: OffersList -> OffersList -> Bool #
Data OffersList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OffersList -> c OffersList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OffersList # toConstr :: OffersList -> Constr # dataTypeOf :: OffersList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OffersList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OffersList) # gmapT :: (forall b. Data b => b -> b) -> OffersList -> OffersList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OffersList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OffersList -> r # gmapQ :: (forall d. Data d => d -> u) -> OffersList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OffersList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OffersList -> m OffersList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OffersList -> m OffersList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OffersList -> m OffersList #
Show OffersList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.List Methods showsPrec :: Int -> OffersList -> ShowS # show :: OffersList -> String # showList :: [OffersList] -> ShowS #
Generic OffersList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.List Associated Types type Rep OffersList :: Type -> Type # Methods from :: OffersList -> Rep OffersList x # to :: Rep OffersList x -> OffersList #
GoogleRequest OffersList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.List Associated Types type Rs OffersList :: Type # type Scopes OffersList :: [Symbol] # Methods requestClient :: OffersList -> GClient (Rs OffersList) #
type Rep OffersList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.List type Rep OffersList = D1 (MetaData "OffersList" "Network.Google.Resource.Partners.Offers.List" "gogol-partners-0.4.0-39sg3ZvEDoCEu9a3s5sq6U" False) (C1 (MetaCons "OffersList'" PrefixI True) (((S1 (MetaSel (Just "_olXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_olUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_olAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_olUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_olRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_olRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 (MetaSel (Just "_olRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 (MetaSel (Just "_olRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_olRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_olRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_olRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_olCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes OffersList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.List type Scopes OffersList = ([] :: [Symbol])
type Rs OffersList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.List type Rs OffersList = ListOffersResponse

Request Lenses

olXgafv :: Lens' OffersList (Maybe Xgafv) Source #

V1 error format.

olUploadProtocol :: Lens' OffersList (Maybe Text) Source #

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

olAccessToken :: Lens' OffersList (Maybe Text) Source #

OAuth access token.

olUploadType :: Lens' OffersList (Maybe Text) Source #

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

olRequestMetadataPartnersSessionId :: Lens' OffersList (Maybe Text) Source #

Google Partners session ID.

olRequestMetadataLocale :: Lens' OffersList (Maybe Text) Source #

Locale to use for the current request.

olRequestMetadataExperimentIds :: Lens' OffersList [Text] Source #

Experiment IDs the current request belongs to.

olRequestMetadataUserOverridesIPAddress :: Lens' OffersList (Maybe Text) Source #

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

olRequestMetadataTrafficSourceTrafficSubId :: Lens' OffersList (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.

olRequestMetadataUserOverridesUserId :: Lens' OffersList (Maybe Text) Source #

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

olRequestMetadataTrafficSourceTrafficSourceId :: Lens' OffersList (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.

olCallback :: Lens' OffersList (Maybe Text) Source #

JSONP