Method: customers.googleAds.searchStream

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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 בשורה Summary ובתשובות שאינן Summary מוחזר בנפרד בשורות המתאימות. הערך של queryResourceConsumption בתשובות שאינן Summary מוחזר בקבוצת התוצאות הסופית.

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

SummaryRowSetting

Enum שמתאר את ההגדרות של שורת הסיכום של ההחזרות.

טיפוסים בני מנייה (enum)
UNSPECIFIED לא צוין.
UNKNOWN מייצגים ערכים לא ידועים בשורת הסיכום של ההחזרות.
NO_SUMMARY_ROW לא להחזיר שורת סיכום.
SUMMARY_ROW_WITH_RESULTS החזרת שורת סיכום יחד עם התוצאות. שורת הסיכום תוחזר רק בקבוצה האחרונה (הקבוצה האחרונה לא תכיל תוצאות).
SUMMARY_ROW_ONLY להציג רק שורת סיכום ולא להחזיר תוצאות.