Method: customers.googleAds.searchStream

מחזירה את כל השורות שתואמות לשאילתת זרם החיפוש.

רשימת שגיאות שקרו: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
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 עבור השורה 'סיכום' ותגובות שאינן סיכום מוחזרות בנפרד בשורות המתאימות. queryResourceConsumption עבור תגובות שאינן סיכום מוחזרות בקבוצת התוצאות הסופית.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.