Use wide Search Ads 360 API integration
With Ants & Apps platform you can connect Search Ads 360 API with more than 30 available apps, 600+ functional formulas to boost your productivity
Reference
conversion
This action retrieves a list of conversions from a DoubleClick Search engine account.
GETDoubleclicksearchConversionGet
Request parameters
- advertiserId*string
Numeric ID of the advertiser.
- agencyId*string
Numeric ID of the agency.
- endDate*integer
Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
- engineAccountId*string
Numeric ID of the engine account.
- rowCount*integer
The number of conversions to return per call.
- startDate*integer
First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
- startRow*integer
The 0-based starting index for retrieving conversions results.
- adGroupIdstring
Numeric ID of the ad group.
- adIdstring
Numeric ID of the ad.
- campaignIdstring
Numeric ID of the campaign.
- criterionIdstring
Numeric ID of the criterion.
This action inserts a batch of new conversions into DoubleClick Search.
POSTDoubleclicksearchConversionInsert
Request body
- conversionarray
The conversions being requested.
- kindstring
Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
This action updates the availabilities of a batch of floodlight activities in DoubleClick Search.
POSTDoubleclicksearchConversionUpdateAvailability
Request body
- availabilitiesarray
The availabilities being requested.
This action updates a batch of conversions in DoubleClick Search.
PUTDoubleclicksearchConversionUpdate
Request body
- conversionarray
The conversions being requested.
- kindstring
Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
This action updates a batch of conversions in DoubleClick Search. This method supports patch semantics.
PATCHDoubleclicksearchConversionPatch
Request parameters
- advertiserId*string
Numeric ID of the advertiser.
- agencyId*string
Numeric ID of the agency.
- endDate*integer
Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
- engineAccountId*string
Numeric ID of the engine account.
- rowCount*integer
The number of conversions to return per call.
- startDate*integer
First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
- startRow*integer
The 0-based starting index for retrieving conversions results.
Request body
- conversionarray
The conversions being requested.
- kindstring
Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
reports
GETDoubleclicksearchReportsGet
Request parameters
- reportId*string
ID of the report request being polled.
GETDoubleclicksearchReportsGetFile
Request parameters
- reportFragment*integer
The index of the report fragment to download.
- reportId*string
ID of the report.
POSTDoubleclicksearchReportsGenerate
Request body
- columnsarray
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.
- downloadFormatstring
Format that the report should be returned in. Currently csv or tsv is supported.
- filtersarray
A list of filters to be applied to the report. The maximum number of filters per request is 300.
- includeDeletedEntitiesboolean
Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
- includeRemovedEntitiesboolean
Determines if removed entities should be included in the report. Defaults to false.
- maxRowsPerFileinteger
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.
- orderByarray
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.
- reportScopeobject
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.
- reportTypestring
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.
- rowCountinteger
Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.
- startRowinteger
Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.
- statisticsCurrencystring
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).
- timeRangeobject
If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
- verifySingleTimeZoneboolean
If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
- metricFilterClausesarray
The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated.
- pageSizeinteger
Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to a higher value.
- hideValueRangesboolean
If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.
- hideTotalsboolean
If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.
- cohortGroupobject
Cohort group associated with this request. If there is a cohort group in the request the `ga:cohort` dimension must be present. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `cohortGroup` definition.
- filtersExpressionstring
Dimension or metric filters that restrict the data returned for your request. To use the `filtersExpression`, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects `ga:browser` dimension which starts with Firefox; `ga:browser=~^Firefox`. For more information on dimensions and metric filters, see [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).
- viewIdstring
The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `viewId`.
- metricsarray
The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.
- dimensionFilterClausesarray
The dimension filter clauses for filtering Dimension Values. They are logically combined with the `AND` operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions.
- orderBysarray
Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.
- segmentsarray
Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `segments` definition. Requests with segments must have the `ga:segment` dimension.
- samplingLevelstring
The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.
- dimensionsarray
The dimensions requested. Requests can have a total of 9 dimensions.
- dateRangesarray
Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The `reportRequest.dateRanges` field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `dateRanges` definition.
- pageTokenstring
A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request.
- pivotsarray
The pivot definitions. Requests can have a maximum of 2 pivots.
- includeEmptyRowsboolean
If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows.
This action inserts a report request into the reporting system.
POSTDoubleclicksearchReportsRequest
Request body
- columnsarray
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.
- downloadFormatstring
Format that the report should be returned in. Currently csv or tsv is supported.
- filtersarray
A list of filters to be applied to the report. The maximum number of filters per request is 300.
- includeDeletedEntitiesboolean
Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
- includeRemovedEntitiesboolean
Determines if removed entities should be included in the report. Defaults to false.
- maxRowsPerFileinteger
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.
- orderByarray
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.
- reportScopeobject
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.
- reportTypestring
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.
- rowCountinteger
Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.
- startRowinteger
Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.
- statisticsCurrencystring
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).
- timeRangeobject
If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
- verifySingleTimeZoneboolean
If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
- metricFilterClausesarray
The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated.
- pageSizeinteger
Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to a higher value.
- hideValueRangesboolean
If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.
- hideTotalsboolean
If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.
- cohortGroupobject
Cohort group associated with this request. If there is a cohort group in the request the `ga:cohort` dimension must be present. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `cohortGroup` definition.
- filtersExpressionstring
Dimension or metric filters that restrict the data returned for your request. To use the `filtersExpression`, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects `ga:browser` dimension which starts with Firefox; `ga:browser=~^Firefox`. For more information on dimensions and metric filters, see [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).
- viewIdstring
The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `viewId`.
- metricsarray
The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.
- dimensionFilterClausesarray
The dimension filter clauses for filtering Dimension Values. They are logically combined with the `AND` operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions.
- orderBysarray
Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.
- segmentsarray
Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `segments` definition. Requests with segments must have the `ga:segment` dimension.
- samplingLevelstring
The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.
- dimensionsarray
The dimensions requested. Requests can have a total of 9 dimensions.
- dateRangesarray
Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The `reportRequest.dateRanges` field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `dateRanges` definition.
- pageTokenstring
A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request.
- pivotsarray
The pivot definitions. Requests can have a maximum of 2 pivots.
- includeEmptyRowsboolean
If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows.