REST Resource: properties.audiences

リソース: Audience

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

出力のみ。非パーソナライズド広告のオーディエンスであり、広告のパーソナライズから除外されている場合は、Google アナリティクスによって自動的に false に設定されます。

eventTrigger

object (AudienceEventTrigger)

(省略可)ユーザーがオーディエンスに参加したときに記録するイベントを指定します。設定されていない場合、ユーザーがオーディエンスに参加しても、イベントはログに記録されません。

exclusionDurationMode

enum (AudienceExclusionDurationMode)

変更不可。除外フィルタを満たすユーザーの除外の有効期間を指定します。この設定はすべての EXCLUDE フィルタ句に適用され、オーディエンスに EXCLUDE フィルタ句がない場合は無視されます。

filterClauses[]

object (AudienceFilterClause)

必須。変更不可。順序なしリスト。オーディエンスを定義するフィルタ句。すべての句は AND で結合されます。

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)

NOT で求められるフィルタ式(反転、補数など)。含めることができるのは dimensionOrMetricFilter のみです。この設定は、最上位の AudienceFilterExpression では設定できません。

dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

単一のディメンションまたは指標に対するフィルタ。この設定は、最上位の AudienceFilterExpression では設定できません。

eventFilter

object (AudienceEventFilter)

特定のイベントに一致するフィルタを作成します。この設定は、最上位の AudienceFilterExpression では設定できません。

AudienceFilterExpressionList

オーディエンス フィルタ式のリスト。

JSON 表現
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
フィールド
filterExpressions[]

object (AudienceFilterExpression)

オーディエンス フィルタ式のリスト。

AudienceDimensionOrMetricFilter

1 つのディメンションまたは指標に対する特定のフィルタ。

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。数値の 1 つ。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 を設定することはできません(たとえば、ネストされたイベント フィルタはサポートされません)。これは、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 の場合、このステップを満たすイベントは、最後のステップを満たすイベントの次の 1 つである必要があります。このポリシーを設定しない場合、または 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 フィルタ句が満たされている場合、ユーザーはオーディエンスから除外されます。

Methods

archive

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

create

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

get

1 つのオーディエンスのルックアップ。

list

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

patch

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