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)
    }
  ]
}
שדות
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.

AudienceEventTrigger

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

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

string

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

enum (LogCondition)

חובה. מתי צריך לתעד את האירוע.

LogCondition

ההגדרה הזו קובעת מתי האירוע יתועד ביומן.

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

AudienceExclusionDurationMode

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

טיפוסים בני מנייה (enums)
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

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

טיפוסים בני מנייה (enums)
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)

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

MatchType

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

טיפוסים בני מנייה (enums)
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)

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

פעולה

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

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

string (Duration format)

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

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

object (AudienceFilterExpression)

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

AudienceClauseType

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

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

שיטות

archive

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

create

 יצירת קהל.

get

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

list

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

patch

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