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

出力のみ。非パーソナライズド広告のオーディエンスであり、広告のパーソナライズから除外されている場合は、GA によって自動的に 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 で結合される式のリスト。AudienceFilterExpressions は orGroup とともにのみ含めることができます。最上位の AudienceFilterExpression で設定する必要があります。
orGroup

object (AudienceFilterExpressionList)

OR で結合する式のリスト。AudienceFilterExpressions を andGroup または orGroup とともに含めることはできません。
notExpression

object (AudienceFilterExpression)

除外するフィルタ式（反転、補完など）。含めることができるのは、dimensionOrMetricFilter のみです。最上位の AudienceFilterExpression には設定できません。
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

1 つのディメンションまたは指標に対するフィルタ。最上位の 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。数値のいずれか。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」のフィルタが含まれている場合、その 1 つのフィルタのみが考慮され、他のすべてのフィルタは無視されます。

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 フィルタ句が満たされた場合、ユーザーはオーディエンスから除外されます。

Methods

archive

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

create

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

get

 1 つのオーディエンスを検索します。

list

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

patch

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