159 lines
4.7 KiB
HTML
159 lines
4.7 KiB
HTML
<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="mybusinessbusinessinformation_v1.html">My Business Business Information API</a> . <a href="mybusinessbusinessinformation_v1.chains.html">chains</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="#get">get(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets the specified chain. Returns `NOT_FOUND` if the chain does not exist.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#search">search(chainName=None, pageSize=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Searches the chain based on chain name.</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="get">get(name, x__xgafv=None)</code>
|
|
<pre>Gets the specified chain. Returns `NOT_FOUND` if the chain does not exist.
|
|
|
|
Args:
|
|
name: string, Required. The chain's resource name, in the format `chains/{chain_place_id}`. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A chain is a brand that your business's locations can be affiliated with.
|
|
"chainNames": [ # Names of the chain.
|
|
{ # Name to be used when displaying the chain.
|
|
"displayName": "A String", # The display name for this chain.
|
|
"languageCode": "A String", # The BCP 47 code of language of the name.
|
|
},
|
|
],
|
|
"locationCount": 42, # Number of locations that are part of this chain.
|
|
"name": "A String", # Required. The chain's resource name, in the format `chains/{chain_id}`.
|
|
"websites": [ # Websites of the chain.
|
|
{ # Url to be used when displaying the chain.
|
|
"uri": "A String", # The uri for this chain.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="search">search(chainName=None, pageSize=None, x__xgafv=None)</code>
|
|
<pre>Searches the chain based on chain name.
|
|
|
|
Args:
|
|
chainName: string, Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"
|
|
pageSize: integer, The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.
|
|
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 Locations.SearchChains.
|
|
"chains": [ # Chains that match the queried chain_display_name in SearchChainsRequest. If there are no matches, this field will be empty. Results are listed in order of relevance.
|
|
{ # A chain is a brand that your business's locations can be affiliated with.
|
|
"chainNames": [ # Names of the chain.
|
|
{ # Name to be used when displaying the chain.
|
|
"displayName": "A String", # The display name for this chain.
|
|
"languageCode": "A String", # The BCP 47 code of language of the name.
|
|
},
|
|
],
|
|
"locationCount": 42, # Number of locations that are part of this chain.
|
|
"name": "A String", # Required. The chain's resource name, in the format `chains/{chain_id}`.
|
|
"websites": [ # Websites of the chain.
|
|
{ # Url to be used when displaying the chain.
|
|
"uri": "A String", # The uri for this chain.
|
|
},
|
|
],
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |