gogol-adsense-0.4.0: Google AdSense Management 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.AdSense.Reports.Generate

Contents

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 Management API Reference for adsense.reports.generate.

Synopsis

REST Resource

type ReportsGenerateResource = ("adsense" :> ("v1.4" :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "accountId" Text :> (QueryParams "metric" Text :> (QueryParam "currency" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Int32) :> (QueryParam "useTimezoneReporting" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AdsenseReportsGenerateResponse)))))))))))))))) :<|> ("adsense" :> ("v1.4" :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "accountId" Text :> (QueryParams "metric" Text :> (QueryParam "currency" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Int32) :> (QueryParam "useTimezoneReporting" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltMedia :> Get '[OctetStream] Stream)))))))))))))))) Source #

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

Creating a Request

reportsGenerate Source #

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

Data ReportsGenerate Source # 
Instance details

Defined in Network.Google.Resource.AdSense.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.AdSense.Reports.Generate

Generic ReportsGenerate Source # 
Instance details

Defined in Network.Google.Resource.AdSense.Reports.Generate

Associated Types

type Rep ReportsGenerate :: Type -> Type #

GoogleRequest ReportsGenerate Source # 
Instance details

Defined in Network.Google.Resource.AdSense.Reports.Generate

Associated Types

type Rs ReportsGenerate :: Type #

type Scopes ReportsGenerate :: [Symbol] #

GoogleRequest (MediaDownload ReportsGenerate) Source # 
Instance details

Defined in Network.Google.Resource.AdSense.Reports.Generate

type Rep ReportsGenerate Source # 
Instance details

Defined in Network.Google.Resource.AdSense.Reports.Generate

type Rep ReportsGenerate = D1 (MetaData "ReportsGenerate" "Network.Google.Resource.AdSense.Reports.Generate" "gogol-adsense-0.4.0-8cOCEo3eYdbFA6XwLd5vHV" 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 "_rgAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_rgMetric") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 (MetaSel (Just "_rgCurrency") 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 Int32))) :*: (S1 (MetaSel (Just "_rgUseTimezoneReporting") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_rgMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))))))
type Scopes ReportsGenerate Source # 
Instance details

Defined in Network.Google.Resource.AdSense.Reports.Generate

type Scopes ReportsGenerate = "https://www.googleapis.com/auth/adsense" ': ("https://www.googleapis.com/auth/adsense.readonly" ': ([] :: [Symbol]))
type Rs ReportsGenerate Source # 
Instance details

Defined in Network.Google.Resource.AdSense.Reports.Generate

type Scopes (MediaDownload ReportsGenerate) Source # 
Instance details

Defined in Network.Google.Resource.AdSense.Reports.Generate

type Rs (MediaDownload ReportsGenerate) Source # 
Instance details

Defined in Network.Google.Resource.AdSense.Reports.Generate

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.

rgAccountId :: Lens' ReportsGenerate [Text] Source #

Accounts upon which to report.

rgMetric :: Lens' ReportsGenerate [Text] Source #

Numeric columns to include in the report.

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

Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.

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.

rgFilter :: Lens' ReportsGenerate [Text] Source #

Filters to be run on the report.

rgStartIndex :: Lens' ReportsGenerate (Maybe Int32) Source #

Index of the first row of report data to return.

rgUseTimezoneReporting :: Lens' ReportsGenerate (Maybe Bool) Source #

Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.

rgMaxResults :: Lens' ReportsGenerate (Maybe Int32) Source #

The maximum number of rows of report data to return.