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

إذا كان صحيحًا، سيتم تضمين إجمالي عدد النتائج التي تتطابق مع طلب البحث مع تجاهل عبارة 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