Method: customers.searchAds360.searchStream

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

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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