Skip to content

Commit

Permalink
feat(doubleclicksearch): update the api
Browse files Browse the repository at this point in the history
#### 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)
  • Loading branch information
yoshi-automation committed Oct 18, 2022
1 parent 1808832 commit 1e7db3e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 183 deletions.
85 changes: 6 additions & 79 deletions docs/dyn/doubleclicksearch_v2.conversion.html
Expand Up @@ -77,9 +77,6 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<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>
<p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a batch of new conversions into DoubleClick Search.</p>
Expand All @@ -95,82 +92,6 @@ <h3>Method Details</h3>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<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>
<pre>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.
&quot;conversion&quot;: [ # The conversions being requested.
{ # A conversion containing data relevant to DoubleClick Search.
&quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
&quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
&quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
&quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
&quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
&quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
&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
&quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
&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.
&quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
&quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
&quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
&quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
&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.
&quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
{ # A message containing the custom dimension.
&quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
&quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
},
],
&quot;customMetric&quot;: [ # Custom metrics for the conversion.
{ # A message containing the custom metric.
&quot;name&quot;: &quot;A String&quot;, # Custom metric name.
&quot;value&quot;: 3.14, # Custom metric numeric value.
},
],
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
&quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
&quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
&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.
&quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
&quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
&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.
&quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
&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.
&quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
&quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
&quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
&quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
&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;.
&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`).
},
],
&quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
}</pre>
</div>

<div class="method">
<code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
<pre>Inserts a batch of new conversions into DoubleClick Search.
Expand Down Expand Up @@ -208,6 +129,7 @@ <h3>Method Details</h3>
&quot;value&quot;: 3.14, # Custom metric numeric value.
},
],
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
Expand Down Expand Up @@ -267,6 +189,7 @@ <h3>Method Details</h3>
&quot;value&quot;: 3.14, # Custom metric numeric value.
},
],
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
Expand Down Expand Up @@ -327,6 +250,7 @@ <h3>Method Details</h3>
&quot;value&quot;: 3.14, # Custom metric numeric value.
},
],
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
Expand Down Expand Up @@ -386,6 +310,7 @@ <h3>Method Details</h3>
&quot;value&quot;: 3.14, # Custom metric numeric value.
},
],
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
&quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
&quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
&quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
Expand Down Expand Up @@ -423,6 +348,7 @@ <h3>Method Details</h3>
&quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
&quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
&quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
&quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
&quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
&quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
Expand All @@ -444,6 +370,7 @@ <h3>Method Details</h3>
&quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
&quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
&quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
&quot;customerId&quot;: &quot;A String&quot;, # Customer ID of a client account in the new Search Ads 360 experience.
&quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
&quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
&quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
Expand Down
113 changes: 9 additions & 104 deletions googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json
Expand Up @@ -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",
Expand Down Expand Up @@ -434,7 +331,7 @@
}
}
},
"revision": "20221004",
"revision": "20221011",
"rootUrl": "https://doubleclicksearch.googleapis.com/",
"schemas": {
"Availability": {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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"
Expand Down

0 comments on commit 1e7db3e

Please sign in to comment.