blob: 5ecea786c1d44953ad1557585951076bc1343848 [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.geoTargetConstants.html">geoTargetConstants</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="#suggest">suggest(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns GeoTargetConstant suggestions by location name or by resource name. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [GeoTargetConstantSuggestionError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</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="suggest">suggest(body=None, x__xgafv=None)</code>
<pre>Returns GeoTargetConstant suggestions by location name or by resource name. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [GeoTargetConstantSuggestionError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
Args:
body: object, The request body.
The object takes the form of:
{ # Request message for GeoTargetConstantService.SuggestGeoTargetConstants.
&quot;countryCode&quot;: &quot;A String&quot;, # Returned geo targets are restricted to this country code.
&quot;geoTargets&quot;: { # A list of geo target constant resource names. # The geo target constant resource names to filter by.
&quot;geoTargetConstants&quot;: [ # A list of geo target constant resource names.
&quot;A String&quot;,
],
},
&quot;locale&quot;: &quot;A String&quot;, # If possible, returned geo targets are translated using this locale. If not, en is used by default. This is also used as a hint for returned geo targets.
&quot;locationNames&quot;: { # A list of location names. # The location names to search by. At most 25 names can be set.
&quot;names&quot;: [ # A list of location names.
&quot;A String&quot;,
],
},
}
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 GeoTargetConstantService.SuggestGeoTargetConstants.
&quot;geoTargetConstantSuggestions&quot;: [ # Geo target constant suggestions.
{ # A geo target constant suggestion.
&quot;geoTargetConstant&quot;: { # A geo target constant. # The GeoTargetConstant result.
&quot;canonicalName&quot;: &quot;A String&quot;, # Output only. The fully qualified English name, consisting of the target&#x27;s name and that of its parent and country.
&quot;countryCode&quot;: &quot;A String&quot;, # Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
&quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the geo target constant.
&quot;name&quot;: &quot;A String&quot;, # Output only. Geo target constant English name.
&quot;parentGeoTarget&quot;: &quot;A String&quot;, # Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{parent_geo_target_constant_id}`
&quot;resourceName&quot;: &quot;A String&quot;, # Output only. The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
&quot;status&quot;: &quot;A String&quot;, # Output only. Geo target constant status.
&quot;targetType&quot;: &quot;A String&quot;, # Output only. Geo target constant target type.
},
&quot;geoTargetConstantParents&quot;: [ # The list of parents of the geo target constant.
{ # A geo target constant.
&quot;canonicalName&quot;: &quot;A String&quot;, # Output only. The fully qualified English name, consisting of the target&#x27;s name and that of its parent and country.
&quot;countryCode&quot;: &quot;A String&quot;, # Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
&quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the geo target constant.
&quot;name&quot;: &quot;A String&quot;, # Output only. Geo target constant English name.
&quot;parentGeoTarget&quot;: &quot;A String&quot;, # Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{parent_geo_target_constant_id}`
&quot;resourceName&quot;: &quot;A String&quot;, # Output only. The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
&quot;status&quot;: &quot;A String&quot;, # Output only. Geo target constant status.
&quot;targetType&quot;: &quot;A String&quot;, # Output only. Geo target constant target type.
},
],
&quot;locale&quot;: &quot;A String&quot;, # The language this GeoTargetConstantSuggestion is currently translated to. It affects the name of geo target fields. For example, if locale=en, then name=Spain. If locale=es, then name=EspaƱa. The default locale will be returned if no translation exists for the locale in the request.
&quot;reach&quot;: &quot;A String&quot;, # Approximate user population that will be targeted, rounded to the nearest 100.
&quot;searchTerm&quot;: &quot;A String&quot;, # If the request searched by location name, this is the location name that matched the geo target.
},
],
}</pre>
</div>
</body></html>