Method: accounts.reports.search

खोज क्वेरी से तय की गई रिपोर्ट को वापस लाता है. जवाब में, pageSize में बताई गई लाइनों की तुलना में कम लाइनें हो सकती हैं. nextPageToken का इस्तेमाल करके यह पता लगाएं कि क्या और लाइनों का अनुरोध किया जाना है.

एचटीटीपी अनुरोध

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. कॉल करने वाले खाते का आईडी. यह स्टैंडअलोन खाता या एमसीए का उप-खाता होना चाहिए. फ़ॉर्मैट: accounts/{account}

अनुरोध का मुख्य भाग

अनुरोध के मुख्य भाग में, नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:

JSON के काेड में दिखाना 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
फ़ील्ड
query

string

ज़रूरी है. वह क्वेरी जो किसी रिपोर्ट को वापस लाने के बारे में बताती है.

क्वेरी बनाने का तरीका जानने के लिए, क्वेरी लैंग्वेज की गाइड देखें. उपलब्ध टेबल और फ़ील्ड की पूरी सूची के लिए, उपलब्ध फ़ील्ड देखें.
pageSize

integer

ज़रूरी नहीं. एक पेज में ReportRows की संख्या. डिफ़ॉल्ट रूप से, यह वैल्यू 1,000 होती है. 5,000 से ज़्यादा वैल्यू को 5,000 पर सेट कर दिया जाता है.
pageToken

string

ज़रूरी नहीं. जिस पेज को वापस लाना है उसका टोकन. अगर कोई वैल्यू नहीं दी जाती है, तो नतीजों का पहला पेज दिखता है. नतीजों के अगले पेज का अनुरोध करने के लिए, पिछले जवाब में nextPageToken से मिली वैल्यू का इस्तेमाल किया जाना चाहिए.

जवाब का मुख्य भाग

ReportService.Search तरीके के लिए रिस्पॉन्स मैसेज.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
results[]

object (ReportRow)

खोज क्वेरी से मैच होने वाली पंक्तियां.
nextPageToken

string

अगला पेज पाने के लिए, pageToken के तौर पर भेजा जा सकने वाला टोकन. अगर इसे शामिल नहीं किया जाता है, तो इसके बाद कोई पेज नहीं दिखेगा.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/content

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.