تعرض جميع الصفوف التي تطابق طلب البحث.
قائمة الأخطاء الملموسة: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError
طلب HTTP
POST https://googleads.googleapis.com/v16/customers/{customerId}/googleAds:search
يستخدم عنوان URL بنية تحويل الترميز gRPC.
معلمات المسار
المَعلمات | |
---|---|
customerId |
مطلوبة. رقم تعريف العميل الذي يجري الاستعلام عنه. |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"query": string,
"pageToken": string,
"pageSize": integer,
"validateOnly": boolean,
"returnTotalResultsCount": boolean,
"summaryRowSetting": enum ( |
الحقول | |
---|---|
query |
مطلوبة. سلسلة طلب البحث |
pageToken |
الرمز المميّز للصفحة لاسترداده. في حال عدم تحديد أي خيار، سيتم عرض الصفحة الأولى من النتائج. استخدِم القيمة التي تم الحصول عليها من |
pageSize |
عدد العناصر المطلوب استردادها في صفحة واحدة. عندما يتم طلب صفحة كبيرة جدًا، قد يقرّر الخادم تقييد عدد الموارد التي يتم عرضها بشكل أكبر. |
validateOnly |
إذا كانت الإجابة "صحيح"، يتم التحقّق من صحة الطلب ولكن لا يتم تنفيذه. |
returnTotalResultsCount |
إذا كانت true، فسيتم تضمين العدد الإجمالي للنتائج التي تطابق الاستعلام مع تجاهل عبارة LIMIT في الإجابة. والقيمة التلقائية هي "خطأ". |
summaryRowSetting |
تحدِّد هذه السياسة ما إذا كان سيتم عرض صف ملخّص. ولا يتم عرض صف الملخّص تلقائيًا. وإذا لزم الأمر، سيتم إرسال صف الملخص كاستجابة بمفرده بعد عرض جميع نتائج الاستعلام الأخرى. |
نص الاستجابة
رسالة الرد لـ "GoogleAdsService.Search
".
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "results": [ { object ( |
الحقول | |
---|---|
results[] |
قائمة الصفوف التي تطابق طلب البحث. |
nextPageToken |
الرمز المميّز لتقسيم النتائج على عدّة صفحات يُستخدم لاسترداد الصفحة التالية من النتائج. مرِّر محتوى هذه السلسلة كسمة |
totalResultsCount |
إجمالي عدد النتائج التي تطابق طلب البحث مع تجاهل عبارة LIMIT. |
fieldMask |
قناع الحقل الذي يمثل الحقول التي طلبها المستخدم. هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: |
summaryRow |
صف الملخص الذي يحتوي على ملخص المقاييس في النتائج يعني ملخص المقاييس تجميع المقاييس عبر جميع النتائج، ويمكن أن يكون التجميع هنا هو المجموع والمتوسط والمعدل وما إلى ذلك. |
queryResourceConsumption |
مقدار الموارد المستهلكة لعرض الاستعلام. |
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/adwords
لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.