Method: customers.searchAds360.searchStream

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

इस्तेमाल की गई गड़बड़ियों की सूची: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

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

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

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

पाथ के पैरामीटर

पैरामीटर
customerId

string

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

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

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

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

string

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

integer

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

enum (SummaryRowSetting)

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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)

फ़ील्डमास्क से पता चलता है कि उपयोगकर्ता ने किन फ़ील्ड के लिए अनुरोध किया था.

यह फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा-सेपरेटेड लिस्ट है. उदाहरण: "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