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)
    }
  ],
  "createTime": string
}
フィールド
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 結合されます。
createTime

string (Timestamp format)

出力専用。オーディエンスが作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

AudienceEventTrigger

ユーザーがオーディエンスに参加したときに記録するイベントを指定します。

JSON 表現 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
フィールド
eventName

string

必須。ログに記録されるイベント名。
logCondition

enum (LogCondition)

必須。イベントをロギングするタイミング。

LogCondition

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

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

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

Audience のメンバーになるために満たす必要があるシンプルなフィルタを定義します。

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

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

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 に設定した場合、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 は設定できません（たとえば、ネストされたイベント フィルタはサポートされていません）。1 つの andGroup で、dimensionOrMetricFilter または notExpression を指定します。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

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