Method: customers.googleAds.search

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

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

בקשת HTTP

POST https://googleads.googleapis.com/v17/customers/{customerId}/googleAds:search

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

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

גוף התשובה

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

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

ייצוג JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "queryResourceConsumption": string
}
שדות
results[]

object (GoogleAdsRow)

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

string

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

string (int64 format)

המספר הכולל של תוצאות שתואמות לשאילתה, בהתעלמות מסעיף LIMIT.
fieldMask

string (FieldMask format)

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

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

object (GoogleAdsRow)

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

string (int64 format)

כמות המשאבים שצורכו לצורך מילוי השאילתה.

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

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

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

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.