1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
|
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="mybusinessqanda_v1.locations.questions.answers.html">answers()</a></code>
</p>
<p class="firstline">Returns the answers Resource.</p>
<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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a question for the specified location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a specific question written by the current user.</p>
<p class="toc_element">
<code><a href="#list">list(parent, answersPerQuestion=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the paginated list of questions and some of its answers for a specified location. This operation is only valid if the specified location is verified.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a specific question written by the current user.</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="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Adds a question for the specified location.
Args:
parent: string, Required. The name of the location to write a question for. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a single question and some of its answers.
"author": { # Represents the author of a question or answer # Output only. The author of the question.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the question was written.
"name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
"text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
"topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
{ # Represents an answer to a question
"author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
"name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
"text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
"updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the answer.
},
],
"totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
"updateTime": "A String", # Output only. The timestamp for when the question was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the question.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a single question and some of its answers.
"author": { # Represents the author of a question or answer # Output only. The author of the question.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the question was written.
"name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
"text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
"topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
{ # Represents an answer to a question
"author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
"name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
"text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
"updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the answer.
},
],
"totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
"updateTime": "A String", # Output only. The timestamp for when the question was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the question.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a specific question written by the current user.
Args:
name: string, Required. The name of the question to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, answersPerQuestion=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns the paginated list of questions and some of its answers for a specified location. This operation is only valid if the specified location is verified.
Args:
parent: string, Required. The name of the location to fetch questions for. (required)
answersPerQuestion: integer, Optional. How many answers to fetch per question. The default and maximum `answers_per_question` values are 10.
filter: string, Optional. A filter constraining the questions to return. The only filter currently supported is "ignore_answered=true"
orderBy: string, Optional. The order to return the questions. Valid options include 'update_time desc' and 'upvote_count desc', which will return the questions sorted descendingly by the requested field. The default sort order is 'update_time desc'.
pageSize: integer, Optional. How many questions to fetch per page. The default and maximum `page_size` values are 10.
pageToken: string, Optional. If specified, the next page of questions 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.ListQuestions
"nextPageToken": "A String", # If the number of questions exceeds the requested max page size, this field is populated with a token to fetch the next page of questions on a subsequent call. If there are no more questions, this field is not present in the response.
"questions": [ # The requested questions,
{ # Represents a single question and some of its answers.
"author": { # Represents the author of a question or answer # Output only. The author of the question.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the question was written.
"name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
"text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
"topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
{ # Represents an answer to a question
"author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
"name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
"text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
"updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the answer.
},
],
"totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
"updateTime": "A String", # Output only. The timestamp for when the question was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the question.
},
],
"totalSize": 42, # The total number of questions posted for this location across all pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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 'execute()' 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="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a specific question written by the current user.
Args:
name: string, Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a single question and some of its answers.
"author": { # Represents the author of a question or answer # Output only. The author of the question.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the question was written.
"name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
"text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
"topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
{ # Represents an answer to a question
"author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
"name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
"text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
"updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the answer.
},
],
"totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
"updateTime": "A String", # Output only. The timestamp for when the question was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the question.
}
updateMask: string, Required. The specific fields to update. Only question text can be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a single question and some of its answers.
"author": { # Represents the author of a question or answer # Output only. The author of the question.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the question was written.
"name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
"text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
"topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
{ # Represents an answer to a question
"author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
"displayName": "A String", # The display name of the user
"profilePhotoUri": "A String", # The profile photo URI of the user.
"type": "A String", # The type of user the author is.
},
"createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
"name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
"text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
"updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the answer.
},
],
"totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
"updateTime": "A String", # Output only. The timestamp for when the question was last modified.
"upvoteCount": 42, # Output only. The number of upvotes for the question.
}</pre>
</div>
</body></html>
|
