blob: 3188944643f4b25fc93a1b8f2f94d0a0748f3d85 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="searchads360_v23.html">Search Ads 360 Reporting API</a> . <a href="searchads360_v23.customers.html">customers</a> . <a href="searchads360_v23.customers.customConversionGoals.html">customConversionGoals</a></h1>
<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="#mutate">mutate(customerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates, updates or removes custom conversion goals. Operation statuses are returned.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="mutate">mutate(customerId, body=None, x__xgafv=None)</code>
<pre>Creates, updates or removes custom conversion goals. Operation statuses are returned.
Args:
customerId: string, Required. The ID of the customer whose custom conversion goals are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CustomConversionGoalService.MutateCustomConversionGoals.
&quot;operations&quot;: [ # Required. The list of operations to perform on individual custom conversion goal.
{ # A single operation (create, remove) on a custom conversion goal.
&quot;create&quot;: { # Custom conversion goal that can make arbitrary conversion actions biddable. # Create operation: No resource name is expected for the new custom conversion goal
&quot;conversionActions&quot;: [ # Conversion actions that the custom conversion goal makes biddable.
&quot;A String&quot;,
],
&quot;id&quot;: &quot;A String&quot;, # Immutable. The ID for this custom conversion goal.
&quot;name&quot;: &quot;A String&quot;, # The name for this custom conversion goal.
&quot;resourceName&quot;: &quot;A String&quot;, # Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: `customers/{customer_id}/customConversionGoals/{goal_id}`
&quot;status&quot;: &quot;A String&quot;, # The status of the custom conversion goal.
},
&quot;remove&quot;: &quot;A String&quot;, # Remove operation: A resource name for the removed custom conversion goal is expected, in this format: &#x27;customers/{customer_id}/customConversionGoals/{goal_id}&#x27;
&quot;update&quot;: { # Custom conversion goal that can make arbitrary conversion actions biddable. # Update operation: The custom conversion goal is expected to have a valid resource name.
&quot;conversionActions&quot;: [ # Conversion actions that the custom conversion goal makes biddable.
&quot;A String&quot;,
],
&quot;id&quot;: &quot;A String&quot;, # Immutable. The ID for this custom conversion goal.
&quot;name&quot;: &quot;A String&quot;, # The name for this custom conversion goal.
&quot;resourceName&quot;: &quot;A String&quot;, # Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: `customers/{customer_id}/customConversionGoals/{goal_id}`
&quot;status&quot;: &quot;A String&quot;, # The status of the custom conversion goal.
},
&quot;updateMask&quot;: &quot;A String&quot;, # FieldMask that determines which resource fields are modified in an update.
},
],
&quot;responseContentType&quot;: &quot;A String&quot;, # The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.
&quot;validateOnly&quot;: True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for a custom conversion goal mutate.
&quot;results&quot;: [ # All results for the mutate.
{ # The result for the custom conversion goal mutate.
&quot;customConversionGoal&quot;: { # Custom conversion goal that can make arbitrary conversion actions biddable. # The mutated CustomConversionGoal with only mutable fields after mutate. The field will only be returned when response_content_type is set to &quot;MUTABLE_RESOURCE&quot;.
&quot;conversionActions&quot;: [ # Conversion actions that the custom conversion goal makes biddable.
&quot;A String&quot;,
],
&quot;id&quot;: &quot;A String&quot;, # Immutable. The ID for this custom conversion goal.
&quot;name&quot;: &quot;A String&quot;, # The name for this custom conversion goal.
&quot;resourceName&quot;: &quot;A String&quot;, # Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: `customers/{customer_id}/customConversionGoals/{goal_id}`
&quot;status&quot;: &quot;A String&quot;, # The status of the custom conversion goal.
},
&quot;resourceName&quot;: &quot;A String&quot;, # Returned for successful operations.
},
],
}</pre>
</div>
</body></html>