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

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

object (AudienceEventTrigger)

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

enum (AudienceExclusionDurationMode)

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

object (AudienceFilterClause)

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

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-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. הוא לא יכול להכיל AudienceFilterExpressions עם andGroup או orGroup.
notExpression

object (AudienceFilterExpression)

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

חובה. אי אפשר לשנות. שם המאפיין או שם המדד שרוצים לסנן. אם שם השדה מתייחס למאפיין או למדד מותאם אישית, יתווסף קידומת היקף לפני השם של המאפיין או המדד המותאם אישית. מידע נוסף על קידומות של היקף או על מאפיינים ומדדים מותאמים אישית זמין במאמרי העזרה של ה-API של Google Analytics Data.
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, ההתאמה לא תלוית-רישיות.

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 או 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

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