| { |
| "ownerDomain": "google.com", |
| "id": "doubleclicksearch:v2", |
| "description": "The Search Ads 360 API allows developers to automate uploading conversions and downloading reports from Search Ads 360.", |
| "documentationLink": "https://developers.google.com/search-ads", |
| "protocol": "rest", |
| "name": "doubleclicksearch", |
| "resources": { |
| "reports": { |
| "methods": { |
| "get": { |
| "flatPath": "doubleclicksearch/v2/reports/{reportId}", |
| "scopes": [ |
| "https://www.googleapis.com/auth/doubleclicksearch" |
| ], |
| "path": "doubleclicksearch/v2/reports/{reportId}", |
| "response": { |
| "$ref": "Report" |
| }, |
| "parameterOrder": [ |
| "reportId" |
| ], |
| "id": "doubleclicksearch.reports.get", |
| "description": "Polls for the status of a report request.", |
| "httpMethod": "GET", |
| "parameters": { |
| "reportId": { |
| "type": "string", |
| "required": true, |
| "description": "ID of the report request being polled.", |
| "location": "path" |
| } |
| } |
| }, |
| "getFile": { |
| "httpMethod": "GET", |
| "scopes": [ |
| "https://www.googleapis.com/auth/doubleclicksearch" |
| ], |
| "useMediaDownloadService": true, |
| "parameters": { |
| "reportId": { |
| "description": "ID of the report.", |
| "required": true, |
| "location": "path", |
| "type": "string" |
| }, |
| "reportFragment": { |
| "format": "int32", |
| "required": true, |
| "type": "integer", |
| "location": "path", |
| "description": "The index of the report fragment to download.", |
| "minimum": "0" |
| } |
| }, |
| "parameterOrder": [ |
| "reportId", |
| "reportFragment" |
| ], |
| "flatPath": "doubleclicksearch/v2/reports/{reportId}/files/{reportFragment}", |
| "id": "doubleclicksearch.reports.getFile", |
| "supportsMediaDownload": true, |
| "path": "doubleclicksearch/v2/reports/{reportId}/files/{reportFragment}", |
| "description": "Downloads a report file encoded in UTF-8." |
| }, |
| "generate": { |
| "description": "Generates and returns a report immediately.", |
| "parameterOrder": [], |
| "request": { |
| "$ref": "ReportRequest" |
| }, |
| "id": "doubleclicksearch.reports.generate", |
| "scopes": [ |
| "https://www.googleapis.com/auth/doubleclicksearch" |
| ], |
| "flatPath": "doubleclicksearch/v2/reports/generate", |
| "response": { |
| "$ref": "Report" |
| }, |
| "httpMethod": "POST", |
| "parameters": {}, |
| "path": "doubleclicksearch/v2/reports/generate" |
| }, |
| "request": { |
| "request": { |
| "$ref": "ReportRequest" |
| }, |
| "flatPath": "doubleclicksearch/v2/reports", |
| "httpMethod": "POST", |
| "response": { |
| "$ref": "Report" |
| }, |
| "path": "doubleclicksearch/v2/reports", |
| "parameters": {}, |
| "description": "Inserts a report request into the reporting system.", |
| "scopes": [ |
| "https://www.googleapis.com/auth/doubleclicksearch" |
| ], |
| "id": "doubleclicksearch.reports.request", |
| "parameterOrder": [] |
| } |
| } |
| }, |
| "conversion": { |
| "methods": { |
| "update": { |
| "path": "doubleclicksearch/v2/conversion", |
| "flatPath": "doubleclicksearch/v2/conversion", |
| "parameterOrder": [], |
| "httpMethod": "PUT", |
| "response": { |
| "$ref": "ConversionList" |
| }, |
| "id": "doubleclicksearch.conversion.update", |
| "scopes": [ |
| "https://www.googleapis.com/auth/doubleclicksearch" |
| ], |
| "parameters": {}, |
| "request": { |
| "$ref": "ConversionList" |
| }, |
| "description": "Updates a batch of conversions in DoubleClick Search." |
| }, |
| "insert": { |
| "httpMethod": "POST", |
| "description": "Inserts a batch of new conversions into DoubleClick Search.", |
| "id": "doubleclicksearch.conversion.insert", |
| "parameters": {}, |
| "response": { |
| "$ref": "ConversionList" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/doubleclicksearch" |
| ], |
| "path": "doubleclicksearch/v2/conversion", |
| "flatPath": "doubleclicksearch/v2/conversion", |
| "parameterOrder": [], |
| "request": { |
| "$ref": "ConversionList" |
| } |
| }, |
| "get": { |
| "parameters": { |
| "rowCount": { |
| "required": true, |
| "location": "query", |
| "minimum": "1", |
| "maximum": "1000", |
| "type": "integer", |
| "format": "int32", |
| "description": "The number of conversions to return per call." |
| }, |
| "startRow": { |
| "location": "query", |
| "type": "integer", |
| "format": "uint32", |
| "required": true, |
| "description": "The 0-based starting index for retrieving conversions results." |
| }, |
| "adGroupId": { |
| "type": "string", |
| "location": "query", |
| "description": "Numeric ID of the ad group.", |
| "format": "int64" |
| }, |
| "campaignId": { |
| "description": "Numeric ID of the campaign.", |
| "location": "query", |
| "type": "string", |
| "format": "int64" |
| }, |
| "advertiserId": { |
| "location": "path", |
| "description": "Numeric ID of the advertiser.", |
| "format": "int64", |
| "type": "string", |
| "required": true |
| }, |
| "endDate": { |
| "maximum": "99991231", |
| "minimum": "20091101", |
| "format": "int32", |
| "required": true, |
| "description": "Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.", |
| "location": "query", |
| "type": "integer" |
| }, |
| "adId": { |
| "location": "query", |
| "type": "string", |
| "description": "Numeric ID of the ad.", |
| "format": "int64" |
| }, |
| "criterionId": { |
| "location": "query", |
| "format": "int64", |
| "type": "string", |
| "description": "Numeric ID of the criterion." |
| }, |
| "engineAccountId": { |
| "required": true, |
| "type": "string", |
| "location": "path", |
| "format": "int64", |
| "description": "Numeric ID of the engine account." |
| }, |
| "startDate": { |
| "format": "int32", |
| "maximum": "99991231", |
| "type": "integer", |
| "description": "First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.", |
| "location": "query", |
| "minimum": "20091101", |
| "required": true |
| }, |
| "agencyId": { |
| "type": "string", |
| "required": true, |
| "location": "path", |
| "description": "Numeric ID of the agency.", |
| "format": "int64" |
| } |
| }, |
| "description": "Retrieves a list of conversions from a DoubleClick Search engine account.", |
| "response": { |
| "$ref": "ConversionList" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/doubleclicksearch" |
| ], |
| "path": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion", |
| "parameterOrder": [ |
| "agencyId", |
| "advertiserId", |
| "engineAccountId", |
| "endDate", |
| "rowCount", |
| "startDate", |
| "startRow" |
| ], |
| "flatPath": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion", |
| "httpMethod": "GET", |
| "id": "doubleclicksearch.conversion.get" |
| }, |
| "updateAvailability": { |
| "parameterOrder": [], |
| "flatPath": "doubleclicksearch/v2/conversion/updateAvailability", |
| "parameters": {}, |
| "id": "doubleclicksearch.conversion.updateAvailability", |
| "httpMethod": "POST", |
| "description": "Updates the availabilities of a batch of floodlight activities in DoubleClick Search.", |
| "scopes": [ |
| "https://www.googleapis.com/auth/doubleclicksearch" |
| ], |
| "path": "doubleclicksearch/v2/conversion/updateAvailability", |
| "request": { |
| "$ref": "UpdateAvailabilityRequest" |
| }, |
| "response": { |
| "$ref": "UpdateAvailabilityResponse" |
| } |
| } |
| } |
| }, |
| "savedColumns": { |
| "methods": { |
| "list": { |
| "id": "doubleclicksearch.savedColumns.list", |
| "response": { |
| "$ref": "SavedColumnList" |
| }, |
| "description": "Retrieve the list of saved columns for a specified advertiser.", |
| "parameterOrder": [ |
| "agencyId", |
| "advertiserId" |
| ], |
| "path": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/savedcolumns", |
| "scopes": [ |
| "https://www.googleapis.com/auth/doubleclicksearch" |
| ], |
| "httpMethod": "GET", |
| "parameters": { |
| "agencyId": { |
| "required": true, |
| "location": "path", |
| "type": "string", |
| "description": "DS ID of the agency.", |
| "format": "int64" |
| }, |
| "advertiserId": { |
| "type": "string", |
| "format": "int64", |
| "description": "DS ID of the advertiser.", |
| "location": "path", |
| "required": true |
| } |
| }, |
| "flatPath": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/savedcolumns" |
| } |
| } |
| } |
| }, |
| "revision": "20200825", |
| "ownerName": "Google", |
| "schemas": { |
| "ReportRow": { |
| "description": "A row in a DoubleClick Search report.", |
| "additionalProperties": { |
| "description": "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.", |
| "type": "any" |
| }, |
| "type": "object", |
| "id": "ReportRow" |
| }, |
| "ConversionList": { |
| "type": "object", |
| "description": "A list of conversions.", |
| "id": "ConversionList", |
| "properties": { |
| "kind": { |
| "description": "Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.", |
| "type": "string" |
| }, |
| "conversion": { |
| "items": { |
| "$ref": "Conversion" |
| }, |
| "description": "The conversions being requested.", |
| "type": "array" |
| } |
| } |
| }, |
| "Conversion": { |
| "properties": { |
| "quantityMillis": { |
| "type": "string", |
| "format": "int64", |
| "description": "The quantity of this conversion, in millis." |
| }, |
| "criterionId": { |
| "type": "string", |
| "description": "DS criterion (keyword) ID.", |
| "format": "int64" |
| }, |
| "customMetric": { |
| "description": "Custom metrics for the conversion.", |
| "items": { |
| "$ref": "CustomMetric" |
| }, |
| "type": "array" |
| }, |
| "dsConversionId": { |
| "description": "ID that DoubleClick Search generates for each conversion.", |
| "type": "string", |
| "format": "int64" |
| }, |
| "conversionModifiedTimestamp": { |
| "description": "The time at which the conversion was last modified, in epoch millis UTC.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "channel": { |
| "type": "string", |
| "description": "Sales channel for the product. Acceptable values are: - \"`local`\": a physical store - \"`online`\": an online store " |
| }, |
| "productCountry": { |
| "description": "The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.", |
| "type": "string" |
| }, |
| "storeId": { |
| "description": "The ID of the local store for which the product was advertised. Applicable only when the channel is \"`local`\".", |
| "type": "string" |
| }, |
| "adGroupId": { |
| "type": "string", |
| "format": "int64", |
| "description": "DS ad group ID." |
| }, |
| "segmentationType": { |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.conversion.insert" |
| ] |
| }, |
| "type": "string", |
| "description": "The segmentation type of this conversion (for example, `FLOODLIGHT`)." |
| }, |
| "conversionTimestamp": { |
| "description": "The time at which the conversion took place, in epoch millis UTC.", |
| "type": "string", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.conversion.insert" |
| ] |
| } |
| }, |
| "attributionModel": { |
| "description": "Available to advertisers only after contacting DoubleClick Search customer support.", |
| "type": "string" |
| }, |
| "state": { |
| "description": "The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.", |
| "type": "string" |
| }, |
| "productId": { |
| "type": "string", |
| "description": "The product ID (SKU)." |
| }, |
| "deviceType": { |
| "description": "The type of device on which the conversion occurred.", |
| "type": "string" |
| }, |
| "productLanguage": { |
| "description": "The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.", |
| "type": "string" |
| }, |
| "advertiserId": { |
| "type": "string", |
| "description": "DS advertiser ID.", |
| "format": "int64" |
| }, |
| "adId": { |
| "type": "string", |
| "format": "int64", |
| "description": "DS ad ID." |
| }, |
| "inventoryAccountId": { |
| "description": "ID that DS generates and uses to uniquely identify the inventory account that contains the product.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "customDimension": { |
| "description": "Custom dimensions for the conversion, which can be used to filter data in a report.", |
| "type": "array", |
| "items": { |
| "$ref": "CustomDimension" |
| } |
| }, |
| "segmentationId": { |
| "description": "The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).", |
| "type": "string", |
| "format": "int64" |
| }, |
| "productGroupId": { |
| "type": "string", |
| "description": "DS product group ID.", |
| "format": "int64" |
| }, |
| "currencyCode": { |
| "type": "string", |
| "description": "The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format." |
| }, |
| "type": { |
| "description": "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`).", |
| "type": "string" |
| }, |
| "countMillis": { |
| "description": "Available to advertisers only after contacting DoubleClick Search customer support.", |
| "type": "string", |
| "format": "int64" |
| }, |
| "agencyId": { |
| "type": "string", |
| "format": "int64", |
| "description": "DS agency ID." |
| }, |
| "revenueMicros": { |
| "type": "string", |
| "description": "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." |
| }, |
| "clickId": { |
| "description": "DS click ID for the conversion.", |
| "type": "string" |
| }, |
| "segmentationName": { |
| "type": "string", |
| "description": "The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name)." |
| }, |
| "engineAccountId": { |
| "description": "DS engine account ID.", |
| "type": "string", |
| "format": "int64" |
| }, |
| "floodlightOrderId": { |
| "type": "string", |
| "description": "The Floodlight order ID provided by the advertiser for the conversion." |
| }, |
| "conversionId": { |
| "description": "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.", |
| "type": "string", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.conversion.insert" |
| ] |
| } |
| }, |
| "campaignId": { |
| "type": "string", |
| "description": "DS campaign ID.", |
| "format": "int64" |
| } |
| }, |
| "description": "A conversion containing data relevant to DoubleClick Search.", |
| "type": "object", |
| "id": "Conversion" |
| }, |
| "UpdateAvailabilityRequest": { |
| "type": "object", |
| "properties": { |
| "availabilities": { |
| "description": "The availabilities being requested.", |
| "items": { |
| "$ref": "Availability" |
| }, |
| "type": "array" |
| } |
| }, |
| "description": "The request to update availability.", |
| "id": "UpdateAvailabilityRequest" |
| }, |
| "SavedColumn": { |
| "id": "SavedColumn", |
| "type": "object", |
| "description": "A saved column", |
| "properties": { |
| "kind": { |
| "description": "Identifies this as a SavedColumn resource. Value: the fixed string doubleclicksearch#savedColumn.", |
| "type": "string" |
| }, |
| "type": { |
| "type": "string", |
| "description": "The type of data this saved column will produce." |
| }, |
| "savedColumnName": { |
| "description": "The name of the saved column.", |
| "type": "string" |
| } |
| } |
| }, |
| "SavedColumnList": { |
| "properties": { |
| "items": { |
| "type": "array", |
| "items": { |
| "$ref": "SavedColumn" |
| }, |
| "description": "The saved columns being requested." |
| }, |
| "kind": { |
| "type": "string", |
| "description": "Identifies this as a SavedColumnList resource. Value: the fixed string doubleclicksearch#savedColumnList." |
| } |
| }, |
| "type": "object", |
| "id": "SavedColumnList", |
| "description": "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." |
| }, |
| "ReportApiColumnSpec": { |
| "id": "ReportApiColumnSpec", |
| "properties": { |
| "endDate": { |
| "description": "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`.", |
| "type": "string" |
| }, |
| "groupByColumn": { |
| "description": "Synchronous report only. Set to `true` to group by this column. Defaults to `false`.", |
| "type": "boolean" |
| }, |
| "columnName": { |
| "description": "Name of a DoubleClick Search column to include in the report.", |
| "type": "string" |
| }, |
| "savedColumnName": { |
| "type": "string", |
| "description": "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." |
| }, |
| "startDate": { |
| "description": "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`.", |
| "type": "string" |
| }, |
| "headerText": { |
| "description": "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.", |
| "type": "string" |
| }, |
| "productReportPerspective": { |
| "type": "string", |
| "description": "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 " |
| }, |
| "platformSource": { |
| "type": "string", |
| "description": "The platform that is used to provide data for the custom dimension. Acceptable values are \"floodlight\"." |
| }, |
| "customMetricName": { |
| "type": "string", |
| "description": "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." |
| }, |
| "customDimensionName": { |
| "description": "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.", |
| "type": "string" |
| } |
| }, |
| "description": "A request object used to create a DoubleClick Search report.", |
| "type": "object" |
| }, |
| "Availability": { |
| "type": "object", |
| "id": "Availability", |
| "properties": { |
| "advertiserId": { |
| "format": "int64", |
| "type": "string", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.conversion.updateAvailability" |
| ] |
| }, |
| "description": "DS advertiser ID." |
| }, |
| "segmentationId": { |
| "type": "string", |
| "description": "The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).", |
| "format": "int64" |
| }, |
| "agencyId": { |
| "description": "DS agency ID.", |
| "format": "int64", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.conversion.updateAvailability" |
| ] |
| }, |
| "type": "string" |
| }, |
| "segmentationName": { |
| "type": "string", |
| "description": "The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name)." |
| }, |
| "availabilityTimestamp": { |
| "description": "The time by which all conversions have been uploaded, in epoch millis UTC.", |
| "format": "int64", |
| "type": "string", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.conversion.updateAvailability" |
| ] |
| } |
| }, |
| "segmentationType": { |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.conversion.updateAvailability" |
| ] |
| }, |
| "type": "string", |
| "description": "The segmentation type that this availability is for (its default value is `FLOODLIGHT`)." |
| } |
| }, |
| "description": "A message containing availability data relevant to DoubleClick Search." |
| }, |
| "UpdateAvailabilityResponse": { |
| "properties": { |
| "availabilities": { |
| "type": "array", |
| "description": "The availabilities being returned.", |
| "items": { |
| "$ref": "Availability" |
| } |
| } |
| }, |
| "description": "The response to a update availability request.", |
| "id": "UpdateAvailabilityResponse", |
| "type": "object" |
| }, |
| "ReportRequest": { |
| "properties": { |
| "includeDeletedEntities": { |
| "type": "boolean", |
| "description": "Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead." |
| }, |
| "rowCount": { |
| "type": "integer", |
| "description": "Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.", |
| "format": "int32", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.reports.generate" |
| ] |
| } |
| }, |
| "downloadFormat": { |
| "type": "string", |
| "description": "Format that the report should be returned in. Currently `csv` or `tsv` is supported.", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.reports.request" |
| ] |
| } |
| }, |
| "reportScope": { |
| "type": "object", |
| "description": "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.", |
| "properties": { |
| "campaignId": { |
| "type": "string", |
| "format": "int64", |
| "description": "DS campaign ID." |
| }, |
| "keywordId": { |
| "type": "string", |
| "format": "int64", |
| "description": "DS keyword ID." |
| }, |
| "advertiserId": { |
| "type": "string", |
| "format": "int64", |
| "description": "DS advertiser ID." |
| }, |
| "engineAccountId": { |
| "format": "int64", |
| "type": "string", |
| "description": "DS engine account ID." |
| }, |
| "agencyId": { |
| "description": "DS agency ID.", |
| "type": "string", |
| "format": "int64" |
| }, |
| "adGroupId": { |
| "format": "int64", |
| "type": "string", |
| "description": "DS ad group ID." |
| }, |
| "adId": { |
| "format": "int64", |
| "description": "DS ad ID.", |
| "type": "string" |
| } |
| } |
| }, |
| "includeRemovedEntities": { |
| "description": "Determines if removed entities should be included in the report. Defaults to `false`.", |
| "type": "boolean" |
| }, |
| "orderBy": { |
| "items": { |
| "properties": { |
| "sortOrder": { |
| "type": "string", |
| "description": "The sort direction, which is either `ascending` or `descending`." |
| }, |
| "column": { |
| "description": "Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.", |
| "$ref": "ReportApiColumnSpec" |
| } |
| }, |
| "type": "object" |
| }, |
| "description": "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.", |
| "type": "array" |
| }, |
| "verifySingleTimeZone": { |
| "type": "boolean", |
| "description": "If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`." |
| }, |
| "statisticsCurrency": { |
| "type": "string", |
| "description": "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).", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.reports.generate", |
| "doubleclicksearch.reports.request" |
| ] |
| } |
| }, |
| "maxRowsPerFile": { |
| "type": "integer", |
| "format": "int32", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.reports.request" |
| ] |
| }, |
| "description": "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." |
| }, |
| "startRow": { |
| "type": "integer", |
| "format": "int32", |
| "description": "Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.reports.generate" |
| ] |
| } |
| }, |
| "timeRange": { |
| "description": "If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.", |
| "properties": { |
| "endDate": { |
| "description": "Inclusive date in YYYY-MM-DD format.", |
| "type": "string" |
| }, |
| "changedAttributesSinceTimestamp": { |
| "type": "string", |
| "description": "Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed attribute reports work." |
| }, |
| "startDate": { |
| "type": "string", |
| "description": "Inclusive date in YYYY-MM-DD format." |
| }, |
| "changedMetricsSinceTimestamp": { |
| "type": "string", |
| "description": "Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed metrics reports work." |
| } |
| }, |
| "type": "object" |
| }, |
| "reportType": { |
| "type": "string", |
| "description": "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](/search-ads/v2/report-types/) reference for the columns that are available for each type.", |
| "annotations": { |
| "required": [ |
| "doubleclicksearch.reports.generate", |
| "doubleclicksearch.reports.request" |
| ] |
| } |
| }, |
| "columns": { |
| "type": "array", |
| "items": { |
| "$ref": "ReportApiColumnSpec" |
| }, |
| "description": "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." |
| }, |
| "filters": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "properties": { |
| "column": { |
| "$ref": "ReportApiColumnSpec", |
| "description": "Column to perform the filter on. This can be a DoubleClick Search column or a saved column." |
| }, |
| "values": { |
| "description": "A list of values to filter the column value against.\\ The maximum number of filter values per request is 300.", |
| "type": "array", |
| "items": { |
| "type": "any" |
| } |
| }, |
| "operator": { |
| "description": "Operator to use in the filter. See the filter reference for a list of available operators.", |
| "type": "string" |
| } |
| } |
| }, |
| "description": "A list of filters to be applied to the report.\\ The maximum number of filters per request is 300." |
| } |
| }, |
| "description": "A request object used to create a DoubleClick Search report.", |
| "id": "ReportRequest", |
| "type": "object" |
| }, |
| "CustomDimension": { |
| "type": "object", |
| "id": "CustomDimension", |
| "description": "A message containing the custom dimension.", |
| "properties": { |
| "name": { |
| "description": "Custom dimension name.", |
| "type": "string" |
| }, |
| "value": { |
| "description": "Custom dimension value.", |
| "type": "string" |
| } |
| } |
| }, |
| "CustomMetric": { |
| "id": "CustomMetric", |
| "properties": { |
| "name": { |
| "description": "Custom metric name.", |
| "type": "string" |
| }, |
| "value": { |
| "type": "number", |
| "description": "Custom metric numeric value.", |
| "format": "double" |
| } |
| }, |
| "description": "A message containing the custom metric.", |
| "type": "object" |
| }, |
| "Report": { |
| "type": "object", |
| "properties": { |
| "files": { |
| "description": "Asynchronous report only. Contains a list of generated report files once the report has successfully completed.", |
| "items": { |
| "type": "object", |
| "properties": { |
| "byteCount": { |
| "type": "string", |
| "description": "The size of this report file in bytes.", |
| "format": "int64" |
| }, |
| "url": { |
| "type": "string", |
| "description": "Use this url to download the report file." |
| } |
| } |
| }, |
| "type": "array" |
| }, |
| "request": { |
| "description": "The request that created the report. Optional fields not specified in the original request are filled with default values.", |
| "$ref": "ReportRequest" |
| }, |
| "id": { |
| "type": "string", |
| "description": "Asynchronous report only. Id of the report." |
| }, |
| "statisticsTimeZone": { |
| "description": "If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.", |
| "type": "string" |
| }, |
| "rowCount": { |
| "format": "int32", |
| "type": "integer", |
| "description": "The number of report rows generated by the report, not including headers." |
| }, |
| "statisticsCurrencyCode": { |
| "description": "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.", |
| "type": "string" |
| }, |
| "kind": { |
| "type": "string", |
| "description": "Identifies this as a Report resource. Value: the fixed string `doubleclicksearch#report`." |
| }, |
| "rows": { |
| "description": "Synchronous report only. Generated report rows.", |
| "type": "array", |
| "items": { |
| "$ref": "ReportRow" |
| } |
| }, |
| "isReportReady": { |
| "description": "Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.", |
| "type": "boolean" |
| } |
| }, |
| "description": "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.", |
| "id": "Report" |
| } |
| }, |
| "basePath": "", |
| "version": "v2", |
| "kind": "discovery#restDescription", |
| "baseUrl": "https://doubleclicksearch.googleapis.com/", |
| "rootUrl": "https://doubleclicksearch.googleapis.com/", |
| "batchPath": "batch", |
| "discoveryVersion": "v1", |
| "mtlsRootUrl": "https://doubleclicksearch.mtls.googleapis.com/", |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "servicePath": "", |
| "title": "Search Ads 360 API", |
| "canonicalName": "Doubleclicksearch", |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/doubleclicksearch": { |
| "description": "View and manage your advertising data in DoubleClick Search" |
| } |
| } |
| } |
| }, |
| "parameters": { |
| "callback": { |
| "type": "string", |
| "location": "query", |
| "description": "JSONP" |
| }, |
| "oauth_token": { |
| "type": "string", |
| "location": "query", |
| "description": "OAuth 2.0 token for the current user." |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query", |
| "type": "string" |
| }, |
| "$.xgafv": { |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "location": "query", |
| "description": "V1 error format.", |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "type": "string" |
| }, |
| "access_token": { |
| "location": "query", |
| "description": "OAuth access token.", |
| "type": "string" |
| }, |
| "key": { |
| "location": "query", |
| "type": "string", |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." |
| }, |
| "alt": { |
| "location": "query", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "default": "json", |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "description": "Data format for response.", |
| "type": "string" |
| }, |
| "uploadType": { |
| "type": "string", |
| "location": "query", |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." |
| }, |
| "prettyPrint": { |
| "default": "true", |
| "location": "query", |
| "description": "Returns response with indentations and line breaks.", |
| "type": "boolean" |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "type": "string", |
| "location": "query" |
| }, |
| "quotaUser": { |
| "location": "query", |
| "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
| "type": "string" |
| } |
| } |
| } |
