REST Resource: properties.audiences

リソース: Audience

オーディエンスを表すリソース メッセージ。

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)

変更不可。除外フィルタの条件を満たすユーザーに対する除外の期間を指定します。これはすべての 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

イベントをログに記録するタイミングを決定します。

列挙型
LOG_CONDITION_UNSPECIFIED ログ条件が指定されていません。
AUDIENCE_JOINED このイベントは、ユーザーが参加したときにのみログに記録する必要があります。
AUDIENCE_MEMBERSHIP_RENEWED ユーザーがすでにオーディエンスのメンバーである場合でも、オーディエンスの条件が満たされるたびにイベントを記録する必要があります。

AudienceExclusionDurationMode

除外フィルタの条件を満たすユーザーの除外期間を指定します。

列挙型
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

オーディエンスへの参加についてユーザーを評価する方法を指定します。

列挙型
AUDIENCE_FILTER_SCOPE_UNSPECIFIED スコープが指定されていません。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT 1 つのイベント内でフィルタ条件が満たされると、ユーザーはオーディエンスに参加します。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION 1 つのセッション内でフィルタ条件が満たされると、ユーザーはオーディエンスに参加します。
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 結合される式のリスト。orGroup を含む AudienceFilterExpressions のみを含めることができます。これは、最上位の AudienceFilterExpression に設定する必要があります。
orGroup

object (AudienceFilterExpressionList)

OR 演算子で結合する式のリスト。andGroup または orGroup を含む AudienceFilterExpressions を含めることはできません。
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

必須。変更不可。フィルタを適用するディメンション名または指標名。フィールド名がカスタム ディメンションまたはカスタム指標を参照している場合は、カスタム ディメンションまたはカスタム指標名の先頭にスコープ接頭辞が追加されます。スコープ接頭辞またはカスタム ディメンション/指標について詳しくは、Google アナリティクス Data API のドキュメントをご覧ください。
atAnyPointInTime

boolean

省略可。このフィルタで動的評価が必要かどうかを示します。true に設定すると、一度でも条件を満たしたことのあるユーザーはすべてオーディエンスに追加されます（静的評価）。未設定の場合、または false に設定されている場合、ユーザーリストのユーザー評価は動的になります。条件を満たすユーザーがユーザーリストに追加され、条件を満たさなくなるとユーザーリストから削除されます。

これは、Audience スコープが ACROSS_ALL_SESSIONS の場合にのみ設定できます。
inAnyNDayPeriod

integer

省略可。設定されている場合、データを評価する期間を日数で指定します。設定されていない場合、オーディエンス データはライフタイム データに対して評価されます（無限の時間枠など）。

たとえば、1 日に設定されている場合、当日のデータのみが評価されます。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

文字列フィルタのマッチタイプ。

列挙型
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)

必須。照合する数値または日付の値。

オペレーション

数値フィルタに適用されるオペレーション。

列挙型
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

double 値。

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 を設定することはできません（たとえば、ネストされたイベント フィルタはサポートされていません）。これは、dimensionOrMetricFilter または notExpression の単一の andGroup である必要があります。OR の AND はサポートされていません。また、「eventCount」のフィルタが含まれている場合は、そのフィルタのみが考慮され、他のすべてのフィルタは無視されます。

AudienceSequenceFilter

ユーザーがオーディエンスのメンバーになるために特定の順序で発生する必要があるフィルタを定義します。

JSON 表現 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
フィールド
scope

enum (AudienceFilterScope)

必須。変更不可。このフィルタのスコープを指定します。
sequenceMaximumDuration

string (Duration format)

省略可。シーケンス全体が発生する期間を定義します。

s で終わる小数 9 桁までの秒単位の期間。例: "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 で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
filterExpression

object (AudienceFilterExpression)

必須。変更不可。各ステップのオーディエンス ディメンション、指標、イベント フィルタの論理式。

AudienceClauseType

これが包含フィルタ句か除外フィルタ句かを指定します。

列挙型
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED 句のタイプが指定されていません。
INCLUDE フィルタ句が満たされると、ユーザーはオーディエンスに含まれます。
EXCLUDE フィルタ句が満たされると、ユーザーはオーディエンスから除外されます。

メソッド

archive

 プロパティのオーディエンスをアーカイブします。

create

 オーディエンスを作成します。

get

 単一のオーディエンスのルックアップ。

list

 プロパティのオーディエンスを一覧表示します。

patch

 プロパティのユーザーリストを更新します。