- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
यह फ़ंक्शन, किसी जगह के लिए समीक्षाओं की पेज के हिसाब से बांटी गई सूची दिखाता है. यह कार्रवाई सिर्फ़ तब मान्य होती है, जब बताई गई जगह की पुष्टि हो चुकी हो.
एचटीटीपी अनुरोध
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*/locations/*}/reviews
यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
parent |
उस जगह का नाम जिसके लिए समीक्षाएं फ़ेच करनी हैं. |
क्वेरी पैरामीटर
| पैरामीटर | |
|---|---|
pageSize |
हर पेज पर कितनी समीक्षाएं फ़ेच करनी हैं. ज़्यादा से ज़्यादा |
pageToken |
अगर यह विकल्प चुना जाता है, तो यह समीक्षाओं का अगला पेज फ़ेच करता है. |
orderBy |
इस फ़ील्ड में, समीक्षाओं को क्रम से लगाने के लिए फ़ील्ड की जानकारी दी जाती है. अगर इसे तय नहीं किया जाता है, तो समीक्षाओं को डिफ़ॉल्ट रूप से |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
Reviews.ListReviews के लिए जवाब का मैसेज.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
| JSON फ़ॉर्मैट में दिखाया गया है |
|---|
{
"reviews": [
{
object ( |
| फ़ील्ड | |
|---|---|
reviews[] |
समीक्षाएं. |
averageRating |
इस जगह के लिए, सभी समीक्षाओं की औसत स्टार रेटिंग. यह रेटिंग, एक से पांच के स्केल पर दी जाती है. इसमें पांच सबसे ज़्यादा रेटिंग होती है. |
totalReviewCount |
इस जगह के लिए समीक्षाओं की कुल संख्या. |
nextPageToken |
अगर समीक्षाओं की संख्या, अनुरोध किए गए पेज के साइज़ से ज़्यादा है, तो इस फ़ील्ड में एक टोकन भर दिया जाता है. इससे reviews.list को बाद में कॉल करने पर, समीक्षाओं का अगला पेज फ़ेच किया जा सकता है. अगर कोई और समीक्षा नहीं है, तो यह फ़ील्ड जवाब में मौजूद नहीं होता. |
अनुमति पाने के लिंक
इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/plus.business.managehttps://www.googleapis.com/auth/business.manage
ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.