Method: customers.searchAds360.search

همه ردیف‌هایی را که با عبارت جستجو مطابقت دارند برمی‌گرداند.

لیست خطاهای پرتاب شده: AuthenticationError AuthorizationError HeaderError داخلی خطا QueryError QuotaError RequestError

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
customer Id

string

مورد نیاز. شناسه مشتری مورد سوال

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
فیلدها
query

string

مورد نیاز. رشته پرس و جو.

page Token

string

نشانه صفحه برای بازیابی. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد. از مقدار بدست آمده از nextPageToken در پاسخ قبلی برای درخواست صفحه بعدی نتایج استفاده کنید.

page Size

integer

تعداد عناصر برای بازیابی در یک صفحه هنگامی که یک صفحه خیلی بزرگ درخواست می شود، سرور ممکن است تصمیم بگیرد تعداد منابع برگشتی را بیشتر محدود کند.

validate Only

boolean

اگر درست باشد، درخواست تایید می شود اما اجرا نمی شود.

return Total Results Count

boolean

اگر درست باشد، تعداد کل نتایجی که با پرس و جو مطابقت دارند و بند LIMIT را نادیده می گیرند، در پاسخ لحاظ می شود. پیش فرض نادرست است.

summary Row Setting

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 )

لیست ردیف هایی که با پرس و جو مطابقت دارند.

next Page Token

string

نشانه صفحه بندی برای بازیابی صفحه بعدی نتایج استفاده می شود. محتوای این رشته را به عنوان صفت pageToken درخواست بعدی ارسال کنید. nextPageToken برای صفحه آخر بازگردانده نمی شود.

total Results Count

string ( int64 format)

تعداد کل نتایجی که با پرس و جو مطابقت دارند و بند LIMIT را نادیده می گیرند.

field Mask

string ( FieldMask format)

FieldMask که نشان می دهد چه فیلدهایی توسط کاربر درخواست شده است.

این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" .

summary Row

object ( SearchAds360Row )

ردیف خلاصه که شامل خلاصه معیارها در نتایج است. خلاصه معیارها به معنای تجمیع معیارها در همه نتایج است، در اینجا تجمیع می تواند مجموع، میانگین، نرخ و غیره باشد.

custom Column Headers[]

object ( CustomColumnHeader )

سرصفحه های ستون های سفارشی در نتایج.

conversion Custom Metric Headers[]

object ( ConversionCustomMetricHeader )

سرصفحه‌های معیارهای سفارشی تبدیل در نتایج.

conversion Custom Dimension Headers[]

object ( ConversionCustomDimensionHeader )

هدر ابعاد سفارشی تبدیل در نتایج.

raw Event Conversion Metric Headers[]

object ( RawEventConversionMetricHeader )

سرصفحه های معیارهای تبدیل رویداد خام در نتایج.

raw Event Conversion Dimension Headers[]

object ( RawEventConversionDimensionHeader )

هدر ابعاد تبدیل رویداد خام در نتایج.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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