blob: 9ec0c463f85b49208c97e17e6df77d9ecb74a94c [file] [log] [blame]
<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="mybusinessqanda_v1.html">My Business Q&A API</a> . <a href="mybusinessqanda_v1.locations.html">locations</a> . <a href="mybusinessqanda_v1.locations.questions.html">questions</a> . <a href="mybusinessqanda_v1.locations.questions.answers.html">answers</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="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the paginated list of answers for a specified question.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#upsert">upsert(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an answer or updates the existing answer written by the user for the specified question. A user can only create one answer per question.</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="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns the paginated list of answers for a specified question.
Args:
parent: string, Required. The name of the question to fetch answers for. (required)
orderBy: string, Optional. The order to return the answers. Valid options include &#x27;update_time desc&#x27; and &#x27;upvote_count desc&#x27;, which will return the answers sorted descendingly by the requested field. The default sort order is &#x27;update_time desc&#x27;.
pageSize: integer, Optional. How many answers to fetch per page. The default and maximum `page_size` values are 10.
pageToken: string, Optional. If specified, the next page of answers is retrieved.
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 QuestionsAndAnswers.ListAnswers
&quot;answers&quot;: [ # The requested answers.
{ # Represents an answer to a question
&quot;author&quot;: { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
&quot;displayName&quot;: &quot;A String&quot;, # The display name of the user
&quot;profilePhotoUri&quot;: &quot;A String&quot;, # The profile photo URI of the user.
&quot;type&quot;: &quot;A String&quot;, # The type of user the author is.
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
&quot;name&quot;: &quot;A String&quot;, # Output only. The unique name for the answer locations/*/questions/*/answers/*
&quot;text&quot;: &quot;A String&quot;, # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp for when the answer was last modified.
&quot;upvoteCount&quot;: 42, # Output only. The number of upvotes for the answer.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # If the number of answers exceeds the requested max page size, this field is populated with a token to fetch the next page of answers on a subsequent call. If there are no more answers, this field is not present in the response.
&quot;totalSize&quot;: 42, # The total number of answers posted for this question across all pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="upsert">upsert(parent, body=None, x__xgafv=None)</code>
<pre>Creates an answer or updates the existing answer written by the user for the specified question. A user can only create one answer per question.
Args:
parent: string, Required. The name of the question to write an answer for. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for QuestionsAndAnswers.UpsertAnswer
&quot;answer&quot;: { # Represents an answer to a question # Required. The new answer.
&quot;author&quot;: { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
&quot;displayName&quot;: &quot;A String&quot;, # The display name of the user
&quot;profilePhotoUri&quot;: &quot;A String&quot;, # The profile photo URI of the user.
&quot;type&quot;: &quot;A String&quot;, # The type of user the author is.
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
&quot;name&quot;: &quot;A String&quot;, # Output only. The unique name for the answer locations/*/questions/*/answers/*
&quot;text&quot;: &quot;A String&quot;, # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp for when the answer was last modified.
&quot;upvoteCount&quot;: 42, # Output only. The number of upvotes for the answer.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an answer to a question
&quot;author&quot;: { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
&quot;displayName&quot;: &quot;A String&quot;, # The display name of the user
&quot;profilePhotoUri&quot;: &quot;A String&quot;, # The profile photo URI of the user.
&quot;type&quot;: &quot;A String&quot;, # The type of user the author is.
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
&quot;name&quot;: &quot;A String&quot;, # Output only. The unique name for the answer locations/*/questions/*/answers/*
&quot;text&quot;: &quot;A String&quot;, # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp for when the answer was last modified.
&quot;upvoteCount&quot;: 42, # Output only. The number of upvotes for the answer.
}</pre>
</div>
</body></html>