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.

View and manage your advertising data in DoubleClick Search

Represents the entirety of the methods and resources available for the DoubleClick Search API service.

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

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.

A request object used to create a DoubleClick Search report.

See: reportRequest smart constructor.

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
• rrReportScope
• rrStatisticsCurrency
• rrTimeRange
• rrOrderBy
• rrFilters
• rrIncludeRemovedEntities
• rrIncludeDeletedEntities
• rrDownloadFormat
• rrStartRow
• rrColumns
• rrReportType
• rrVerifySingleTimeZone
• rrRowCount

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.

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.

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

If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.

Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows. The maximum number of orderings per request is 300.

A list of filters to be applied to the report. The maximum number of filters per request is 300.

Determines if removed entities should be included in the report. Defaults to false.

Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.

Format that the report should be returned in. Currently csv or tsv is supported.

Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.

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. The maximum number of columns per request is 300.

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.

If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.

Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.

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
• rrobiColumn

The sort direction, which is either ascending or descending.

Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.

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
• rRows
• rStatisticsCurrencyCode
• rIsReportReady
• rFiles
• rId
• rStatisticsTimeZone
• rRowCount
• rRequest

Identifies this as a Report resource. Value: the fixed string doubleclicksearch#report.

Synchronous report only. Generated report rows.

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.

Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.

Asynchronous report only. Contains a list of generated report files once the report has succesfully completed.

Asynchronous report only. Id of the report.

If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.

The number of report rows generated by the report, not including headers.

The request that created the report. Optional fields not specified in the original request are filled with default values.

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
• rfiByteCount

Use this url to download the report file.

The size of this report file in bytes.

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
• rrfiValues
• rrfiColumn

Operator to use in the filter. See the filter reference for a list of available operators.

A list of values to filter the column value against. The maximum number of filter values per request is 300.

Column to perform the filter on. This can be a DoubleClick Search column or a saved column.

A message containing availability data relevant to DoubleClick Search.

See: availability smart constructor.

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:

• aAgencyId
• aAdvertiserId
• aSegmentationId
• aSegmentationName
• aAvailabilityTimestamp
• aSegmentationType

DS agency ID.

DS advertiser ID.

The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

The time by which all conversions have been uploaded, in epoch millis UTC.

The segmentation type that this availability is for (its default value is FLOODLIGHT).

The request to update availability.

See: updateAvailabilityRequest smart constructor.

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

The availabilities being requested.

A message containing the custome metric.

See: customMetric smart constructor.

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
• cmName

Custom metric numeric value.

Custom metric name.

A list of conversions.

See: conversionList smart constructor.

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
• clConversion

Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.

The conversions being requested.

A request object used to create a DoubleClick Search report.

See: reportAPIColumnSpec smart constructor.

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
• racsSavedColumnName
• racsGroupByColumn
• racsCustomMetricName
• racsEndDate
• racsProductReportPerspective
• racsStartDate
• racsHeaderText
• racsPlatformSource
• racsColumnName

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.

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.

Synchronous report only. Set to true to group by this column. Defaults to false.

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.

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.

Returns metrics only for a specific type of product activity. Accepted values are: - "sold": returns metrics only for products that were sold - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold

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.

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.

The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".

Name of a DoubleClick Search column to include in the report.

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.

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
• rrtrChangedAttributesSinceTimestamp
• rrtrStartDate
• rrtrChangedMetricsSinceTimestamp

Inclusive date in YYYY-MM-DD format.

Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work.

Inclusive date in YYYY-MM-DD format.

Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work.

A conversion containing data relevant to DoubleClick Search.

See: conversion smart constructor.

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

DS ad group ID.

The time at which the conversion was last modified, in epoch millis UTC.

The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.

DS engine account ID.

DS agency ID.

The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.

The ID of the local store for which the product was advertised. Applicable only when the channel is "local".

ID that DoubleClick Search generates for each conversion.

For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.

DS advertiser ID.

The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

Sales channel for the product. Acceptable values are: - "local": a physical store - "online": an online store

The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.

DS campaign ID.

DS criterion (keyword) ID.

The time at which the conversion took place, in epoch millis UTC.

Available to advertisers only after contacting DoubleClick Search customer support.

The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.

Custom metrics for the conversion.

Available to advertisers only after contacting DoubleClick Search customer support.

The quantity of this conversion, in millis.

DS ad ID.

The type of device on which the conversion occurred.

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

Custom dimensions for the conversion, which can be used to filter data in a report.

The Floodlight order ID provided by the advertiser for the conversion.

The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.

DS click ID for the conversion.

ID that DS generates and uses to uniquely identify the inventory account that contains the product.

The segmentation type of this conversion (for example, FLOODLIGHT).

The product ID (SKU).

DS product group ID.

A saved column

See: savedColumn smart constructor.

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
• scKind
• scType

The name of the saved column.

Identifies this as a SavedColumn resource. Value: the fixed string doubleclicksearch#savedColumn.

The type of data this saved column will produce.

A message containing the custome dimension.

See: customDimension smart constructor.