Method: customers.googleAds.search

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

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

בקשת HTTP

POST https://googleads.googleapis.com/v16/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.