Method: customers.searchAds360.searchStream

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

गड़बड़ियों की सूची: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

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

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

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

पाथ पैरामीटर

पैरामीटर
customerId

string

ज़रूरी है. जिस ग्राहक के बारे में क्वेरी की जा रही है उसका आईडी.

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

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

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

string

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

integer

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

enum (SummaryRowSetting)

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

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

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

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
फ़ील्ड
results[]

object (SearchAds360Row)

क्वेरी से मेल खाने वाली लाइनों की सूची.
fieldMask

string (FieldMask format)

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

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

object (SearchAds360Row)

खास जानकारी वाली लाइन, जिसमें नतीजों में मौजूद मेट्रिक की खास जानकारी होती है. मेट्रिक की खास जानकारी का मतलब है कि सभी नतीजों में मेट्रिक को इकट्ठा करना. यहां मेट्रिक को इकट्ठा करने का मतलब जोड़ना, औसत निकालना, दर निकालना वगैरह हो सकता है.
customColumnHeaders[]

object (CustomColumnHeader)

नतीजों में मौजूद कस्टम कॉलम के हेडर.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

नतीजों में कन्वर्ज़न की कस्टम मेट्रिक के हेडर.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

नतीजों में कन्वर्ज़न कस्टम डाइमेंशन के हेडर.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

नतीजों में, रॉ इवेंट कन्वर्ज़न मेट्रिक के हेडर.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

नतीजों में, रॉ इवेंट कन्वर्ज़न डाइमेंशन के हेडर.
requestId

string

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

अनुमति पाने के लिंक

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

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