- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- MonthlyRange
- SearchKeywordCount
- InsightsValue
खोज या मैप में किसी कारोबार को ढूंढने के लिए इस्तेमाल किए गए खोज कीवर्ड दिखाता है. हर सर्च कीवर्ड के साथ इंप्रेशन होते हैं, जो हर महीने के हिसाब से इकट्ठा होते हैं.
अनुरोध का उदाहरण: GET
https://businessprofileperformance.googleapis.com/v1/locations/12345/searchkeywords/impressions/monthly?monthlyRange.start_month.year=2022&monthlyRange.start_month.month=1&monthlyRange.end_month.year=2022&monthlyRange.end_month.month=3
एचटीटीपी अनुरोध
GET https://businessprofileperformance.googleapis.com/v1/{parent=locations/*}/searchkeywords/impressions/monthly
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
पैरामीटर | |
---|---|
parent |
ज़रूरी है. वह जगह जिसके लिए टाइम सीरीज़ फ़ेच की जानी चाहिए. फ़ॉर्मैट: locations/{locationId} जहां locationId, बिना किसी डिकोड वाला लिस्टिंग आईडी है. |
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
monthlyRange |
ज़रूरी है. महीनों की वह सीमा जिसमें सर्च कीवर्ड के इंप्रेशन इकट्ठा करने हैं. |
pageSize |
ज़रूरी नहीं. अनुरोध किए गए नतीजों की संख्या. पेज का डिफ़ॉल्ट साइज़ 100 होता है. पेज का साइज़ ज़्यादा से ज़्यादा 100 पर सेट किया जा सकता है. |
pageToken |
ज़रूरी नहीं. पेज पर नंबर वाले अगले नतीजे को दिखाने वाला टोकन. base64 कोड में बदली गई स्ट्रिंग. |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
month.list के लिए जवाब को दिखाता है.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
---|
{
"searchKeywordsCounts": [
{
object ( |
फ़ील्ड | |
---|---|
searchKeywordsCounts[] |
खोज के लिए इस्तेमाल हुए वे शब्द जिनका इस्तेमाल किसी कारोबार को ढूंढने के लिए किया गया है. |
nextPageToken |
पेज पर नंबर वाले आखिरी नतीजे को दिखाने वाला टोकन. अगले "पेज" को ऐक्सेस करने के अनुरोधों को स्वीकार करके, इसका इस्तेमाल किया जा सकता है कीवर्ड की सूची में शामिल हैं. यह सिर्फ़ तब मौजूद होगा, जब ज़्यादा नतीजे दिखाए जाएंगे. base64 कोड में बदली गई स्ट्रिंग. |
अनुमति के दायरे
नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:
https://www.googleapis.com/auth/business.manage
ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.
MonthlyRange
महीने की रेंज दिखाने वाली समयसीमा (दोनों शामिल हैं).
JSON के काेड में दिखाना |
---|
{ "startMonth": { object ( |
फ़ील्ड | |
---|---|
startMonth |
ज़रूरी है. सभी सुविधाओं वाला फ़ील्ड - सिर्फ़ साल और महीने वाले फ़ील्ड शामिल किए जाएंगे |
endMonth |
ज़रूरी है. सभी सुविधाओं वाला फ़ील्ड - सिर्फ़ साल और महीने वाले फ़ील्ड शामिल किए जाएंगे |
SearchKeywordCount
यह एक सर्च कीवर्ड और उसकी वैल्यू दिखाता है.
JSON के काेड में दिखाना |
---|
{
"searchKeyword": string,
"insightsValue": {
object ( |
फ़ील्ड | |
---|---|
searchKeyword |
वह स्ट्रिंग जो उपयोगकर्ता ने अंग्रेज़ी के छोटे अक्षरों में डाली है. |
insightsValue |
इनमें से एक: 1) महीने में कीवर्ड का इस्तेमाल करने वाले यूनीक उपयोगकर्ताओं की संख्या का योग, जिसे हर उस महीने के लिए एक साथ दिखाया जाता है जिस महीने के लिए आपने अनुरोध किया था. 2) एक थ्रेशोल्ड जिससे पता चलता है कि असल वैल्यू इस थ्रेशोल्ड से कम है. |
InsightsValue
अहम जानकारी की वैल्यू दिखाता है.
JSON के काेड में दिखाना |
---|
{ // Union field |
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड InsightsValue . इससे पता चलता है कि यहां दिए गए प्रोटो फ़ील्ड में से सिर्फ़ एक फ़ील्ड मौजूद होना चाहिए. InsightsValue इनमें से सिर्फ़ एक हो सकता है: |
|
value |
असल वैल्यू दिखाता है. |
threshold |
इससे तय होता है कि असल वैल्यू किस थ्रेशोल्ड से कम है. |