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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists the Historical Offers for the current user (or user's entire company)

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

Synopsis

type OffersHistoryListResource = "v2" :> ("offers" :> ("history" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "entireCompany" Bool :> (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] ListOffersHistoryResponse)))))))))))))))))))
offersHistoryList :: OffersHistoryList
data OffersHistoryList
ohlXgafv :: Lens' OffersHistoryList (Maybe Xgafv)
ohlUploadProtocol :: Lens' OffersHistoryList (Maybe Text)
ohlOrderBy :: Lens' OffersHistoryList (Maybe Text)
ohlAccessToken :: Lens' OffersHistoryList (Maybe Text)
ohlUploadType :: Lens' OffersHistoryList (Maybe Text)
ohlEntireCompany :: Lens' OffersHistoryList (Maybe Bool)
ohlRequestMetadataPartnersSessionId :: Lens' OffersHistoryList (Maybe Text)
ohlRequestMetadataLocale :: Lens' OffersHistoryList (Maybe Text)
ohlRequestMetadataExperimentIds :: Lens' OffersHistoryList [Text]
ohlRequestMetadataUserOverridesIPAddress :: Lens' OffersHistoryList (Maybe Text)
ohlPageToken :: Lens' OffersHistoryList (Maybe Text)
ohlRequestMetadataTrafficSourceTrafficSubId :: Lens' OffersHistoryList (Maybe Text)
ohlPageSize :: Lens' OffersHistoryList (Maybe Int32)
ohlRequestMetadataUserOverridesUserId :: Lens' OffersHistoryList (Maybe Text)
ohlRequestMetadataTrafficSourceTrafficSourceId :: Lens' OffersHistoryList (Maybe Text)
ohlCallback :: Lens' OffersHistoryList (Maybe Text)

REST Resource

type OffersHistoryListResource = "v2" :> ("offers" :> ("history" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "entireCompany" Bool :> (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] ListOffersHistoryResponse))))))))))))))))))) Source #

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

Creating a Request

offersHistoryList :: OffersHistoryList Source #

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

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

data OffersHistoryList Source #

Lists the Historical Offers for the current user (or user's entire company)

See: offersHistoryList smart constructor.

Instances

Eq OffersHistoryList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.History.List Methods (==) :: OffersHistoryList -> OffersHistoryList -> Bool # (/=) :: OffersHistoryList -> OffersHistoryList -> Bool #
Data OffersHistoryList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.History.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OffersHistoryList -> c OffersHistoryList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OffersHistoryList # toConstr :: OffersHistoryList -> Constr # dataTypeOf :: OffersHistoryList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OffersHistoryList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OffersHistoryList) # gmapT :: (forall b. Data b => b -> b) -> OffersHistoryList -> OffersHistoryList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OffersHistoryList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OffersHistoryList -> r # gmapQ :: (forall d. Data d => d -> u) -> OffersHistoryList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OffersHistoryList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OffersHistoryList -> m OffersHistoryList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OffersHistoryList -> m OffersHistoryList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OffersHistoryList -> m OffersHistoryList #
Show OffersHistoryList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.History.List Methods showsPrec :: Int -> OffersHistoryList -> ShowS # show :: OffersHistoryList -> String # showList :: [OffersHistoryList] -> ShowS #
Generic OffersHistoryList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.History.List Associated Types type Rep OffersHistoryList :: Type -> Type # Methods from :: OffersHistoryList -> Rep OffersHistoryList x # to :: Rep OffersHistoryList x -> OffersHistoryList #
GoogleRequest OffersHistoryList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.History.List Associated Types type Rs OffersHistoryList :: Type # type Scopes OffersHistoryList :: [Symbol] # Methods requestClient :: OffersHistoryList -> GClient (Rs OffersHistoryList) #
type Rep OffersHistoryList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.History.List type Rep OffersHistoryList = D1 (MetaData "OffersHistoryList" "Network.Google.Resource.Partners.Offers.History.List" "gogol-partners-0.4.0-39sg3ZvEDoCEu9a3s5sq6U" False) (C1 (MetaCons "OffersHistoryList'" PrefixI True) ((((S1 (MetaSel (Just "_ohlXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_ohlUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ohlOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ohlAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_ohlUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ohlEntireCompany") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 (MetaSel (Just "_ohlRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ohlRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 (MetaSel (Just "_ohlRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_ohlRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ohlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ohlRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_ohlPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :: S1 (MetaSel (Just "_ohlRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ohlRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ohlCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes OffersHistoryList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.History.List type Scopes OffersHistoryList = ([] :: [Symbol])
type Rs OffersHistoryList Source #
Instance details Defined in Network.Google.Resource.Partners.Offers.History.List type Rs OffersHistoryList = ListOffersHistoryResponse

Request Lenses

ohlXgafv :: Lens' OffersHistoryList (Maybe Xgafv) Source #

V1 error format.

ohlUploadProtocol :: Lens' OffersHistoryList (Maybe Text) Source #

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

ohlOrderBy :: Lens' OffersHistoryList (Maybe Text) Source #

Comma-separated list of fields to order by, e.g.: "foo,bar,baz". Use "foo desc" to sort descending. List of valid field names is: name, offer_code, expiration_time, status, last_modified_time, sender_name, creation_time, country_code, offer_type.

ohlAccessToken :: Lens' OffersHistoryList (Maybe Text) Source #

OAuth access token.

ohlUploadType :: Lens' OffersHistoryList (Maybe Text) Source #

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

ohlEntireCompany :: Lens' OffersHistoryList (Maybe Bool) Source #

if true, show history for the entire company. Requires user to be admin.

ohlRequestMetadataPartnersSessionId :: Lens' OffersHistoryList (Maybe Text) Source #

Google Partners session ID.

ohlRequestMetadataLocale :: Lens' OffersHistoryList (Maybe Text) Source #

Locale to use for the current request.

ohlRequestMetadataExperimentIds :: Lens' OffersHistoryList [Text] Source #

Experiment IDs the current request belongs to.

ohlRequestMetadataUserOverridesIPAddress :: Lens' OffersHistoryList (Maybe Text) Source #

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

ohlPageToken :: Lens' OffersHistoryList (Maybe Text) Source #

Token to retrieve a specific page.

ohlRequestMetadataTrafficSourceTrafficSubId :: Lens' OffersHistoryList (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.

ohlPageSize :: Lens' OffersHistoryList (Maybe Int32) Source #

Maximum number of rows to return per page.

ohlRequestMetadataUserOverridesUserId :: Lens' OffersHistoryList (Maybe Text) Source #

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

ohlRequestMetadataTrafficSourceTrafficSourceId :: Lens' OffersHistoryList (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.

ohlCallback :: Lens' OffersHistoryList (Maybe Text) Source #

JSONP