Method: customers.searchAds360.search

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

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

בקשת HTTP

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

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

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

פרמטרים
customerId

string

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
שדות
query

string

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

string

אסימון של הדף לאחזור. אם לא מצוין, יוצג דף התוצאות הראשון. כדי לבקש את דף התוצאות הבא, משתמשים בערך שהתקבל מ-nextPageToken בתגובה הקודמת.
pageSize

integer

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

boolean

אם הערך הוא true, הבקשה מאומתת אבל לא מבוצעת.
returnTotalResultsCount

boolean

אם True, המספר הכולל של התוצאות שתואמות לשאילתה, בהתעלמות מהסעיף LIMIT, ייכלל בתשובה. ברירת המחדל היא False.
summaryRowSetting

enum (SummaryRowSetting)

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

גוף התשובה

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

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

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

object (SearchAds360Row)

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

string

אסימון העימוד שמשמש לאחזור דף התוצאות הבא. צריך להעביר את התוכן של המחרוזת הזו כמאפיין pageToken של הבקשה הבאה. הערך nextPageToken לא מוחזר לגבי הדף האחרון.
totalResultsCount

string (int64 format)

המספר הכולל של התוצאות שתואמות לשאילתה, בלי להתחשב בתנאי LIMIT.
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)

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

היקפי ההרשאות

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

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