REST Resource: customers.userListQueries

משאב: UserListQuery

הגדרה של שאילתת רשימת משתמשים שאפשר להפעיל ב-Ads Data Hub.

ייצוג JSON
{
  "name": string,
  "title": string,
  "queryText": string,
  "parameterTypes": {
    string: {
      object (ParameterType)
    },
    ...
  },
  "queryState": enum (QueryState),
  "updateTime": string,
  "updateEmail": string,
  "createTime": string,
  "createEmail": string,
  "queryShare": [
    {
      object (QueryShare)
    }
  ],
  "userList": [
    string
  ]
}
שדות
name

string

שם שמזהה שאילתה באופן ייחודי. יש לו את הטופס ללקוחות/[customerId]/userListQuery/[resource_id], למשל ##39;customers/123/userListQuery/abcd1234' מזהה המשאב נוצר על ידי השרת.

title

string

שם השאילתה הוא ייחודי ללקוח מסוג Ads Data Hub ולסוג שאילתה אחד.

queryText

string

טקסט של שאילתה.

parameterTypes

map (key: string, value: object (ParameterType))

פרמטרים נוספים שצפויים להתקבל מהשאילתה. ממפה כל שם ארגומנט לסוג ארגומנט.

אובייקט שמכיל רשימה של "key": value צמדים. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }

queryState

enum (QueryState)

מצב השאילתה.

updateTime

string (Timestamp format)

מועד העדכון האחרון של השאילתה.

חותמת זמן בפורמט RFC3339 UTC "Zulu" עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

updateEmail

string

כתובת האימייל של המשתמש שעדכן לאחרונה את השאילתה.

createTime

string (Timestamp format)

מועד יצירת השאילתה.

חותמת זמן בפורמט RFC3339 UTC "Zulu" עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

createEmail

string

כתובת האימייל של המשתמש שיצר את השאילתה.

queryShare[]

object (QueryShare)

מציין דרכים שבהן ניתן לשתף שאילתה מעבר ללקוח שבבעלותו חשבון Ads Data Hub.

userList[]

string

פלט בלבד. משאב רשימת המשתמשים של Ads Data Hub שאפשר לאכלס בו את השאילתה של רשימת המשתמשים הזו.

שיטות

create

יוצר שאילתה של רשימת משתמשים לביצוע מאוחר יותר.

delete

מתבצעת מחיקה של שאילתה ברשימת משתמשים.

get

מאחזר את השאילתה המבוקשת של רשימת המשתמשים.

list

רשימה של שאילתות רשימת המשתמשים שבבעלות הלקוח שצוין.

patch

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

start

מתחיל ביצוע בשאילתה של רשימת משתמשים מאוחסנת.

startTransient
(deprecated)

הביצוע מתחיל בשאילתה זמנית של רשימת משתמשים.

validate

מבצע בדיקות אימות סטטיות בשאילתה של רשימת המשתמשים שצוינה.