Package google.ads.datamanager.v1

string

必須。広告イベントの広告主の ID。

これは、リンクフローで送信された ID と一致している必要があります。

EventType

必須。イベントのタイプ。

Timestamp

必須。イベントの発生時間。

string

省略可。このイベントを一意に識別する、呼び出し元が作成して管理する ID。

複数のリクエストに含まれる広告イベントを重複除去する場合は必須です。それ以外の場合、このフィールドは省略可能です。

UserData

省略可。イベントに関連付けられているユーザーを表す、複数のユーザー提供データ。

同じ種類のデータ（メールアドレスなど）の複数のインスタンスを指定できます。提供されるデータが多いほど、一致が見つかる可能性が高くなります。

DeviceInfo

省略可。広告イベントが発生したときに使用されていたデバイスに関する情報。

string

省略可。広告が配信されたデバイスのデバイス ID。

string

必須。関連付けられたキャンペーンの ID。

string

必須。関連付けられたキャンペーンの名前。

string

省略可。関連付けられた広告グループの ID。

string

省略可。グループ内の関連付けられた広告の ID。

int32

省略可。広告の高さ（ピクセル単位）。

int32

省略可。広告の幅（ピクセル単位）。

string

必須。ISO 3166-2 の国と地域。

string

必須。Google アナリティクスの参照元に似た、広告のプラットフォーム参照元。

string

必須。Google アナリティクスのメディアと同様に、広告のメディア。

AttributionHint

省略可。この広告イベントのパートナーが想定するアトリビューション ステータス。

これは、パートナーが想定したアトリビューションがどのように機能したかを示すシグナルとしてのみ機能し、最終レポートで最終結果を強制することはありません。

ViewabilityInfo

必須。配信された広告の視認性の詳細。

EventSubtype

イベント サブタイプの列挙値。

string

イベント サブタイプの文字列値。

AdType

広告タイプの列挙値。

string

広告タイプの文字列値。

AdFormat

広告フォーマットの列挙値。

string

広告フォーマットの文字列値。

AdPlacement

広告プレースメントの列挙値。

string

広告プレースメントの文字列値。

TargetingType

ターゲティング タイプの列挙値。

string

ターゲティング タイプの文字列値。

PlatformType

プラットフォーム タイプの列挙値。

string

プラットフォーム タイプの文字列値。

Platform

プラットフォームの列挙値。

string

プラットフォームの文字列値。

bool

省略可。地域の管轄内の適用されるプライバシー法に準拠して、行を測定目的で使用できるかどうかを表します。

string

省略可。イベント アトリビューションとモデリングのセッション属性。

string

省略可。このイベントに関連付けられている Google クリック ID（gclid）。

string

省略可。アプリイベントに関連付けられ、iOS14 以降の iOS デバイスから発生しているクリックのクリック ID。

string

省略可。ウェブ イベントに関連付けられ、iOS14 以降の iOS デバイスから発生しているクリックのクリック ID。

DeviceInfo

省略可。広告をクリックして広告主のサイトにアクセスしたときに使用されたデバイス（ある場合）に関する情報。

string

省略可。広告主向けのモバイル広告 ID。iOS の場合は IDFA、Android の場合は AdID、その他のプラットフォームの場合は広告主向けの識別子となります。

string

省略可。このイベントに関連付けられたディスプレイ広告のクリック ID。

string

省略可。このイベントに関連付けられたインプレッション ID。

string

省略可。このイベントを前のイベントと結合するために使用される一致 ID フィールド。

EncryptedUserId

省略可。暗号化されたユーザー ID の数。

string

必須。ユーザーの（名）をすべて小文字で指定します。句読点、先頭または末尾の空白文字は使用せず、SHA-256 としてハッシュ化します。

string

必須。ユーザーの姓（ラストネーム）。すべて小文字で、句読点、先頭または末尾の空白文字は使用せず、SHA-256 としてハッシュ化します。

string

必須。ユーザーの住所の 2 文字の地域コード（ISO-3166-1 alpha-2 形式）。

string

必須。ユーザーの住所の郵便番号。

string

省略可。オーディエンス メンバーを送信する Destination を定義します。

Consent

省略可。ユーザーの同意設定。

UserData

ユーザーを識別するユーザー提供データ。

PairData

Publisher Advertiser Identity Reconciliation（PAIR）ID。

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

MobileData

ユーザーのモバイル デバイスを特定するデータ。

UserIdData

広告主が定義したユーザーの固有識別子に関連するデータ。

PpidData

パブリッシャー指定の識別子に関連するデータ。

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

CompositeData

複数の識別子タイプのグループ。

KeyType

必須。データの暗号化に使用されるアルゴリズムのタイプ。

string

必須。KMS 復号アクセス用に想定する IAM ロールの Amazon リソース名。arn:{partition}:iam::{account_id}:role/{role_name} の形式でなければなりません。

string

必須。DEK の復号に使用される AWS KMS 鍵の URI。arn:{partition}:kms:{region}:{account_id}:key/{key_id} または aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id} の形式にする必要があります。

string

必須。Base64 でエンコードされた暗号化データ暗号鍵。

Location

リクエストのベースライン ロケーション。ベースラインのロケーションは、リクエストされたリージョンの OR リストです。

bool

true に設定すると、サービスは分析情報のベースラインの場所を自動的に検出します。

string

ISO 3166-1 alpha-2 地域コードのリスト。

string

省略可。商品アイテムに関連付けられた Merchant Center ID。

string

省略可。アイテムのフィードに関連付けられている Merchant Center のフィードラベル。

string

省略可。商品アイテムのアップロード先の Merchant Center フィードに関連付けられている ISO 639-1 の言語コード。

double

省略可。トランザクションに関連付けられたすべての割引の合計。

Item

省略可。イベントに関連付けられているアイテムのリスト。

string

省略可。カートに適用されたクーポンコードのリスト。カート単位と商品アイテム単位のクーポン コードは独立しています。

イベントの宛先が Google アナリティクスの場合、クーポンコードは 1 つだけ指定してください。Google アナリティクスでは、追加のクーポン コードは無視されます。

UserData

省略可。ユーザーを識別するユーザー提供データ。

IpData

省略可。オーディエンスの作成に使用された顧客とのやり取りを表す IP アドレス データ。

ConsentStatus

省略可。ユーザーが広告ユーザーデータに同意しているかどうかを表します。

ConsentStatus

省略可。ユーザーが広告のパーソナライズに同意しているかどうかを表します。

int32

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

DataSourceType

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

string

必須。選択したコーディネーター キーの ID。

string

必須。このパートナー リンクのコレクションを所有する親。形式: accountTypes/{account_type}/accounts/{account}

PartnerLink

必須。作成するパートナー リンク。

string

必須。ライセンスが付与されるユーザーリストを所有するアカウント。accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} の形式にする必要があります。

UserListDirectLicense

必須。作成するユーザーリストの直接ライセンス。

string

必須。ライセンスが付与されるユーザーリストを所有するアカウント。accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} の形式にする必要があります。

UserListGlobalLicense

必須。作成するユーザーリストのグローバル ライセンス。

string

必須。このユーザーリストが作成される親アカウント。形式: accountTypes/{account_type}/accounts/{account}

UserList

必須。作成するユーザーリスト。

bool

省略可。true の場合、リクエストは検証されますが実行されません。

string

省略可。設定するカスタム変数の名前。指定された宛先の変数が検出されない場合、その変数は無視されます。

string

省略可。カスタム変数に保存する値。

string

省略可。カスタム変数を送信する Event.destination_references を決定するために使用される参照文字列。空の場合、Event.destination_references が使用されます。

string

必須。削除するパートナー リンクのリソース名。形式: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

string

必須。削除するユーザー リストの名前。形式: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

bool

省略可。true の場合、リクエストは検証されますが実行されません。

string

省略可。この Destination リソースの ID。リクエスト内で一意です。IngestEventsRequest と IngestAudienceMembersRequest でこの Destination を参照するために使用します。

ProductAccount

省略可。この API 呼び出しに使用されたアカウント。operating_account からデータを追加または削除するには、この login_account に operating_account への書き込みアクセス権が必要です。たとえば、operating_account の MCC アカウントや、operating_account へのリンクが確立されているアカウントなどです。

ProductAccount

省略可。呼び出し元のユーザーの login_account が、確立されたアカウント リンクを通じてアクセスできるアカウント。たとえば、データ パートナーの login_account がクライアントの linked_account にアクセスできる場合があります。パートナーはこのフィールドを使用して、linked_account から別の operating_account にデータを送信する場合があります。

ProductAccount

必須。データの送信先または削除元のアカウント。

string

必須。取り込むサービス アカウント内のオブジェクト。たとえば、Google 広告のオーディエンス ID、ディスプレイ＆ビデオ 360 のオーディエンス ID、Google 広告のコンバージョン アクション ID などです。

string

省略可。指定されたコンテキストのデバイスのユーザー エージェント文字列。

string

省略可。特定のコンテキストにおけるデバイスの IP アドレス。

注: Google 広告では、欧州経済領域（EEA）、英国（UK）、スイス（CH）のエンドユーザーについては、IP アドレスの照合がサポートされません。これらのユーザーからの IP アドレスの共有を条件付きで除外するロジックを追加し、サイトやアプリ、その他のプロパティで収集するデータに関して明確で包括的な情報をユーザーに開示し、法律または適用される Google のポリシーで求められる場合には同意を得るようにしてください。詳しくは、オフライン コンバージョンのインポートについてをご覧ください。

string

省略可。デバイスのカテゴリ。例: 「パソコン」、「タブレット」、「モバイル」、「スマートテレビ」。

string

省略可。デバイスで使用される言語（ISO 639-1 形式）。

int32

省略可。画面の高さ（ピクセル単位）。

int32

省略可。画面の幅（ピクセル単位）。

string

省略可。デバイスのオペレーティング システムまたはプラットフォーム。

string

省略可。オペレーティング システムまたはプラットフォームのバージョン。

string

省略可。デバイスのモデル。

string

省略可。デバイスのブランド。

string

省略可。ブラウザのブランドまたはタイプ。

string

省略可。ブラウザのバージョン。

string

必須。暗号化された英数字の ID。

EncryptionEntityType

必須。暗号化のエンティティ タイプ。広告配信またはデータ転送の暗号化設定と一致する必要があります。

int64

必須。暗号化のエンティティ ID。広告配信またはデータ転送の暗号化設定と一致する必要があります。

EncryptionSource

必須。暗号化された Cookie が広告配信（%m マクロ）とデータ転送のどちらから受信されたかを示します。

GcpWrappedKeyInfo

Google Cloud Platform のラップされた鍵情報。

AwsWrappedKeyInfo

Amazon Web Services のラップされた鍵情報。

CoordinatorKeyInfo

選択したコーディネーター キーのキー情報。

これは、IngestEvents、IngestAudienceMembers、RemoveAudienceMembers メソッドではサポートされていません。

int64

特定の理由でアップロードできなかったレコードの数。

ProcessingErrorReason

失敗したレコードのエラー理由。

ErrorCount

エラーのリストとエラーの理由ごとのカウント。場合によっては入力されないことがあります。

string

省略可。宛先の決定に使用される参照文字列。空の場合、イベントはリクエスト内のすべての destinations に送信されます。

string

省略可。このイベントの一意の識別子。タグ コンバージョンの追加のデータソースとして送信されるイベントに必要です。

Timestamp

必須。イベントの発生時間。

Timestamp

省略可。イベントが最後に更新された日時。

UserData

省略可。イベントに関連付けられたユーザーを表す、ユーザー提供データの断片。

Consent

省略可。関連付けられたユーザーがさまざまな種類の同意を提供したかどうかに関する情報。

AdIdentifiers

省略可。コンバージョン イベントを他のオンライン アクティビティ（広告クリックなど）と照合するために使用される ID やその他の情報。

string

省略可。このイベント内のすべての金銭的価値に関連付けられている通貨コード。

EventSource

省略可。イベントが発生した場所（ウェブ、アプリ、店舗など）を示すシグナル。

DeviceInfo

省略可。イベント発生時に使用されていたデバイスに関する情報（ある場合）。

CartData

省略可。イベントに関連付けられた取引とアイテムに関する情報。

CustomVariable

省略可。コンバージョン コンテナ（コンバージョン アクションまたは FL アクティビティ）に送信する追加のキーと値のペアの情報。

ExperimentalField

省略可。最終的に API の一部に昇格する可能性のある試験運用フィールドの Key-Value ペアのリスト。

UserProperties

省略可。イベント発生時のユーザーに関する広告主様が評価した情報。

string

省略可。イベントの名前。GA4 イベントで必須です。

string

省略可。この GA4 ウェブ ストリームのウェブ クライアントのユーザー インスタンスの一意の識別子。

string

省略可。広告主が定義したユーザーの固有識別子。

EventParameter

省略可。他の構造化フィールドを使用してまだ指定されていない、イベントに含めるイベント パラメータのバケット。

UserData

省略可。user_data で提供されるデータと同じタイプですが、自社データではなく、第三者が所有するデータとして提供されることが明示的に示されます。

EventLocation

省略可。このイベントが発生したときのユーザーの現在地に関する情報。

string

省略可。この GA4 アプリ ストリームのアプリ クライアントのユーザー インスタンスの一意の識別子。

double

省略可。価値に基づくコンバージョンの場合、イベントに関連付けられたコンバージョン値。

double

省略可。カウントベースのコンバージョンについて、イベントに関連付けられたコンバージョン数。

string

省略可。店舗販売測定に必須です。イベントが発生した実店舗を表す識別子。

string

省略可。イベントが発生した都市の名前。

string

省略可。イベントが発生した ISO 3166-2 の地域区分コード。

string

省略可。ユーザーの住所の 2 文字の CLDR 地域コード。

string

省略可。イベントが発生した亜大陸の UN M49 形式のコード。

string

省略可。イベントが発生した大陸の UN M49 形式のコード。

string

必須。使用するパラメータの名前。

string

必須。設定するパラメータ値の文字列表現。

string

省略可。使用するフィールドの名前。

string

省略可。設定するフィールドの値。

KeyType

必須。データの暗号化に使用されるアルゴリズムのタイプ。

string

必須。KEK の使用に必要な Workload Identity プール プロバイダ。

string

必須。Google Cloud Platform の Cloud Key Management Service リソース ID。projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} または gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} の形式にする必要があります。

string

必須。Base64 でエンコードされた暗号化データ暗号鍵。

string

必須。ユーザーリストの直接ライセンスのリソース名。

string

必須。ユーザーリストのグローバル ライセンスのリソース名。

string

必須。取得する UserList のリソース名。形式: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

AdEvent

必須。必須（少なくとも 1 つ）。広告イベントのリスト。

EncryptionInfo

省略可。データの暗号化に使用される暗号鍵に関する情報。

bool

省略可。true の場合、リクエストは検証されますが、実行されません。

Destination

必須。オーディエンス メンバーの送信先リスト。

AudienceMember

必須。指定されたリンク先に送信するユーザーのリスト。1 回のリクエストで送信できる AudienceMember リソースは最大 10,000 個です。

Consent

省略可。リクエスト内のすべてのユーザーに適用されるリクエスト レベルの同意。ユーザーレベルの同意はリクエストレベルの同意よりも優先され、各 AudienceMember で指定できます。

bool

省略可。テスト目的。true の場合、リクエストは検証されますが、実行されません。結果ではなく、エラーのみが返されます。

Encoding

省略可。UserData のアップロードに必須です。ユーザー識別子のエンコード タイプ。ハッシュ化されたユーザー ID の場合、これはハッシュ化された文字列のエンコード タイプです。暗号化されたハッシュ化ユーザー ID の場合、これは外側の暗号化された文字列のエンコード タイプですが、内側のハッシュ化された文字列のエンコード タイプとは限りません。つまり、内側のハッシュ化された文字列は、外側の暗号化された文字列とは異なる方法でエンコードされる可能性があります。UserData 以外のアップロードの場合、このフィールドは無視されます。

EncryptionInfo

省略可。UserData アップロードの暗号化情報。設定されていない場合、アップロードされた識別情報はハッシュ化されているが暗号化されていないと見なされます。UserData 以外のアップロードの場合、このフィールドは無視されます。

TermsOfService

省略可。ユーザーが同意または拒否した利用規約。

string

リクエストの自動生成 ID。

Destination

必須。イベントの送信先リスト。

Event

必須。指定されたリンク先に送信するイベントのリスト。1 回のリクエストで送信できる Event リソースは最大 2,000 個です。

Consent

省略可。リクエスト内のすべてのユーザーに適用されるリクエスト レベルの同意。ユーザーレベルの同意はリクエストレベルの同意をオーバーライドし、各 Event で指定できます。

bool

省略可。テスト目的。true の場合、リクエストは検証されますが、実行されません。結果ではなく、エラーのみが返されます。

Encoding

省略可。UserData のアップロードに必須です。ユーザー識別子のエンコード タイプ。ハッシュ化されたユーザー ID の場合、これはハッシュ化された文字列のエンコード タイプです。暗号化されたハッシュ化ユーザー ID の場合、これは外側の暗号化された文字列のエンコード タイプですが、内側のハッシュ化された文字列のエンコード タイプとは限りません。つまり、内側のハッシュ化された文字列は、外側の暗号化された文字列とは異なる方法でエンコードされる可能性があります。UserData 以外のアップロードの場合、このフィールドは無視されます。

EncryptionInfo

省略可。UserData アップロードの暗号化情報。設定されていない場合、アップロードされた識別情報はハッシュ化されているが暗号化されていないと見なされます。UserData 以外のアップロードの場合、このフィールドは無視されます。

string

リクエストの自動生成 ID。

UploadKeyType

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

ContactIdInfo

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

MobileIdInfo

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

UserIdInfo

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

PairIdInfo

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

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

PseudonymousIdInfo

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

PartnerAudienceInfo

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

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

string

必須。お客様とのやり取りの際に取得された IP アドレス。IPv4 と IPv6 の両方の標準文字列形式を受け入れます。

Timestamp

省略可。セッションでこの IP アドレスから最初に記録されたインタラクションの時刻。

Timestamp

省略可。セッションにおけるこの IP アドレスからの最後のインタラクションの記録時間。

string

省略可。Merchant Center アカウント内の商品 ID。

int64

省略可。イベントに関連付けられているこのアイテムの数。

double

省略可。単価。税金、送料、注文単位での割引は含みません。

string

省略可。アイテムを参照するための一意の識別子。

ItemParameter

省略可。他の構造化フィールドを使用してまだ指定されていない、イベント内に含めるアイテムに関連するイベント パラメータのバケット。

string

省略可。商品アイテムに関連付けられた Merchant Center ID。店舗販売イベントの場合、この値はカートレベルで設定された値をオーバーライドします。他のイベントでは、このフィールドは無視されます。

string

省略可。Merchant Center フィードのフィードラベル。国がまだ使用されている場合は、代わりに ISO-3166-1 alpha-2 の 2 文字の国コードを使用できます。店舗販売イベントの場合、この値はカートレベルで設定された値をオーバーライドします。他のイベントでは、このフィールドは無視されます。

string

省略可。商品アイテムのアップロード先の Merchant Center フィードに関連付けられている ISO 639-1 の言語コード。

ItemCustomVariable

省略可。アイテムごとのコンバージョンをトラッキングする際に、コンバージョン コンテナ（コンバージョン アクションまたは Floodlight アクティビティ）に送信する追加の Key-Value ペア情報。

double

省略可。コンバージョン値がアイテムごとに異なる場合に、イベント内のこのアイテムに関連付けられたコンバージョン値。

string

省略可。設定するカスタム変数の名前。指定された宛先の変数が検出されない場合、その変数は無視されます。

string

省略可。カスタム変数に保存する値。

string

省略可。カスタム変数を送信する Event.destination_references を決定するために使用される参照文字列。空の場合、Event.destination_references が使用されます。

string

必須。使用するパラメータの名前。

string

必須。設定するパラメータ値の文字列表現。

string

必須。ライセンスが照会されているアカウント。accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} の形式にする必要があります。

string

省略可。リスト リクエストに適用するフィルタ文字列。すべてのフィールドは、各条件の左側に配置する必要があります（例: user_list_id = 123）。フィールドは、すべて camel case またはすべて snake case を使用して指定する必要があります。キャメルケースとスネークケースを組み合わせて使用しないでください。

サポートされているオペレーション:

• AND
• =
• !=
• >
• >=
• <
• <=

サポートされている関数: - IN(field, value1, value2, ...): フィールドが値のいずれかに一致する場合に true を返します。例: IN(user_list_id, 123, 456)

サポートされていないフィールド:

• name（代わりに get メソッドを使用）
• historical_pricings とそのすべてのサブフィールド
• pricing.start_time
• pricing.end_time

int32

省略可。ページごとに返すライセンスの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のライセンスが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

string

省略可。前回の ListUserListDirectLicense 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListUserListDirectLicense に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

UserListDirectLicense

リクエスト内の指定されたユーザーリストのライセンス。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

string

必須。顧客情報がクエリされているグローバル ライセンス。accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID} 形式で指定する必要があります。アカウントのすべてのグローバル ライセンス顧客情報を一覧表示するには、ユーザーリストのグローバル ライセンス ID を「-」に置き換えます（例: accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-）。

string

省略可。リスト リクエストに適用するフィルタ文字列。すべてのフィールドは、各条件の左側に配置する必要があります（例: user_list_id = 123）。フィールドは、すべて camel case またはすべて snake case を使用して指定する必要があります。キャメルケースとスネークケースを組み合わせて使用しないでください。

サポートされているオペレーション:

• AND
• =
• !=
• >
• >=
• <
• <=

サポートされている関数: - IN(field, value1, value2, ...): フィールドが値のいずれかに一致する場合に true を返します。例: IN(user_list_id, 123, 456)

サポートされていないフィールド:

• name（代わりに get メソッドを使用）
• historical_pricings とそのすべてのサブフィールド
• pricing.start_time
• pricing.end_time

int32

省略可。返すライセンスの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のライセンスが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

string

省略可。前回の ListUserListDirectLicense 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListUserListDirectLicense に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

UserListGlobalLicenseCustomerInfo

リクエスト内の指定されたライセンスの顧客情報。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

string

必須。ライセンスが照会されているアカウント。accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} の形式にする必要があります。

string

省略可。リスト リクエストに適用するフィルタ文字列。すべてのフィールドは、各条件の左側に配置する必要があります（例: user_list_id = 123）。フィールドは、すべて camel case またはすべて snake case を使用して指定する必要があります。キャメルケースとスネークケースを組み合わせて使用しないでください。

サポートされているオペレーション:

• AND
• =
• !=
• >
• >=
• <
• <=

サポートされている関数: - IN(field, value1, value2, ...): フィールドが値のいずれかに一致する場合に true を返します。例: IN(user_list_id, 123, 456)

サポートされていないフィールド:

• name（代わりに get メソッドを使用）
• historical_pricings とそのすべてのサブフィールド
• pricing.start_time
• pricing.end_time

int32

省略可。返すライセンスの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のライセンスが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

string

省略可。前回の ListUserListGlobalLicense 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListUserListDirectLicense に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

UserListGlobalLicense

リクエスト内の指定されたユーザーリストのライセンス。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

string

必須。このユーザーリストのコレクションを所有する親アカウント。形式: accountTypes/{account_type}/accounts/{account}

int32

省略可。返すユーザーリストの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 件のユーザーリストが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

string

省略可。前回の ListUserLists 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListUserLists に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

string

省略可。フィルタ文字列。すべてのフィールドは、各条件の左側に配置する必要があります（例: display_name = "list 1"）。フィールドは、すべて camel case またはすべて snake case を使用して指定する必要があります。キャメルケースとスネークケースを組み合わせて使用しないでください。

サポートされているオペレーション:

• AND
• =
• !=
• >
• >=
• <
• <=
• :（あり）

サポートされている関数: - IN(field, value1, value2, ...): フィールドが値のいずれかに一致する場合に true を返します。例: IN(display_name, "name1", "name2")

サポートされているフィールド:

• id
• display_name
• description
• membership_status
• integration_code
• access_reason
• ingested_user_list_info.upload_key_types

UserList

指定したアカウントのユーザーリスト。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

string

必須。モバイル デバイス ID（広告 ID/IDFA）のリスト。1 つの AudienceMember で指定できる mobileIds は最大 10 個です。

DataSourceType

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

KeySpace

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

string

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

string

必須。Cleanroom から提供された PII データ。SHA256 でハッシュ化され、PAIR ユーザーリストのパブリッシャー キーを使用して EC 可換暗号で暗号化されています。1 つの AudienceMember で指定できる pairIds は最大 10 個です。

int64

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

string

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

int32

必須。このフィールドは、このユーザーリストと対応するパブリッシャーのファーストパーティ データとのメンバーシップ マッチ率を示します。0 ～ 100 の範囲で指定してください（両端を含む）。

int64

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

string

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

PartnerAudienceSource

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

string

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

string

必須。パートナーの ID スペースにおけるお客様アカウントの識別子。

string

省略可。アカウントの名前。

string

省略可。アカウントのタイプ。広告主アカウントとビジネスレベルのアカウントを区別するために使用できます。

string

ID。パートナー リンクの名前。形式: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

string

出力専用。パートナー リンク ID。

ProductAccount

必須。パートナー アカウントへのアクセス権を付与する所有アカウント。

ProductAccount

必須。所有アカウントによってアクセス権が付与されたパートナー アカウント。

FeatureSet

省略可。変更不可。パートナー リンクでサポートされている機能のセット。指定しない場合、システムの動作はデフォルトで FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT になります。

PartnerCustomerAccount

省略可。パートナー システムのお客様アカウント。これは、FEATURE_SET_AD_EVENT_MANAGEMENT 機能セットを含むパートナー リンクに必要です。

PartnerLinkMetadata

省略可。パートナー リンクに関連付けられたメタデータ。これは省略可能で、FEATURE_SET_AD_EVENT_MANAGEMENT を含むパートナー リンクでのみ使用できます。

PartnerCustomerAccount

省略可。暗黙的なアカウントのリスト。

string

必須。ユーザーに対してパブリッシャーが提供した識別子のリスト。

Product

非推奨です。account_type を代わりに使用してください。

string

必須。アカウントの ID。たとえば、Google 広告アカウント ID などです。

AccountType

必須。アカウントのタイプ。（例: GOOGLE_ADS）。account_type または非推奨の product のいずれかが必要です。両方が設定されている場合、値は一致する必要があります。

SyncStatus

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

int64

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

Destination

必須。ユーザーを削除するリンク先のリスト。

AudienceMember

必須。削除するユーザーのリスト。

bool

省略可。テスト目的。true の場合、リクエストは検証されますが、実行されません。結果ではなく、エラーのみが返されます。

Encoding

省略可。UserData のアップロードに必須です。ユーザー識別子のエンコード タイプ。暗号化されたユーザー ID の外部エンコードにのみ適用されます。UserData 以外のアップロードの場合、このフィールドは無視されます。

EncryptionInfo

省略可。UserData アップロードの暗号化情報。設定されていない場合、アップロードされた識別情報はハッシュ化されているが暗号化されていないと見なされます。UserData 以外のアップロードの場合、このフィールドは無視されます。

string

リクエストの自動生成 ID。

Destination

DM API リクエスト内の宛先。

RequestStatus

宛先のリクエスト ステータス。

ErrorInfo

アップロードに関連するエラーの理由とエラー数を含むエラー情報エラー。request_status が FAILED または PARTIAL_SUCCESS の場合にのみ入力されます。リクエストの request_status が PROCESSING の場合、このフィールドは入力されません。

WarningInfo

アップロードに関連する警告理由と警告数を含む警告情報。リクエストの request_status が PROCESSING の場合、このフィールドは入力されません。

IngestAudienceMembersStatus

オーディエンス メンバーのリクエストのステータス。

IngestEventsStatus

取り込みイベント リクエストのステータス。

RemoveAudienceMembersStatus

オーディエンス メンバーの削除リクエストのステータス。

DataType

データの型。

int64

このデータ型の数。

IngestUserDataStatus

宛先へのユーザーデータの取り込みステータス。

IngestMobileDataStatus

宛先へのモバイルデータの取り込みのステータス。

IngestPairDataStatus

宛先へのペアデータの取り込みのステータス。

IngestUserIdDataStatus

宛先へのユーザー ID データの取り込みステータス。

IngestPpidDataStatus

宛先への ppid データの取り込みステータス。

IngestCompositeDataStatus

宛先への複合データの取り込みのステータス。

int64

アップロード リクエストで送信された、デスティネーションのオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバーが含まれます。取り込みが成功したかどうかは関係ありません。

DataTypeCount

移行先へのアップロード リクエストで送信されたデータ型の合計数（データ型別）。リクエスト内のすべてのデータ型が含まれます（取り込みが成功したかどうかに関係なく）。

MatchRateRange

アップロードのマッチ率の範囲。

int64

アップロード リクエストで送信されたイベントの合計数。リクエスト内のすべてのイベントが含まれます。イベントが正常に取り込まれたかどうかは関係ありません。

int64

アップロード リクエストで送信された、デスティネーションのオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバーが含まれます。取り込みが成功したかどうかは関係ありません。

int64

アップロード リクエストで送信されたモバイル ID の合計数。リクエストに含まれるすべてのモバイル ID が含まれます。取り込みが成功したかどうかは関係ありません。

int64

アップロード リクエストで送信された、デスティネーションのオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバーが含まれます。取り込みが成功したかどうかは関係ありません。

int64

アップロード リクエストで送信されたペア ID の合計数。リクエスト内のすべてのペア ID が含まれます。取り込みが成功したかどうかは関係ありません。

int64

アップロード リクエストで送信された、デスティネーションのオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバーが含まれます。取り込みが成功したかどうかは関係ありません。

int64

宛先のアップロード リクエストで送信された ppids の合計数。リクエスト内のすべての ppid が含まれます。取り込みに成功したかどうかは関係ありません。

int64

アップロード リクエストで送信された、デスティネーションのオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバーが含まれます。取り込みが成功したかどうかは関係ありません。

int64

アップロード リクエストで送信されたユーザー識別子の合計数。リクエスト内のすべてのユーザー識別子が含まれます。取り込みが成功したかどうかは関係ありません。

MatchRateRange

アップロードのマッチ率の範囲。

int64

アップロード リクエストで送信された、デスティネーションのオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバーが含まれます。取り込みが成功したかどうかは関係ありません。

int64

アップロード リクエストで送信されたユーザー ID の合計数。リクエスト内のすべてのユーザー ID が含まれます（取り込みに成功したかどうかは関係ありません）。

RemoveUserDataStatus

宛先からのユーザーデータの削除ステータス。

RemoveMobileDataStatus

宛先からのモバイルデータ削除のステータス。

RemovePairDataStatus

宛先からのペアデータの削除ステータス。

RemoveUserIdDataStatus

宛先からのユーザー ID データの削除ステータス。

RemovePpidDataStatus

宛先からの ppid データの削除ステータス。

RemoveCompositeDataStatus

宛先からの複合データの削除ステータス。

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストには、削除に成功したかどうかに関係なく、すべてのオーディエンス メンバーが含まれます。

DataTypeCount

削除リクエストで送信されたデータ型の合計数（データ型別）。リクエスト内のすべてのデータ型が含まれます。削除が成功したかどうかは関係ありません。

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストには、削除に成功したかどうかに関係なく、すべてのオーディエンス メンバーが含まれます。

int64

削除リクエストで送信されたモバイル ID の合計数。リクエスト内のすべてのモバイル ID が含まれます。削除が成功したかどうかは関係ありません。

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストには、削除に成功したかどうかに関係なく、すべてのオーディエンス メンバーが含まれます。

int64

削除リクエストで送信されたペア ID の合計数。ペア ID が正常に削除されたかどうかに関係なく、リクエスト内のすべてのペア ID が含まれます。

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストには、削除に成功したかどうかに関係なく、すべてのオーディエンス メンバーが含まれます。

int64

削除リクエストで送信された ppids の合計数。リクエスト内のすべての ppids が含まれます。削除が成功したかどうかは関係ありません。

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストには、削除に成功したかどうかに関係なく、すべてのオーディエンス メンバーが含まれます。

int64

削除リクエストで送信されたユーザー ID の合計数。リクエスト内のすべてのユーザー識別子が含まれます（削除が成功したかどうかは問いません）。

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストには、削除に成功したかどうかに関係なく、すべてのオーディエンス メンバーが含まれます。

int64

削除リクエストで送信されたユーザー ID の合計数。削除に成功したかどうかに関係なく、リクエスト内のすべてのユーザー ID が含まれます。

string

必須。ユーザーリストを所有する親アカウント。形式: accountTypes/{account_type}/accounts/{account}

Baseline

必須。リクエストされた分析情報のベースライン。

string

必須。分析情報の取得をリクエストするユーザーリストの ID。

MarketingDataInsight

マーケティング データの分析情報が含まれます。

AudienceInsightsDimension

インサイトが属するディメンション。

MarketingDataInsightsAttribute

特定のディメンションの値の分析情報。

int64

ユーザー インタレスト ID。

float

ベースラインと比較した、属性値に対するオーディエンスのリフトの指標。範囲は [0 ～ 1] です。

AgeRange

リフトが提供されるユーザーの年齢層。

Gender

リフトが提供されるオーディエンスの性別。

string

必須。必須。Data Manager API リクエストのリクエスト ID。

RequestStatusPerDestination

宛先ごとのリクエスト ステータスのリスト。ステータスの順序は、元のリクエストの宛先の順序と一致します。

string

必須。パートナー リンクを検索するアカウント。filter が指定されていない場合は、このアカウントが owning_account または partner_account のいずれかであるすべてのパートナー リンクが返されます。

形式: accountTypes/{account_type}/accounts/{account}

int32

返すパートナー リンクの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 10 個のパートナー リンクが返されます。最大値は 100 です。100 を超える値は 100 に強制変換されます。

string

前回の SearchPartnerLinks 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、SearchPartnerLinks に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

string

省略可。フィルタ文字列。すべてのフィールドは、各条件の左側に配置する必要があります（例: partner_link_id = 123456789）。フィールドは、すべて camel case またはすべて snake case を使用して指定する必要があります。キャメルケースとスネークケースを組み合わせて使用しないでください。

サポートされているオペレーション:

• AND
• =
• !=

サポートされているフィールド:

• partner_link_id
• owning_account.account_type
• owning_account.account_id
• partner_account.account_type
• partner_account.account_id

例: owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321

PartnerLink

指定されたアカウントのパートナー リンク。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

int64

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

int64

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

int64

出力専用。YouTube でこのユーザーリストに登録されているメンバーの推定数。

int64

出力専用。Gmail でこのユーザーリストに登録されているメンバーの推定数。

bool

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

bool

省略可。このユーザーリストが Google 検索ネットワークの対象かどうかを示します。

TermsOfServiceStatus

省略可。カスタマー マッチの利用規約: https://support.google.com/adspolicy/answer/6299717。UserData または MobileData を取り込む場合は、これに同意する必要があります。このフィールドは、パートナー マッチのユーザーリストでは必須ではありません。

UserListDirectLicense

必須。ライセンスの name フィールドは、更新するライセンスを識別するために使用されます。

FieldMask

省略可。更新するフィールドのリスト。特殊文字 * はサポートされていません。使用すると INVALID_UPDATE_MASK エラーがスローされます。

UserListGlobalLicense

必須。ライセンスの name フィールドは、更新するライセンスを識別するために使用されます。

FieldMask

省略可。更新するフィールドのリスト。特殊文字 * はサポートされていません。使用すると INVALID_UPDATE_MASK エラーがスローされます。

UserList

必須。更新するユーザーリスト。

ユーザーリストの name フィールドは、更新するユーザーリストを識別するために使用されます。形式: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

FieldMask

省略可。更新するフィールドのリスト。

bool

省略可。true の場合、リクエストは検証されますが実行されません。

UserIdentifier

必須。ユーザーの識別子。同じタイプのデータ（複数のメールアドレスなど）の複数のインスタンスを提供できます。一致の可能性を高めるには、できるだけ多くの識別子を指定します。1 つの AudienceMember または Event で指定できる userIdentifiers は最大 10 個です。

string

必須。広告主が定義したユーザーの固有識別子。

DataSourceType

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

string

正規化後に SHA-256 ハッシュ関数を使用してハッシュ化されたメールアドレス。

string

正規化（E164 規格）後に SHA-256 ハッシュ関数を使用してハッシュ化された電話番号。

AddressInfo

ユーザーの住所の既知のコンポーネント。一度に照合される識別子のグループ化を保持します。

string

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

int64

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

bool

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

Duration

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

AccessReason

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

SizeInfo

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

TargetNetworkInfo

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

string

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

string

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

MembershipStatus

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

string

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

ClosingReason

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

AccessStatus

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

IngestedUserListInfo

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

string

ID。ユーザーリストの直接ライセンスのリソース名。

string

出力専用。ライセンスが付与されるユーザーリストの名前。

このフィールドは読み取り専用です。

string

出力専用。ユーザーリストのライセンスが付与されているクライアント顧客の名前。

このフィールドは読み取り専用です。

UserListLicensePricing

省略可。UserListDirectLicense の料金。

UserListLicensePricing

出力専用。このユーザーリスト ライセンスの料金履歴。

このフィールドは読み取り専用です。

UserListLicenseMetrics

出力専用。このライセンスに関連する指標

このフィールドは読み取り専用で、ListUserListDirectLicenses 呼び出しで開始日と終了日が設定されている場合にのみ入力されます。

int64

変更不可。ライセンスが付与されるユーザーリストの ID。

UserListLicenseClientAccountType

変更不可。ユーザーリストのライセンスが付与されているクライアント顧客のアカウント タイプ。

int64

変更不可。ユーザーリストのライセンスが付与されているクライアント顧客の ID。

UserListLicenseStatus

省略可。UserListDirectLicense のステータス（ENABLED または DISABLED）。