Method: customers.searchAds360.searchStream

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

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

درخواست HTTP

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

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

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

پارامترها
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
،

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

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

درخواست HTTP

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

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

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

پارامترها
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
،

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

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

درخواست HTTP

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

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

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

پارامترها
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
،

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

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

درخواست HTTP

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

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

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

پارامترها
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