همه ردیفهایی را که با عبارت جستجو مطابقت دارند برمیگرداند.
لیست خطاهای پرتاب شده: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError داخلی خطا QueryError QuotaError RequestError
درخواست HTTP
POST https://googleads.googleapis.com/v17/customers/{customerId}/googleAds:search
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
customerId | ضروری. شناسه مشتری مورد سوال |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"query": string,
"pageToken": string,
"pageSize": integer,
"validateOnly": boolean,
"returnTotalResultsCount": boolean,
"summaryRowSetting": enum ( |
زمینه های | |
---|---|
query | ضروری. رشته پرس و جو. |
pageToken | نشانه صفحه برای بازیابی. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد. از مقدار بدست آمده از |
pageSize | تعداد عناصر برای بازیابی در یک صفحه هنگامی که یک صفحه خیلی بزرگ درخواست می شود، سرور ممکن است تصمیم بگیرد تعداد منابع برگشتی را بیشتر محدود کند. |
validateOnly | اگر درست باشد، درخواست تایید می شود اما اجرا نمی شود. |
returnTotalResultsCount | اگر درست باشد، تعداد کل نتایجی که با پرس و جو مطابقت دارند و بند LIMIT را نادیده می گیرند، در پاسخ لحاظ می شود. پیش فرض نادرست است. |
summaryRowSetting | تعیین می کند که آیا یک ردیف خلاصه بازگردانده می شود یا خیر. به طور پیش فرض، ردیف خلاصه برگردانده نمی شود. در صورت درخواست، ردیف خلاصه پس از بازگرداندن سایر نتایج پرس و جو، خود به خود در پاسخ ارسال می شود. |
بدن پاسخگو
پیام پاسخ برای GoogleAdsService.Search
.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "results": [ { object ( |
زمینه های | |
---|---|
results[] | لیست ردیف هایی که با پرس و جو مطابقت دارند. |
nextPageToken | نشانه صفحه بندی برای بازیابی صفحه بعدی نتایج استفاده می شود. محتوای این رشته را به عنوان صفت |
totalResultsCount | تعداد کل نتایجی که با پرس و جو مطابقت دارند و بند LIMIT را نادیده می گیرند. |
fieldMask | FieldMask که نشان می دهد چه فیلدهایی توسط کاربر درخواست شده است. این فهرستی از نامهای فیلدهای کاملاً واجد شرایط با کاما است. مثال: |
summaryRow | ردیف خلاصه که شامل خلاصه معیارها در نتایج است. خلاصه معیارها به معنای تجمیع معیارها در همه نتایج است، در اینجا تجمیع می تواند مجموع، میانگین، نرخ و غیره باشد. |
queryResourceConsumption | مقدار منابع مصرف شده برای ارائه پرس و جو. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/adwords
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.