חובה. המזהה של המפרסם שאליו שייכות קבוצות המודעות.
פרמטרים של שאילתה
פרמטרים
pageSize
integer
גודל הדף המבוקש. חייב להיות בין 1 ל-200. אם לא צוין ערך, ברירת המחדל תהיה 100. הפונקציה מחזירה את קוד השגיאה INVALID_ARGUMENT אם צוין ערך לא חוקי.
pageToken
string
אסימון שמזהה דף של תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method youtubeAdGroups.list. אם לא מציינים שום אפשרות, יוחזר דף התוצאות הראשון.
orderBy
string
שדה שלפיו ממיינים את הרשימה. הערכים הקבילים הם:
displayName (ברירת מחדל)
entityStatus
סדר המיון שמוגדר כברירת מחדל הוא בסדר עולה. כדי לציין סדר יורד של שדה, צריך להוסיף סיומת 'description' לשם השדה. דוגמה: displayName desc
filter
string
מאפשר סינון לפי שדות מותאמים אישית של קבוצות מודעות ב-YouTube.
תחביר נתמך:
ביטויי סינון מורכבים מהגבלה אחת או יותר.
אפשר לשלב את ההגבלות באמצעות AND ו-OR. רצף של הגבלות משתמש באופן לא מפורש ב-AND.
המונח של הגבלה הוא {field} {operator} {value}.
יש להשתמש באופרטור EQUALS (=) בכל השדות.
מאפיינים נתמכים:
adGroupId
displayName
entityStatus
lineItemId
adGroupFormat
דוגמאות:
כל קבוצות המודעות בפריט: lineItemId="1234"
כל ENTITY_STATUS_ACTIVE או ENTITY_STATUS_PAUSED קבוצות המודעות YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM של מפרסם: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"