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 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- adexchangeseller.accounts.adclients.list
- adexchangeseller.accounts.alerts.list
- adexchangeseller.accounts.customchannels.get
- adexchangeseller.accounts.customchannels.list
- adexchangeseller.accounts.get
- adexchangeseller.accounts.list
- adexchangeseller.accounts.metadata.dimensions.list
- adexchangeseller.accounts.metadata.metrics.list
- adexchangeseller.accounts.preferreddeals.get
- adexchangeseller.accounts.preferreddeals.list
- adexchangeseller.accounts.reports.generate
- adexchangeseller.accounts.reports.saved.generate
- adexchangeseller.accounts.reports.saved.list
- adexchangeseller.accounts.urlchannels.list
- Types
Accesses the inventory of Ad Exchange seller users and generates reports.
- adExchangeSellerService :: ServiceConfig
- adExchangeSellerReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/adexchange.seller.readonly"]
- adExchangeSellerScope :: Proxy '["https://www.googleapis.com/auth/adexchange.seller"]
- type AdExchangeSellerAPI = AccountsAdClientsListResource :<|> (AccountsReportsSavedListResource :<|> (AccountsReportsSavedGenerateResource :<|> (AccountsReportsGenerateResource :<|> (AccountsAlertsListResource :<|> (AccountsURLChannelsListResource :<|> (AccountsCustomChannelsListResource :<|> (AccountsCustomChannelsGetResource :<|> (AccountsPreferredDealsListResource :<|> (AccountsPreferredDealsGetResource :<|> (AccountsMetadataMetricsListResource :<|> (AccountsMetadataDimensionsListResource :<|> (AccountsListResource :<|> AccountsGetResource))))))))))))
- module Network.Google.Resource.AdExchangeSeller.Accounts.AdClients.List
- module Network.Google.Resource.AdExchangeSeller.Accounts.Alerts.List
- module Network.Google.Resource.AdExchangeSeller.Accounts.CustomChannels.Get
- module Network.Google.Resource.AdExchangeSeller.Accounts.CustomChannels.List
- module Network.Google.Resource.AdExchangeSeller.Accounts.Get
- module Network.Google.Resource.AdExchangeSeller.Accounts.List
- module Network.Google.Resource.AdExchangeSeller.Accounts.Metadata.Dimensions.List
- module Network.Google.Resource.AdExchangeSeller.Accounts.Metadata.Metrics.List
- module Network.Google.Resource.AdExchangeSeller.Accounts.PreferredDeals.Get
- module Network.Google.Resource.AdExchangeSeller.Accounts.PreferredDeals.List
- module Network.Google.Resource.AdExchangeSeller.Accounts.Reports.Generate
- module Network.Google.Resource.AdExchangeSeller.Accounts.Reports.Saved.Generate
- module Network.Google.Resource.AdExchangeSeller.Accounts.Reports.Saved.List
- module Network.Google.Resource.AdExchangeSeller.Accounts.URLChannels.List
- data AdClients
- adClients :: AdClients
- acEtag :: Lens' AdClients (Maybe Text)
- acNextPageToken :: Lens' AdClients (Maybe Text)
- acKind :: Lens' AdClients Text
- acItems :: Lens' AdClients [AdClient]
- data ReportingMetadataEntry
- reportingMetadataEntry :: ReportingMetadataEntry
- rmeKind :: Lens' ReportingMetadataEntry Text
- rmeRequiredMetrics :: Lens' ReportingMetadataEntry [Text]
- rmeCompatibleMetrics :: Lens' ReportingMetadataEntry [Text]
- rmeRequiredDimensions :: Lens' ReportingMetadataEntry [Text]
- rmeId :: Lens' ReportingMetadataEntry (Maybe Text)
- rmeCompatibleDimensions :: Lens' ReportingMetadataEntry [Text]
- rmeSupportedProducts :: Lens' ReportingMetadataEntry [Text]
- data Accounts
- accounts :: Accounts
- aEtag :: Lens' Accounts (Maybe Text)
- aNextPageToken :: Lens' Accounts (Maybe Text)
- aKind :: Lens' Accounts Text
- aItems :: Lens' Accounts [Account]
- data Alerts
- alerts :: Alerts
- aleKind :: Lens' Alerts Text
- aleItems :: Lens' Alerts [Alert]
- data SavedReports
- savedReports :: SavedReports
- srEtag :: Lens' SavedReports (Maybe Text)
- srNextPageToken :: Lens' SavedReports (Maybe Text)
- srKind :: Lens' SavedReports Text
- srItems :: Lens' SavedReports [SavedReport]
- data SavedReport
- savedReport :: SavedReport
- sKind :: Lens' SavedReport Text
- sName :: Lens' SavedReport (Maybe Text)
- sId :: Lens' SavedReport (Maybe Text)
- data URLChannels
- urlChannels :: URLChannels
- ucEtag :: Lens' URLChannels (Maybe Text)
- ucNextPageToken :: Lens' URLChannels (Maybe Text)
- ucKind :: Lens' URLChannels Text
- ucItems :: Lens' URLChannels [URLChannel]
- data CustomChannels
- customChannels :: CustomChannels
- ccEtag :: Lens' CustomChannels (Maybe Text)
- ccNextPageToken :: Lens' CustomChannels (Maybe Text)
- ccKind :: Lens' CustomChannels Text
- ccItems :: Lens' CustomChannels [CustomChannel]
- data Report
- report :: Report
- rKind :: Lens' Report Text
- rAverages :: Lens' Report [Text]
- rWarnings :: Lens' Report [Text]
- rRows :: Lens' Report [[Text]]
- rTotals :: Lens' Report [Text]
- rHeaders :: Lens' Report [ReportHeadersItem]
- rTotalMatchedRows :: Lens' Report (Maybe Int64)
- data Alert
- alert :: Alert
- aaKind :: Lens' Alert Text
- aaSeverity :: Lens' Alert (Maybe Text)
- aaId :: Lens' Alert (Maybe Text)
- aaType :: Lens' Alert (Maybe Text)
- aaMessage :: Lens' Alert (Maybe Text)
- data Account
- account :: Account
- accKind :: Lens' Account Text
- accName :: Lens' Account (Maybe Text)
- accId :: Lens' Account (Maybe Text)
- data AdClient
- adClient :: AdClient
- adKind :: Lens' AdClient Text
- adArcOptIn :: Lens' AdClient (Maybe Bool)
- adSupportsReporting :: Lens' AdClient (Maybe Bool)
- adId :: Lens' AdClient (Maybe Text)
- adProductCode :: Lens' AdClient (Maybe Text)
- data ReportHeadersItem
- reportHeadersItem :: ReportHeadersItem
- rhiName :: Lens' ReportHeadersItem (Maybe Text)
- rhiCurrency :: Lens' ReportHeadersItem (Maybe Text)
- rhiType :: Lens' ReportHeadersItem (Maybe Text)
- data CustomChannelTargetingInfo
- customChannelTargetingInfo :: CustomChannelTargetingInfo
- cctiLocation :: Lens' CustomChannelTargetingInfo (Maybe Text)
- cctiSiteLanguage :: Lens' CustomChannelTargetingInfo (Maybe Text)
- cctiAdsAppearOn :: Lens' CustomChannelTargetingInfo (Maybe Text)
- cctiDescription :: Lens' CustomChannelTargetingInfo (Maybe Text)
- data PreferredDeals
- preferredDeals :: PreferredDeals
- pdKind :: Lens' PreferredDeals Text
- pdItems :: Lens' PreferredDeals [PreferredDeal]
- data Metadata
- metadata :: Metadata
- mKind :: Lens' Metadata Text
- mItems :: Lens' Metadata [ReportingMetadataEntry]
- data CustomChannel
- customChannel :: CustomChannel
- cTargetingInfo :: Lens' CustomChannel (Maybe CustomChannelTargetingInfo)
- cKind :: Lens' CustomChannel Text
- cName :: Lens' CustomChannel (Maybe Text)
- cCode :: Lens' CustomChannel (Maybe Text)
- cId :: Lens' CustomChannel (Maybe Text)
- data URLChannel
- urlChannel :: URLChannel
- urlcKind :: Lens' URLChannel Text
- urlcId :: Lens' URLChannel (Maybe Text)
- urlcURLPattern :: Lens' URLChannel (Maybe Text)
- data PreferredDeal
- preferredDeal :: PreferredDeal
- pAdvertiserName :: Lens' PreferredDeal (Maybe Text)
- pCurrencyCode :: Lens' PreferredDeal (Maybe Text)
- pStartTime :: Lens' PreferredDeal (Maybe Word64)
- pKind :: Lens' PreferredDeal Text
- pBuyerNetworkName :: Lens' PreferredDeal (Maybe Text)
- pEndTime :: Lens' PreferredDeal (Maybe Word64)
- pId :: Lens' PreferredDeal (Maybe Int64)
- pFixedCpm :: Lens' PreferredDeal (Maybe Int64)
Service Configuration
adExchangeSellerService :: ServiceConfig Source #
Default request referring to version 'v2.0' of the Ad Exchange Seller API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
adExchangeSellerReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/adexchange.seller.readonly"] Source #
View your Ad Exchange data
adExchangeSellerScope :: Proxy '["https://www.googleapis.com/auth/adexchange.seller"] Source #
View and manage your Ad Exchange data
API Declaration
type AdExchangeSellerAPI = AccountsAdClientsListResource :<|> (AccountsReportsSavedListResource :<|> (AccountsReportsSavedGenerateResource :<|> (AccountsReportsGenerateResource :<|> (AccountsAlertsListResource :<|> (AccountsURLChannelsListResource :<|> (AccountsCustomChannelsListResource :<|> (AccountsCustomChannelsGetResource :<|> (AccountsPreferredDealsListResource :<|> (AccountsPreferredDealsGetResource :<|> (AccountsMetadataMetricsListResource :<|> (AccountsMetadataDimensionsListResource :<|> (AccountsListResource :<|> AccountsGetResource)))))))))))) Source #
Represents the entirety of the methods and resources available for the Ad Exchange Seller API service.
Resources
adexchangeseller.accounts.adclients.list
adexchangeseller.accounts.alerts.list
adexchangeseller.accounts.customchannels.get
adexchangeseller.accounts.customchannels.list
adexchangeseller.accounts.get
adexchangeseller.accounts.list
adexchangeseller.accounts.metadata.dimensions.list
adexchangeseller.accounts.metadata.metrics.list
adexchangeseller.accounts.preferreddeals.get
adexchangeseller.accounts.preferreddeals.list
adexchangeseller.accounts.reports.generate
adexchangeseller.accounts.reports.saved.generate
adexchangeseller.accounts.reports.saved.list
adexchangeseller.accounts.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:
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 adexchangeseller#adClients.
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 adexchangeseller#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.
Accounts
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:
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.
Alerts
SavedReports
data SavedReports Source #
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:
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 adexchangeseller#savedReports.
srItems :: Lens' SavedReports [SavedReport] Source #
The saved reports returned in this list response.
SavedReport
data SavedReport Source #
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 adexchangeseller#savedReport.
URLChannels
data URLChannels Source #
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:
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 adexchangeseller#urlChannels.
ucItems :: Lens' URLChannels [URLChannel] Source #
The URL channels returned in this list response.
CustomChannels
data CustomChannels Source #
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:
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 adexchangeseller#customChannels.
ccItems :: Lens' CustomChannels [CustomChannel] Source #
The custom channels returned in this list response.
Report
rAverages :: Lens' Report [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.
rRows :: Lens' Report [[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.
rTotals :: Lens' Report [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.
rHeaders :: Lens' Report [ReportHeadersItem] 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.
rTotalMatchedRows :: Lens' Report (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.
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.
Account
accKind :: Lens' Account Text Source #
Kind of resource this is, in this case adexchangeseller#account.
AdClient
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 adexchangeseller#adClient.
adSupportsReporting :: Lens' AdClient (Maybe Bool) Source #
Whether this ad client supports being reported on.
adProductCode :: Lens' AdClient (Maybe Text) Source #
This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
ReportHeadersItem
data ReportHeadersItem Source #
reportHeadersItem :: ReportHeadersItem Source #
Creates a value of ReportHeadersItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rhiCurrency :: Lens' ReportHeadersItem (Maybe Text) Source #
The currency of this column. Only present if the header type is METRIC_CURRENCY.
rhiType :: Lens' ReportHeadersItem (Maybe Text) Source #
The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
CustomChannelTargetingInfo
data CustomChannelTargetingInfo Source #
The targeting information of this custom channel, if activated.
See: customChannelTargetingInfo
smart constructor.
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.
PreferredDeals
data PreferredDeals Source #
preferredDeals :: PreferredDeals Source #
Creates a value of PreferredDeals
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdKind :: Lens' PreferredDeals Text Source #
Kind of list this is, in this case adexchangeseller#preferredDeals.
pdItems :: Lens' PreferredDeals [PreferredDeal] Source #
The preferred deals returned in this list response.
Metadata
CustomChannel
data CustomChannel Source #
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 adexchangeseller#customChannel.
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
data URLChannel Source #
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 adexchangeseller#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
PreferredDeal
data PreferredDeal Source #
preferredDeal :: PreferredDeal Source #
Creates a value of PreferredDeal
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pAdvertiserName :: Lens' PreferredDeal (Maybe Text) Source #
The name of the advertiser this deal is for.
pCurrencyCode :: Lens' PreferredDeal (Maybe Text) Source #
The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
pStartTime :: Lens' PreferredDeal (Maybe Word64) Source #
Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.
pKind :: Lens' PreferredDeal Text Source #
Kind of resource this is, in this case adexchangeseller#preferredDeal.
pBuyerNetworkName :: Lens' PreferredDeal (Maybe Text) Source #
The name of the buyer network this deal is for.