Method: customers.googleAds.search

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

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

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

POST https://googleads.googleapis.com/v14/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)
  }
}
फ़ील्ड
results[]

object (GoogleAdsRow)

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

string

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

string (int64 format)

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

string (FieldMask format)

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

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

object (GoogleAdsRow)

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

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

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

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

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