Method: customers.searchAds360.search

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

गड़बड़ियों की सूची: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError 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