Method: customers.googleAds.searchStream

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

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

درخواست HTTP

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

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

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

پارامترها
customerId

string

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

درخواست بدن

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

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

string

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

summaryRowSetting

enum ( SummaryRowSetting )

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

بدن پاسخگو

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

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
فیلدها
results[]

object ( GoogleAdsRow )

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

fieldMask

string ( FieldMask format)

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

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

summaryRow

object ( GoogleAdsRow )

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

requestId

string

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

queryResourceConsumption

string ( int64 format)

مقدار منابع مصرف شده برای ارائه پرس و جو. queryResourceConsumption برای ردیف Summary و پاسخ های non Summary به طور جداگانه در ردیف های مربوطه خود برگردانده می شوند. queryResourceConsumption برای پاسخ‌های غیر خلاصه در دسته نهایی نتایج بازگردانده می‌شود.

محدوده مجوز

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

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

SummaryRowSetting

Enum تنظیمات ردیف خلاصه بازگشتی را توصیف می کند.

Enums
UNSPECIFIED مشخص نشده است.
UNKNOWN مقادیر ناشناخته ردیف خلاصه بازگشتی را نشان می دهد.
NO_SUMMARY_ROW ردیف خلاصه را برنگردانید.
SUMMARY_ROW_WITH_RESULTS ردیف خلاصه را به همراه نتایج برگردانید. ردیف خلاصه به تنهایی در آخرین دسته برگردانده می شود (آخرین دسته هیچ نتیجه ای نخواهد داشت).
SUMMARY_ROW_ONLY فقط ردیف خلاصه را برگردانید و هیچ نتیجه ای برگردانید.