Method: customers.searchAds360.searchStream

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

لیست خطاهای رخ داده: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
customerId

string

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

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "query": string,
  "batchSize": integer,
  "summaryRowSetting": enum (SummaryRowSetting)
}
فیلدها
query

string

الزامی. رشته‌ی پرس‌وجو.

batchSize

integer

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

summaryRowSetting

enum ( SummaryRowSetting )

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

بدنه پاسخ

پیام پاسخ برای SearchAds360Service.SearchStream .

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
فیلدها
results[]

object ( SearchAds360Row )

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

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 )

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

requestId

string

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

دامنه‌های مجوز

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

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