Network.Google.Resource.AdSense.Reports.Generate

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.

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))))))))))))))))

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

Creating a Request

reportsGenerate

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:

• rgDimension
• rgLocale
• rgEndDate
• rgStartDate
• rgAccountId
• rgMetric
• rgCurrency
• rgSort
• rgFilter
• rgStartIndex
• rgUseTimezoneReporting
• rgMaxResults

data ReportsGenerate

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

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

Methods

(==) :: ReportsGenerate -> ReportsGenerate -> Bool

(/=) :: ReportsGenerate -> ReportsGenerate -> Bool

Data ReportsGenerate

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

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

Methods

showsPrec :: Int -> ReportsGenerate -> ShowS

show :: ReportsGenerate -> String

showList :: [ReportsGenerate] -> ShowS

Generic ReportsGenerate

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

Associated Types

type Rep ReportsGenerate :: Type -> Type

Methods

from :: ReportsGenerate -> Rep ReportsGenerate x

to :: Rep ReportsGenerate x -> ReportsGenerate

GoogleRequest ReportsGenerate

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

Associated Types

type Rs ReportsGenerate :: Type

type Scopes ReportsGenerate :: [Symbol]

Methods

requestClient :: ReportsGenerate -> GClient (Rs ReportsGenerate)

GoogleRequest (MediaDownload ReportsGenerate)

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

Associated Types

type Rs (MediaDownload ReportsGenerate) :: Type

type Scopes (MediaDownload ReportsGenerate) :: [Symbol]

Methods

requestClient :: MediaDownload ReportsGenerate -> GClient (Rs (MediaDownload ReportsGenerate))

type Rep ReportsGenerate

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

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

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

type Rs ReportsGenerate = AdsenseReportsGenerateResponse

type Scopes (MediaDownload ReportsGenerate)

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

type Scopes (MediaDownload ReportsGenerate) = Scopes ReportsGenerate

type Rs (MediaDownload ReportsGenerate)

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

type Rs (MediaDownload ReportsGenerate) = Stream

Request Lenses

rgDimension :: Lens' ReportsGenerate [Text]

Dimensions to base the report on.

rgLocale :: Lens' ReportsGenerate (Maybe Text)

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

rgEndDate :: Lens' ReportsGenerate Text

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

rgStartDate :: Lens' ReportsGenerate Text

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

rgAccountId :: Lens' ReportsGenerate [Text]

Accounts upon which to report.

rgMetric :: Lens' ReportsGenerate [Text]

Numeric columns to include in the report.

rgCurrency :: Lens' ReportsGenerate (Maybe Text)

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

rgSort :: Lens' ReportsGenerate [Text]

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]

Filters to be run on the report.

rgStartIndex :: Lens' ReportsGenerate (Maybe Int32)

Index of the first row of report data to return.

rgUseTimezoneReporting :: Lens' ReportsGenerate (Maybe Bool)

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)

The maximum number of rows of report data to return.