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.AdSenseHost.Reports.Generate

Contents

REST Resource
Creating a Request
Request Lenses

Description

Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

See: AdSense Host API Reference for adsensehost.reports.generate.

Synopsis

type ReportsGenerateResource = "adsensehost" :> ("v4.1" :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "metric" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Report))))))))))))
reportsGenerate :: Text -> Text -> ReportsGenerate
data ReportsGenerate
rgDimension :: Lens' ReportsGenerate [Text]
rgLocale :: Lens' ReportsGenerate (Maybe Text)
rgEndDate :: Lens' ReportsGenerate Text
rgStartDate :: Lens' ReportsGenerate Text
rgMetric :: Lens' ReportsGenerate [Text]
rgSort :: Lens' ReportsGenerate [Text]
rgFilter :: Lens' ReportsGenerate [Text]
rgStartIndex :: Lens' ReportsGenerate (Maybe Word32)
rgMaxResults :: Lens' ReportsGenerate (Maybe Word32)

REST Resource

type ReportsGenerateResource = "adsensehost" :> ("v4.1" :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "metric" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Report)))))))))))) Source #

A resource alias for adsensehost.reports.generate method which the ReportsGenerate request conforms to.

Creating a Request

reportsGenerate Source #

Arguments

:: Text	`rgEndDate`
-> Text	`rgStartDate`
-> ReportsGenerate

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

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

data ReportsGenerate Source #

Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

See: reportsGenerate smart constructor.

Instances

Eq ReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Reports.Generate Methods (==) :: ReportsGenerate -> ReportsGenerate -> Bool # (/=) :: ReportsGenerate -> ReportsGenerate -> Bool #
Data ReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Reports.Generate Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReportsGenerate -> c ReportsGenerate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReportsGenerate # toConstr :: ReportsGenerate -> Constr # dataTypeOf :: ReportsGenerate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ReportsGenerate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReportsGenerate) # gmapT :: (forall b. Data b => b -> b) -> ReportsGenerate -> ReportsGenerate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReportsGenerate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReportsGenerate -> r # gmapQ :: (forall d. Data d => d -> u) -> ReportsGenerate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ReportsGenerate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReportsGenerate -> m ReportsGenerate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportsGenerate -> m ReportsGenerate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportsGenerate -> m ReportsGenerate #
Show ReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Reports.Generate Methods showsPrec :: Int -> ReportsGenerate -> ShowS # show :: ReportsGenerate -> String # showList :: [ReportsGenerate] -> ShowS #
Generic ReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Reports.Generate Associated Types type Rep ReportsGenerate :: Type -> Type # Methods from :: ReportsGenerate -> Rep ReportsGenerate x # to :: Rep ReportsGenerate x -> ReportsGenerate #
GoogleRequest ReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Reports.Generate Associated Types type Rs ReportsGenerate :: Type # type Scopes ReportsGenerate :: [Symbol] # Methods requestClient :: ReportsGenerate -> GClient (Rs ReportsGenerate) #
type Rep ReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Reports.Generate type Rep ReportsGenerate = D1 (MetaData "ReportsGenerate" "Network.Google.Resource.AdSenseHost.Reports.Generate" "gogol-adsense-host-0.4.0-9ZqQWUle4m2HKOQnxH9pTD" False) (C1 (MetaCons "ReportsGenerate'" PrefixI True) (((S1 (MetaSel (Just "_rgDimension") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_rgLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_rgEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_rgStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_rgMetric") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_rgSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 (MetaSel (Just "_rgFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 (MetaSel (Just "_rgStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))) :: S1 (MetaSel (Just "_rgMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))))))))
type Scopes ReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Reports.Generate type Scopes ReportsGenerate = "https://www.googleapis.com/auth/adsensehost" ': ([] :: [Symbol])
type Rs ReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Reports.Generate type Rs ReportsGenerate = Report

Request Lenses

rgDimension :: Lens' ReportsGenerate [Text] Source #

Dimensions to base the report on.

rgLocale :: Lens' ReportsGenerate (Maybe Text) Source #

Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

rgEndDate :: Lens' ReportsGenerate Text Source #

End of the date range to report on in "YYYY-MM-DD" format, inclusive.

rgStartDate :: Lens' ReportsGenerate Text Source #

Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

rgMetric :: Lens' ReportsGenerate [Text] Source #

Numeric columns to include in the report.

rgSort :: Lens' ReportsGenerate [Text] Source #

The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.