REST Resource: properties.audiences

{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ],
  "createTime": string
}

string

出力専用。このオーディエンス リソースのリソース名。形式: properties/{propertyId}/audiences/{audienceId}

string

必須。オーディエンスの表示名。

string

必須。オーディエンスの説明。

integer

必須。変更不可。ユーザーがオーディエンスに保持される期間。540 日を超える期間を設定することはできません。

boolean

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

object (AudienceEventTrigger)

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

enum (AudienceExclusionDurationMode)

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

object (AudienceFilterClause)

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

string (Timestamp format)

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

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

{
  "eventName": string,
  "logCondition": enum (LogCondition)
}

string

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

enum (LogCondition)

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

{
  "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.
}

enum (AudienceClauseType)

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

object (AudienceSimpleFilter)

ユーザーがオーディエンスのメンバーになるために満たす必要があるシンプルなフィルタ。

object (AudienceSequenceFilter)

ユーザーがオーディエンスのメンバーとなるために、特定の順序で実行する必要があるフィルタ。

{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}

enum (AudienceFilterScope)

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

object (AudienceFilterExpression)

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

{

  // 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.
}

object (AudienceFilterExpressionList)

AND 結合される式のリスト。orGroup を持つ AudienceFilterExpressions のみを含めることができます。トップレベルの AudienceFilterExpression に対して設定する必要があります。

object (AudienceFilterExpressionList)

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

object (AudienceFilterExpression)

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

object (AudienceDimensionOrMetricFilter)

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

object (AudienceEventFilter)

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

{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}

object (AudienceFilterExpression)

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

{
  "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.
}

string

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

boolean

省略可。このフィルタに動的評価が必要かどうかを示します。true に設定すると、条件を満たしたことのあるユーザーはオーディエンスに参加します（静的評価）。このポリシーを未設定のままにするか false に設定した場合、Audience のユーザー評価は動的に行われます。条件を満たすユーザーはオーディエンスに追加され、条件を満たさなくなったユーザーは削除されます。

これは、オーディエンス スコープが ACROSS_ALL_SESSIONS の場合にのみ設定できます。

integer

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

たとえば、1 日に設定した場合、当日のデータのみが評価されます。基準点は、atAnyPointInTime が未設定または false である当日です。

オーディエンス スコープが ACROSS_ALL_SESSIONS の場合にのみ設定でき、60 日を超えることはできません。

object (StringFilter)

特定のパターンに一致する文字列型のディメンションのフィルタ。

object (InListFilter)

特定のオプション リストに一致する文字列ディメンションのフィルタ。

object (NumericFilter)

ディメンションまたは指標の数値または日付の値のフィルタ。

object (BetweenFilter)

ディメンションまたは指標の特定の値の間で数値や日付の値を表示するフィルタ。

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

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

string

必須。照合する文字列値。

boolean

省略可。true の場合、大文字と小文字が区別されます。false の場合、大文字と小文字が区別されません。

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

必須。照合対象となる文字列値のリスト。空でない必要があります。

boolean

省略可。true の場合、大文字と小文字が区別されます。false の場合、大文字と小文字が区別されません。

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

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

object (NumericValue)

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

{

  // 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.
}

string (int64 format)

整数値。

number

double 値。

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

必須。この数値（両端を含む）で始まります。

object (NumericValue)

必須。末尾はこの数字（両端を含む）で終わります。

{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}

string

必須。変更不可。照合するイベントの名前。

object (AudienceFilterExpression)

省略可。指定すると、このフィルタは単一のイベント名とパラメータのフィルタ式の両方に一致するイベントに一致します。パラメータ フィルタ式内の AudienceEventFilter は設定できません（たとえば、ネストされたイベント フィルタはサポートされていません）。1 つの andGroup で、dimensionOrMetricFilter または notExpression を指定します。OR の AND はサポートされていません。また、「eventCount」のフィルタが含まれている場合は、そのフィルタのみが考慮されます。他のすべてのフィルタは無視されます

{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}

enum (AudienceFilterScope)

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

string (Duration format)

省略可。シーケンス全体が行われる必要がある期間を定義します。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

object (AudienceSequenceStep)

必須。順序付けられた一連のステップ。ユーザーがシーケンス フィルタに参加するためには、各ステップを完了する必要があります。

{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}

enum (AudienceFilterScope)

必須。変更不可。このステップの範囲を指定します。

boolean

省略可。true の場合、このステップを満たすイベントは、最後のステップを満たすイベントの直後のイベントである必要があります。未設定または false の場合、このステップは前のステップの後続ステップになります。たとえば、前のステップとこのステップの間にイベントがある場合があります。最初のステップでは無視されます。

string (Duration format)

省略可。設定した場合、このステップは前のステップの constraintDuration 内（たとえば、t[i] - t[i-1] <= constraintDuration）内に満たされる必要があります。設定しない場合、期間の要件はありません（期間は実質的に無制限になります）。最初のステップでは無視されます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

object (AudienceFilterExpression)

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