Method: customers.searchAds360.search

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

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

בקשת HTTP

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

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

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

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