Remarketing Audiences

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソース表現

アナリティクス リマーケティング ユーザーリストの JSON テンプレート。

{
  "kind": "analytics#remarketingAudience",
  "id": string,
  "accountId": string,
  "webPropertyId": string,
  "internalWebPropertyId": string,
  "created": datetime,
  "updated": datetime,
  "name": string,
  "description": string,
  "linkedAdAccounts": [
    {
      "kind": "analytics#linkedForeignAccount",
      "id": string,
      "accountId": string,
      "webPropertyId": string,
      "internalWebPropertyId": string,
      "remarketingAudienceId": string,
      "linkedAccountId": string,
      "type": string,
      "status": string,
      "eligibleForSearch": boolean
    }
  ],
  "linkedViews": [
    string
  ],
  "audienceType": string,
  "audienceDefinition": {
    "includeConditions": {
      "kind": "analytics#includeConditions",
      "isSmartList": boolean,
      "segment": string,
      "membershipDurationDays": integer,
      "daysToLookBack": integer
    }
  },
  "stateBasedAudienceDefinition": {
    "includeConditions": {
      "kind": "analytics#includeConditions",
      "isSmartList": boolean,
      "segment": string,
      "membershipDurationDays": integer,
      "daysToLookBack": integer
    },
    "excludeConditions": {
      "segment": string,
      "exclusionDuration": string
    }
  }
}
プロパティ名 説明 メモ
accountId string このリマーケティング ユーザーリストが属するアカウントの ID。
audienceDefinition object ユーザーをユーザーリストに追加するためのシンプルなユーザーリストの定義。 書き込み可能
audienceDefinition.includeConditions nested object ユーザーをユーザーリストに追加する条件を定義します。 書き込み可能
audienceDefinition.includeConditions.daysToLookBack integer ルックバック ウィンドウでは、ユーザーリストへの追加対象となるユーザーの行動を評価する期間を指定します。たとえば、「中央アジア」のユーザーで「トランザクション数 > 2」というフィルタを定義し、ルックバック日数を 14 日に設定した場合、中央アジアに在住し、過去 14 日間の累積トランザクション数が 3 以上であるすべてのユーザーがユーザーリストに追加されます。 書き込み可能
audienceDefinition.includeConditions.isSmartList boolean このセグメントがスマートリストかどうかを示すブール値(https://support.google.com/analytics/answer/4628577)。 書き込み可能
audienceDefinition.includeConditions.kind string 一致条件のリソースタイプ。
audienceDefinition.includeConditions.membershipDurationDays integer ユーザーがユーザーリストに残る日数(1~540 の範囲内)。 書き込み可能
audienceDefinition.includeConditions.segment string ユーザーをユーザーリストに追加するためのセグメント条件。 書き込み可能
audienceType string ユーザーリストの種類(SIMPLE または STATE_BASED)。

有効な値は次のとおりです。
  • "SIMPLE"
  • "STATE_BASED"
書き込み可能
created datetime このリマーケティング ユーザーリストが作成された日時。
description string このリマーケティング ユーザーリストの説明。
id string リマーケティング ユーザーリスト ID。
internalWebPropertyId string このリマーケティング ユーザーリストが属するウェブ プロパティの内部 ID。
kind string コレクション タイプ。
linkedAdAccounts[] list このリマーケティング ユーザーリストに関連付けられているリンクされた広告アカウント。現在のところ、リマーケティング ユーザーリストに設定できる linkedAdAccount は 1 つのみです。 書き込み可能
linkedAdAccounts[].accountId string このリンクされた外国のアカウントが属するアカウント ID。
linkedAdAccounts[].eligibleForSearch boolean これを検索で使用できるかどうかを示すブール値。
linkedAdAccounts[].id string エンティティ広告アカウント リンクの ID。
linkedAdAccounts[].internalWebPropertyId string このリンクされた外国のアカウントが属するウェブ プロパティの内部 ID。
linkedAdAccounts[].kind string リンクされた外国のアカウントのリソースタイプ。
linkedAdAccounts[].linkedAccountId string 外国のアカウント ID。たとえば、Google 広告の「linkedAccountId」は、「XXX-XXX-XXXX」という形式になります。 書き込み可能
linkedAdAccounts[].remarketingAudienceId string このリンクされた外国のアカウントが属するリマーケティング ユーザーリスト ID。
linkedAdAccounts[].status string この外国のアカウント リンクのステータス。

有効な値は次のとおりです。
  • "CLOSED"
  • "OPEN"
linkedAdAccounts[].type string 外国のアカウントの種類。例: 「ADWORDS_LINKS」「DBM_LINKS」「MCC_LINKS」「OPTIMIZE」 書き込み可能
linkedAdAccounts[].webPropertyId string このリンクされた外国のアカウントが属するウェブ プロパティ ID(UA-XXXXX-YY 形式)。
linkedViews[] list このリマーケティング ユーザーリストのリンク先のビュー(旧プロファイル)。 書き込み可能
name string このリマーケティング ユーザーリストの名前。 書き込み可能
stateBasedAudienceDefinition object ユーザーをユーザーリストに追加またはユーザーリストから削除するための状態ベースのユーザーリストの定義。 書き込み可能
stateBasedAudienceDefinition.excludeConditions object ユーザーリストからユーザーを除外する条件を定義します。 書き込み可能
stateBasedAudienceDefinition.excludeConditions.exclusionDuration string 除外期間を「TEMPORARY」(一時的)にするか「PERMANENT」(永続的)にするか。

有効な値は次のとおりです。
  • "PERMANENT"
  • "TEMPORARY"
書き込み可能
stateBasedAudienceDefinition.excludeConditions.segment string ユーザーをユーザーリストから削除するためのセグメント条件。 書き込み可能
stateBasedAudienceDefinition.includeConditions nested object ユーザーをユーザーリストに追加する条件を定義します。 書き込み可能
stateBasedAudienceDefinition.includeConditions.daysToLookBack integer ルックバック ウィンドウでは、ユーザーリストへの追加対象となるユーザーの行動を評価する期間を指定します。たとえば、「中央アジア」のユーザーで「トランザクション数 > 2」というフィルタを定義し、ルックバック日数を 14 日に設定した場合、中央アジアに在住し、過去 14 日間の累積トランザクション数が 3 以上であるすべてのユーザーがユーザーリストに追加されます。 書き込み可能
stateBasedAudienceDefinition.includeConditions.isSmartList boolean このセグメントがスマートリストかどうかを示すブール値(https://support.google.com/analytics/answer/4628577)。 書き込み可能
stateBasedAudienceDefinition.includeConditions.kind string 一致条件のリソースタイプ。
stateBasedAudienceDefinition.includeConditions.membershipDurationDays integer ユーザーがユーザーリストに残る日数(1~540 の範囲内)。 書き込み可能
stateBasedAudienceDefinition.includeConditions.segment string ユーザーをユーザーリストに追加するためのセグメント条件。 書き込み可能
updated datetime このリマーケティング ユーザーリストの最終更新日時。
webPropertyId string このリマーケティング ユーザーリストが属するウェブ プロパティ ID(UA-XXXXX-YY 形式)。

Methods

delete
リマーケティング オーディエンスを削除する。
get
ユーザーがアクセスできるリマーケティング オーディエンスを取得します。
insert
新しいリマーケティング オーディエンスを作成します。
list
ユーザーがアクセスできるリマーケティング オーディエンスを一覧表示します。
patch
既存のリマーケティング オーディエンスを更新します。このメソッドはパッチの動作をサポートしています。
update
既存のリマーケティング オーディエンスを更新します。