Skip to content

Commit 1e7db3e

Browse files
feat(doubleclicksearch): update the api
#### doubleclicksearch:v2 The following keys were deleted: - resources.conversion.methods.get (Total Keys: 53) The following keys were added: - schemas.Availability.properties.customerId.type (Total Keys: 1) - schemas.Conversion.properties.customerId.type (Total Keys: 1)
1 parent 1808832 commit 1e7db3e

File tree

2 files changed

+15
-183
lines changed

2 files changed

+15
-183
lines changed

docs/dyn/doubleclicksearch_v2.conversion.html

Lines changed: 6 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,6 @@ <h2>Instance Methods</h2>
7777
<p class="toc_element">
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
80-
<p class="toc_element">
81-
<code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None, x__xgafv=None)</a></code></p>
82-
<p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p>
8380
<p class="toc_element">
8481
<code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
8582
<p class="firstline">Inserts a batch of new conversions into DoubleClick Search.</p>
@@ -95,82 +92,6 @@ <h3>Method Details</h3>
9592
<pre>Close httplib2 connections.</pre>
9693
</div>
9794

98-
<div class="method">
99-
<code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None, x__xgafv=None)</code>
100-
<pre>Retrieves a list of conversions from a DoubleClick Search engine account.
101-
102-
Args:
103-
agencyId: string, Numeric ID of the agency. (required)
104-
advertiserId: string, Numeric ID of the advertiser. (required)
105-
engineAccountId: string, Numeric ID of the engine account. (required)
106-
endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
107-
rowCount: integer, The number of conversions to return per call. (required)
108-
startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
109-
startRow: integer, The 0-based starting index for retrieving conversions results. (required)
110-
adGroupId: string, Numeric ID of the ad group.
111-
adId: string, Numeric ID of the ad.
112-
campaignId: string, Numeric ID of the campaign.
113-
criterionId: string, Numeric ID of the criterion.
114-
x__xgafv: string, V1 error format.
115-
Allowed values
116-
1 - v1 error format
117-
2 - v2 error format
118-
119-
Returns:
120-
An object of the form:
121-
122-
{ # A list of conversions.
123-
&quot;conversion&quot;: [ # The conversions being requested.
124-
{ # A conversion containing data relevant to DoubleClick Search.
125-
&quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
126-
&quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
127-
&quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
128-
&quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
129-
&quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
130-
&quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
131-
&quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are: - &quot;`local`&quot;: a physical store - &quot;`online`&quot;: an online store
132-
&quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
133-
&quot;conversionId&quot;: &quot;A String&quot;, # 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&#x27;s Floodlight instructions.
134-
&quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
135-
&quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
136-
&quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
137-
&quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
138-
&quot;currencyCode&quot;: &quot;A String&quot;, # The currency code for the conversion&#x27;s revenue. Should be in ISO 4217 alphabetic (3-char) format.
139-
&quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
140-
{ # A message containing the custom dimension.
141-
&quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
142-
&quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
143-
},
144-
],
145-
&quot;customMetric&quot;: [ # Custom metrics for the conversion.
146-
{ # A message containing the custom metric.
147-
&quot;name&quot;: &quot;A String&quot;, # Custom metric name.
148-
&quot;value&quot;: 3.14, # Custom metric numeric value.
149-
},
150-
],
151-
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
152-
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
153-
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
154-
&quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
155-
&quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
156-
&quot;productCountry&quot;: &quot;A String&quot;, # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
157-
&quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
158-
&quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
159-
&quot;productLanguage&quot;: &quot;A String&quot;, # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
160-
&quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
161-
&quot;revenueMicros&quot;: &quot;A String&quot;, # The revenue amount of this `TRANSACTION` conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of &quot;10&quot; enter &quot;10000000&quot; (10 million) in your request.
162-
&quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
163-
&quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
164-
&quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
165-
&quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
166-
&quot;storeId&quot;: &quot;A String&quot;, # The ID of the local store for which the product was advertised. Applicable only when the channel is &quot;`local`&quot;.
167-
&quot;type&quot;: &quot;A String&quot;, # 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`).
168-
},
169-
],
170-
&quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
171-
}</pre>
172-
</div>
173-
17495
<div class="method">
17596
<code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
17697
<pre>Inserts a batch of new conversions into DoubleClick Search.
@@ -208,6 +129,7 @@ <h3>Method Details</h3>
208129
&quot;value&quot;: 3.14, # Custom metric numeric value.
209130
},
210131
],
132+
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
211133
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
212134
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
213135
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
@@ -267,6 +189,7 @@ <h3>Method Details</h3>
267189
&quot;value&quot;: 3.14, # Custom metric numeric value.
268190
},
269191
],
192+
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
270193
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
271194
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
272195
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
@@ -327,6 +250,7 @@ <h3>Method Details</h3>
327250
&quot;value&quot;: 3.14, # Custom metric numeric value.
328251
},
329252
],
253+
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
330254
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
331255
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
332256
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
@@ -386,6 +310,7 @@ <h3>Method Details</h3>
386310
&quot;value&quot;: 3.14, # Custom metric numeric value.
387311
},
388312
],
313+
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
389314
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
390315
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
391316
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
@@ -423,6 +348,7 @@ <h3>Method Details</h3>
423348
&quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
424349
&quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
425350
&quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
351+
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
426352
&quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
427353
&quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
428354
&quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
@@ -444,6 +370,7 @@ <h3>Method Details</h3>
444370
&quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
445371
&quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
446372
&quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
373+
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
447374
&quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
448375
&quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
449376
&quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).

googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json

Lines changed: 9 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -106,109 +106,6 @@
106106
"resources": {
107107
"conversion": {
108108
"methods": {
109-
"get": {
110-
"description": "Retrieves a list of conversions from a DoubleClick Search engine account.",
111-
"flatPath": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion",
112-
"httpMethod": "GET",
113-
"id": "doubleclicksearch.conversion.get",
114-
"parameterOrder": [
115-
"agencyId",
116-
"advertiserId",
117-
"engineAccountId",
118-
"endDate",
119-
"rowCount",
120-
"startDate",
121-
"startRow"
122-
],
123-
"parameters": {
124-
"adGroupId": {
125-
"description": "Numeric ID of the ad group.",
126-
"format": "int64",
127-
"location": "query",
128-
"type": "string"
129-
},
130-
"adId": {
131-
"description": "Numeric ID of the ad.",
132-
"format": "int64",
133-
"location": "query",
134-
"type": "string"
135-
},
136-
"advertiserId": {
137-
"description": "Numeric ID of the advertiser.",
138-
"format": "int64",
139-
"location": "path",
140-
"required": true,
141-
"type": "string"
142-
},
143-
"agencyId": {
144-
"description": "Numeric ID of the agency.",
145-
"format": "int64",
146-
"location": "path",
147-
"required": true,
148-
"type": "string"
149-
},
150-
"campaignId": {
151-
"description": "Numeric ID of the campaign.",
152-
"format": "int64",
153-
"location": "query",
154-
"type": "string"
155-
},
156-
"criterionId": {
157-
"description": "Numeric ID of the criterion.",
158-
"format": "int64",
159-
"location": "query",
160-
"type": "string"
161-
},
162-
"endDate": {
163-
"description": "Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
164-
"format": "int32",
165-
"location": "query",
166-
"maximum": "99991231",
167-
"minimum": "20091101",
168-
"required": true,
169-
"type": "integer"
170-
},
171-
"engineAccountId": {
172-
"description": "Numeric ID of the engine account.",
173-
"format": "int64",
174-
"location": "path",
175-
"required": true,
176-
"type": "string"
177-
},
178-
"rowCount": {
179-
"description": "The number of conversions to return per call.",
180-
"format": "int32",
181-
"location": "query",
182-
"maximum": "1000",
183-
"minimum": "1",
184-
"required": true,
185-
"type": "integer"
186-
},
187-
"startDate": {
188-
"description": "First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
189-
"format": "int32",
190-
"location": "query",
191-
"maximum": "99991231",
192-
"minimum": "20091101",
193-
"required": true,
194-
"type": "integer"
195-
},
196-
"startRow": {
197-
"description": "The 0-based starting index for retrieving conversions results.",
198-
"format": "uint32",
199-
"location": "query",
200-
"required": true,
201-
"type": "integer"
202-
}
203-
},
204-
"path": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion",
205-
"response": {
206-
"$ref": "ConversionList"
207-
},
208-
"scopes": [
209-
"https://www.googleapis.com/auth/doubleclicksearch"
210-
]
211-
},
212109
"insert": {
213110
"description": "Inserts a batch of new conversions into DoubleClick Search.",
214111
"flatPath": "doubleclicksearch/v2/conversion",
@@ -434,7 +331,7 @@
434331
}
435332
}
436333
},
437-
"revision": "20221004",
334+
"revision": "20221011",
438335
"rootUrl": "https://doubleclicksearch.googleapis.com/",
439336
"schemas": {
440337
"Availability": {
@@ -471,6 +368,10 @@
471368
"format": "int64",
472369
"type": "string"
473370
},
371+
"customerId": {
372+
"description": "Customer ID of a client account in the new Search Ads 360 experience.",
373+
"type": "string"
374+
},
474375
"segmentationId": {
475376
"description": "The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).",
476377
"format": "int64",
@@ -584,6 +485,10 @@
584485
},
585486
"type": "array"
586487
},
488+
"customerId": {
489+
"description": "Customer ID of a client account in the new Search Ads 360 experience.",
490+
"type": "string"
491+
},
587492
"deviceType": {
588493
"description": "The type of device on which the conversion occurred.",
589494
"type": "string"

0 commit comments

Comments
 (0)