REST Resource: accountTypes.accounts.userLists

リソース: UserList

ユーザーリスト リソース。

JSON 表現 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
フィールド
name

string

ID。ユーザーリストのリソース名。形式: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

出力専用。ユーザーリストの一意の ID。
readOnly

boolean

出力専用。ユーザーがリストを編集できるかどうかを示すオプション。
membershipDuration

string (Duration format)

省略可。ユーザーがユーザーリストに登録されている期間。有効な期間は、24 時間（86,400 秒）の倍数です。24 時間の倍数でない値を指定すると、INVALID_ARGUMENT エラーが発生します。

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

enum (AccessReason)

出力専用。このアカウントにリストへのアクセス権が付与された理由。
sizeInfo

object (SizeInfo)

出力専用。さまざまなターゲット ネットワークにおけるこのユーザーリストのメンバー数の推定値。
targetNetworkInfo

object (TargetNetworkInfo)

省略可。さまざまなターゲット ネットワークの利用資格情報。
displayName

string

必須。ユーザー リストの表示名。
description

string

省略可。ユーザーリストの説明。
membershipStatus

enum (MembershipStatus)

省略可。このユーザーリストのメンバーシップのステータス。
integrationCode

string

省略可。外部システムの ID。ユーザーリストの販売者がシステム上の ID を関連付けるために使用します。
closingReason

enum (ClosingReason)

出力専用。このユーザーリストのメンバーシップのステータスが終了した理由。
accountAccessStatus

enum (AccessStatus)

省略可。この共有がまだ有効かどうかを示します。ユーザーリストがアカウントと共有されると、このフィールドは ENABLED に設定されます。後で、ユーザーリストのオーナーは共有を取り消して DISABLED にすることができます。
共用体フィールド user_list_info。ユーザーリストに関する追加情報。user_list_info は次のいずれかになります。
ingestedUserListInfo

object (IngestedUserListInfo)

省略可。ユーザーが取り込んだデータによって作成されるユーザーリストを表します。

MembershipStatus

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

列挙型
MEMBERSHIP_STATUS_UNSPECIFIED 指定されていません。
OPEN オープン - ユーザーリストにメンバーが追加されており、ターゲットに設定できます。
CLOSED クローズ ステータス - 新しいメンバーは追加されません。

ClosingReason

ユーザーリストが閉じられた理由を示します。この列挙型は、リストがシステムによって自動的に閉じられる場合にのみ使用されます。

列挙型
CLOSING_REASON_UNSPECIFIED 指定されていません。
UNUSED ユーザーリストは、最近ターゲティングで使用されていないため、閉鎖されました。詳しくは、https://support.google.com/google-ads/answer/2472738 をご覧ください。

AccessReason

アクセス理由として考えられるものを記述する列挙型。

列挙型
ACCESS_REASON_UNSPECIFIED 指定されていません。
OWNED リソースはユーザーが所有しています。
SHARED リソースがユーザーと共有されます。
LICENSED リソースのライセンスがユーザーに付与されている。
SUBSCRIBED ユーザーがリソースをサブスクライブしました。
AFFILIATED リソースにアクセスできる。

AccessStatus

このクライアントがリストにアクセスできるかどうかを示します。

列挙型
ACCESS_STATUS_UNSPECIFIED 指定されていません。
ENABLED アクセスが有効になります。
DISABLED アクセスが無効になっています。

SizeInfo

さまざまなターゲット ネットワークにおけるこのユーザーリストのメンバー数の推定値。

JSON 表現 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string
}
フィールド
displayNetworkMembersCount

string (int64 format)

出力専用。Google ディスプレイ ネットワークでこのユーザーリストに登録されているメンバーの推定数。
searchNetworkMembersCount

string (int64 format)

出力専用。google.com ドメインのこのユーザーリストに含まれるメンバーの見積もり数。これらは、検索キャンペーンでターゲティングに使用できるメンバーです。

TargetNetworkInfo

さまざまなターゲット ネットワークの利用資格情報。

JSON 表現 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
フィールド
eligibleForDisplay

boolean

出力専用。このユーザーリストが Google ディスプレイ ネットワークの対象であることを示します。

IngestedUserListInfo

ユーザー提供データによって入力されるユーザーリストを表します。

JSON 表現 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
フィールド
uploadKeyTypes[]

enum (UploadKeyType)

必須。変更不可。このユーザーリストのアップロード鍵の種類。
contactIdInfo

object (ContactIdInfo)

省略可。CONTACT_ID が uploadKeyTypes のいずれかである場合の追加情報。
mobileIdInfo

object (MobileIdInfo)

省略可。MOBILE_ID が uploadKeyTypes のいずれかである場合の追加情報。
userIdInfo

object (UserIdInfo)

省略可。USER_ID が uploadKeyTypes のいずれかである場合の追加情報。
pairIdInfo

object (PairIdInfo)

省略可。PAIR_ID が uploadKeyTypes のいずれかである場合の追加情報。

この機能はデータ パートナーのみが利用できます。
pseudonymousIdInfo

object (PseudonymousIdInfo)

省略可。PSEUDONYMOUS_ID の追加情報は uploadKeyTypes のいずれかです。
partnerAudienceInfo

object (PartnerAudienceInfo)

省略可。パートナー オーディエンスに関する追加情報。

この機能はデータ パートナーのみが利用できます。

UploadKeyType

ユーザーリストのアップロード鍵の種類を表す列挙型。

列挙型
UPLOAD_KEY_TYPE_UNSPECIFIED 指定されていません。
CONTACT_ID メールアドレス、電話番号、住所などの顧客情報。
MOBILE_ID モバイル広告 ID。
USER_ID サードパーティが提供するユーザー ID。
PAIR_ID パブリッシャーの広告主の身元確認 ID。
PSEUDONYMOUS_ID データ管理プラットフォーム ID: - Google ユーザー ID - パートナー提供 ID - パブリッシャー提供 ID - iOS IDFA - Android 広告 ID - Roku ID - Amazon Fire TV ID - Xbox または Microsoft ID

ContactIdInfo

CONTACT_ID が uploadKeyTypes のいずれかである場合の追加情報。

JSON 表現 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
フィールド
matchRatePercentage

integer

出力専用。カスタマー マッチのユーザーリストのマッチ率。
dataSourceType

enum (DataSourceType)

省略可。変更不可。アップロード データのソース

DataSourceType

アップロード データのソースを示します。

列挙型
DATA_SOURCE_TYPE_UNSPECIFIED 指定されていません。
DATA_SOURCE_TYPE_FIRST_PARTY アップロードされたデータはファーストパーティ データです。
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU アップロードされたデータは、サードパーティの信用調査機関から提供されたものです。
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE アップロードされたデータは、第三者の有権者ファイルからのものです。
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA アップロードされたデータは、パートナー事業者のデータです。

MobileIdInfo

MOBILE_ID が uploadKeyTypes のいずれかである場合の追加情報。

JSON 表現 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
フィールド
dataSourceType

enum (DataSourceType)

省略可。変更不可。アップロード データのソース。
keySpace

enum (KeySpace)

必須。変更不可。モバイル ID のキースペース。
appId

string

必須。変更不可。データが収集されたモバイルアプリを一意に識別する文字列。

KeySpace

モバイル ID のキー空間。

列挙型
KEY_SPACE_UNSPECIFIED 指定されていません。
IOS iOS キースペース。
ANDROID Android キースペース。

UserIdInfo

USER_ID が uploadKeyTypes のいずれかである場合の追加情報。

JSON 表現 
{
  "dataSourceType": enum (DataSourceType)
}
フィールド
dataSourceType

enum (DataSourceType)

省略可。変更不可。アップロード データのソース。

PairIdInfo

PAIR_ID が uploadKeyTypes のいずれかである場合の追加情報。

この機能はデータ パートナーのみが利用できます。

JSON 表現 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
フィールド
publisherId

string (int64 format)

必須。変更不可。Publisher Advertiser Identity Reconciliation ユーザー リストが照合されるパブリッシャーを識別します。このフィールドはクリーンルーム プロバイダによって提供され、そのクリーンルームのスコープ内でのみ一意です。複数のクリーンルームにわたるグローバル識別子として使用することはできません。
publisherName

string

必須。ターゲティングの精度を高めるために UI に表示されるパブリッシャーのわかりやすい名前。
matchRatePercentage

integer

必須。このフィールドは、このユーザーリストのメンバーシップが対応するパブリッシャーのファーストパーティ データと一致する割合を示します。0 ～ 100 の範囲で指定してください。
advertiserIdentifierCount

string (int64 format)

省略可。クリーンルーム プロバイダにアップロードされた広告主のファーストパーティ データ レコードの数。これは、PAIR ユーザー リストのサイズを示すものではありません。
cleanRoomIdentifier

string

必須。変更不可。1 つまたは複数のクリーンルーム プロバイダとの広告主とパブリッシャーの固有の関係を識別します。

PseudonymousIdInfo

PSEUDONYMOUS_ID が uploadKeyTypes のいずれかである場合の追加情報。

JSON 表現 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
フィールド
syncStatus

enum (SyncStatus)

出力専用。ユーザーリストの同期ステータス。
billableRecordCount

string (int64 format)

省略可。変更不可。課金対象レコードの数（アップロードされたレコードや一致したレコードなど）。

SyncStatus

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

列挙型
SYNC_STATUS_UNSPECIFIED 指定されていません。
CREATED ユーザー リストはプレースホルダとして作成されています。リストのコンテンツやメタデータの同期がまだ完了していません。ユーザーリストを使用する準備ができていません。
READY_FOR_USE ユーザーリストを使用できるようになりました。コンテンツと Cookie が正しく同期されている。
FAILED ユーザーリストのコンテンツやメタデータの同期中にエラーが発生しました。ユーザーリストは使用できません。

PartnerAudienceInfo

パートナー オーディエンスに関する追加情報。

この機能はデータ パートナーのみが利用できます。

JSON 表現 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
フィールド
partnerAudienceSource

enum (PartnerAudienceSource)

必須。変更不可。パートナー オーディエンスのソース。
commercePartner

string

省略可。コマース パートナー名。partnerAudienceSource が COMMERCE_AUDIENCE の場合にのみ許可されます。

PartnerAudienceSource

パートナーのオーディエンス ソース。

列挙型
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED 指定されていません。
COMMERCE_AUDIENCE パートナー オーディエンス ソースはコマース オーディエンスです。
LINEAR_TV_AUDIENCE パートナー オーディエンス ソースは地上波 TV オーディエンスです。
AGENCY_PROVIDER_AUDIENCE パートナー オーディエンス ソースは代理店/プロバイダのオーディエンスです。

メソッド

create

 UserList を作成します。

delete

 UserList を削除します。

get

 UserList を取得します。

list

 UserList を一覧表示します。

patch

 UserList を更新します。