מחזירה את כל השורות שתואמות לשאילתת זרם החיפוש.
רשימת שגיאות שקרו: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError
בקשת HTTP
POST https://googleads.googleapis.com/v16/customers/{customerId}/googleAds:searchStream
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
customerId |
חובה. מזהה הלקוח שלגביו נשלחת שאילתה. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"query": string,
"summaryRowSetting": enum ( |
שדות | |
---|---|
query |
חובה. מחרוזת השאילתה. |
summaryRowSetting |
המדיניות הזו קובעת אם תוחזר שורת סיכום. כברירת מחדל, שורת הסיכום לא מוצגת. אם תופיע בקשה, שורת הסיכום תישלח כתגובה מעצמה אחרי שכל שאר התוצאות של השאילתה יוחזרו. |
גוף התשובה
הודעת תשובה לגבי GoogleAdsService.SearchStream
.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "results": [ { object ( |
שדות | |
---|---|
results[] |
רשימת השורות שתאמו לשאילתה. |
fieldMask |
FieldMask שמייצג את השדות שהתבקשו על ידי המשתמש. זוהי רשימה מופרדת בפסיקים של שמות מלאים של שדות. דוגמה: |
summaryRow |
שורת סיכום שמכילה את סיכום המדדים בתוצאות. סיכום המדדים פירושו צבירה של מדדים מכל התוצאות. כאן הצבירה יכולה להיות סכום, ממוצע, שיעור וכו'. |
requestId |
המזהה הייחודי של הבקשה שמשמש למטרות ניפוי באגים. |
queryResourceConsumption |
כמות המשאבים שנצרכת כדי להציג את השאילתה. queryResourceConsumption עבור השורה 'סיכום' ותגובות שאינן סיכום מוחזרות בנפרד בשורות המתאימות. queryResourceConsumption עבור תגובות שאינן סיכום מוחזרות בקבוצת התוצאות הסופית. |
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/adwords
למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.