REST Resource: customers.analysisQueries

משאב: AnalysisQuery

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

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

  // Union field filtered_row can be only one of the following:
  "filteredRowSummary": {
    object (FilteredRowSummary)
  },
  "generateFilteredRowSummaryAutomatically": boolean
  // End of list of possible types for union field filtered_row.
}
שדות
name

string

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

title

string

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

queryText

string

טקסט השאילתה נכתב ב-SQL סטנדרטי. פרטים נוספים זמינים בכתובת https://cloud.google.com/bigquery/docs/reference/standard-sql/.

parameterTypes

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

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

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

mergeSpec
(deprecated)

object (MergeSpec)

הוראות למיזוג שורות. אם יש שורות קיימות, כל השורות שהיו מוסרות מטעמי פרטיות ישולבו בשורה אחת. השורה הממוזגת תוצג בפלט הסופי אם השורה שמוזגה עומדת בדרישות הפרטיות.

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.

שדה איחוד filtered_row. הוראות למיזוג שורות. filtered_row יכול להיות רק אחד מאלה:
filteredRowSummary

object (FilteredRowSummary)

הגדרה של השילוב של שורות שהוטמעו מטעמי פרטיות בשורה אחת שמוזגה. השורה שמוזגה תיכלל בפלט הסופי, אם השורה שמוזגה עומדת בדרישות הפרטיות.

generateFilteredRowSummaryAutomatically

boolean

אם True, המערכת יוצרת באופן אוטומטי סיכום של שורה מסוננת.

מיזוג

מיזוג ההוראות בסכימת התוצאות של שאילתת ניתוח.

ייצוג JSON
{
  "columns": {
    string: {
      object (MergeColumn)
    },
    ...
  }
}
שדות
columns

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

הוראות למיזוג של כל עמודה, לפי שם. כל העמודות החסרות יטופלו כ-GAM_TYPE_UNSPECIFIED.

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

מיזוג

מיזוג ההוראות בעמודה של פלט בודד.

ייצוג JSON
{
  "type": enum (MergeType),
  "value": {
    object (ParameterValue)
  }
}
שדות
type

enum (MergeType)

השיטה שמשמשת לשילוב הערכים של העמודה.

value

object (ParameterValue)

הערך הקבוע לשימוש (תקף רק לסוג מיזוג CONSTANT).

סוג המיזוג

כל הפעולות הנתמכות למיזוג עמודות.

Enums
MERGE_TYPE_UNSPECIFIED סוג המיזוג לא צוין. ערך העמודה שמוזג יהיה NULL.
CONSTANT החלפת ערך העמודה שמוזגה בקבוע הנתון.
SUM מזינים את הסכום של ערכי העמודות שמוזגו.

הסיכום מסונן

מיזוג ההוראות בסכימת התוצאות של שאילתת ניתוח.

ייצוג JSON
{
  "columns": {
    string: {
      object (ColumnSummaryRule)
    },
    ...
  }
}
שדות
columns

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

הוראות למיזוג של כל עמודה, לפי שם. כל העמודות החסרות יטופלו בתור SUMMARY_TYPE_UNSPECIFIED.

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

כלל Columnsummary

מיזוג ההוראות בעמודה של פלט בודד.

ייצוג JSON
{
  "type": enum (SummaryType),
  "value": {
    object (ParameterValue)
  }
}
שדות
type

enum (SummaryType)

השיטה שמשמשת לשילוב הערכים של העמודה.

value

object (ParameterValue)

הערך הקבוע לשימוש (תקף רק לסוג סיכום CONSTANT).

סוג הסיכום

כל הפעולות הנתמכות למיזוג עמודות.

Enums
SUMMARY_TYPE_UNSPECIFIED סוג הסיכום לא צוין. הערך בעמודה הסיכום יהיה NULL.
CONSTANT החלפת ערך העמודה שמוזגה בקבוע הנתון.
SUM מזינים את הסכום של ערכי העמודות שמוזגו.

שיטות

create

יוצרת שאילתת ניתוח להפעלה מאוחרת יותר.

delete

מחיקת שאילתת ניתוח.

get

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

list

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

patch

עדכון שאילתת ניתוח קיימת.

start

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

startTransient

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

validate

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