Method: customers.googleAds.searchStream

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

רשימה של שגיאות ש להופיע: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

בקשת HTTP

POST https://googleads.googleapis.com/v17/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.