Method: customers.searchAds360.search

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

قائمة بالأخطاء الناتجة: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

طلب HTTP

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360: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

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

boolean

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

enum (SummaryRowSetting)

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

نص الاستجابة

رسالة الرد لـ "SearchAds360Service.Search".

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

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

object (SearchAds360Row)

قائمة الصفوف التي تطابق طلب البحث.
nextPageToken

string

الرمز المميّز لتقسيم النتائج على عدّة صفحات يُستخدم لاسترداد الصفحة التالية من النتائج. مرِّر محتوى هذه السلسلة كسمة pageToken للطلب التالي. لا يتم عرض nextPageToken للصفحة الأخيرة.
totalResultsCount

string (int64 format)

إجمالي عدد النتائج التي تطابق طلب البحث مع تجاهل عبارة LIMIT.
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)

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

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

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

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