Method: customers.searchAds360.searchStream

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

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

בקשת HTTP

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

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

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

פרמטרים
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