Close httplib2 connections.
- -Retrieves a list of conversions from a DoubleClick Search engine account.
insert(body=None, x__xgafv=None)
Inserts a batch of new conversions into DoubleClick Search.
@@ -95,82 +92,6 @@Close httplib2 connections.-
get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None, x__xgafv=None)
- Retrieves a list of conversions from a DoubleClick Search engine account.
-
-Args:
- agencyId: string, Numeric ID of the agency. (required)
- advertiserId: string, Numeric ID of the advertiser. (required)
- engineAccountId: string, Numeric ID of the engine account. (required)
- endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
- rowCount: integer, The number of conversions to return per call. (required)
- startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
- startRow: integer, The 0-based starting index for retrieving conversions results. (required)
- adGroupId: string, Numeric ID of the ad group.
- adId: string, Numeric ID of the ad.
- campaignId: string, Numeric ID of the campaign.
- criterionId: string, Numeric ID of the criterion.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A list of conversions.
- "conversion": [ # The conversions being requested.
- { # A conversion containing data relevant to DoubleClick Search.
- "adGroupId": "A String", # DS ad group ID.
- "adId": "A String", # DS ad ID.
- "advertiserId": "A String", # DS advertiser ID.
- "agencyId": "A String", # DS agency ID.
- "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
- "campaignId": "A String", # DS campaign ID.
- "channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store
- "clickId": "A String", # DS click ID for the conversion.
- "conversionId": "A String", # 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.
- "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
- "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
- "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
- "criterionId": "A String", # DS criterion (keyword) ID.
- "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
- "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
- { # A message containing the custom dimension.
- "name": "A String", # Custom dimension name.
- "value": "A String", # Custom dimension value.
- },
- ],
- "customMetric": [ # Custom metrics for the conversion.
- { # A message containing the custom metric.
- "name": "A String", # Custom metric name.
- "value": 3.14, # Custom metric numeric value.
- },
- ],
- "deviceType": "A String", # The type of device on which the conversion occurred.
- "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
- "engineAccountId": "A String", # DS engine account ID.
- "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
- "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
- "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
- "productGroupId": "A String", # DS product group ID.
- "productId": "A String", # The product ID (SKU).
- "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
- "quantityMillis": "A String", # The quantity of this conversion, in millis.
- "revenueMicros": "A String", # 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.
- "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
- "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
- "segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`).
- "state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
- "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`".
- "type": "A String", # 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`).
- },
- ],
- "kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
-}
-insert(body=None, x__xgafv=None)
Inserts a batch of new conversions into DoubleClick Search. @@ -208,6 +129,7 @@Method Details
"value": 3.14, # Custom metric numeric value. }, ], + "customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience. "deviceType": "A String", # The type of device on which the conversion occurred. "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. "engineAccountId": "A String", # DS engine account ID. @@ -267,6 +189,7 @@Method Details
"value": 3.14, # Custom metric numeric value. }, ], + "customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience. "deviceType": "A String", # The type of device on which the conversion occurred. "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. "engineAccountId": "A String", # DS engine account ID. @@ -327,6 +250,7 @@Method Details
"value": 3.14, # Custom metric numeric value. }, ], + "customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience. "deviceType": "A String", # The type of device on which the conversion occurred. "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. "engineAccountId": "A String", # DS engine account ID. @@ -386,6 +310,7 @@Method Details
"value": 3.14, # Custom metric numeric value. }, ], + "customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience. "deviceType": "A String", # The type of device on which the conversion occurred. "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. "engineAccountId": "A String", # DS engine account ID. @@ -423,6 +348,7 @@Method Details
"advertiserId": "A String", # DS advertiser ID. "agencyId": "A String", # DS agency ID. "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC. + "customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience. "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). "segmentationType": "A String", # The segmentation type that this availability is for (its default value is `FLOODLIGHT`). @@ -444,6 +370,7 @@Method Details
"advertiserId": "A String", # DS advertiser ID. "agencyId": "A String", # DS agency ID. "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC. + "customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience. "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). "segmentationType": "A String", # The segmentation type that this availability is for (its default value is `FLOODLIGHT`). diff --git a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json index 0b7c6e064b9..b4aaf8c0230 100644 --- a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json @@ -106,109 +106,6 @@ "resources": { "conversion": { "methods": { - "get": { - "description": "Retrieves a list of conversions from a DoubleClick Search engine account.", - "flatPath": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion", - "httpMethod": "GET", - "id": "doubleclicksearch.conversion.get", - "parameterOrder": [ - "agencyId", - "advertiserId", - "engineAccountId", - "endDate", - "rowCount", - "startDate", - "startRow" - ], - "parameters": { - "adGroupId": { - "description": "Numeric ID of the ad group.", - "format": "int64", - "location": "query", - "type": "string" - }, - "adId": { - "description": "Numeric ID of the ad.", - "format": "int64", - "location": "query", - "type": "string" - }, - "advertiserId": { - "description": "Numeric ID of the advertiser.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - }, - "agencyId": { - "description": "Numeric ID of the agency.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - }, - "campaignId": { - "description": "Numeric ID of the campaign.", - "format": "int64", - "location": "query", - "type": "string" - }, - "criterionId": { - "description": "Numeric ID of the criterion.", - "format": "int64", - "location": "query", - "type": "string" - }, - "endDate": { - "description": "Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.", - "format": "int32", - "location": "query", - "maximum": "99991231", - "minimum": "20091101", - "required": true, - "type": "integer" - }, - "engineAccountId": { - "description": "Numeric ID of the engine account.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - }, - "rowCount": { - "description": "The number of conversions to return per call.", - "format": "int32", - "location": "query", - "maximum": "1000", - "minimum": "1", - "required": true, - "type": "integer" - }, - "startDate": { - "description": "First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.", - "format": "int32", - "location": "query", - "maximum": "99991231", - "minimum": "20091101", - "required": true, - "type": "integer" - }, - "startRow": { - "description": "The 0-based starting index for retrieving conversions results.", - "format": "uint32", - "location": "query", - "required": true, - "type": "integer" - } - }, - "path": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion", - "response": { - "$ref": "ConversionList" - }, - "scopes": [ - "https://www.googleapis.com/auth/doubleclicksearch" - ] - }, "insert": { "description": "Inserts a batch of new conversions into DoubleClick Search.", "flatPath": "doubleclicksearch/v2/conversion", @@ -434,7 +331,7 @@ } } }, - "revision": "20221004", + "revision": "20221011", "rootUrl": "https://doubleclicksearch.googleapis.com/", "schemas": { "Availability": { @@ -471,6 +368,10 @@ "format": "int64", "type": "string" }, + "customerId": { + "description": "Customer ID of a client account in the new Search Ads 360 experience.", + "type": "string" + }, "segmentationId": { "description": "The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).", "format": "int64", @@ -584,6 +485,10 @@ }, "type": "array" }, + "customerId": { + "description": "Customer ID of a client account in the new Search Ads 360 experience.", + "type": "string" + }, "deviceType": { "description": "The type of device on which the conversion occurred.", "type": "string"