Method: customers.searchAds360.searchStream

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

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

בקשת HTTP

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
customerId

string

חובה. המזהה של הלקוח שלגביו נשלחת שאילתה.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "query": string,
  "batchSize": integer,
  "summaryRowSetting": enum (SummaryRowSetting)
}
שדות
query

string

חובה. מחרוזת השאילתה.
batchSize

integer

מספר השורות שמוחזרות בכל קבוצה של תגובות בסטרימינג. כאשר נשלחת בקשה בכמות גדולה מדי, השרת עשוי להגביל עוד יותר את מספר השורות המוחזרות.
summaryRowSetting

enum (SummaryRowSetting)

קובעת אם תוחזר שורת סיכום. כברירת מחדל, שורת הסיכום לא מוחזרת. אם תתקבל בקשה, שורת הסיכום תישלח בתשובה עצמה אחרי שכל שאר תוצאות השאילתה יוחזרו.

גוף התשובה

הודעת תשובה עבור SearchAds360Service.SearchStream.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
שדות
results[]

object (SearchAds360Row)

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

string (FieldMask format)

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

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

object (SearchAds360Row)

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

object (CustomColumnHeader)

הכותרות של העמודות בהתאמה אישית בתוצאות.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

הכותרות של המדדים המותאמים אישית של ההמרות בתוצאות.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

הכותרות של המאפיין המותאם אישית של ההמרה בתוצאות.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

הכותרות של מדדי ההמרות הגולמיים של האירועים בתוצאות.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

הכותרות של מאפייני ההמרות הגולמיים של האירועים בתוצאות.
requestId

string

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

היקפי הרשאה

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

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