REST Resource: customers.userLists

リソース: UserList

Ads Data Hub で管理されるユーザーリストを定義します。

JSON 表現 
{
  "name": string,
  "userListId": string,
  "adsDataCustomerId": string,
  "title": string,
  "description": string,
  "type": enum (UserListType),
  "createEmail": string,
  "listSize": string,
  "populateTime": string,
  "recipientAdsDataLinks": [
    string
  ],
  "state": enum (State),

  // Union field user_list can be only one of the following:
  "frequencyList": {
    object (FrequencyBasedListInfo)
  },
  "remarketingList": {
    object (RemarketingListInfo)
  }
  // End of list of possible types for union field user_list.
}
フィールド
name

string

出力のみ。Ads Data Hub ユーザーリストを一意に識別する名前。形式は customers/[customerId]/userLists/[userListId] です。
userListId

string (int64 format)

出力のみ。ユーザーリスト ID。このフィールドはサービスによって生成され、UserList にデータを入力するために使用されます。
adsDataCustomerId

string (int64 format)

不変。このユーザー リストに関連付けられているリンクされた Ads Data Hub お客様 ID。このユーザーリストを使用して UserListQuery ジョブを実行する場合は、この ID を adsDataCustomerId として指定する必要があります。指定されていない場合は、親のお客様が使用されます。リストの作成後にこれを変更することはできません。
title

string

必須。ユーザーリストのタイトル。指定した adsDataCustomerId に固有のものです。
description

string

必須。ユーザーリストの説明。
type

enum (UserListType)

出力のみ。UserList 型の値は userList と同じである必要があります。この値は読み取り専用で、取得/一覧表示のリクエストでアクセスできます。
createEmail

string

出力のみ。このユーザーリストを作成したユーザーのメールアドレス。
listSize

string (int64 format)

出力のみ。ユーザーリストのユーザー数。リストサイズの更新が遅れる場合があります。
populateTime

string (Timestamp format)

出力のみ。リストが最後に入力された時刻。

RFC3339 UTC の Zulu 形式のタイムスタンプ。ナノ秒単位で、小数点以下は 9 桁までとなります。（例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"）。
state

enum (State)

出力のみ。ユーザーリストの状態（有効/削除済み）。この値は読み取り専用で、取得/一覧表示のリクエストでアクセスできます。

共用体フィールド user_list。ユーザーリストのタイプに応じた追加の設定を行います。

1 つだけ設定する必要があります。user_list は次のいずれかになります。
frequencyList

object (FrequencyBasedListInfo)

フリークエンシー キャップ用のユーザーリスト。
remarketingList

object (RemarketingListInfo)

リマーケティング リスト

UserListType

ユーザーリストの種類。ターゲティング時のユーザーリストの作成と使用は、この列挙型によって異なります。作成後にリストの種類を切り替えることはできません。

列挙型
USER_LIST_TYPE_UNSPECIFIED デフォルト値: 使用されません。
REMARKETING ADH で SQL クエリを使用して作成されたリマーケティング オーディエンス。リマーケティング リストは、非除外ターゲティングと非除外ターゲティングで使用できます。
FREQUENCY_BASED フリークエンシー キャップのあるオーディエンス。この種類のオーディエンスは除外ターゲティングに制限されています。

頻度に基づくリスト情報

頻度ベースのユーザーリストのメタデータ。

JSON 表現 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
フィールド
dv360LineitemIds[]
(deprecated)

string (int64 format)

このフリークエンシーに関与するディスプレイ&ビデオ 360 広告申込情報の ID。
cmCampaignIds[]
(deprecated)

string (int64 format)

この頻度に寄与する CM キャンペーンの ID。
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

この頻度に貢献する Google 広告キャンペーンの ID。
eventMatchers[]

object (EventMatcher)

この頻度に寄与するイベントは？頻度に基づくユーザーリストを作成する際は、頻度に寄与するイベントを指定するために eventMatchers をおすすめします。eventMatchers が空の場合、dv360LineitemIds、cmCampaignIds、googleAdsCampaignIds が使用されます。
frequencyConstraint

object (FrequencyConstraint)

ユーザーがリストに追加されるタイミングを表します。
slidingWindowDays

integer

必須。各イベントの発生頻度を計算する際に使用される時間枠のサイズ。これは日数で測定します

イベント マッチャー

この頻度に影響する一般的なイベント。

JSON 表現 
{
  "matchType": enum (MatchType),
  "value": string
}
フィールド
matchType

enum (MatchType)

頻度カウントに含める制約のタイプ。
value

string

制約の値。たとえば、Google 広告のキャンペーン ID を「1234」と指定すると、matchType は「GOOGLE_ADS_CAMPAIGN_ID」になり、値は「##39;1234'」となります。各 MatchType にこの値があるイベントは、フリークエンシー キャップに含まれます。

MatchType

フリークエンシー数に対してサポートされている制約のタイプ。今後、他の列挙型をサポートするために、この列挙型にさらに型が追加される可能性があります。describeValidFrequencyLimitingEventMatchersRequest で MatchType のフィルタを指定して、結果で返されるイベント マッチャーを API でサポートされているイベント マッチに制限できます。たとえば、フィルタを "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" に設定すると、これら 2 つのタイプの EventMatcher のみが返されます。

列挙型
MATCH_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
CM_CAMPAIGN_ID キャンペーン マネージャー キャンペーン ID を表す制約タイプ。
DV360_INSERTION_ORDER_ID ディスプレイ&ビデオ 360 広告掲載オーダー ID を表す制約タイプ。
DV360_LINE_ITEM_ID ディスプレイ&ビデオ 360 広告申込情報 ID を表す制約タイプ。
GOOGLE_ADS_CAMPAIGN_ID Google 広告の広告キャンペーン ID を表す制約タイプです。

頻度の制約

キャップの最小イベント数を指定します。

JSON 表現 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
フィールド
eventType

enum (EventType)

不変。しきい値イベントに対してカウントされるイベントの種類。ここでは、比較制約をすべて GREATER_OR_EQUAL と仮定して、比較の制約を明示的に表現しません。
thresholdEventCount

string (int64 format)

必須。各ユーザーは少なくとも K 件のイベントに含まれます。

EventType

頻度のカウントに使用できるイベントのタイプ。

列挙型
EVENT_TYPE_UNSPECIFIED デフォルト値: 使用されません。
IMPRESSIONS すべてのインプレッションをカウントします。

リマーケティング リスト情報

リマーケティング リストのメタデータ。

JSON 表現 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
フィールド
userListQuery

string

不変。Ads Data Hub ユーザーリスト クエリリソース。ユーザーをこのオーディエンスに追加する方法を指定します。次の形式があります。customers/[customerId]/userListQueries/[query_resource_id]
populatingUserListQueries[]

string

出力のみ。Ads Data Hub ユーザーリストには、このオーディエンスに入力済みのクエリリソースが表示されます。これは、1 対 1 の userlist:query の制限事項が適用される前に複数のクエリで入力されていたユーザーリストをサポートする以前のフィールドとして使用することを目的としています。次の形式があります。customers/[customerId]/userListQueries/[query_resource_id]

State

ユーザーリストのステータス。

列挙型
STATE_UNSPECIFIED デフォルト値 / 未設定の値。
STATE_ACTIVE ユーザーリストはまだ開いていて、有効です。
STATE_DELETED ユーザーリストは削除済みとマークされています。今後ターゲティングに使用しないでください

Methods

addEventMatchers

 フリークエンシーベースのユーザーリストにイベント マッチャーを追加します。

addRecipients

 Ads Data Hub で管理されるユーザーリストの受信者にエンティティを追加します。

create

 Ads Data Hub で管理されるユーザーリストを作成します。

delete

 リクエストされた Ads Data Hub で管理されているユーザーリストを削除します。

generateFrequencyListMemberships

 UserList のメンバーシップを生成します。

get

 リクエストされた Ads Data Hub マネージド ユーザーリストを取得します。

list

 指定した Ads Data Hub 顧客によって管理されているユーザーリストを一覧表示します。

patch

 リクエストされた Ads Data Hub マネージド ユーザーリストを更新します。

removeRecipients

 Ads Data Hub で管理されるユーザーリストの受信者からエンティティを削除します。