Method: customers.googleAds.searchStream

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

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

طلب HTTP

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
customerId

string

مطلوب. رقم تعريف العميل الذي يتم الاستعلام عنه.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
الحقول
query

string

مطلوب. سلسلة طلب البحث.
summaryRowSetting

enum (SummaryRowSetting)

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

نص الاستجابة

رسالة الردّ بشأن GoogleAdsService.SearchStream

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

تمثيل JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
الحقول
results[]

object (GoogleAdsRow)

قائمة الصفوف التي تطابقت مع طلب البحث
fieldMask

string (FieldMask format)

قناع حقل يمثّل الحقول التي طلبها المستخدم

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

object (GoogleAdsRow)

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

string

المعرّف الفريد للطلب الذي يُستخدَم لأغراض تصحيح الأخطاء.
queryResourceConsumption

string (int64 format)

مقدار الموارد المستهلك لعرض طلب البحث. يتمّ عرض قيمة queryResourceConsumption لصف "الملخّص" والردود غير "الملخّص" بشكلٍ منفصل في صفوفهما المعنيّة. ويتمّ عرض قيمة queryResourceConsumption للردود غير "الملخّص" في المجموعة النهائية من النتائج.

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.

SummaryRowSetting

فهرس يصف إعدادات صف ملخّص الإرجاع

عمليات التعداد
UNSPECIFIED غير محدّد
UNKNOWN تمثّل القيم غير المعروفة لصف ملخّص الإرجاع.
NO_SUMMARY_ROW لا تعرض صفًا تلخيصيًا.
SUMMARY_ROW_WITH_RESULTS عرض صف الملخّص مع النتائج سيتم عرض صف الملخّص في الحزمة الأخيرة فقط (لن تحتوي الحزمة الأخيرة على أي نتائج).
SUMMARY_ROW_ONLY عرض صف الملخّص فقط وعدم عرض أي نتائج