Method: customers.googleAds.search

عرض جميع الصفوف التي تطابق طلب البحث.

قائمة الأخطاء التي تظهر: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز 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

إذا كانت القيمة true، يتم التحقق من صحة الطلب ولكن لا يتم تنفيذه.
returnTotalResultsCount

boolean

إذا تم التعيين على "true"، فسيتم تضمين العدد الإجمالي للنتائج التي تطابق الاستعلام مع تجاهل عبارة LIMIT في الرد. القيمة التلقائية هي "خطأ".
summaryRowSetting

enum (SummaryRowSetting)

تحدِّد هذه السياسة ما إذا كان سيتم عرض صف ملخّص. لا يتم عرض صف الملخّص تلقائيًا. وفي حال طلب ذلك، سيتم إرسال صف الملخص في استجابة بمفرده بعد عرض جميع نتائج طلبات البحث الأخرى.

نص الاستجابة

رسالة الرد على GoogleAdsService.Search.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "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)

FieldMask الذي يمثل الحقول التي طلبها المستخدم.

هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: "user.displayName,photo"
summaryRow

object (GoogleAdsRow)

صف الملخّص الذي يحتوي على ملخّص للمقاييس في النتائج يعني ملخص المقاييس تجميع المقاييس عبر جميع النتائج، ويمكن أن يكون التجميع هنا المجموع والمتوسط والمعدل وما إلى ذلك.
queryResourceConsumption

string (int64 format)

مقدار الموارد المستهلكة لعرض طلب البحث.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.