Method: googleAudiences.list

מציג רשימה של קהלים של Google.

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v3/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.
פרמטר של איחוד accessor. חובה. מזהה את הישות ב-DV360 שבה מתבצעת הבקשה. בקשת LIST תחזיר רק ישויות של קהלים ב-Google שאפשר לגשת אליהן באמצעות ישות DV360 שזוהתה בתוך accessor. הערך 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.