REST Resource: properties.audiences

משאב: קהל

הודעת משאב שמייצגת קהל.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ],
  "createTime": string
}
שדות
name

string

פלט בלבד. שם המשאב של משאב הקהל הזה. פורמט: properties/{propertyId}/audiences/{audienceId}
displayName

string

חובה. השם המוצג של הקהל.
description

string

חובה. התיאור של הקהל.
membershipDurationDays

integer

חובה. לא ניתן לשינוי. משך הזמן שבו משתמש צריך להישאר בקהל. אי אפשר להגדיר את התקופה ליותר מ-540 ימים.
adsPersonalizationEnabled

boolean

פלט בלבד. מערכת GA מגדירה אותו באופן אוטומטי כ-false אם מדובר בקהל NPA והוא לא נכלל בהתאמה האישית של המודעות.
eventTrigger

object (AudienceEventTrigger)

אופציונלי. אירוע שרוצים לתעד ביומן כשמשתמש מצטרף לקהל. אם לא מגדירים את הפרמטר, לא מתועד אירוע כשמשתמש מצטרף לקהל.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

לא ניתן לשינוי. מציין כמה זמן ההחרגה נמשכת למשתמשים שעומדים בדרישות של מסנן ההחרגה. הוא חל על כל התנאים של מסנן ההחרגה, והמערכת מתעלמת ממנו אם אין תנאי של מסנן החרגה בקהל.
filterClauses[]

object (AudienceFilterClause)

חובה. לא ניתן לשינוי. רשימה לא ממוינת. סינון תנאים שמגדירים את הקהל. כל התנאים ישויכו באמצעות AND.
createTime

string (Timestamp format)

פלט בלבד. השעה שבה נוצר הקהל.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר גם להשתמש בשינויים (offsets) אחרים מלבד 'Z'. לדוגמה: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

AudienceEventTrigger

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

ייצוג ב-JSON 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
שדות
eventName

string

חובה. שם האירוע שיירשם ביומן.
logCondition

enum (LogCondition)

חובה. מתי האירוע יתועד ביומן.

LogCondition

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

טיפוסים בני מנייה (enum)
LOG_CONDITION_UNSPECIFIED לא צוין תנאי יומן.
AUDIENCE_JOINED צריך לתעד את האירוע רק כשמשתמש מצטרף.
AUDIENCE_MEMBERSHIP_RENEWED האירוע צריך להירשם ביומן בכל פעם שהתנאי של הקהל מתקיים, גם אם המשתמש כבר חבר בקהל.

AudienceExclusionDurationMode

מציין כמה זמן ההחרגה נמשכת למשתמשים שעומדים בדרישות של מסנן ההחרגה.

טיפוסים בני מנייה (enum)
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED לא צוין.
EXCLUDE_TEMPORARILY החרגת משתמשים מהקהל בתקופות שבהן הם עומדים בתנאי של תנאי הסינון.
EXCLUDE_PERMANENTLY החרגת משתמשים מהקהל אם הם אי פעם עמדו בתנאי של סעיף המסנן.

AudienceFilterClause

תנאי להגדרת מסנן פשוט או מסנן רצף. מסנן יכול להיות מסנן הכללה (לדוגמה, משתמשים שעומדים בתנאי של תנאי המסנן נכללים בקהל) או מסנן החרגה (לדוגמה, משתמשים שעומדים בתנאי של תנאי המסנן נכללים בקהל).

ייצוג ב-JSON 
{
  "clauseType": enum (AudienceClauseType),

  // Union field filter can be only one of the following:
  "simpleFilter": {
    object (AudienceSimpleFilter)
  },
  "sequenceFilter": {
    object (AudienceSequenceFilter)
  }
  // End of list of possible types for union field filter.
}
שדות
clauseType

enum (AudienceClauseType)

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

שדה האיחוד filter.

הערך של filter יכול להיות רק אחת מהאפשרויות הבאות:
simpleFilter

object (AudienceSimpleFilter)

מסנן פשוט שמשתמש חייב לעמוד בו כדי להיכלל בקהל.
sequenceFilter

object (AudienceSequenceFilter)

מסננים שחייבים להתקיים בסדר ספציפי כדי שהמשתמש יתווסף לקהל.

AudienceSimpleFilter

הגדרת מסנן פשוט שהמשתמש צריך לעמוד בו כדי להיכלל בקהל.

ייצוג ב-JSON 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
שדות
scope

enum (AudienceFilterScope)

חובה. לא ניתן לשינוי. ההיקף של המסנן.
filterExpression

object (AudienceFilterExpression)

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

AudienceFilterScope

קובעת איך להעריך משתמשים כדי להוסיף אותם לקהל.

טיפוסים בני מנייה (enum)
AUDIENCE_FILTER_SCOPE_UNSPECIFIED ההיקף לא צוין.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT המשתמש מצטרף לקהל אם התנאי של המסנן מתקיים באירוע אחד.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION המשתמש מצטרף לקהל אם התנאי של המסנן מתקיים במהלך סשן אחד.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS משתמש מצטרף לקהל אם התנאי של המסנן מתקיים לגבי אירוע כלשהו בכל סשן.

AudienceFilterExpression

ביטוי לוגי של מסנני מאפיינים, מדדים או אירועים של קהל.

ייצוג ב-JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (AudienceFilterExpressionList)
  },
  "orGroup": {
    object (AudienceFilterExpressionList)
  },
  "notExpression": {
    object (AudienceFilterExpression)
  },
  "dimensionOrMetricFilter": {
    object (AudienceDimensionOrMetricFilter)
  },
  "eventFilter": {
    object (AudienceEventFilter)
  }
  // End of list of possible types for union field expr.
}
שדות
שדה האיחוד expr. הביטוי שחלה על מסנן. הערך של expr יכול להיות רק אחת מהאפשרויות הבאות:
andGroup

object (AudienceFilterExpressionList)

רשימה של ביטויים שצריך לבצע ביניהם AND. הוא יכול להכיל רק ביטויים מסוג AudienceFilterExpressions עם orGroup. צריך להגדיר את הערך הזה ל-AudienceFilterExpression ברמה העליונה.
orGroup

object (AudienceFilterExpressionList)

רשימה של ביטויים שצריך לבצע ביניהם או (OR). הוא לא יכול להכיל ביטויים של AudienceFilter עם andGroup או orGroup.
notExpression

object (AudienceFilterExpression)

ביטוי סינון שרוצים להפעיל עליו את הפונקציה NOT (למשל, הפוך, משלימה). הוא יכול לכלול רק מסנן מסוג dimensionOrMetricFilter. לא ניתן להגדיר את האפשרות הזו ב-AudienceFilterExpression ברמה העליונה.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

מסנן לפי מאפיין או מדד יחיד. לא ניתן להגדיר את האפשרות הזו ב-AudienceFilterExpression ברמה העליונה.
eventFilter

object (AudienceEventFilter)

יצירת מסנן שתואמת לאירוע ספציפי. לא ניתן להגדיר את האפשרות הזו ב-AudienceFilterExpression ברמה העליונה.

AudienceFilterExpressionList

רשימה של ביטויים לסינון קהלים.

ייצוג ב-JSON 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
שדות
filterExpressions[]

object (AudienceFilterExpression)

רשימה של ביטויים לסינון קהלים.

AudienceDimensionOrMetricFilter

מסנן ספציפי למאפיין או למדד יחיד.

ייצוג ב-JSON 
{
  "fieldName": string,
  "atAnyPointInTime": boolean,
  "inAnyNDayPeriod": integer,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
שדות
fieldName

string

חובה. לא ניתן לשינוי. שם המאפיין או שם המדד שרוצים לסנן. אם שם השדה מתייחס למאפיין או למדד בהתאמה אישית, תחילית של ההיקף תתווסף לתחילת השם של המאפיין או המדד בהתאמה אישית. מידע נוסף על תחיליות היקף או על מאפיינים/מדדים מותאמים אישית זמין במסמכי העזרה של Google Analytics Data API.
atAnyPointInTime

boolean

אופציונלי. מציין אם המסנן הזה צריך הערכה דינמית או לא. אם הערך מוגדר כ-true, משתמשים מצטרפים לקהל אם הם אי פעם עמדו בתנאי (הערכה סטטית). אם לא מגדירים את הערך או מגדירים אותו כ-False, הערכת המשתמשים לקהל היא דינמית. המשתמשים מתווספים לקהל כשהם עומדים בתנאים, ומוחרגים ממנו כשהם כבר לא עומדים בהם.

אפשר להגדיר את הערך הזה רק כאשר היקף הקהל הוא ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

אופציונלי. אם השדה מוגדר, הוא מציין את חלון הזמן שבו יתבצע הערכת הנתונים במספר ימים. אם לא תגדירו את הערך, נתוני הקהל ייבדקו בהשוואה לנתונים מכל תקופת הפעילות (לדוגמה, חלון זמן אינסופי).

לדוגמה, אם הערך מוגדר ל-1 יום, המערכת תערוך הערכה רק על סמך הנתונים מהיום הנוכחי. נקודת העזרה היא היום הנוכחי כשהערך של atAnyPointInTime לא מוגדר או שהוא שגוי.

אפשר להגדיר אותו רק כשהיקף הקהל הוא ACROSS_ALL_SESSIONS, והוא לא יכול להיות ארוך מ-60 ימים.
שדה האיחוד one_filter. אחד מהמסננים שלמעלה. הערך של one_filter יכול להיות רק אחת מהאפשרויות הבאות:
stringFilter

object (StringFilter)

מסנן למאפיין מסוג מחרוזת שתואמת לדפוס מסוים.
inListFilter

object (InListFilter)

מסנן למימד מחרוזת שתואמת לרשימת אפשרויות מסוימת.
numericFilter

object (NumericFilter)

מסנן לערכים מספריים או לתאריכים במאפיין או במדד.
betweenFilter

object (BetweenFilter)

מסנן לערכים מספריים או לתאריכים שנמצאים בין ערכים מסוימים במאפיין או במדד.

StringFilter

מסנן למאפיין מסוג מחרוזת שתואמת לדפוס מסוים.

ייצוג ב-JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
שדות
matchType

enum (MatchType)

חובה. סוג ההתאמה של מסנן המחרוזת.
value

string

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

boolean

אופציונלי. אם הערך הוא True, ההתאמה תלוית אותיות רישיות. אם הערך הוא false, ההתאמה לא תלויה ברישיות.

MatchType

סוג ההתאמה של מסנן המחרוזת.

טיפוסים בני מנייה (enum)
MATCH_TYPE_UNSPECIFIED לא צוין
EXACT התאמה מדויקת של ערך המחרוזת.
BEGINS_WITH מתחיל בערך המחרוזת.
ENDS_WITH מסתיים בערך המחרוזת.
CONTAINS מכיל את ערך המחרוזת.
FULL_REGEXP הביטוי הרגולרי המלא תואם לערך המחרוזת.

InListFilter

מסנן למימד מחרוזת שתואמת לרשימת אפשרויות מסוימת.

ייצוג ב-JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
שדות
values[]

string

חובה. רשימת ערכי המחרוזות האפשריים להתאמה. השדה לא יכול להיות ריק.
caseSensitive

boolean

אופציונלי. אם הערך הוא True, ההתאמה תלוית אותיות רישיות. אם הערך הוא false, ההתאמה לא תלויה ברישיות.

NumericFilter

מסנן לערכים מספריים או לתאריכים במאפיין או במדד.

ייצוג ב-JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
שדות
operation

enum (Operation)

חובה. הפעולה שחלה על מסנן מספרי.
value

object (NumericValue)

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

פעולה

הפעולה שחלה על מסנן מספרי.

טיפוסים בני מנייה (enum)
OPERATION_UNSPECIFIED לא צוין.
EQUAL שווה.
LESS_THAN פחות מ-.
GREATER_THAN גדול מ-.

NumericValue

כדי לייצג מספר.

ייצוג ב-JSON 
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
שדות
שדה האיחוד one_value. ערך מספרי. הערך של one_value יכול להיות רק אחת מהאפשרויות הבאות:
int64Value

string (int64 format)

ערך של מספר שלם.
doubleValue

number

ערך כפול.

BetweenFilter

מסנן לערכים מספריים או לתאריכים שנמצאים בין ערכים מסוימים במאפיין או במדד.

ייצוג ב-JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
שדות
fromValue

object (NumericValue)

חובה. המספר הזה מופיע בהתחלה, כולל.
toValue

object (NumericValue)

חובה. מסתיים במספר הזה, כולל.

AudienceEventFilter

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

ייצוג ב-JSON 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
שדות
eventName

string

חובה. לא ניתן לשינוי. שם האירוע שרוצים להתאים אליו.
eventParameterFilterExpression

object (AudienceFilterExpression)

אופציונלי. אם מציינים את המסנן הזה, הוא יתאים לאירועים שתואמים גם לשם האירוע היחיד וגם לביטויים של מסנן הפרמטרים. אי אפשר להגדיר את AudienceEventFilter בתוך ביטוי המסנן של הפרמטר (לדוגמה, אין תמיכה במסנני אירועים בתצוגת עץ). הביטוי הזה צריך להיות קבוצת andGroup יחידה של dimensionOrMetricFilter או notExpression. לא נתמכים ביטויים מסוג AND של ביטויים מסוג OR. בנוסף, אם הוא כולל מסנן עבור 'eventCount', רק המסנן הזה יילקח בחשבון. כל שאר המסננים יימחקו.

AudienceSequenceFilter

הגדרת מסננים שצריכים להתרחש בסדר מסוים כדי שהמשתמש ייכלל בקהל.

ייצוג ב-JSON 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
שדות
scope

enum (AudienceFilterScope)

חובה. לא ניתן לשינוי. ההיקף של המסנן.
sequenceMaximumDuration

string (Duration format)

אופציונלי. תקופת הזמן שבה כל הרצף צריך להתרחש.

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

חובה. רצף מסודר של שלבים. כדי להצטרף לסינון הרצף, המשתמש צריך להשלים כל שלב.

AudienceSequenceStep

תנאי שחייב להתרחש בסדר השלבים שצוין כדי שהמשתמש הזה יתאים לרצף.

ייצוג ב-JSON 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
שדות
scope

enum (AudienceFilterScope)

חובה. לא ניתן לשינוי. היקף השלב.
immediatelyFollows

boolean

אופציונלי. אם הערך הוא true, האירוע שעומד בדרישות של השלב הזה חייב להיות האירוע הבא אחרי האירוע שעומד בדרישות של השלב האחרון. אם השדה לא מוגדר או שהוא שווה ל-false, השלב הזה מתרחש בעקיפין אחרי השלב הקודם. לדוגמה, יכול להיות שיהיו אירועים בין השלב הקודם לשלב הזה. המערכת מתעלמת ממנו בשלב הראשון.
constraintDuration

string (Duration format)

אופציונלי. כשמגדירים את השלב הזה, הוא חייב להתקיים במסגרת constraintDuration של השלב הקודם (לדוגמה, t[i] - t[i-1] <= constraintDuration). אם לא תגדירו את הערך הזה, לא תהיה דרישה למשך הזמן (המשך הזמן הוא למעשה בלתי מוגבל). המערכת מתעלמת ממנו בשלב הראשון.

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".
filterExpression

object (AudienceFilterExpression)

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

AudienceClauseType

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

טיפוסים בני מנייה (enum)
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED סוג פסקה לא צוין.
INCLUDE משתמשים ייכללו בקהל אם התנאי של תנאי המסנן יתקיים.
EXCLUDE משתמשים יוחרגו מהקהל אם התנאי של תנאי הסינון יתקיים.

Methods

archive

 העברת קהל לארכיון בנכס.

create

 יצירת קהל.

get

 חיפוש של קהל יחיד.

list

 רשימת הקהלים בנכס.

patch

 עדכון של קהל בנכס.