Method: customers.searchAds360.search

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
customerId

string

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

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

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

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

string

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

pageToken

string

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

pageSize

integer

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

validateOnly

boolean

अगर सही है, तो अनुरोध की पुष्टि की जाती है, लेकिन उसे लागू नहीं किया जाता.

returnTotalResultsCount

boolean

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

summaryRowSetting

enum (SummaryRowSetting)

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

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

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

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

JSON के काेड में दिखाना
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ]
}
फ़ील्ड
results[]

object (SearchAds360Row)

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

nextPageToken

string

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

totalResultsCount

string (int64 format)

LIMIT क्लॉज़ को अनदेखा करके, क्वेरी से मैच होने वाले नतीजों की कुल संख्या.

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)

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

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

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

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