Method: customers.googleAds.searchStream

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

दिखने वाली गड़बड़ियों की सूची: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

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

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

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

पाथ पैरामीटर

पैरामीटर
customerId

string

ज़रूरी है. उस ग्राहक का आईडी जिसकी जानकारी चाहिए.

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

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

JSON के काेड में दिखाना 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
फ़ील्ड
query

string

ज़रूरी है. क्वेरी स्ट्रिंग.
summaryRowSetting

enum (SummaryRowSetting)

इससे यह तय होता है कि खास जानकारी वाली लाइन दिखेगी या नहीं. डिफ़ॉल्ट रूप से, खास जानकारी वाली लाइन नहीं दिखती. अगर अनुरोध किया जाता है, तो क्वेरी के अन्य सभी नतीजे मिलने के बाद, खास जानकारी वाली लाइन अपने-आप जवाब के तौर पर भेजी जाएगी.

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

GoogleAdsService.SearchStream के लिए जवाब का मैसेज.

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

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

object (GoogleAdsRow)

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

string (FieldMask format)

FieldMask, जो यह दिखाता है कि उपयोगकर्ता ने किन फ़ील्ड के लिए अनुरोध किया था.

यह फ़ील्ड के पूरी तरह से क्वालिफ़ाइड नामों की सूची है. इसमें नामों को कॉमा लगाकर अलग किया गया है. उदाहरण: "user.displayName,photo".
summaryRow

object (GoogleAdsRow)

खास जानकारी वाली लाइन, जिसमें नतीजों में मेट्रिक की खास जानकारी होती है. मेट्रिक की खास जानकारी का मतलब है, सभी नतीजों में मेट्रिक को इकट्ठा करना. यहां एग्रीगेशन, कुल, औसत, दर वगैरह हो सकता है.
requestId

string

अनुरोध का यूनीक आईडी, जिसका इस्तेमाल डीबग करने के लिए किया जाता है.
queryResourceConsumption

string (int64 format)

क्वेरी को दिखाने के लिए खर्च किए गए संसाधनों की संख्या. खास जानकारी वाली लाइन और खास जानकारी के अलावा अन्य जवाबों के लिए, queryResourceConsumption की वैल्यू को उनकी अपनी लाइनों में अलग-अलग दिखाया जाता है. खास जानकारी के अलावा अन्य जवाबों के लिए, queryResourceConsumption की वैल्यू को नतीजों के आखिरी बैच में दिखाया जाता है.

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

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

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

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

SummaryRowSetting

सामान लौटाने की खास जानकारी वाली लाइन की सेटिंग के बारे में बताने वाला एन्म्.

Enums
UNSPECIFIED इसकी जानकारी नहीं दी गई है.
UNKNOWN सामान लौटाने की खास जानकारी वाली लाइन की अनजान वैल्यू दिखाता है.
NO_SUMMARY_ROW खास जानकारी वाली पंक्ति न दिखाएं.
SUMMARY_ROW_WITH_RESULTS नतीजों के साथ खास जानकारी वाली लाइन दिखाता है. खास जानकारी वाली लाइन सिर्फ़ आखिरी बैच में दिखेगी. आखिरी बैच में कोई नतीजा नहीं होगा.
SUMMARY_ROW_ONLY सिर्फ़ खास जानकारी वाली लाइन दिखाएं और कोई नतीजा न दिखाएं.