Method: googleAudiences.list

מציג רשימות של קהלים ב-Google.

הסדר מוגדר על ידי הפרמטר orderBy.

בקשת HTTP

GET https://displayvideo.googleapis.com/v4/googleAudiences

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

פרמטרים של שאילתה

פרמטרים
pageSize

integer

גודל הדף המבוקש. הערך חייב להיות בין 1 ל-200. אם לא מציינים ערך, ברירת המחדל היא 100. אם צוין ערך לא תקין, הפונקציה מחזירה את קוד השגיאה INVALID_ARGUMENT.
pageToken

string

אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל זה הערך של nextPageToken שמוחזר מהקריאה הקודמת לשיטת googleAudiences.list. אם לא מציינים ערך, יוצג דף התוצאות הראשון.
orderBy

string

השדה שלפיו רוצים למיין את הרשימה. הערכים הקבילים הם:

  • ‫googleAudienceId (ברירת מחדל)
  • displayName

סדר המיון שמוגדר כברירת מחדל הוא סדר עולה. כדי לציין סדר יורד בשדה, צריך להוסיף את הסיומת 'desc' לשם השדה. דוגמה: displayName desc
filter

string

מאפשר סינון לפי שדות קהל של Google.

תחביר נתמך:

  • ביטויי סינון של קהלים ב-Google יכולים להכיל לכל היותר הגבלה אחת.
  • הגבלה היא בפורמט {field} {operator} {value}.
  • כל השדות צריכים להשתמש באופרטור HAS (:).

שדות נתמכים:

  • displayName

דוגמאות:

  • כל הקהלים של Google ששם התצוגה שלהם מכיל את המילה Google: displayName:"Google".

האורך של השדה הזה לא יכול להיות יותר מ-500 תווים.

מידע נוסף זמין במדריך בנושא בקשות לסינון LIST.
חובה. המזהה של הישות ב-DV360 שבה מתבצעת הבקשה. בקשת LIST תחזיר רק ישויות של קהלים ב-Google שאפשר לגשת אליהן לישות DV360 שזוהתה בתוך accessor. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
partnerId

string (int64 format)

המזהה של השותף שיש לו גישה לקהלים של Google שאוחזרו.
advertiserId

string (int64 format)

המזהה של המפרסם שיש לו גישה לקהלים של Google שאוחזרו.
סוף השדות הבלעדיים.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

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

ייצוג ב-JSON 
{
  "googleAudiences": [
    {
      object (GoogleAudience)
    }
  ],
  "nextPageToken": string
}
שדות
googleAudiences[]

object (GoogleAudience)

רשימת הקהלים ב-Google.

אם הרשימה ריקה, היא לא תופיע.
nextPageToken

string

אסימון לאחזור של דף התוצאות הבא. מעבירים את הערך הזה בשדה pageToken בקריאה הבאה לשיטה googleAudiences.list כדי לאחזר את דף התוצאות הבא.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/display-video

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.