Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit bfaf4b3

Browse files
committedNov 1, 2022
feat(doubleclicksearch): update the api
#### doubleclicksearch:v2 The following keys were added: - resources.conversion.methods.GetCustomerId (Total Keys: 53) - resources.conversion.methods.get (Total Keys: 55)
1 parent ff9240b commit bfaf4b3

File tree

2 files changed

+375
-1
lines changed

2 files changed

+375
-1
lines changed
 

‎docs/dyn/doubleclicksearch_v2.conversion.html

+162
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,15 @@
7474

7575
<h1><a href="doubleclicksearch_v2.html">Search Ads 360 API</a> . <a href="doubleclicksearch_v2.conversion.html">conversion</a></h1>
7676
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#GetCustomerId">GetCustomerId(customerId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, advertiserId=None, agencyId=None, campaignId=None, criterionId=None, engineAccountId=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p>
7780
<p class="toc_element">
7881
<code><a href="#close">close()</a></code></p>
7982
<p class="firstline">Close httplib2 connections.</p>
83+
<p class="toc_element">
84+
<code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None, customerId=None, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p>
8086
<p class="toc_element">
8187
<code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
8288
<p class="firstline">Inserts a batch of new conversions into DoubleClick Search.</p>
@@ -87,11 +93,167 @@ <h2>Instance Methods</h2>
8793
<code><a href="#updateAvailability">updateAvailability(body=None, x__xgafv=None)</a></code></p>
8894
<p class="firstline">Updates the availabilities of a batch of floodlight activities in DoubleClick Search.</p>
8995
<h3>Method Details</h3>
96+
<div class="method">
97+
<code class="details" id="GetCustomerId">GetCustomerId(customerId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, advertiserId=None, agencyId=None, campaignId=None, criterionId=None, engineAccountId=None, x__xgafv=None)</code>
98+
<pre>Retrieves a list of conversions from a DoubleClick Search engine account.
99+
100+
Args:
101+
customerId: string, Customer ID of a client account in the new Search Ads 360 experience. (required)
102+
endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
103+
rowCount: integer, The number of conversions to return per call. (required)
104+
startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
105+
startRow: integer, The 0-based starting index for retrieving conversions results. (required)
106+
adGroupId: string, Numeric ID of the ad group.
107+
adId: string, Numeric ID of the ad.
108+
advertiserId: string, Numeric ID of the advertiser.
109+
agencyId: string, Numeric ID of the agency.
110+
campaignId: string, Numeric ID of the campaign.
111+
criterionId: string, Numeric ID of the criterion.
112+
engineAccountId: string, Numeric ID of the engine account.
113+
x__xgafv: string, V1 error format.
114+
Allowed values
115+
1 - v1 error format
116+
2 - v2 error format
117+
118+
Returns:
119+
An object of the form:
120+
121+
{ # A list of conversions.
122+
&quot;conversion&quot;: [ # The conversions being requested.
123+
{ # A conversion containing data relevant to DoubleClick Search.
124+
&quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
125+
&quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
126+
&quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
127+
&quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
128+
&quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
129+
&quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
130+
&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
131+
&quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
132+
&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.
133+
&quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
134+
&quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
135+
&quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
136+
&quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
137+
&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.
138+
&quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
139+
{ # A message containing the custom dimension.
140+
&quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
141+
&quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
142+
},
143+
],
144+
&quot;customMetric&quot;: [ # Custom metrics for the conversion.
145+
{ # A message containing the custom metric.
146+
&quot;name&quot;: &quot;A String&quot;, # Custom metric name.
147+
&quot;value&quot;: 3.14, # Custom metric numeric value.
148+
},
149+
],
150+
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
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+
90174
<div class="method">
91175
<code class="details" id="close">close()</code>
92176
<pre>Close httplib2 connections.</pre>
93177
</div>
94178

179+
<div class="method">
180+
<code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None, customerId=None, x__xgafv=None)</code>
181+
<pre>Retrieves a list of conversions from a DoubleClick Search engine account.
182+
183+
Args:
184+
agencyId: string, Numeric ID of the agency. (required)
185+
advertiserId: string, Numeric ID of the advertiser. (required)
186+
engineAccountId: string, Numeric ID of the engine account. (required)
187+
endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
188+
rowCount: integer, The number of conversions to return per call. (required)
189+
startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
190+
startRow: integer, The 0-based starting index for retrieving conversions results. (required)
191+
adGroupId: string, Numeric ID of the ad group.
192+
adId: string, Numeric ID of the ad.
193+
campaignId: string, Numeric ID of the campaign.
194+
criterionId: string, Numeric ID of the criterion.
195+
customerId: string, Customer ID of a client account in the new Search Ads 360 experience.
196+
x__xgafv: string, V1 error format.
197+
Allowed values
198+
1 - v1 error format
199+
2 - v2 error format
200+
201+
Returns:
202+
An object of the form:
203+
204+
{ # A list of conversions.
205+
&quot;conversion&quot;: [ # The conversions being requested.
206+
{ # A conversion containing data relevant to DoubleClick Search.
207+
&quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
208+
&quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
209+
&quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
210+
&quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
211+
&quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
212+
&quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
213+
&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
214+
&quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
215+
&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.
216+
&quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
217+
&quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
218+
&quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
219+
&quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
220+
&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.
221+
&quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
222+
{ # A message containing the custom dimension.
223+
&quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
224+
&quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
225+
},
226+
],
227+
&quot;customMetric&quot;: [ # Custom metrics for the conversion.
228+
{ # A message containing the custom metric.
229+
&quot;name&quot;: &quot;A String&quot;, # Custom metric name.
230+
&quot;value&quot;: 3.14, # Custom metric numeric value.
231+
},
232+
],
233+
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
234+
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
235+
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
236+
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
237+
&quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
238+
&quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
239+
&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.
240+
&quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
241+
&quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
242+
&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.
243+
&quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
244+
&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.
245+
&quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
246+
&quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
247+
&quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
248+
&quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
249+
&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;.
250+
&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`).
251+
},
252+
],
253+
&quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
254+
}</pre>
255+
</div>
256+
95257
<div class="method">
96258
<code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
97259
<pre>Inserts a batch of new conversions into DoubleClick Search.

‎googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json

+213-1
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,218 @@
106106
"resources": {
107107
"conversion": {
108108
"methods": {
109+
"GetCustomerId": {
110+
"description": "Retrieves a list of conversions from a DoubleClick Search engine account.",
111+
"flatPath": "doubleclicksearch/v2/customer/{customerId}/conversion",
112+
"httpMethod": "GET",
113+
"id": "doubleclicksearch.conversion.GetCustomerId",
114+
"parameterOrder": [
115+
"customerId",
116+
"endDate",
117+
"rowCount",
118+
"startDate",
119+
"startRow"
120+
],
121+
"parameters": {
122+
"adGroupId": {
123+
"description": "Numeric ID of the ad group.",
124+
"format": "int64",
125+
"location": "query",
126+
"type": "string"
127+
},
128+
"adId": {
129+
"description": "Numeric ID of the ad.",
130+
"format": "int64",
131+
"location": "query",
132+
"type": "string"
133+
},
134+
"advertiserId": {
135+
"description": "Numeric ID of the advertiser.",
136+
"format": "int64",
137+
"location": "query",
138+
"type": "string"
139+
},
140+
"agencyId": {
141+
"description": "Numeric ID of the agency.",
142+
"format": "int64",
143+
"location": "query",
144+
"type": "string"
145+
},
146+
"campaignId": {
147+
"description": "Numeric ID of the campaign.",
148+
"format": "int64",
149+
"location": "query",
150+
"type": "string"
151+
},
152+
"criterionId": {
153+
"description": "Numeric ID of the criterion.",
154+
"format": "int64",
155+
"location": "query",
156+
"type": "string"
157+
},
158+
"customerId": {
159+
"description": "Customer ID of a client account in the new Search Ads 360 experience.",
160+
"location": "path",
161+
"required": true,
162+
"type": "string"
163+
},
164+
"endDate": {
165+
"description": "Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
166+
"format": "int32",
167+
"location": "query",
168+
"maximum": "99991231",
169+
"minimum": "20091101",
170+
"required": true,
171+
"type": "integer"
172+
},
173+
"engineAccountId": {
174+
"description": "Numeric ID of the engine account.",
175+
"format": "int64",
176+
"location": "query",
177+
"type": "string"
178+
},
179+
"rowCount": {
180+
"description": "The number of conversions to return per call.",
181+
"format": "int32",
182+
"location": "query",
183+
"maximum": "1000",
184+
"minimum": "1",
185+
"required": true,
186+
"type": "integer"
187+
},
188+
"startDate": {
189+
"description": "First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
190+
"format": "int32",
191+
"location": "query",
192+
"maximum": "99991231",
193+
"minimum": "20091101",
194+
"required": true,
195+
"type": "integer"
196+
},
197+
"startRow": {
198+
"description": "The 0-based starting index for retrieving conversions results.",
199+
"format": "uint32",
200+
"location": "query",
201+
"required": true,
202+
"type": "integer"
203+
}
204+
},
205+
"path": "doubleclicksearch/v2/customer/{customerId}/conversion",
206+
"response": {
207+
"$ref": "ConversionList"
208+
},
209+
"scopes": [
210+
"https://www.googleapis.com/auth/doubleclicksearch"
211+
]
212+
},
213+
"get": {
214+
"description": "Retrieves a list of conversions from a DoubleClick Search engine account.",
215+
"flatPath": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion",
216+
"httpMethod": "GET",
217+
"id": "doubleclicksearch.conversion.get",
218+
"parameterOrder": [
219+
"agencyId",
220+
"advertiserId",
221+
"engineAccountId",
222+
"endDate",
223+
"rowCount",
224+
"startDate",
225+
"startRow"
226+
],
227+
"parameters": {
228+
"adGroupId": {
229+
"description": "Numeric ID of the ad group.",
230+
"format": "int64",
231+
"location": "query",
232+
"type": "string"
233+
},
234+
"adId": {
235+
"description": "Numeric ID of the ad.",
236+
"format": "int64",
237+
"location": "query",
238+
"type": "string"
239+
},
240+
"advertiserId": {
241+
"description": "Numeric ID of the advertiser.",
242+
"format": "int64",
243+
"location": "path",
244+
"required": true,
245+
"type": "string"
246+
},
247+
"agencyId": {
248+
"description": "Numeric ID of the agency.",
249+
"format": "int64",
250+
"location": "path",
251+
"required": true,
252+
"type": "string"
253+
},
254+
"campaignId": {
255+
"description": "Numeric ID of the campaign.",
256+
"format": "int64",
257+
"location": "query",
258+
"type": "string"
259+
},
260+
"criterionId": {
261+
"description": "Numeric ID of the criterion.",
262+
"format": "int64",
263+
"location": "query",
264+
"type": "string"
265+
},
266+
"customerId": {
267+
"description": "Customer ID of a client account in the new Search Ads 360 experience.",
268+
"location": "query",
269+
"type": "string"
270+
},
271+
"endDate": {
272+
"description": "Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
273+
"format": "int32",
274+
"location": "query",
275+
"maximum": "99991231",
276+
"minimum": "20091101",
277+
"required": true,
278+
"type": "integer"
279+
},
280+
"engineAccountId": {
281+
"description": "Numeric ID of the engine account.",
282+
"format": "int64",
283+
"location": "path",
284+
"required": true,
285+
"type": "string"
286+
},
287+
"rowCount": {
288+
"description": "The number of conversions to return per call.",
289+
"format": "int32",
290+
"location": "query",
291+
"maximum": "1000",
292+
"minimum": "1",
293+
"required": true,
294+
"type": "integer"
295+
},
296+
"startDate": {
297+
"description": "First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
298+
"format": "int32",
299+
"location": "query",
300+
"maximum": "99991231",
301+
"minimum": "20091101",
302+
"required": true,
303+
"type": "integer"
304+
},
305+
"startRow": {
306+
"description": "The 0-based starting index for retrieving conversions results.",
307+
"format": "uint32",
308+
"location": "query",
309+
"required": true,
310+
"type": "integer"
311+
}
312+
},
313+
"path": "doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion",
314+
"response": {
315+
"$ref": "ConversionList"
316+
},
317+
"scopes": [
318+
"https://www.googleapis.com/auth/doubleclicksearch"
319+
]
320+
},
109321
"insert": {
110322
"description": "Inserts a batch of new conversions into DoubleClick Search.",
111323
"flatPath": "doubleclicksearch/v2/conversion",
@@ -331,7 +543,7 @@
331543
}
332544
}
333545
},
334-
"revision": "20221018",
546+
"revision": "20221025",
335547
"rootUrl": "https://doubleclicksearch.googleapis.com/",
336548
"schemas": {
337549
"Availability": {

0 commit comments

Comments
 (0)
Please sign in to comment.