Method: customers.googleAds.search

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

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

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

POST https://googleads.googleapis.com/v16/customers/{customerId}/googleAds:search

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

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

पैरामीटर
customerId

string

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

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

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "queryResourceConsumption": string
}
फ़ील्ड
results[]

object (GoogleAdsRow)

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

string

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

string (int64 format)

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

string (FieldMask format)

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

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

object (GoogleAdsRow)

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

string (int64 format)

क्वेरी करने के लिए इस्तेमाल किए गए संसाधनों की संख्या.

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

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

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

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