Method: customers.searchAds360.searchStream

تعرض هذه الدالة جميع الصفوف التي تتطابق مع طلب البحث في "دفق البحث".

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

طلب HTTP

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

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

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

المعلمات
customerId

string

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

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

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

string

الحقل مطلوب. سلسلة طلب البحث
batchSize

integer

عدد الصفوف التي يتم عرضها في كل مجموعة من الردود المتدفقة. عند طلب مجموعة كبيرة جدًا، قد يقرّر الخادم فرض المزيد من القيود على عدد الصفوف المعروضة.
summaryRowSetting

enum (SummaryRowSetting)

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

نص الاستجابة

رسالة الردّ على SearchAds360Service.SearchStream

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

تمثيل JSON 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
الحقول
results[]

object (SearchAds360Row)

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

string (FieldMask format)

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

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

object (SearchAds360Row)

صف الملخّص الذي يتضمّن ملخّصًا للمقاييس في النتائج يعني ملخّص المقاييس تجميع المقاييس على مستوى جميع النتائج، ويمكن أن يكون التجميع هنا عبارة عن مجموع أو متوسط أو معدّل أو غير ذلك.
customColumnHeaders[]

object (CustomColumnHeader)

عناوين الأعمدة المخصّصة في النتائج
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

عناوين مقاييس الإحالات الناجحة المخصّصة في النتائج
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

عناوين سمة الإحالة الناجحة المخصّصة في النتائج
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

عناوين مقاييس الإحالات الناجحة للأحداث الأولية في النتائج
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

عناوين سمات الإحالات الناجحة للأحداث الأولية في النتائج.
requestId

string

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

نطاقات الأذونات

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

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