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 オーディエンスで広告のパーソナライズから除外されている場合、この値は 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 を含む AudienceFilterExpression を含めることはできません。
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 が未設定または 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)

省略可。シーケンス全体を発生させる制限時間（例: 30 分）を定義します。

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

 プロパティのオーディエンスを更新します。