Copyright | (c) 2015 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
- ReportRow
- ReportRequest
- ReportRequestOrderByItem
- Report
- ReportFilesItem
- ReportRequestFiltersItem
- Availability
- UpdateAvailabilityRequest
- CustomMetric
- ConversionList
- ReportAPIColumnSpec
- ReportRequestTimeRange
- Conversion
- SavedColumn
- CustomDimension
- UpdateAvailabilityResponse
- ReportRequestReportScope
- SavedColumnList
- doubleClickSearchService :: Service
- doubleclicksearchScope :: OAuthScope
- data ReportRow
- reportRow :: HashMap Text JSONValue -> ReportRow
- rrAddtional :: Lens' ReportRow (HashMap Text JSONValue)
- data ReportRequest
- reportRequest :: ReportRequest
- rrMaxRowsPerFile :: Lens' ReportRequest (Maybe Int32)
- rrReportScope :: Lens' ReportRequest (Maybe ReportRequestReportScope)
- rrStatisticsCurrency :: Lens' ReportRequest (Maybe Text)
- rrTimeRange :: Lens' ReportRequest (Maybe ReportRequestTimeRange)
- rrOrderBy :: Lens' ReportRequest [ReportRequestOrderByItem]
- rrFilters :: Lens' ReportRequest [ReportRequestFiltersItem]
- rrIncludeRemovedEntities :: Lens' ReportRequest Bool
- rrIncludeDeletedEntities :: Lens' ReportRequest Bool
- rrDownloadFormat :: Lens' ReportRequest (Maybe Text)
- rrStartRow :: Lens' ReportRequest Int32
- rrColumns :: Lens' ReportRequest [ReportAPIColumnSpec]
- rrReportType :: Lens' ReportRequest (Maybe Text)
- rrVerifySingleTimeZone :: Lens' ReportRequest Bool
- rrRowCount :: Lens' ReportRequest Int32
- data ReportRequestOrderByItem
- reportRequestOrderByItem :: ReportRequestOrderByItem
- rrobiSortOrder :: Lens' ReportRequestOrderByItem (Maybe Text)
- rrobiColumn :: Lens' ReportRequestOrderByItem (Maybe ReportAPIColumnSpec)
- data Report
- report :: Report
- rKind :: Lens' Report Text
- rRows :: Lens' Report [ReportRow]
- rStatisticsCurrencyCode :: Lens' Report (Maybe Text)
- rIsReportReady :: Lens' Report (Maybe Bool)
- rFiles :: Lens' Report [ReportFilesItem]
- rId :: Lens' Report (Maybe Text)
- rStatisticsTimeZone :: Lens' Report (Maybe Text)
- rRowCount :: Lens' Report (Maybe Int32)
- rRequest :: Lens' Report (Maybe ReportRequest)
- data ReportFilesItem
- reportFilesItem :: ReportFilesItem
- rfiURL :: Lens' ReportFilesItem (Maybe Text)
- rfiByteCount :: Lens' ReportFilesItem (Maybe Int64)
- data ReportRequestFiltersItem
- reportRequestFiltersItem :: ReportRequestFiltersItem
- rrfiOperator :: Lens' ReportRequestFiltersItem (Maybe Text)
- rrfiValues :: Lens' ReportRequestFiltersItem [JSONValue]
- rrfiColumn :: Lens' ReportRequestFiltersItem (Maybe ReportAPIColumnSpec)
- data Availability
- availability :: Availability
- aAgencyId :: Lens' Availability (Maybe Int64)
- aAdvertiserId :: Lens' Availability (Maybe Int64)
- aSegmentationId :: Lens' Availability (Maybe Int64)
- aSegmentationName :: Lens' Availability (Maybe Text)
- aAvailabilityTimestamp :: Lens' Availability (Maybe Word64)
- aSegmentationType :: Lens' Availability (Maybe Text)
- data UpdateAvailabilityRequest
- updateAvailabilityRequest :: UpdateAvailabilityRequest
- uarAvailabilities :: Lens' UpdateAvailabilityRequest [Availability]
- data CustomMetric
- customMetric :: CustomMetric
- cmValue :: Lens' CustomMetric (Maybe Double)
- cmName :: Lens' CustomMetric (Maybe Text)
- data ConversionList
- conversionList :: ConversionList
- clKind :: Lens' ConversionList Text
- clConversion :: Lens' ConversionList [Conversion]
- data ReportAPIColumnSpec
- reportAPIColumnSpec :: ReportAPIColumnSpec
- racsCustomDimensionName :: Lens' ReportAPIColumnSpec (Maybe Text)
- racsSavedColumnName :: Lens' ReportAPIColumnSpec (Maybe Text)
- racsGroupByColumn :: Lens' ReportAPIColumnSpec Bool
- racsCustomMetricName :: Lens' ReportAPIColumnSpec (Maybe Text)
- racsEndDate :: Lens' ReportAPIColumnSpec (Maybe Text)
- racsProductReportPerspective :: Lens' ReportAPIColumnSpec (Maybe Text)
- racsStartDate :: Lens' ReportAPIColumnSpec (Maybe Text)
- racsHeaderText :: Lens' ReportAPIColumnSpec (Maybe Text)
- racsPlatformSource :: Lens' ReportAPIColumnSpec (Maybe Text)
- racsColumnName :: Lens' ReportAPIColumnSpec (Maybe Text)
- data ReportRequestTimeRange
- reportRequestTimeRange :: ReportRequestTimeRange
- rrtrEndDate :: Lens' ReportRequestTimeRange (Maybe Text)
- rrtrChangedAttributesSinceTimestamp :: Lens' ReportRequestTimeRange (Maybe UTCTime)
- rrtrStartDate :: Lens' ReportRequestTimeRange (Maybe Text)
- rrtrChangedMetricsSinceTimestamp :: Lens' ReportRequestTimeRange (Maybe UTCTime)
- data Conversion
- conversion :: Conversion
- cAdGroupId :: Lens' Conversion (Maybe Int64)
- cConversionModifiedTimestamp :: Lens' Conversion (Maybe Word64)
- cState :: Lens' Conversion (Maybe Text)
- cEngineAccountId :: Lens' Conversion (Maybe Int64)
- cAgencyId :: Lens' Conversion (Maybe Int64)
- cCurrencyCode :: Lens' Conversion (Maybe Text)
- cStoreId :: Lens' Conversion (Maybe Text)
- cDsConversionId :: Lens' Conversion (Maybe Int64)
- cConversionId :: Lens' Conversion (Maybe Text)
- cAdvertiserId :: Lens' Conversion (Maybe Int64)
- cSegmentationId :: Lens' Conversion (Maybe Int64)
- cChannel :: Lens' Conversion (Maybe Text)
- cProductCountry :: Lens' Conversion (Maybe Text)
- cCampaignId :: Lens' Conversion (Maybe Int64)
- cCriterionId :: Lens' Conversion (Maybe Int64)
- cConversionTimestamp :: Lens' Conversion (Maybe Word64)
- cAttributionModel :: Lens' Conversion (Maybe Text)
- cSegmentationName :: Lens' Conversion (Maybe Text)
- cProductLanguage :: Lens' Conversion (Maybe Text)
- cCustomMetric :: Lens' Conversion [CustomMetric]
- cCountMillis :: Lens' Conversion (Maybe Int64)
- cQuantityMillis :: Lens' Conversion (Maybe Int64)
- cAdId :: Lens' Conversion (Maybe Int64)
- cDeviceType :: Lens' Conversion (Maybe Text)
- cType :: Lens' Conversion (Maybe Text)
- cCustomDimension :: Lens' Conversion [CustomDimension]
- cFloodlightOrderId :: Lens' Conversion (Maybe Text)
- cRevenueMicros :: Lens' Conversion (Maybe Int64)
- cClickId :: Lens' Conversion (Maybe Text)
- cInventoryAccountId :: Lens' Conversion (Maybe Int64)
- cSegmentationType :: Lens' Conversion (Maybe Text)
- cProductId :: Lens' Conversion (Maybe Text)
- cProductGroupId :: Lens' Conversion (Maybe Int64)
- data SavedColumn
- savedColumn :: SavedColumn
- scSavedColumnName :: Lens' SavedColumn (Maybe Text)
- scKind :: Lens' SavedColumn Text
- scType :: Lens' SavedColumn (Maybe Text)
- data CustomDimension
- customDimension :: CustomDimension
- cdValue :: Lens' CustomDimension (Maybe Text)
- cdName :: Lens' CustomDimension (Maybe Text)
- data UpdateAvailabilityResponse
- updateAvailabilityResponse :: UpdateAvailabilityResponse
- uAvailabilities :: Lens' UpdateAvailabilityResponse [Availability]
- data ReportRequestReportScope
- reportRequestReportScope :: ReportRequestReportScope
- rrrsKeywordId :: Lens' ReportRequestReportScope (Maybe Int64)
- rrrsAdGroupId :: Lens' ReportRequestReportScope (Maybe Int64)
- rrrsEngineAccountId :: Lens' ReportRequestReportScope (Maybe Int64)
- rrrsAgencyId :: Lens' ReportRequestReportScope (Maybe Int64)
- rrrsAdvertiserId :: Lens' ReportRequestReportScope (Maybe Int64)
- rrrsCampaignId :: Lens' ReportRequestReportScope (Maybe Int64)
- rrrsAdId :: Lens' ReportRequestReportScope (Maybe Int64)
- data SavedColumnList
- savedColumnList :: SavedColumnList
- sclKind :: Lens' SavedColumnList Text
- sclItems :: Lens' SavedColumnList [SavedColumn]
Service Configuration
doubleClickSearchService :: Service Source
Default request referring to version v2
of the DoubleClick Search API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
doubleclicksearchScope :: OAuthScope Source
View and manage your advertising data in DoubleClick Search
ReportRow
A row in a DoubleClick Search report.
See: reportRow
smart constructor.
Creates a value of ReportRow
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrAddtional :: Lens' ReportRow (HashMap Text JSONValue) Source
Indicates the columns that are represented in this row. That is, each key corresponds to a column with a non-empty cell in this row.
ReportRequest
data ReportRequest Source
A request object used to create a DoubleClick Search report.
See: reportRequest
smart constructor.
reportRequest :: ReportRequest Source
Creates a value of ReportRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrMaxRowsPerFile :: Lens' ReportRequest (Maybe Int32) Source
Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive.
rrReportScope :: Lens' ReportRequest (Maybe ReportRequestReportScope) Source
The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
rrStatisticsCurrency :: Lens' ReportRequest (Maybe Text) Source
Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).
rrTimeRange :: Lens' ReportRequest (Maybe ReportRequestTimeRange) Source
If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
rrOrderBy :: Lens' ReportRequest [ReportRequestOrderByItem] Source
Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.
rrFilters :: Lens' ReportRequest [ReportRequestFiltersItem] Source
A list of filters to be applied to the report.
rrIncludeRemovedEntities :: Lens' ReportRequest Bool Source
Determines if removed entities should be included in the report. Defaults to false.
rrIncludeDeletedEntities :: Lens' ReportRequest Bool Source
Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
rrDownloadFormat :: Lens' ReportRequest (Maybe Text) Source
Format that the report should be returned in. Currently csv or tsv is supported.
rrStartRow :: Lens' ReportRequest Int32 Source
Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.
rrColumns :: Lens' ReportRequest [ReportAPIColumnSpec] Source
The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.
rrReportType :: Lens' ReportRequest (Maybe Text) Source
Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type.
rrVerifySingleTimeZone :: Lens' ReportRequest Bool Source
If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
rrRowCount :: Lens' ReportRequest Int32 Source
Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.
ReportRequestOrderByItem
reportRequestOrderByItem :: ReportRequestOrderByItem Source
Creates a value of ReportRequestOrderByItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrobiSortOrder :: Lens' ReportRequestOrderByItem (Maybe Text) Source
The sort direction, which is either ascending or descending.
rrobiColumn :: Lens' ReportRequestOrderByItem (Maybe ReportAPIColumnSpec) Source
Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
Report
A DoubleClick Search report. This object contains the report request, some report metadata such as currency code, and the generated report rows or report files.
See: report
smart constructor.
Creates a value of Report
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rKind :: Lens' Report Text Source
Identifies this as a Report resource. Value: the fixed string doubleclicksearch#report.
rStatisticsCurrencyCode :: Lens' Report (Maybe Text) Source
The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the statisticsCurrency field of the report request.
rIsReportReady :: Lens' Report (Maybe Bool) Source
Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.
rFiles :: Lens' Report [ReportFilesItem] Source
Asynchronous report only. Contains a list of generated report files once the report has succesfully completed.
rStatisticsTimeZone :: Lens' Report (Maybe Text) Source
If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.
rRowCount :: Lens' Report (Maybe Int32) Source
The number of report rows generated by the report, not including headers.
rRequest :: Lens' Report (Maybe ReportRequest) Source
The request that created the report. Optional fields not specified in the original request are filled with default values.
ReportFilesItem
data ReportFilesItem Source
reportFilesItem :: ReportFilesItem Source
Creates a value of ReportFilesItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rfiByteCount :: Lens' ReportFilesItem (Maybe Int64) Source
The size of this report file in bytes.
ReportRequestFiltersItem
reportRequestFiltersItem :: ReportRequestFiltersItem Source
Creates a value of ReportRequestFiltersItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrfiOperator :: Lens' ReportRequestFiltersItem (Maybe Text) Source
Operator to use in the filter. See the filter reference for a list of available operators.
rrfiValues :: Lens' ReportRequestFiltersItem [JSONValue] Source
A list of values to filter the column value against.
rrfiColumn :: Lens' ReportRequestFiltersItem (Maybe ReportAPIColumnSpec) Source
Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
Availability
data Availability Source
A message containing availability data relevant to DoubleClick Search.
See: availability
smart constructor.
availability :: Availability Source
Creates a value of Availability
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aAdvertiserId :: Lens' Availability (Maybe Int64) Source
DS advertiser ID.
aSegmentationId :: Lens' Availability (Maybe Int64) Source
The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
aSegmentationName :: Lens' Availability (Maybe Text) Source
The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
aAvailabilityTimestamp :: Lens' Availability (Maybe Word64) Source
The time by which all conversions have been uploaded, in epoch millis UTC.
aSegmentationType :: Lens' Availability (Maybe Text) Source
The segmentation type that this availability is for (its default value is FLOODLIGHT).
UpdateAvailabilityRequest
data UpdateAvailabilityRequest Source
The request to update availability.
See: updateAvailabilityRequest
smart constructor.
updateAvailabilityRequest :: UpdateAvailabilityRequest Source
Creates a value of UpdateAvailabilityRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uarAvailabilities :: Lens' UpdateAvailabilityRequest [Availability] Source
The availabilities being requested.
CustomMetric
data CustomMetric Source
A message containing the custome metric.
See: customMetric
smart constructor.
customMetric :: CustomMetric Source
Creates a value of CustomMetric
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ConversionList
data ConversionList Source
A list of conversions.
See: conversionList
smart constructor.
conversionList :: ConversionList Source
Creates a value of ConversionList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clKind :: Lens' ConversionList Text Source
Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
clConversion :: Lens' ConversionList [Conversion] Source
The conversions being requested.
ReportAPIColumnSpec
data ReportAPIColumnSpec Source
A request object used to create a DoubleClick Search report.
See: reportAPIColumnSpec
smart constructor.
reportAPIColumnSpec :: ReportAPIColumnSpec Source
Creates a value of ReportAPIColumnSpec
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
racsCustomDimensionName :: Lens' ReportAPIColumnSpec (Maybe Text) Source
Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
racsSavedColumnName :: Lens' ReportAPIColumnSpec (Maybe Text) Source
Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
racsGroupByColumn :: Lens' ReportAPIColumnSpec Bool Source
Synchronous report only. Set to true to group by this column. Defaults to false.
racsCustomMetricName :: Lens' ReportAPIColumnSpec (Maybe Text) Source
Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
racsEndDate :: Lens' ReportAPIColumnSpec (Maybe Text) Source
Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
racsProductReportPerspective :: Lens' ReportAPIColumnSpec (Maybe Text) Source
Provide different source for product items. Acceptable values are "advertised" and "sold".
racsStartDate :: Lens' ReportAPIColumnSpec (Maybe Text) Source
Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
racsHeaderText :: Lens' ReportAPIColumnSpec (Maybe Text) Source
Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
racsPlatformSource :: Lens' ReportAPIColumnSpec (Maybe Text) Source
The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
racsColumnName :: Lens' ReportAPIColumnSpec (Maybe Text) Source
Name of a DoubleClick Search column to include in the report.
ReportRequestTimeRange
data ReportRequestTimeRange Source
If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
See: reportRequestTimeRange
smart constructor.
reportRequestTimeRange :: ReportRequestTimeRange Source
Creates a value of ReportRequestTimeRange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrtrEndDate :: Lens' ReportRequestTimeRange (Maybe Text) Source
Inclusive date in YYYY-MM-DD format.
rrtrChangedAttributesSinceTimestamp :: Lens' ReportRequestTimeRange (Maybe UTCTime) Source
Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work.
rrtrStartDate :: Lens' ReportRequestTimeRange (Maybe Text) Source
Inclusive date in YYYY-MM-DD format.
rrtrChangedMetricsSinceTimestamp :: Lens' ReportRequestTimeRange (Maybe UTCTime) Source
Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work.
Conversion
data Conversion Source
A conversion containing data relevant to DoubleClick Search.
See: conversion
smart constructor.
conversion :: Conversion Source
Creates a value of Conversion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cAdGroupId
cConversionModifiedTimestamp
cState
cEngineAccountId
cAgencyId
cCurrencyCode
cStoreId
cDsConversionId
cConversionId
cAdvertiserId
cSegmentationId
cChannel
cProductCountry
cCampaignId
cCriterionId
cConversionTimestamp
cAttributionModel
cSegmentationName
cProductLanguage
cCustomMetric
cCountMillis
cQuantityMillis
cAdId
cDeviceType
cType
cCustomDimension
cFloodlightOrderId
cRevenueMicros
cClickId
cInventoryAccountId
cSegmentationType
cProductId
cProductGroupId
cAdGroupId :: Lens' Conversion (Maybe Int64) Source
DS ad group ID.
cConversionModifiedTimestamp :: Lens' Conversion (Maybe Word64) Source
The time at which the conversion was last modified, in epoch millis UTC.
cState :: Lens' Conversion (Maybe Text) Source
The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
cEngineAccountId :: Lens' Conversion (Maybe Int64) Source
DS engine account ID.
cCurrencyCode :: Lens' Conversion (Maybe Text) Source
The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
cStoreId :: Lens' Conversion (Maybe Text) Source
The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
cDsConversionId :: Lens' Conversion (Maybe Int64) Source
ID that DoubleClick Search generates for each conversion.
cConversionId :: Lens' Conversion (Maybe Text) Source
For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
cAdvertiserId :: Lens' Conversion (Maybe Int64) Source
DS advertiser ID.
cSegmentationId :: Lens' Conversion (Maybe Int64) Source
The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
cChannel :: Lens' Conversion (Maybe Text) Source
Sales channel for the product. Acceptable values are: - "local": a physical store - "online": an online store
cProductCountry :: Lens' Conversion (Maybe Text) Source
The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
cCampaignId :: Lens' Conversion (Maybe Int64) Source
DS campaign ID.
cCriterionId :: Lens' Conversion (Maybe Int64) Source
DS criterion (keyword) ID.
cConversionTimestamp :: Lens' Conversion (Maybe Word64) Source
The time at which the conversion took place, in epoch millis UTC.
cAttributionModel :: Lens' Conversion (Maybe Text) Source
This field is ignored.
cSegmentationName :: Lens' Conversion (Maybe Text) Source
The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
cProductLanguage :: Lens' Conversion (Maybe Text) Source
The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
cCustomMetric :: Lens' Conversion [CustomMetric] Source
Custom metrics for the conversion.
cCountMillis :: Lens' Conversion (Maybe Int64) Source
This field is ignored.
cQuantityMillis :: Lens' Conversion (Maybe Int64) Source
The quantity of this conversion, in millis.
cDeviceType :: Lens' Conversion (Maybe Text) Source
The type of device on which the conversion occurred.
cType :: Lens' Conversion (Maybe Text) Source
The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
cCustomDimension :: Lens' Conversion [CustomDimension] Source
Custom dimensions for the conversion, which can be used to filter data in a report.
cFloodlightOrderId :: Lens' Conversion (Maybe Text) Source
The Floodlight order ID provided by the advertiser for the conversion.
cRevenueMicros :: Lens' Conversion (Maybe Int64) Source
The revenue amount of this TRANSACTION conversion, in micros.
cInventoryAccountId :: Lens' Conversion (Maybe Int64) Source
ID that DS generates and uses to uniquely identify the inventory account that contains the product.
cSegmentationType :: Lens' Conversion (Maybe Text) Source
The segmentation type of this conversion (for example, FLOODLIGHT).
cProductId :: Lens' Conversion (Maybe Text) Source
The product ID (SKU).
cProductGroupId :: Lens' Conversion (Maybe Int64) Source
DS product group ID.
SavedColumn
data SavedColumn Source
A saved column
See: savedColumn
smart constructor.
savedColumn :: SavedColumn Source
Creates a value of SavedColumn
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scSavedColumnName :: Lens' SavedColumn (Maybe Text) Source
The name of the saved column.
scKind :: Lens' SavedColumn Text Source
Identifies this as a SavedColumn resource. Value: the fixed string doubleclicksearch#savedColumn.
CustomDimension
data CustomDimension Source
A message containing the custome dimension.
See: customDimension
smart constructor.
customDimension :: CustomDimension Source
Creates a value of CustomDimension
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
UpdateAvailabilityResponse
data UpdateAvailabilityResponse Source
The response to a update availability request.
See: updateAvailabilityResponse
smart constructor.
updateAvailabilityResponse :: UpdateAvailabilityResponse Source
Creates a value of UpdateAvailabilityResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uAvailabilities :: Lens' UpdateAvailabilityResponse [Availability] Source
The availabilities being returned.
ReportRequestReportScope
data ReportRequestReportScope Source
The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
See: reportRequestReportScope
smart constructor.
reportRequestReportScope :: ReportRequestReportScope Source
Creates a value of ReportRequestReportScope
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrrsKeywordId :: Lens' ReportRequestReportScope (Maybe Int64) Source
DS keyword ID.
rrrsAdGroupId :: Lens' ReportRequestReportScope (Maybe Int64) Source
DS ad group ID.
rrrsEngineAccountId :: Lens' ReportRequestReportScope (Maybe Int64) Source
DS engine account ID.
rrrsAgencyId :: Lens' ReportRequestReportScope (Maybe Int64) Source
DS agency ID.
rrrsAdvertiserId :: Lens' ReportRequestReportScope (Maybe Int64) Source
DS advertiser ID.
rrrsCampaignId :: Lens' ReportRequestReportScope (Maybe Int64) Source
DS campaign ID.
SavedColumnList
data SavedColumnList Source
A list of saved columns. Advertisers create saved columns to report on Floodlight activities, Google Analytics goals, or custom KPIs. To request reports with saved columns, you'll need the saved column names that are available from this list.
See: savedColumnList
smart constructor.
savedColumnList :: SavedColumnList Source
Creates a value of SavedColumnList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sclKind :: Lens' SavedColumnList Text Source
Identifies this as a SavedColumnList resource. Value: the fixed string doubleclicksearch#savedColumnList.
sclItems :: Lens' SavedColumnList [SavedColumn] Source
The saved columns being requested.