gogol-adsense-0.0.1: Google AdSense Management SDK.

Copyright(c) 2015 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.AdSense

Contents

Description

Gives AdSense publishers access to their inventory and the ability to generate reports

See: AdSense Management API Reference

Synopsis

Service Configuration

adSenseService :: Service Source

Default request referring to version 'v1.4' of the AdSense Management API. This contains the host and root path used as a starting point for constructing service requests.

API Declaration

Resources

adsense.accounts.adclients.list

adsense.accounts.adunits.customchannels.list

adsense.accounts.adunits.get

adsense.accounts.adunits.getAdCode

adsense.accounts.adunits.list

adsense.accounts.alerts.delete

adsense.accounts.alerts.list

adsense.accounts.customchannels.adunits.list

adsense.accounts.customchannels.get

adsense.accounts.customchannels.list

adsense.accounts.get

adsense.accounts.list

adsense.accounts.payments.list

adsense.accounts.reports.generate

adsense.accounts.reports.saved.generate

adsense.accounts.reports.saved.list

adsense.accounts.savedadstyles.get

adsense.accounts.savedadstyles.list

adsense.accounts.urlchannels.list

adsense.adclients.list

adsense.adunits.customchannels.list

adsense.adunits.get

adsense.adunits.getAdCode

adsense.adunits.list

adsense.alerts.delete

adsense.alerts.list

adsense.customchannels.adunits.list

adsense.customchannels.get

adsense.customchannels.list

adsense.metadata.dimensions.list

adsense.metadata.metrics.list

adsense.payments.list

adsense.reports.generate

adsense.reports.saved.generate

adsense.reports.saved.list

adsense.savedadstyles.get

adsense.savedadstyles.list

adsense.urlchannels.list

Types

AdClients

adClients :: AdClients Source

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

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

acEtag :: Lens' AdClients (Maybe Text) Source

ETag of this response for caching purposes.

acNextPageToken :: Lens' AdClients (Maybe Text) Source

Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.

acKind :: Lens' AdClients Text Source

Kind of list this is, in this case adsense#adClients.

acItems :: Lens' AdClients [AdClient] Source

The ad clients returned in this list response.

ReportingMetadataEntry

reportingMetadataEntry :: ReportingMetadataEntry Source

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

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

rmeKind :: Lens' ReportingMetadataEntry Text Source

Kind of resource this is, in this case adsense#reportingMetadataEntry.

rmeRequiredMetrics :: Lens' ReportingMetadataEntry [Text] Source

The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.

rmeCompatibleMetrics :: Lens' ReportingMetadataEntry [Text] Source

The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.

rmeRequiredDimensions :: Lens' ReportingMetadataEntry [Text] Source

The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.

rmeId :: Lens' ReportingMetadataEntry (Maybe Text) Source

Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.

rmeCompatibleDimensions :: Lens' ReportingMetadataEntry [Text] Source

For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.

rmeSupportedProducts :: Lens' ReportingMetadataEntry [Text] Source

The codes of the projects supported by the dimension or metric this reporting metadata entry describes.

AdsenseReportsGenerateResponseHeadersItem

adsenseReportsGenerateResponseHeadersItem :: AdsenseReportsGenerateResponseHeadersItem Source

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

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

argrhiCurrency :: Lens' AdsenseReportsGenerateResponseHeadersItem (Maybe Text) Source

The currency of this column. Only present if the header type is METRIC_CURRENCY.

argrhiType :: Lens' AdsenseReportsGenerateResponseHeadersItem (Maybe Text) Source

The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.

Payment

payment :: Payment Source

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

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

pPaymentAmountCurrencyCode :: Lens' Payment (Maybe Text) Source

The currency code for the amount to be paid.

pKind :: Lens' Payment Text Source

Kind of resource this is, in this case adsense#payment.

pPaymentDate :: Lens' Payment (Maybe Text) Source

The date this payment was/will be credited to the user, or none if the payment threshold has not been met.

pId :: Lens' Payment (Maybe Text) Source

Unique identifier of this Payment.

pPaymentAmount :: Lens' Payment (Maybe Text) Source

The amount to be paid.

Accounts

accounts :: Accounts Source

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

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

aEtag :: Lens' Accounts (Maybe Text) Source

ETag of this response for caching purposes.

aNextPageToken :: Lens' Accounts (Maybe Text) Source

Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this.

aKind :: Lens' Accounts Text Source

Kind of list this is, in this case adsense#accounts.

aItems :: Lens' Accounts [Account] Source

The accounts returned in this list response.

Alerts

alerts :: Alerts Source

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

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

aleKind :: Lens' Alerts Text Source

Kind of list this is, in this case adsense#alerts.

aleItems :: Lens' Alerts [Alert] Source

The alerts returned in this list response.

SavedReports

savedReports :: SavedReports Source

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

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

srEtag :: Lens' SavedReports (Maybe Text) Source

ETag of this response for caching purposes.

srNextPageToken :: Lens' SavedReports (Maybe Text) Source

Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.

srKind :: Lens' SavedReports Text Source

Kind of list this is, in this case adsense#savedReports.

srItems :: Lens' SavedReports [SavedReport] Source

The saved reports returned in this list response.

AdUnits

adUnits :: AdUnits Source

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

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

auEtag :: Lens' AdUnits (Maybe Text) Source

ETag of this response for caching purposes.

auNextPageToken :: Lens' AdUnits (Maybe Text) Source

Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.

auKind :: Lens' AdUnits Text Source

Kind of list this is, in this case adsense#adUnits.

auItems :: Lens' AdUnits [AdUnit] Source

The ad units returned in this list response.

SavedReport

savedReport :: SavedReport Source

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

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

sKind :: Lens' SavedReport Text Source

Kind of resource this is, in this case adsense#savedReport.

sName :: Lens' SavedReport (Maybe Text) Source

This saved report's name.

sId :: Lens' SavedReport (Maybe Text) Source

Unique identifier of this saved report.

URLChannels

urlChannels :: URLChannels Source

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

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

ucEtag :: Lens' URLChannels (Maybe Text) Source

ETag of this response for caching purposes.

ucNextPageToken :: Lens' URLChannels (Maybe Text) Source

Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.

ucKind :: Lens' URLChannels Text Source

Kind of list this is, in this case adsense#urlChannels.

ucItems :: Lens' URLChannels [URLChannel] Source

The URL channels returned in this list response.

CustomChannels

customChannels :: CustomChannels Source

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

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

ccEtag :: Lens' CustomChannels (Maybe Text) Source

ETag of this response for caching purposes.

ccNextPageToken :: Lens' CustomChannels (Maybe Text) Source

Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.

ccKind :: Lens' CustomChannels Text Source

Kind of list this is, in this case adsense#customChannels.

ccItems :: Lens' CustomChannels [CustomChannel] Source

The custom channels returned in this list response.

AdUnit

adUnit :: AdUnit Source

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

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

auuStatus :: Lens' AdUnit (Maybe Text) Source

Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.

auuMobileContentAdsSettings :: Lens' AdUnit (Maybe AdUnitMobileContentAdsSettings) Source

Settings specific to WAP mobile content ads (AFMC).

auuKind :: Lens' AdUnit Text Source

Kind of resource this is, in this case adsense#adUnit.

auuFeedAdsSettings :: Lens' AdUnit (Maybe AdUnitFeedAdsSettings) Source

Settings specific to feed ads (AFF).

auuCustomStyle :: Lens' AdUnit (Maybe AdStyle) Source

Custom style information specific to this ad unit.

auuSavedStyleId :: Lens' AdUnit (Maybe Text) Source

ID of the saved ad style which holds this ad unit's style information.

auuName :: Lens' AdUnit (Maybe Text) Source

Name of this ad unit.

auuContentAdsSettings :: Lens' AdUnit (Maybe AdUnitContentAdsSettings) Source

Settings specific to content ads (AFC) and highend mobile content ads (AFMC).

auuCode :: Lens' AdUnit (Maybe Text) Source

Identity code of this ad unit, not necessarily unique across ad clients.

auuId :: Lens' AdUnit (Maybe Text) Source

Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.

Alert

alert :: Alert Source

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

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

aaIsDismissible :: Lens' Alert (Maybe Bool) Source

Whether this alert can be dismissed.

aaKind :: Lens' Alert Text Source

Kind of resource this is, in this case adsense#alert.

aaSeverity :: Lens' Alert (Maybe Text) Source

Severity of this alert. Possible values: INFO, WARNING, SEVERE.

aaId :: Lens' Alert (Maybe Text) Source

Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.

aaType :: Lens' Alert (Maybe Text) Source

Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.

aaMessage :: Lens' Alert (Maybe Text) Source

The localized alert message.

AdStyleFont

adStyleFont :: AdStyleFont Source

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

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

asfSize :: Lens' AdStyleFont (Maybe Text) Source

The size of the font.

asfFamily :: Lens' AdStyleFont (Maybe Text) Source

The family of the font.

Account

account :: Account Source

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

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

accKind :: Lens' Account Text Source

Kind of resource this is, in this case adsense#account.

accPremium :: Lens' Account (Maybe Bool) Source

Whether this account is premium.

accName :: Lens' Account (Maybe Text) Source

Name of this account.

accId :: Lens' Account (Maybe Text) Source

Unique identifier of this account.

accTimezone :: Lens' Account (Maybe Text) Source

AdSense timezone of this account.

accSubAccounts :: Lens' Account [Account] Source

Sub accounts of the this account.

AdUnitMobileContentAdsSettings

adUnitMobileContentAdsSettings :: AdUnitMobileContentAdsSettings Source

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

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

aumcasScriptingLanguage :: Lens' AdUnitMobileContentAdsSettings (Maybe Text) Source

The scripting language to use for this ad unit.

aumcasMarkupLanguage :: Lens' AdUnitMobileContentAdsSettings (Maybe Text) Source

The markup language to use for this ad unit.

SavedAdStyles

savedAdStyles :: SavedAdStyles Source

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

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

sasEtag :: Lens' SavedAdStyles (Maybe Text) Source

ETag of this response for caching purposes.

sasNextPageToken :: Lens' SavedAdStyles (Maybe Text) Source

Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.

sasKind :: Lens' SavedAdStyles Text Source

Kind of list this is, in this case adsense#savedAdStyles.

sasItems :: Lens' SavedAdStyles [SavedAdStyle] Source

The saved ad styles returned in this list response.

AdStyleColors

data AdStyleColors Source

The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.

See: adStyleColors smart constructor.

adStyleColors :: AdStyleColors Source

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

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

ascText :: Lens' AdStyleColors (Maybe Text) Source

The color of the ad text.

ascURL :: Lens' AdStyleColors (Maybe Text) Source

The color of the ad url.

ascBOrder :: Lens' AdStyleColors (Maybe Text) Source

The color of the ad border.

ascTitle :: Lens' AdStyleColors (Maybe Text) Source

The color of the ad title.

ascBackgRound :: Lens' AdStyleColors (Maybe Text) Source

The color of the ad background.

AdUnitContentAdsSettingsBackupOption

adUnitContentAdsSettingsBackupOption :: AdUnitContentAdsSettingsBackupOption Source

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

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

aucasboColor :: Lens' AdUnitContentAdsSettingsBackupOption (Maybe Text) Source

Color to use when type is set to COLOR.

aucasboURL :: Lens' AdUnitContentAdsSettingsBackupOption (Maybe Text) Source

URL to use when type is set to URL.

aucasboType :: Lens' AdUnitContentAdsSettingsBackupOption (Maybe Text) Source

Type of the backup option. Possible values are BLANK, COLOR and URL.

AdClient

adClient :: AdClient Source

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

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

adKind :: Lens' AdClient Text Source

Kind of resource this is, in this case adsense#adClient.

adArcOptIn :: Lens' AdClient (Maybe Bool) Source

Whether this ad client is opted in to ARC.

adSupportsReporting :: Lens' AdClient (Maybe Bool) Source

Whether this ad client supports being reported on.

adId :: Lens' AdClient (Maybe Text) Source

Unique identifier of this ad client.

adProductCode :: Lens' AdClient (Maybe Text) Source

This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.

adArcReviewMode :: Lens' AdClient (Maybe Text) Source

ARC review mode this ad client is in. Empty if the client is not opted in to ARC. Possible values: POST_REVIEW, AUTOMATIC_PRE_REVIEW.

SavedAdStyle

savedAdStyle :: SavedAdStyle Source

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

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

savKind :: Lens' SavedAdStyle Text Source

Kind of resource this is, in this case adsense#savedAdStyle.

savName :: Lens' SavedAdStyle (Maybe Text) Source

The user selected name of this SavedAdStyle.

savId :: Lens' SavedAdStyle (Maybe Text) Source

Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.

CustomChannelTargetingInfo

customChannelTargetingInfo :: CustomChannelTargetingInfo Source

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

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

cctiLocation :: Lens' CustomChannelTargetingInfo (Maybe Text) Source

The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.

cctiSiteLanguage :: Lens' CustomChannelTargetingInfo (Maybe Text) Source

The language of the sites ads will be displayed on.

cctiAdsAppearOn :: Lens' CustomChannelTargetingInfo (Maybe Text) Source

The name used to describe this channel externally.

cctiDescription :: Lens' CustomChannelTargetingInfo (Maybe Text) Source

The external description of the channel.

AdStyle

adStyle :: AdStyle Source

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

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

asCorners :: Lens' AdStyle (Maybe Text) Source

The style of the corners in the ad.

asKind :: Lens' AdStyle Text Source

Kind this is, in this case adsense#adStyle.

asFont :: Lens' AdStyle (Maybe AdStyleFont) Source

The font which is included in the style.

asColors :: Lens' AdStyle (Maybe AdStyleColors) Source

The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.

AdUnitFeedAdsSettings

adUnitFeedAdsSettings :: AdUnitFeedAdsSettings Source

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

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

aufasFrequency :: Lens' AdUnitFeedAdsSettings (Maybe Int32) Source

The frequency at which ads should appear in the feed (i.e. every N entries).

aufasAdPosition :: Lens' AdUnitFeedAdsSettings (Maybe Text) Source

The position of the ads relative to the feed entries.

aufasType :: Lens' AdUnitFeedAdsSettings (Maybe Text) Source

The type of ads which should appear.

aufasMinimumWordCount :: Lens' AdUnitFeedAdsSettings (Maybe Int32) Source

The minimum length an entry should be in order to have attached ads.

Metadata

metadata :: Metadata Source

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

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

mKind :: Lens' Metadata Text Source

Kind of list this is, in this case adsense#metadata.

CustomChannel

customChannel :: CustomChannel Source

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

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

cTargetingInfo :: Lens' CustomChannel (Maybe CustomChannelTargetingInfo) Source

The targeting information of this custom channel, if activated.

cKind :: Lens' CustomChannel Text Source

Kind of resource this is, in this case adsense#customChannel.

cName :: Lens' CustomChannel (Maybe Text) Source

Name of this custom channel.

cCode :: Lens' CustomChannel (Maybe Text) Source

Code of this custom channel, not necessarily unique across ad clients.

cId :: Lens' CustomChannel (Maybe Text) Source

Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.

URLChannel

urlChannel :: URLChannel Source

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

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

urlcKind :: Lens' URLChannel Text Source

Kind of resource this is, in this case adsense#urlChannel.

urlcId :: Lens' URLChannel (Maybe Text) Source

Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.

urlcURLPattern :: Lens' URLChannel (Maybe Text) Source

URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home

AdCode

adCode :: AdCode Source

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

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

addKind :: Lens' AdCode Text Source

Kind this is, in this case adsense#adCode.

addAdCode :: Lens' AdCode (Maybe Text) Source

The ad code snippet.

AdsenseReportsGenerateResponse

adsenseReportsGenerateResponse :: AdsenseReportsGenerateResponse Source

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

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

argrKind :: Lens' AdsenseReportsGenerateResponse Text Source

Kind this is, in this case adsense#report.

argrAverages :: Lens' AdsenseReportsGenerateResponse [Text] Source

The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.

argrEndDate :: Lens' AdsenseReportsGenerateResponse (Maybe Text) Source

The requested end date in yyyy-mm-dd format.

argrWarnings :: Lens' AdsenseReportsGenerateResponse [Text] Source

Any warnings associated with generation of the report.

argrRows :: Lens' AdsenseReportsGenerateResponse [[Text]] Source

The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.

argrTotals :: Lens' AdsenseReportsGenerateResponse [Text] Source

The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.

argrStartDate :: Lens' AdsenseReportsGenerateResponse (Maybe Text) Source

The requested start date in yyyy-mm-dd format.

argrHeaders :: Lens' AdsenseReportsGenerateResponse [AdsenseReportsGenerateResponseHeadersItem] Source

The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.

argrTotalMatchedRows :: Lens' AdsenseReportsGenerateResponse (Maybe Int64) Source

The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.

AdUnitContentAdsSettings

adUnitContentAdsSettings :: AdUnitContentAdsSettings Source

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

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

aucasBackupOption :: Lens' AdUnitContentAdsSettings (Maybe AdUnitContentAdsSettingsBackupOption) Source

The backup option to be used in instances where no ad is available.

Payments

payments :: Payments Source

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

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

payKind :: Lens' Payments Text Source

Kind of list this is, in this case adsense#payments.

payItems :: Lens' Payments [Payment] Source

The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment.