מחזירה את כל השורות שתואמות לשאילתת החיפוש.
רשימה של שגיאות התרעה: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError
בקשת HTTP
POST https://googleads.googleapis.com/v14/customers/{customerId}/googleAds:search
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
customerId |
חובה. מספר הלקוח שלגביו נשלחת שאילתה. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"query": string,
"pageToken": string,
"pageSize": integer,
"validateOnly": boolean,
"returnTotalResultsCount": boolean,
"summaryRowSetting": enum ( |
שדות | |
---|---|
query |
חובה. מחרוזת השאילתה. |
pageToken |
אסימון של הדף שיש לאחזר. אם לא מציינים שום אפשרות, יוחזר דף התוצאות הראשון. יש להשתמש בערך שהתקבל מ- |
pageSize |
מספר הרכיבים לאחזור בדף יחיד. כשנשלחת בקשה לדף גדול מדי, השרת עשוי להגביל עוד יותר את מספר המשאבים שמוחזרים. |
validateOnly |
אם הערך הוא true, הבקשה מאומתת אבל לא מבוצעת. |
returnTotalResultsCount |
אם TRUE, המספר הכולל של התוצאות שתואמות לשאילתה שמתעלמים מסעיף LIMIT ייכלל בתשובה. ברירת המחדל היא False. |
summaryRowSetting |
המדיניות הזו קובעת אם תוחזר שורת סיכום. כברירת מחדל, שורת הסיכום לא מוצגת. אם יתבקשו, שורת הסיכום תישלח בתגובה בעצמה אחרי שיוחזרו כל שאר התוצאות של השאילתה. |
גוף התגובה
הודעת תשובה לגבי GoogleAdsService.Search
.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{ "results": [ { object ( |
שדות | |
---|---|
results[] |
רשימת השורות שתאמו לשאילתה. |
nextPageToken |
אסימון העימוד משמש לאחזור דף התוצאות הבא. יש להעביר את התוכן של המחרוזת הזו בתור המאפיין |
totalResultsCount |
המספר הכולל של תוצאות שתואמות את השאילתה, בהתעלמות מהסעיף LIMIT. |
fieldMask |
FieldMask שמייצג את השדות שהתבקשו על ידי המשתמש. זוהי רשימה של שמות שדות מלאים, שמופרדים בפסיקים. דוגמה: |
summaryRow |
שורת סיכום שמכילה את סיכום המדדים בתוצאות. המשמעות של סיכום המדדים היא צבירה של מדדים בכל התוצאות. כאן הצבירה יכולה להיות סכום, ממוצע, שיעור וכו'. |
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/adwords
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.