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 از سینتکس Transcoding در 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)

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