gogol-affiliates-0.3.0: Google Affiliate Network SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.GAN.Reports.Get

Contents

Description

Retrieves a report of the specified type.

See: Google Affiliate Network API Reference for gan.reports.get.

Synopsis

REST Resource

type ReportsGetResource = "gan" :> ("v1beta1" :> (Capture "role" ReportsGetRole :> (Capture "roleId" Text :> ("report" :> (Capture "reportType" ReportsGetReportType :> (QueryParam "status" ReportsGetStatus :> (QueryParams "advertiserId" Text :> (QueryParam "endDate" Text :> (QueryParam "eventType" ReportsGetEventType :> (QueryParam "startDate" Text :> (QueryParam "calculateTotals" Bool :> (QueryParams "linkId" Text :> (QueryParams "orderId" Text :> (QueryParams "publisherId" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Report))))))))))))))))) Source #

A resource alias for gan.reports.get method which the ReportsGet request conforms to.

Creating a Request

reportsGet Source #

Arguments

:: Text

rgRoleId

-> ReportsGetRole

rgRole

-> ReportsGetReportType

rgReportType

-> ReportsGet 

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

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

data ReportsGet Source #

Retrieves a report of the specified type.

See: reportsGet smart constructor.

Instances

Eq ReportsGet Source # 
Data ReportsGet Source # 

Methods

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

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

toConstr :: ReportsGet -> Constr #

dataTypeOf :: ReportsGet -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ReportsGet -> ReportsGet #

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

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

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

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

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

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

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

Show ReportsGet Source # 
Generic ReportsGet Source # 

Associated Types

type Rep ReportsGet :: * -> * #

Methods

from :: ReportsGet -> Rep ReportsGet x #

to :: Rep ReportsGet x -> ReportsGet #

GoogleRequest ReportsGet Source # 

Associated Types

type Rs ReportsGet :: * #

type Scopes ReportsGet :: [Symbol] #

Methods

requestClient :: ReportsGet -> Client (Rs ReportsGet) #

type Rep ReportsGet Source # 
type Rep ReportsGet = D1 (MetaData "ReportsGet" "Network.Google.Resource.GAN.Reports.Get" "gogol-affiliates-0.3.0-JnD32GtQi0c8cNZneHyDCL" False) (C1 (MetaCons "ReportsGet'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rgStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ReportsGetStatus))) ((:*:) (S1 (MetaSel (Just Symbol "_rgAdvertiserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_rgEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rgRoleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rgRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ReportsGetRole))) ((:*:) (S1 (MetaSel (Just Symbol "_rgEventType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ReportsGetEventType))) (S1 (MetaSel (Just Symbol "_rgStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rgCalculateTotals") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_rgLinkId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_rgOrderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rgPublisherId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_rgReportType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ReportsGetReportType))) ((:*:) (S1 (MetaSel (Just Symbol "_rgStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))) (S1 (MetaSel (Just Symbol "_rgMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))))))
type Scopes ReportsGet Source # 
type Rs ReportsGet Source # 

Request Lenses

rgStatus :: Lens' ReportsGet (Maybe ReportsGetStatus) Source #

Filters out all events that do not have the given status. Valid values: 'active', 'canceled', or 'invalid'. Optional.

rgAdvertiserId :: Lens' ReportsGet [Text] Source #

The IDs of the advertisers to look up, if applicable.

rgEndDate :: Lens' ReportsGet (Maybe Text) Source #

The end date (exclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day after startDate, if that is given, or today. Optional.

rgRoleId :: Lens' ReportsGet Text Source #

The ID of the requesting advertiser or publisher.

rgRole :: Lens' ReportsGet ReportsGetRole Source #

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

rgEventType :: Lens' ReportsGet (Maybe ReportsGetEventType) Source #

Filters out all events that are not of the given type. Valid values: 'action', 'transaction', or 'charge'. Optional.

rgStartDate :: Lens' ReportsGet (Maybe Text) Source #

The start date (inclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day before endDate, if that is given, or yesterday. Optional.

rgCalculateTotals :: Lens' ReportsGet (Maybe Bool) Source #

Whether or not to calculate totals rows. Optional.

rgLinkId :: Lens' ReportsGet [Text] Source #

Filters to capture one of given link IDs. Optional.

rgOrderId :: Lens' ReportsGet [Text] Source #

Filters to capture one of the given order IDs. Optional.

rgPublisherId :: Lens' ReportsGet [Text] Source #

The IDs of the publishers to look up, if applicable.

rgReportType :: Lens' ReportsGet ReportsGetReportType Source #

The type of report being requested. Valid values: 'order_delta'. Required.

rgStartIndex :: Lens' ReportsGet (Maybe Word32) Source #

Offset on which to return results when paging. Optional.

rgMaxResults :: Lens' ReportsGet (Maybe Word32) Source #

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