Method: customers.searchAds360.search

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

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

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

boolean

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

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

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