REST Resource: properties.audiences

משאב: קהל

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

ייצוג 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

פלט בלבד. אם זהו קהל ללא התאמה אישית (NPA), הוא מוגדר באופן אוטומטי על ידי GA כ-FALSE אם הוא מוחרג מההתאמה האישית של המודעות.
eventTrigger

object (AudienceEventTrigger)

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

enum (AudienceExclusionDurationMode)

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

object (AudienceFilterClause)

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

string (Timestamp format)

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

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

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)

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

object (AudienceFilterExpressionList)

רשימת ביטויים שיש להם חיבור ל-OR. היא לא יכולה להכיל AudienceFilterExpressions עם andGroup או אוGroup.
notExpression

object (AudienceFilterExpression)

ביטוי סינון שצריך לא לבצע (לדוגמה, היפוך, ביטוי). הוא יכול לכלול רק מאפייןCustomOrMetricFilter. לא ניתן להגדיר זאת ברמת 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

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

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

אפשר להגדיר אותו רק אם היקף הקהל הוא 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, ההתאמה לא תלוית אותיות רישיות (case-sensitive).

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, ההתאמה לא תלוית אותיות רישיות (case-sensitive).

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 בתוך ביטוי המסנן של הפרמטרים (לדוגמה, אין תמיכה במסנני אירועים בתצוגת עץ). הערך הזה צריך להיות יחיד ו-Group ofdimensionOrMetricFilter או 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)

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

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

object (AudienceFilterExpression)

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

AudienceClauseType

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

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

שיטות

archive

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

create

 יצירת קהל.

get

 מחפשים קהל אחד.

list

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

patch

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