Method: customers.searchAds360.searchStream

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

قائمة الأخطاء التي تم طرحها: AuthenticationError AuthorizationError 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)

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

هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: "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