Method: customers.googleAds.searchStream

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

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

בקשת HTTP

POST https://googleads.googleapis.com/v14/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
}
שדות
results[]

object (GoogleAdsRow)

רשימת השורות שתאמו לשאילתה.
fieldMask

string (FieldMask format)

FieldMask שמייצג את השדות שהתבקשו על ידי המשתמש.

זוהי רשימה של שמות שדות מלאים, שמופרדים בפסיקים. דוגמה: "user.displayName,photo"
summaryRow

object (GoogleAdsRow)

שורת סיכום שמכילה את סיכום המדדים בתוצאות. המשמעות של סיכום המדדים היא צבירה של מדדים בכל התוצאות. כאן הצבירה יכולה להיות סכום, ממוצע, שיעור וכו'.
requestId

string

המזהה הייחודי של הבקשה שמשמש למטרות ניפוי באגים.

היקפי הרשאות

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

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

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