gogol-doubleclick-search-0.0.1: Google DoubleClick Search 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.DoubleClickSearch.Types

Contents

Description

 

Synopsis

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

data ReportRow Source

A row in a DoubleClick Search report.

See: reportRow smart constructor.

reportRow Source

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

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

data Report Source

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.

report :: Report Source

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.

rRows :: Lens' Report [ReportRow] Source

Synchronous report only. Generated report rows.

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.

rId :: Lens' Report (Maybe Text) Source

Asynchronous report only. Id of the report.

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

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:

rfiURL :: Lens' ReportFilesItem (Maybe Text) Source

Use this url to download the report file.

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:

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

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

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:

cmValue :: Lens' CustomMetric (Maybe Double) Source

Custom metric numeric value.

cmName :: Lens' CustomMetric (Maybe Text) Source

Custom metric name.

ConversionList

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

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

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.

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.

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.

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.

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.

cClickId :: Lens' Conversion (Maybe Text) Source

DS click ID for the conversion.

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

SavedColumn

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.

scType :: Lens' SavedColumn (Maybe Text) Source

The type of data this saved column will produce.

CustomDimension

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:

cdValue :: Lens' CustomDimension (Maybe Text) Source

Custom dimension value.

cdName :: Lens' CustomDimension (Maybe Text) Source

Custom dimension name.

UpdateAvailabilityResponse

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:

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.