Package google.ads.datamanager.v1

インデックス

IngestionService

オーディエンス データをサポートされている宛先に送信するためのサービス。

IngestAdEvents

rpc IngestAdEvents(IngestAdEventsRequest) returns (IngestAdEventsResponse)

AdEvent リソースのリストを Google アナリティクスにアップロードします。

この機能は、許可リストに登録されているアカウントでのみご利用いただけます。

Authorization ヘッダー:

このメソッドでは、API がリクエストのアクセスを承認する方法を定義するために、次のヘッダーも必要です。

  • login-account:(必須)認証情報の Google アカウントがユーザーであるデータ パートナー アカウントのリソース名。形式: accountTypes/DATA_PARTNER/accounts/{loginAccountId}
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

AudienceMember リソースのリストを指定された Destination にアップロードします。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
IngestEvents

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

指定された Destination から Event リソースのリストをアップロードします。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
IngestUsers

rpc IngestUsers(IngestUsersRequest) returns (IngestUsersResponse)

指定された宛先にユーザーのリストをアップロードします。IngestAudienceMembers(ターゲティングのために特定の広告主のオーディエンス リストにユーザーを追加する)とは異なり、IngestUsers は特定のオーディエンス セグメントとは無関係に、アカウント単位の ID リンクデータ(モバイル ID にリンクされたユーザー識別子など)を取り込みます。

この機能は、許可リストに登録されているアカウントでのみご利用いただけます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
RemoveAllAudienceMembers

rpc RemoveAllAudienceMembers(RemoveAllAudienceMembersRequest) returns (RemoveAllAudienceMembersResponse)

指定されたリンク先からすべてのオーディエンス メンバーを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
RemoveAudienceMembers

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

指定された Destination から AudienceMember リソースのリストを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
RemoveUsers

rpc RemoveUsers(RemoveUsersRequest) returns (RemoveUsersResponse)

指定された宛先からユーザーのリストを削除します。

この機能は、許可リストに登録されているアカウントでのみご利用いただけます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
RetrieveRequestStatus

rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse)

指定されたリクエスト ID のリクエストのステータスを取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager

MarketingDataInsightsService

マーケティング データに関する分析情報を返すサービス。

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

RetrieveInsights

rpc RetrieveInsights(RetrieveInsightsRequest) returns (RetrieveInsightsResponse)

指定されたユーザーリストのマーケティング データ分析情報を取得します。

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

Authorization ヘッダー:

このメソッドは、API がリクエストのアクセスを承認する方法を定義する、次のオプションのヘッダーをサポートしています。

  • login-account:(省略可)認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (省略可)login-account とのプロダクト リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager

PartnerLinkService

パートナー リンクを管理するためのサービス。

ReportingService

レポートをクエリするためのサービス。

RetrievePartnerMatchReport

rpc RetrievePartnerMatchReport(RetrievePartnerMatchReportRequest) returns (RetrievePartnerMatchReportResponse)

パートナー マッチ レポートを取得します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager

UserListDirectLicenseService

ユーザーリストの直接ライセンスを管理するためのサービス。UserListDirectLicenses では、削除オペレーションはサポートされていません。ライセンスを無効にするには、呼び出し元がライセンス ステータスを DISABLED に更新する必要があります。

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

CreateUserListDirectLicense

rpc CreateUserListDirectLicense(CreateUserListDirectLicenseRequest) returns (UserListDirectLicense)

ユーザーリストの直接ライセンスを作成します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
GetUserListDirectLicense

rpc GetUserListDirectLicense(GetUserListDirectLicenseRequest) returns (UserListDirectLicense)

ユーザーリストの直接ライセンスを取得します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
ListUserListDirectLicenses

rpc ListUserListDirectLicenses(ListUserListDirectLicensesRequest) returns (ListUserListDirectLicensesResponse)

親アカウントが所有するすべてのユーザーリストの直接ライセンスを一覧表示します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
UpdateUserListDirectLicense

rpc UpdateUserListDirectLicense(UpdateUserListDirectLicenseRequest) returns (UserListDirectLicense)

ユーザーリストの直接ライセンスを更新します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager

UserListGlobalLicenseService

ユーザーリストのグローバル ライセンスを管理するためのサービス。UserListGlobalLicenses では、削除オペレーションはサポートされていません。ライセンスを無効にするには、呼び出し元がライセンス ステータスを DISABLED に更新する必要があります。

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

CreateUserListGlobalLicense

rpc CreateUserListGlobalLicense(CreateUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

ユーザーリストのグローバル ライセンスを作成します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
GetUserListGlobalLicense

rpc GetUserListGlobalLicense(GetUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

ユーザーリストのグローバル ライセンスを取得します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
ListUserListGlobalLicenseCustomerInfos

rpc ListUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest) returns (ListUserListGlobalLicenseCustomerInfosResponse)

ユーザーリストのグローバル ライセンスのすべての顧客情報を一覧表示します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
ListUserListGlobalLicenses

rpc ListUserListGlobalLicenses(ListUserListGlobalLicensesRequest) returns (ListUserListGlobalLicensesResponse)

親アカウントが所有するすべてのユーザーリストのグローバル ライセンスを一覧表示します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
UpdateUserListGlobalLicense

rpc UpdateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

ユーザーリストのグローバル ライセンスを更新します。

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager

UserListService

UserList リソースを管理するためのサービス。

CreateUserList

rpc CreateUserList(CreateUserListRequest) returns (UserList)

ユーザーリストを作成します。

Authorization ヘッダー:

このメソッドは、API がリクエストのアクセスを承認する方法を定義する、次のオプションのヘッダーをサポートしています。

  • login-account:(省略可)認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (省略可)login-account とのプロダクト リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
DeleteUserList

rpc DeleteUserList(DeleteUserListRequest) returns (Empty)

UserList を削除します。

Authorization ヘッダー:

このメソッドは、API がリクエストのアクセスを承認する方法を定義する、次のオプションのヘッダーをサポートしています。

  • login-account:(省略可)認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (省略可)login-account とのプロダクト リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
GetUserList

rpc GetUserList(GetUserListRequest) returns (UserList)

UserList を取得します。

Authorization ヘッダー:

このメソッドは、API がリクエストのアクセスを承認する方法を定義する、次のオプションのヘッダーをサポートしています。

  • login-account:(省略可)認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (省略可)login-account とのプロダクト リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
ListUserLists

rpc ListUserLists(ListUserListsRequest) returns (ListUserListsResponse)

UserList を一覧表示します。

Authorization ヘッダー:

このメソッドは、API がリクエストのアクセスを承認する方法を定義する、次のオプションのヘッダーをサポートしています。

  • login-account:(省略可)認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (省略可)login-account とのプロダクト リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager
UpdateUserList

rpc UpdateUserList(UpdateUserListRequest) returns (UserList)

UserList を更新します。

Authorization ヘッダー:

このメソッドは、API がリクエストのアクセスを承認する方法を定義する、次のオプションのヘッダーをサポートしています。

  • login-account:(省略可)認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (省略可)login-account とのプロダクト リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datamanager

AdEvent

広告イベント。

フィールド
advertiser_id

string

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

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

event_type

EventType

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

timestamp

Timestamp

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

event_id

string

省略可。呼び出し元によって作成および管理される ID。このイベントを一意に識別します。

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

user_data

UserData

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

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

device_info

DeviceInfo

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

ip_address

string

省略可。測定に使用される IP アドレス。これは DeviceInfo.ip_address と同じ値にする必要があります。測定のために IP を共有しない場合は、空白のままにします。

mobile_device_id

string

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

campaign_id

string

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

campaign_name

string

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

ad_group_id

string

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

ad_id

string

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

ad_height

int32

省略可。広告の高さ(ピクセル単位)。

ad_width

int32

省略可。広告の幅(ピクセル単位)。

region_code

string

省略可。ISO 3166-2 の国と区分。

source

string

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

medium

string

必須。広告のメディア。Google アナリティクスのメディアに似ています。

attribution_hint

AttributionHint

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

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

viewability_info

ViewabilityInfo

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

共用体フィールド event_subtype_oneof。省略可。広告イベントのタイプに関する追加の分類。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。event_subtype_oneof は次のいずれかになります。

event_subtype

EventSubtype

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

event_subtype_string

string

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

共用体フィールド ad_type_oneof。省略可。配信された広告のタイプ。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。ad_type_oneof は次のいずれかになります。

ad_type

AdType

広告タイプの列挙値。

ad_type_string

string

広告タイプの文字列値。

共用体フィールド ad_format_oneof。省略可。配信された広告のタイプ。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。ad_format_oneof は次のいずれかになります。

ad_format

AdFormat

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

ad_format_string

string

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

共用体フィールド ad_placement_oneof。省略可。配信された広告のプレースメント。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。ad_placement_oneof は次のいずれかになります。

ad_placement

AdPlacement

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

ad_placement_string

string

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

共用体フィールド targeting_type_oneof。省略可。広告の配信に使用されたターゲティングのタイプ。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。targeting_type_oneof は次のいずれかになります。

targeting_type

TargetingType

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

targeting_type_string

string

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

共用体フィールド platform_type_oneof。省略可。広告が配信されたプラットフォームのタイプ。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。platform_type_oneof は次のいずれかになります。

platform_type

PlatformType

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

platform_type_string

string

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

共用体フィールド platform_oneof。省略可。広告が配信されたプラットフォームの詳細。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。platform_oneof は次のいずれかになります。

platform

Platform

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

platform_string

string

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

measurement_allowed

bool

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

EventSubtype

広告イベントのタイプに関する追加の分類。

列挙型
EVENT_SUBTYPE_UNSPECIFIED イベントのサブタイプが指定されていません。
EVENT_SUBTYPE_IMPRESSION インプレッション イベント。
EVENT_SUBTYPE_ENGAGED_VIEW エンゲージ ビュー イベント。
EVENT_SUBTYPE_ONSITE_CLICK オンサイト クリック イベント。
EVENT_SUBTYPE_OUTBOUND_CLICK 離脱クリック イベント。

EventType

イベントのタイプ。

列挙型
EVENT_TYPE_UNSPECIFIED イベントタイプの指定なし。
EVENT_TYPE_VIEW イベントを表示します。
EVENT_TYPE_CLICK クリック イベント。

AdFormat

配信された広告のフォーマット。

列挙型
AD_FORMAT_UNSPECIFIED 未指定の広告フォーマット。
AD_FORMAT_AR AR 広告。
AD_FORMAT_AUDIO オーディオ広告。
AD_FORMAT_BANNER バナー広告。
AD_FORMAT_BUMPER バンパー広告。
AD_FORMAT_COLLECTION コレクション広告。
AD_FORMAT_IMAGE イメージ広告。
AD_FORMAT_INTERACTIVE インタラクティブ広告。
AD_FORMAT_INTERSTITIAL インタースティシャル広告。
AD_FORMAT_IN_FEED インフィード広告。
AD_FORMAT_IN_STREAM インストリーム広告。
AD_FORMAT_IN_STREAM_SKIPPABLE スキップ可能なインストリーム広告。
AD_FORMAT_IN_STREAM_NON_SKIPPABLE スキップ不可のインストリーム広告。
AD_FORMAT_NATIVE ネイティブ広告。
AD_FORMAT_SHORTS YouTube ショート広告。
AD_FORMAT_STORY ストーリー広告。
AD_FORMAT_SPONSORED スポンサー広告。
AD_FORMAT_VIDEO 動画広告。

AdIdentifiers

コンバージョン イベントを他のオンライン アクティビティ(広告クリックなど)と照合するために使用される識別子などの情報。

フィールド
session_attributes

string

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

gclid

string

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

gbraid

string

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

wbraid

string

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

landing_page_device_info

DeviceInfo

省略可。広告を操作した後に広告主のサイトにアクセスしたときに使用されたデバイス(該当する場合)に関する収集情報。

mobile_device_id

string

省略可。広告主向けのモバイル識別子。これには、iOS の IDFA、Android の AdID、その他のプラットフォームの広告主向け識別子が含まれます。

dclid

string

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

impression_id

string

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

match_id

string

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

encrypted_user_ids[]

EncryptedUserId

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

ppid

string

省略可。認証済みユーザー(ログイン済み)の固有識別子。パブリッシャーによって定義されます。

visitor_ppid

string

省略可。パブリッシャーが定義した、未認証ユーザー(ログインしていないユーザー)の固有識別子。

lead_id

string

省略可。ユーザーがリードフォームを送信したときに発行される、Google が生成した ID。

AdPlacement

配信された広告のプレースメント。

列挙型
AD_PLACEMENT_UNSPECIFIED 広告のプレースメントが指定されていません。
AD_PLACEMENT_DISCOVER Discover プレースメント。
AD_PLACEMENT_FEED フィード プレースメント。
AD_PLACEMENT_HEADER ヘッダーの配置。
AD_PLACEMENT_HOME ホーム プレースメント。
AD_PLACEMENT_IN_CONTENT コンテンツ内プレースメント。
AD_PLACEMENT_PROMOTED プロモートされたプレースメント。
AD_PLACEMENT_STORY ストーリーのプレースメント。

AdType

配信された広告のタイプ。

列挙型
AD_TYPE_UNSPECIFIED 広告タイプが指定されていません。
AD_TYPE_DISPLAY ディスプレイ広告。
AD_TYPE_TEXT テキスト広告] を選択します。
AD_TYPE_IMAGE イメージ広告。
AD_TYPE_RICH_MEDIA リッチメディア広告。
AD_TYPE_HTML HTML 広告。
AD_TYPE_AUDIO オーディオ広告。
AD_TYPE_VIDEO 動画広告。

AddressInfo

ユーザーの住所情報。

フィールド
given_name

string

必須。ユーザーの名前。すべて小文字で、句読点や先頭または末尾の空白文字は含めず、SHA-256 でハッシュ化します。

family_name

string

必須。ユーザーの姓。すべて小文字で、句読点や先頭または末尾の空白文字は含めず、SHA-256 でハッシュ化します。

region_code

string

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

postal_code

string

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

address_line

string

省略可。ユーザーの住所の番地。Google アナリティクスでのみ使用されます。このフィールドはハッシュ化され、暗号化されている可能性があります。

ハッシュ化する前に値を正規化します。

  • 記号を削除する
  • 小文字に変換
  • 先頭と末尾の空白文字を削除する
city

string

省略可。ユーザーの住所の市区町村。Google アナリティクスでのみ使用されます。

値は次のように正規化する必要があります。

  • 記号を削除する
  • 小文字に変換
  • 先頭と末尾の空白文字を削除する
administrative_area

string

省略可。ユーザーの住所の行政区域(州 / 都道府県)。Google アナリティクスでのみ使用されます。

値は次のように正規化する必要があります。

  • 記号を削除する
  • 小文字に変換
  • 先頭と末尾の空白文字を削除する

年齢

ユーザー属性の年齢層

列挙型
AGE_RANGE_UNSPECIFIED 指定されていません。
AGE_RANGE_UNKNOWN 不明。
AGE_RANGE_18_24 18 ~ 24 歳。
AGE_RANGE_25_34 25 ~ 34 歳。
AGE_RANGE_35_44 35 ~ 44 歳。
AGE_RANGE_45_54 45 ~ 54 歳。
AGE_RANGE_55_64 55 ~ 64 歳。
AGE_RANGE_65_UP 65 歳以上

AttributionHint

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

列挙型
ATTRIBUTION_HINT_UNSPECIFIED 不明なアトリビューション ステータス。
ATTRIBUTION_HINT_CONVERTED 変換ステータス。
ATTRIBUTION_HINT_NOT_CONVERTED 未変換のステータス。

AudienceMember

操作対象のオーディエンス メンバー。

フィールド
destination_references[]

string

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

consent

Consent

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

共用体フィールド data。操作対象の識別データの種類。data は次のいずれかになります。
user_data

UserData

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

pair_data

PairData

Publisher Advertiser Identity Reconciliation(PAIR)ID。

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

mobile_data

MobileData

ユーザーのモバイル デバイスを識別するデータ。

user_id_data

UserIdData

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

ppid_data

PpidData

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

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

composite_data

CompositeData

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

google_user_id_data

GoogleUserIdData

暗号化された Google ユーザー ID。

partner_provided_id_data

PartnerProvidedIdData

パートナー提供の識別子。

AwsWrappedKeyInfo

AWS KMS 鍵でラップされたデータ暗号鍵。

フィールド
key_type

KeyType

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

role_arn

string

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

kek_uri

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} の形式にする必要があります。

encrypted_dek

string

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

KeyType

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

列挙型
KEY_TYPE_UNSPECIFIED 未指定のキータイプ。使用しないでください。
XCHACHA20_POLY1305 アルゴリズム XChaCha20-Poly1305

ベースライン

インサイトの比較対象となるベースライン基準。

フィールド
共用体フィールド baseline。インサイトの比較対象となるベースラインの場所。baseline は次のいずれかになります。
baseline_location

Location

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

location_auto_detection_enabled

bool

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

ロケーション

リクエストのベースライン ロケーション。ベースラインのロケーションが、リクエストされたリージョンの ISO 3166-1 alpha-2 リージョン コードの OR リストに含まれている。

フィールド
region_codes[]

string

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

CallInfo

このイベントにつながった通話(存在する場合)について収集された情報。

フィールド
start_timestamp

Timestamp

必須。このイベントにつながった通話が開始された時刻。

CartData

イベントに関連付けられているカートのデータ。

フィールド
merchant_id

string

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

merchant_feed_label

string

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

merchant_feed_language_code

string

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

transaction_discount

double

省略可。取引に関連付けられたすべての割引の合計。

items[]

Item

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

coupon_codes[]

string

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

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

CompositeData

ユーザーの識別子と関連データを保持する複合データ。user_data または ip_data の少なくとも 1 つは必須です。

フィールド
user_data

UserData

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

ip_data[]

IpData

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

ユーザーのデジタル市場法(DMA)の同意設定。

フィールド
ad_user_data

ConsentStatus

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

ad_personalization

ConsentStatus

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

ConsentStatus

ユーザーが同意したか、拒否したか、同意を指定していないかを表します。

列挙型
CONSENT_STATUS_UNSPECIFIED 指定されていません。
CONSENT_GRANTED 許可。
CONSENT_DENIED 拒否されました。

ContactIdInfo

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

フィールド
match_rate_percentage

int32

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

data_source_type

DataSourceType

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

CoordinatorKeyInfo

コーディネーター鍵に関する情報。

フィールド
key_id

string

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

CreatePartnerLinkRequest

PartnerLink リソースの作成リクエスト。PartnerLink を返します。

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

CreateUserListDirectLicenseRequest

UserListDirectLicense リソースの作成リクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

user_list_direct_license

UserListDirectLicense

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

CreateUserListGlobalLicenseRequest

UserListGlobalLicense リソースの作成リクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

user_list_global_license

UserListGlobalLicense

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

CreateUserListRequest

CreateUserList のリクエスト メッセージ。

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

user_list

UserList

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

validate_only

bool

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

CustomVariable

広告コンバージョンのカスタム変数。

フィールド
variable

string

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

value

string

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

destination_references[]

string

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

CustomerType

イベントに関連付けられている顧客のタイプ。

列挙型
CUSTOMER_TYPE_UNSPECIFIED CustomerType が指定されていません。使用しないでください。
NEW お客様が広告主にとって新規顧客である。
RETURNING お客様が広告主に戻る。
REENGAGED お客様が広告主と再度やり取りした。

CustomerValueBucket

広告主が評価した顧客の価値。

列挙型
CUSTOMER_VALUE_BUCKET_UNSPECIFIED CustomerValueBucket が指定されていません。使用しないでください。
LOW お客様の価値が低い。
MEDIUM 価値が中程度のユーザー
HIGH お客様が価値の高い顧客である。

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 アップロードされたデータは、パートナー事業者のデータです。

DeletePartnerLinkRequest

PartnerLink リソースの削除リクエスト。google.protobuf.Empty を返します。

このメソッドは、REST API Explorer で試すことができます。
フィールド
name

string

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

DeleteUserListRequest

DeleteUserList のリクエスト メッセージ。

このメソッドは、REST API Explorer で試すことができます。
フィールド
name

string

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

validate_only

bool

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

宛先

データの送信先となる Google サービス。(例: Google 広告アカウント)。

フィールド
reference

string

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

login_account

ProductAccount

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

linked_account

ProductAccount

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

operating_account

ProductAccount

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

product_destination_id

string

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

このフィールドは、Google アド マネージャーのイベント取り込みとユーザー取り込みでは省略可能です。他のすべてのユースケースでは必須です。

DeviceInfo

イベント発生時に使用されていたデバイスに関する情報(該当する場合)。

フィールド
user_agent

string

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

ip_address

string

省略可。指定されたコンテキストのデバイスの IP アドレス。地域チェックの AdEvent で使用する場合は必須です。

category

string

省略可。デバイスのカテゴリ。例: 「desktop」、「タブレット」、「mobile」、「スマートテレビ」。

language_code

string

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

screen_height

int32

省略可。画面の高さ(ピクセル単位)。

screen_width

int32

省略可。画面の幅(ピクセル単位)。

operating_system

string

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

operating_system_version

string

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

model

string

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

brand

string

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

browser

string

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

browser_version

string

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

エンコード

ハッシュ化された個人を特定できる情報のエンコード タイプ。

列挙型
ENCODING_UNSPECIFIED エンコード タイプが指定されていません。使用しないでください。
HEX 16 進数エンコード。
BASE64 Base64 エンコード。

EncryptedUserId

アトリビューションに使用するために発行されるユーザー ID。これを使用する場合は、すべての項目が必須です。

フィールド
encrypted_id

string

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

entity_type

EncryptionEntityType

必須。暗号化エンティティ タイプ。これは、広告配信または Data Transfer の暗号化構成と一致している必要があります。

entity_id

int64

必須。暗号化エンティティ ID。これは、広告配信または Data Transfer の暗号化構成と一致している必要があります。

source

EncryptionSource

必須。暗号化された Cookie が広告配信(%m マクロ)から受信されたか、Data Transfer から受信されたかを示します。

EncryptionEntityType

暗号化エンティティ タイプ。

列挙型
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED 暗号化エンティティ タイプが指定されていません。
CAMPAIGN_MANAGER_ACCOUNT キャンペーン マネージャー 360 アカウント。
CAMPAIGN_MANAGER_ADVERTISER キャンペーン マネージャー 360 の広告主。
DISPLAY_VIDEO_PARTNER ディスプレイ&ビデオ 360 パートナー。
DISPLAY_VIDEO_ADVERTISER ディスプレイ&ビデオ 360 広告主。
GOOGLE_ADS_CUSTOMER Google 広告をご利用のお客様。
GOOGLE_AD_MANAGER_NETWORK_CODE Google アド マネージャー ネットワーク コード。

EncryptionSource

暗号化ソース。

列挙型
ENCRYPTION_SOURCE_UNSPECIFIED 未指定の暗号化ソース。
AD_SERVING 広告配信の暗号化ソース。
DATA_TRANSFER データ転送の暗号化ソース。

EncryptionInfo

取り込まれるデータの暗号化情報。

フィールド
共用体フィールド wrapped_key。データの暗号化に使用されるラップされた鍵。wrapped_key は次のいずれかになります。
gcp_wrapped_key_info

GcpWrappedKeyInfo

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

aws_wrapped_key_info

AwsWrappedKeyInfo

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

coordinator_key_info

CoordinatorKeyInfo

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

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

ErrorCount

特定のエラー理由のエラー数。

フィールド
record_count

int64

特定の理由でアップロードに失敗したレコードの数。

reason

ProcessingErrorReason

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

record_indices[]

int32

このエラー理由で失敗した元のリクエストのレコードの 0 ベースのインデックス。

ErrorInfo

エラータイプごとのエラー数。

フィールド
error_counts[]

ErrorCount

エラーのリストと、エラーの理由ごとのカウント。すべてのケースで入力されるとは限りません。

ErrorReason

Data Manager API のエラー理由。注: この列挙型は固定されておらず、今後新しい値が追加される可能性があります。

列挙型
ERROR_REASON_UNSPECIFIED このデフォルト値は使用しないでください。
INTERNAL_ERROR 内部エラーが発生しました。
DEADLINE_EXCEEDED リクエストの応答に時間がかかりすぎました。
RESOURCE_EXHAUSTED リクエストが多すぎます。
NOT_FOUND リソースが見つかりません。
PERMISSION_DENIED ユーザーに権限がないか、リソースが見つかりません。
INVALID_ARGUMENT リクエストで問題が発生しました。
REQUIRED_FIELD_MISSING 必須欄が空白です。
INVALID_FORMAT 形式が無効です。
INVALID_HEX_ENCODING HEX でエンコードされた値の形式が不適切です。
INVALID_BASE64_ENCODING base64 でエンコードされた値の形式が不適切です。
INVALID_SHA256_FORMAT SHA256 でエンコードされた値の形式が不適切です。
INVALID_POSTAL_CODE 郵便番号が無効です。
INVALID_COUNTRY_CODE

非推奨: Enum は Data Manager API では使用されません。

INVALID_ENUM_VALUE 列挙値は使用できません。
INVALID_USER_LIST_TYPE ユーザーリストの種類は、このリクエストに適用されません。
INVALID_AUDIENCE_MEMBER このオーディエンス メンバーは無効です。
TOO_MANY_AUDIENCE_MEMBERS 1 つのリクエストで許可されるオーディエンス メンバーの最大数は 10,000 人です。
TOO_MANY_USER_IDENTIFIERS レコードごとに許可されるユーザー ID の最大数は 10 個です。
TOO_MANY_DESTINATIONS 1 回のリクエストで指定できる宛先の最大数は 10 です。
INVALID_DESTINATION この宛先は無効です。
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED データ パートナーは、オペレーティング アカウントが所有するユーザーリストにアクセスできません。
INVALID_MOBILE_ID_FORMAT Mobile ID の形式が無効です。
INVALID_USER_LIST_ID ユーザーリストが無効です。
MULTIPLE_DATA_TYPES_NOT_ALLOWED 1 つのリクエストで複数のデータタイプを取り込むことはできません。
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER DataPartner ログイン アカウントを含む宛先構成では、すべての宛先構成で同じログイン アカウントを使用する必要があります。
TERMS_AND_CONDITIONS_NOT_SIGNED 必要な利用規約に同意していません。
INVALID_NUMBER_FORMAT 数値形式が無効です。
INVALID_CONVERSION_ACTION_ID コンバージョン アクション ID が無効です。
INVALID_CONVERSION_ACTION_TYPE コンバージョン アクションのタイプが無効です。
ENCRYPTION_NOT_SUPPORTED このリクエストでは暗号化はサポートされていません。
INVALID_CURRENCY_CODE 通貨コードがサポートされていません。
INVALID_EVENT このイベントは無効です。
TOO_MANY_EVENTS 1 つのリクエストで許可されるイベントの最大数は 10,000 です。
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS 移行先のアカウントでリードの拡張コンバージョンが有効になっていません。
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS Google の顧客データに関するポリシーにより、移行先のアカウントでは拡張コンバージョンを使用できません。Google の担当者にお問い合わせください。
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED 移行先のアカウントが拡張コンバージョンの利用規約に同意していません。
DUPLICATE_DESTINATION_REFERENCE リクエスト内の 2 つ以上の宛先に同じ参照があります。
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER データ パートナーの承認でサポートされていないオペレーティング アカウントです。
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER データ パートナーの承認で、サポートされていないリンクされたアカウントです。
NO_IDENTIFIERS_PROVIDED イベントデータには、ユーザー識別子や広告識別子は含まれません。Floodlight イベントの取り込みの場合、このエラーはリクエストに広告 ID が含まれていないことを示します。
INVALID_PROPERTY_TYPE このプロパティ タイプはサポートされていません。
INVALID_STREAM_TYPE ストリーム タイプがサポートされていません。
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT リンクされたアカウントは、ログイン アカウントが DATA_PARTNER アカウントの場合にのみサポートされます。
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH ログイン アカウントは、特定のユースケースのオペレーティング アカウントと同じである必要があります。
EVENT_TIME_INVALID イベントが許容時間内に発生しなかった。
RESERVED_NAME_USED パラメータに予約済みの名前が使用されています。
INVALID_EVENT_NAME イベント名がサポートされていません。
NOT_ALLOWLISTED アカウントが、指定された機能の許可リストに登録されていません。
INVALID_REQUEST_ID リクエストのステータスを取得するために使用されたリクエスト ID が無効です。ステータスを取得できるのは、成功したリクエストで、validate_only=true がないリクエストのみです。
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT イベントに 2 つ以上の Google アナリティクスのリンク先が設定されている。
FIELD_VALUE_TOO_LONG フィールド値の長さが長すぎます。
FIELD_VALUE_TOO_SHORT フィールド値の長さが短すぎます。
TOO_MANY_ELEMENTS リクエストのリスト内の要素が多すぎます。
TOO_FEW_ELEMENTS リクエストのリスト内の要素が少なすぎます。
ALREADY_EXISTS リソースはすでに存在しています。
IMMUTABLE_FIELD_FOR_UPDATE 更新リクエストに不変フィールドを設定しようとしました。
INVALID_RESOURCE_NAME リソース名が無効です。
INVALID_FILTER クエリフィルタが無効です。
INVALID_UPDATE_MASK 更新マスクが無効です。
INVALID_PAGE_TOKEN ページトークンが無効です。
CANNOT_UPDATE_DISABLED_LICENSE 無効になっているライセンスは更新できません。
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST デリケートなユーザーリストをこのクライアントにライセンス付与することはできません。
INSUFFICIENT_COST このライセンスの費用が低すぎます。
CANNOT_DISABLE_LICENSE 販売パートナー ライセンスは使用中のため、無効にできません。
INVALID_CLIENT_ACCOUNT_ID クライアント アカウント ID が無効です。
PRICING_ONLY_ZERO_COST_ALLOWED このクライアント アカウントでは、ゼロ以外の費用は許可されません。
PRICE_TOO_HIGH このライセンスの費用が高すぎる。
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE お客様はライセンスを作成できません。
INVALID_PRICING_END_DATE このライセンスの料金の終了日が無効です。
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT 共有セグメントまたはライセンス付与済みセグメントを含む論理的ユーザーリストにライセンスを付与することはできません。
MISMATCHED_ACCOUNT_TYPE リクエスト内のクライアントのお客様のアカウントの種類が、お客様の実際のアカウントの種類と一致しません。
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE ライセンス タイプがメディア共有費用をサポートしていません。
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER クライアントのお客様タイプは、メディア共有費用をサポートしていません。
INVALID_MEDIA_SHARE_COST メディア共有費用が無効です。
INVALID_COST_TYPE 費用タイプが無効です。
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST UserList タイプはメディア共有費用をサポートしていません。
MAX_COST_NOT_ALLOWED 最大費用は、費用タイプが MEDIA_SHARE の場合にのみ使用できます。
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED コマース オーディエンスは、直接ライセンスのみ可能です。
INVALID_DESCRIPTION 説明が無効です。
INVALID_DISPLAY_NAME 表示名が無効です。
DISPLAY_NAME_ALREADY_USED この表示名は、アカウントの別のユーザーリストですでに使用されています。
OWNERSHIP_REQUIRED_FOR_UPDATE ユーザーリストを変更するには、所有権が必要です。
USER_LIST_MUTATION_NOT_SUPPORTED ユーザーリストのタイプは読み取り専用であり、変更はサポートされていません。
SENSITIVE_USER_LIST_IMMUTABLE プライバシーに配慮したユーザーリストや、法的な理由で不承認となったユーザーリストは、外部ユーザーが変更することはできません。
BILLABLE_RECORD_COUNT_IMMUTABLE リマーケティング ユーザーリストの請求対象レコード フィールドは、一度設定すると変更できません。
USER_LIST_NAME_RESERVED ユーザーリスト名はシステムリスト用に予約されています。
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA 広告主がアップロードしたデータから作成されたリマーケティング リストを使用するには、広告主が許可リストに登録されている必要があります。
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE パートナー オーディエンス ソースは、ユーザーリスト タイプでサポートされていません。
COMMERCE_PARTNER_NOT_ALLOWED commerce_partner フィールドの設定は、partner_audience_source が COMMERCE_AUDIENCE の場合にのみサポートされます。
UNSUPPORTED_PARTNER_AUDIENCE_INFO partner_audience_info フィールドは、ユーザーリストのタイプでサポートされていません。
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED パートナー マッチのユーザーリストは、MCC アカウントでは作成できません。
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA データ パートナーが THIRD_PARTY_PARTNER_DATA の許可リストに登録されていません。
ADVERTISER_TOS_NOT_ACCEPTED 広告主がパートナーの利用規約に同意していない。
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA この広告主は、THIRD_PARTY_PARTNER_DATA の許可リストに登録されていません。
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT このユーザーリスト タイプは、このアカウントではサポートされていません。
INVALID_COMMERCE_PARTNER commerce_partner フィールドが無効です。
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE データ プロバイダが、コマース オーディエンスを作成するための許可リストに登録されていません。
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES ユーザーリストのアップロード キータイプはサポートされていません。
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG 取り込まれたユーザーリスト情報の設定はサポートされていません。
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE このアカウントの種類は、このユーザーリストの種類ではサポートされていません。
MEMBERSHIP_DURATION_TOO_LONG ユーザーリストの有効期間が長すぎます。
INVALID_MERCHANT_ID merchant_id フィールドが無効です。
EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED お客様のアカウントに、EU の政治広告についての申告がない、免除対象外のキャンペーンが含まれています。
ACCOUNT_INELIGIBLE_FOR_STORE_SALES アカウントが店舗販売測定の対象外である。
INVALID_MERCHANT_FEED_LANGUAGE_CODE 販売者フィードの言語コードが無効です。
INVALID_REGION_CODE 地域コードが無効です。
INVALID_SUBDIVISION_CODE サブディビジョン コードが無効です。
INVALID_SUBCONTINENT_CODE サブコンチネント コードが無効です。
INVALID_CONTINENT_CODE 大陸コードが無効です。
INVALID_DEVICE_CATEGORY デバイスのカテゴリが無効です。
BOTH_CLIENT_ID_AND_APP_INSTANCE_ID_NOT_ALLOWED app_instance_id と client_id の両方が設定されている。
GOOGLE_ANALYTICS_SUBPROPERTY_OR_ROLLUP_PROPERTY_NOT_ALLOWED Google アナリティクスのプロパティがサブプロパティまたは統合プロパティである。
THIRD_PARTY_USER_DATA_NOT_ALLOWED サードパーティのユーザーデータは、データ パートナーのみが設定できます。
INVALID_COUPON_CODE クーポンコードが無効です。
EVENT_SOURCE_AND_DESTINATION_MISMATCH イベントソースのタイプが宛先のタイプと一致しません。
DESTINATION_ACCOUNT_TYPE_MISMATCH 移行先のアカウントの種類が、指定されたアカウント ID と一致しません。
CUSTOM_VARIABLE_VALUE_CONTAINS_PII カスタム変数値に個人を特定できる情報(PII)が含まれている。
CUSTOM_VARIABLE_NOT_ENABLED カスタム変数が有効になっていません。
INVALID_CUSTOM_VARIABLE_VALUE カスタム変数の値が無効です。
CUSTOM_VARIABLE_NOT_FOUND 指定された variable と一致する名前のカスタム変数がリンク先にありません。
TOO_MANY_USERS リクエストごとに許可されるユーザーの最大数は 10,000 人です。
BASELINE_LOCATION_AUTO_DETECTION_FAILED リクエストの location_auto_detection_enabled フィールドが true に設定されていましたが、ベースライン位置の自動検出に失敗しました。
INSIGHTS_MISSING_FOR_DIMENSION このディメンションの分析情報がありません。
INVALID_REMOVE_AS_OF_TIME 削除基準時刻は過去または現在の日時を指定してください。オーディエンス メンバーの削除に、将来のタイムスタンプは使用できません。
REQUEST_TOO_OLD リクエストのステータスは、API がリクエストを受信してから約 50 日間のみ利用できます。
CONVERSION_ACTION_TOO_RECENTLY_CREATED コンバージョン アクションが作成されてからの時間が短すぎます。
INVALID_AD_IDENTIFIER_FOR_ACCOUNT

広告 ID がアカウントに属していません。

たとえば、gclid は宛先の operating_account と product_destination_id に関連付けられていません。

UNSUPPORTED_ACCOUNT_TYPE_FOR_USER_LIST_DIRECT_LICENSE アカウントの種類が、UserListDirectLicense でサポートされている client_account_type ではありません。
DUPLICATE_ELEMENTS リクエストのリストに重複する要素があります。
UNSUPPORTED_BASELINE_LOCATION

ベースライン ロケーションは、生成インサイトの生成ではサポートされていません。

location_auto_detection_enabled が true に設定されている場合、このエラーは、検出されたオーディエンスの主な所在地がサポートされている地域に含まれていないことを示します。

この問題を解決するには、baseline_location でサポートされている地域を明示的に指定するか、サポートされている地域が多数を占めるようにオーディエンス リストが更新されたら、もう一度お試しください。サポートされている国の一覧については、https://support.google.com/google-ads/answer/11161206 をご覧ください。

CONVERSION_PRECEDES_CALL event_timestamp は start_timestamp より前にすることはできません。
INVALID_DATE 日付が無効です。

イベント

広告主のウェブサイトまたはアプリでのユーザー インタラクションを表すイベント。

フィールド
destination_references[]

string

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

transaction_id

string

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

event_timestamp

Timestamp

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

last_updated_timestamp

Timestamp

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

user_data

UserData

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

consent

Consent

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

ad_identifiers

AdIdentifiers

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

currency

string

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

event_source

EventSource

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

event_device_info

DeviceInfo

省略可。イベント発生時に使用されていたデバイス(存在する場合)について収集された情報。

cart_data

CartData

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

custom_variables[]

CustomVariable

省略可。コンバージョン コンテナ(コンバージョン アクションまたは Floodlight アクティビティ)に送信する追加の Key-Value ペア情報。

experimental_fields[]

ExperimentalField

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

user_properties

UserProperties

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

event_name

string

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

client_id

string

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

user_id

string

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

additional_event_parameters[]

EventParameter

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

third_party_user_data

UserData

省略可。user_data で提供されるデータと同じ種類のデータですが、ファーストパーティの広告主データではなく、サードパーティが所有するデータとして提供されることが明示的にフラグ設定されています。

event_location

EventLocation

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

app_instance_id

string

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

call_info

CallInfo

省略可。このイベントにつながった通話(存在する場合)について収集された情報。

conversion_value

double

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

conversion_count

double

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

EventLocation

イベントが発生した場所。

フィールド
store_id

string

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

city

string

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

subdivision_code

string

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

region_code

string

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

subcontinent_code

string

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

continent_code

string

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

EventParameter

GA4 イベントのイベント パラメータ。

フィールド
parameter_name

string

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

value

string

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

EventSource

イベントのソース。

列挙型
EVENT_SOURCE_UNSPECIFIED 未指定の EventSource。使用しないでください。
WEB イベントがウェブブラウザから生成された。
APP イベントがアプリから生成された。
IN_STORE イベントは店舗での取引から生成されました。
PHONE イベントは電話から生成されました。
MESSAGE 予定はメッセージから生成されました。
OTHER イベントが他のソースから生成された。

ExperimentalField

非公式フィールドを表す試験運用フィールド。

フィールド
field

string

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

value

string

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

FeatureSet

パートナー リンクでサポートされている機能のセット。

列挙型
FEATURE_SET_UNSPECIFIED 未指定の機能セット。指定しない場合、システムのデフォルトの動作は FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT です。
FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT オーディエンスとイベントの管理に使用されるリンクを示します。
FEATURE_SET_AD_EVENT_MANAGEMENT 広告イベント管理に使用されるリンクを示します。

FieldWarning

フィールドパスを含む詳細な行レベルの警告。

フィールド
reason

WarningReason

警告の理由。

description

string

問題の詳細な説明を含む警告メッセージ。

field

string

警告をトリガーしたフィールドパス。google.rpc.BadRequest.FieldViolation.field と同じ形式を使用します。

GcpWrappedKeyInfo

Google Cloud Platform のラップされた鍵に関する情報。

フィールド
key_type

KeyType

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

wip_provider

string

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

kek_uri

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} の形式にする必要があります。

encrypted_dek

string

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

KeyType

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

列挙型
KEY_TYPE_UNSPECIFIED 未指定のキータイプ。使用しないでください。
XCHACHA20_POLY1305 アルゴリズム XChaCha20-Poly1305

性別

ユーザー属性の性別のタイプ(女性など)。

列挙型
GENDER_UNSPECIFIED 指定されていません。
GENDER_UNKNOWN 不明。
GENDER_MALE 男性。
GENDER_FEMALE 女性。

GetUserListDirectLicenseRequest

UserListDirectLicense リソースを取得するリクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
name

string

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

GetUserListGlobalLicenseRequest

UserListGlobalLicense リソースを取得するリクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
name

string

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

GetUserListRequest

GetUserList のリクエスト メッセージ。

このメソッドは、REST API Explorer で試すことができます。
フィールド
name

string

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

GoogleUserIdData

暗号化された Google ユーザー ID を保持する Google ユーザー ID データ。少なくとも 1 つの Google ユーザー ID が必要です。

フィールド
google_user_ids[]

string

必須。暗号化された Google ユーザー ID のリスト。

IngestAdEventsRequest

広告イベントのアップロードをリクエストします。

このメソッドは、REST API Explorer で試すことができます。
フィールド
ad_events[]

AdEvent

必須。必須(1 つ以上)。広告イベントのリスト。

encryption_info

EncryptionInfo

省略可。データの暗号化に使用される暗号鍵に関する情報。広告イベントに UserData が含まれている場合は、このフィールドを指定する必要があります。

validate_only
(deprecated)

bool

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

IngestAdEventsResponse

この型にはフィールドがありません。

広告イベント取り込みオペレーションからのレスポンス。

IngestAudienceMembersRequest

指定された宛先にオーディエンス メンバーをアップロードするリクエスト。IngestAudienceMembersResponse を返します。

このメソッドは、REST API Explorer で試すことができます。
フィールド
destinations[]

Destination

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

audience_members[]

AudienceMember

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

consent

Consent

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

validate_only

bool

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

encoding

Encoding

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

encryption_info

EncryptionInfo

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

terms_of_service

TermsOfService

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

IngestAudienceMembersResponse

IngestAudienceMembersRequest からのレスポンス。

フィールド
request_id

string

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

field_warnings[]

FieldWarning

フィールドパスを含む詳細な行レベルの警告。

IngestEventsRequest

指定された宛先にオーディエンス メンバーをアップロードするリクエスト。IngestEventsResponse を返します。

このメソッドは、REST API Explorer で試すことができます。
フィールド
destinations[]

Destination

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

events[]

Event

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

consent

Consent

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

validate_only

bool

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

encoding

Encoding

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

encryption_info

EncryptionInfo

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

IngestEventsResponse

IngestEventsRequest からのレスポンス。

フィールド
request_id

string

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

field_warnings[]

FieldWarning

フィールドパスを含む詳細な行レベルの警告。

IngestUsersRequest

指定された宛先にユーザーをアップロードするリクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
destinations[]

Destination

必須。取り込み先のリスト。

users[]

User

必須。取り込むユーザーのリスト。

encryption_info

EncryptionInfo

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

validate_only

bool

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

encoding

Encoding

必須。ユーザー識別子のエンコード タイプ。暗号化されたユーザー ID の場合、これは外部エンコードにのみ適用されます。

IngestUsersResponse

IngestUsersRequest からのレスポンス。

フィールド
request_id

string

取り込みリクエストの生成されたリクエスト ID。

IngestedUserListInfo

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

フィールド
upload_key_types[]

UploadKeyType

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

contact_id_info

ContactIdInfo

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

mobile_id_info

MobileIdInfo

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

user_id_info

UserIdInfo

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

pair_id_info

PairIdInfo

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

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

pseudonymous_id_info

PseudonymousIdInfo

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

partner_audience_info

PartnerAudienceInfo

省略可。パートナー オーディエンス向けの追加情報。

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

UploadKeyType

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

列挙型
UPLOAD_KEY_TYPE_UNSPECIFIED 指定されていません。
CONTACT_ID メールアドレス、電話番号、住所などの顧客情報。
MOBILE_ID モバイル広告 ID。
USER_ID サードパーティから提供されたユーザー ID。
PAIR_ID Publisher Advertiser Identity Reconciliation ID。
PSEUDONYMOUS_ID

データ管理プラットフォーム ID:

  • Google ユーザー ID
  • パートナー提供の ID
  • パブリッシャー指定の ID
  • iOS IDFA
  • Android 広告 ID
  • Roku ID
  • Amazon Fire TV ID
  • Xbox ID または Microsoft ID
  • 汎用デバイス ID

IpData

ユーザーの IP アドレス情報。カスタマー マッチのマッチ率を向上させるために、observe_start_time と observe_end_time を含めることをおすすめします。

フィールド
ip_address

string

必須。顧客の操作時に取得された IP アドレス。IPv4 と IPv6 の両方の標準文字列形式を受け入れます。

observe_start_time

Timestamp

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

observe_end_time

Timestamp

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

項目

イベントに関連付けられたカート内の商品アイテムを表します。

フィールド
merchant_product_id

string

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

quantity

int64

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

unit_price

double

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

item_id

string

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

additional_item_parameters[]

ItemParameter

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

merchant_id

string

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

merchant_feed_label

string

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

merchant_feed_language_code

string

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

custom_variables[]

ItemCustomVariable

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

conversion_value

double

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

ItemCustomVariable

広告コンバージョンの商品アイテム単位のカスタム変数。

フィールド
variable

string

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

value

string

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

destination_references[]

string

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

ItemParameter

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

フィールド
parameter_name

string

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

value

string

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

ListUserListDirectLicensesRequest

指定されたアカウントのすべての UserListDirectLicense リソースを一覧表示するリクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

filter

string

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

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

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

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

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

  • name(代わりに get メソッドを使用してください)
  • historical_pricings とそのすべてのサブフィールド
  • pricing.start_time
  • pricing.end_time
page_size

int32

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

page_token

string

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

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

ListUserListDirectLicensesResponse

ListUserListDirectLicensesRequest からのレスポンス。

フィールド
user_list_direct_licenses[]

UserListDirectLicense

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

next_page_token

string

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

ListUserListGlobalLicenseCustomerInfosRequest

指定されたユーザーリストのグローバル ライセンスのすべての UserListGlobalLicenseCustomerInfo リソースを一覧表示するリクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

filter

string

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

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

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

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

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

  • name(代わりに get メソッドを使用してください)
  • historical_pricings とそのすべてのサブフィールド
  • pricing.start_time
  • pricing.end_time
page_size

int32

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

page_token

string

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

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

ListUserListGlobalLicenseCustomerInfosResponse

[ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest] からのレスポンス。

フィールド
user_list_global_license_customer_infos[]

UserListGlobalLicenseCustomerInfo

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

next_page_token

string

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

ListUserListGlobalLicensesRequest

指定されたアカウントのすべての UserListGlobalLicense リソースを一覧表示するリクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

filter

string

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

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

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

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

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

  • name(代わりに get メソッドを使用してください)
  • historical_pricings とそのすべてのサブフィールド
  • pricing.start_time
  • pricing.end_time
page_size

int32

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

page_token

string

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

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

ListUserListGlobalLicensesResponse

ListUserListGlobalLicensesRequest からのレスポンス。

フィールド
user_list_global_licenses[]

UserListGlobalLicense

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

next_page_token

string

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

ListUserListsRequest

ListUserLists のリクエスト メッセージ。

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

page_size

int32

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

page_token

string

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

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

filter

string

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

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

  • 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

ListUserListsResponse

ListUserLists のレスポンス メッセージ。

フィールド
user_lists[]

UserList

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

next_page_token

string

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

MatchRateRange

アップロードまたはユーザーリストのマッチ率の範囲。

列挙型
MATCH_RATE_RANGE_UNKNOWN マッチ率の範囲が不明です。
MATCH_RATE_RANGE_NOT_ELIGIBLE マッチ率の範囲が無効です。
MATCH_RATE_RANGE_LESS_THAN_20 マッチ率の範囲が 20% 未満([0, 20) の範囲内)である。
MATCH_RATE_RANGE_20_TO_30 マッチ率の範囲は 20% ~ 30%([20, 31) の範囲内)です。
MATCH_RATE_RANGE_31_TO_40 マッチ率の範囲は 31% ~ 40%([31, 41) の間隔)です。
MATCH_RATE_RANGE_41_TO_50 マッチ率の範囲は 41% ~ 50%([41, 51) の範囲内)です。
MATCH_RATE_RANGE_51_TO_60 マッチ率の範囲は 51% ~ 60%([51, 61) の範囲内)です。
MATCH_RATE_RANGE_61_TO_70 マッチ率の範囲は 61% ~ 70%([61, 71) の範囲内)です。
MATCH_RATE_RANGE_71_TO_80 マッチ率の範囲は 71% ~ 80%([71, 81) の範囲内)です。
MATCH_RATE_RANGE_81_TO_90 マッチ率の範囲は 81% ~ 90%([81, 91) の範囲内)です。
MATCH_RATE_RANGE_91_TO_100

マッチ率の範囲は 91% ~ 100%([91, 100] の間隔)です。

MediaQuartile

メディアが再生された量を個別の四分位数として表したもの。

列挙型
MEDIA_QUARTILE_UNSPECIFIED メディアの四分位数が指定されていません。
MEDIA_QUARTILE_START 開始] をタップします。
MEDIA_QUARTILE_FIRST_QUARTILE 第 1 四分位。
MEDIA_QUARTILE_MIDPOINT 50% 再生。
MEDIA_QUARTILE_THIRD_QUARTILE 第 3 四分位。
MEDIA_QUARTILE_COMPLETE 完全である。

MobileData

オーディエンスのモバイル ID。少なくとも 1 つのモバイル ID が必要です。

フィールド
mobile_ids[]

string

必須。モバイル デバイス ID のリスト(カスタマー マッチ ユーザーリストの場合は Android 広告 ID、iOS IDFA。基本ユーザーリストの場合は Android 広告 ID、iOS IDFA、Xbox または Microsoft ID、Amazon Fire TV ID、Roku ID、汎用デバイス ID)。1 つの AudienceMember に指定できる mobileIds は最大 10 個です。

MobileIdInfo

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

フィールド
data_source_type

DataSourceType

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

key_space

KeySpace

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

app_id

string

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

KeySpace

モバイル ID のキースペース。

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

PairData

オーディエンスの PAIR ID。少なくとも 1 つの PAIR ID が必要です。

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

フィールド
pair_ids[]

string

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

PairIdInfo

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

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

フィールド
publisher_id

int64

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

publisher_name

string

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

match_rate_percentage

int32

必須。このフィールドは、このユーザーリストと、対応するパブリッシャーのファーストパーティ データとのメンバーシップの一致率を示します。0 ~ 100 にする必要があります(両端を含む)。

advertiser_identifier_count

int64

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

clean_room_identifier

string

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

PartnerAudienceInfo

パートナー オーディエンス向けの追加情報。

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

フィールド
partner_audience_source

PartnerAudienceSource

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

commerce_partner

string

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

PartnerAudienceSource

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

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

PartnerCustomerAccount

パートナーのシステム内のお客様アカウントを表します。

フィールド
account_id

string

必須。パートナーの ID 空間における顧客アカウントの識別子。

account_name

string

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

account_type

string

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

PartnerLinkMetadata

パートナー リンクに関連付けられたメタデータを表します。

フィールド
implicit_accounts[]

PartnerCustomerAccount

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

PartnerMatchAdGroup

広告グループの詳細。

フィールド
ad_group_id

int64

広告グループの ID です。

display_name

string

広告グループのわかりやすい名前。

PartnerMatchAdvertiserAccount

広告主アカウントの詳細。

フィールド
account_type

string

アカウントの種類(例: GOOGLE_ADS、DISPLAY_VIDEO_ADVERTISER)。

account_id

string

アカウントのお客様 ID。

display_name

string

アカウントのわかりやすい名前。

PartnerMatchCampaign

キャンペーンの詳細。

フィールド
campaign_id

int64

キャンペーンの ID です。

display_name

string

キャンペーンのわかりやすい名前。

PartnerMatchLineItem

広告申込情報の詳細。

フィールド
line_item_id

int64

広告申込情報の ID。

display_name

string

広告申込情報のわかりやすい名前。

PartnerMatchReportEntry

パートナー マッチ レポートの行 / エントリ。

フィールド
advertiser_account

PartnerMatchAdvertiserAccount

広告主アカウントの詳細。

campaign

PartnerMatchCampaign

キャンペーンの詳細。Google 広告の広告主の場合にのみ返されます。

ad_group

PartnerMatchAdGroup

広告グループの詳細。Google 広告の広告主の場合にのみ返されます。

user_list

PartnerMatchUserList

ユーザーリストの詳細。

impression_count

int64

このエントリのインプレッション数。

media_cost

Money

このエントリに関連付けられたメディア費用。

line_item

PartnerMatchLineItem

広告申込情報の詳細。ディスプレイ&ビデオ 360 の広告主の場合にのみ返されます。

data_fees

Money

このエントリのデータ料金。ディスプレイ&ビデオ 360 の広告主の場合にのみ返されます

PartnerMatchUserList

ユーザーリストの詳細。

フィールド
user_list_id

int64

ユーザーリストの ID。

display_name

string

ユーザーリストのわかりやすい名前。

PartnerProvidedIdData

パートナー提供の識別子を保持するパートナー提供のデータ。パートナー提供の識別子が少なくとも 1 つ必要です。

フィールド
partner_provided_ids[]

string

必須。パートナー提供の識別子のリスト。

プラットフォーム

広告が配信されたプラットフォームの詳細。

列挙型
PLATFORM_UNSPECIFIED プラットフォームが指定されていません。
PLATFORM_IOS iOS プラットフォーム。
PLATFORM_ANDROID Android プラットフォーム。
PLATFORM_WEB ウェブ プラットフォーム。

PlatformType

広告が配信されたプラットフォームのタイプ。

列挙型
PLATFORM_TYPE_UNSPECIFIED プラットフォーム タイプが指定されていません。
PLATFORM_TYPE_MOBILE モバイル プラットフォーム。
PLATFORM_TYPE_DESKTOP デスクトップ プラットフォーム。
PLATFORM_TYPE_CTV CTV プラットフォーム。
PLATFORM_TYPE_PHONE スマートフォンのプラットフォーム。
PLATFORM_TYPE_TABLET タブレット プラットフォーム。

PpidData

PPID を保持するパブリッシャー指定の識別子データ。少なくとも 1 つの ppid が必要です。

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

フィールド
ppids[]

string

必須。ユーザーのパブリッシャー指定の識別子のリスト。

ProcessingErrorReason

処理エラーの理由。今後、新しい理由が追加される可能性があります。

列挙型
PROCESSING_ERROR_REASON_UNSPECIFIED 処理エラーの理由は不明です。
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE カスタム変数が無効です。
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED カスタム変数のステータスが有効になっていません。
PROCESSING_ERROR_REASON_EVENT_TOO_OLD コンバージョンの古さが、サポートされている古さの制限を超えています。
PROCESSING_ERROR_REASON_DUPLICATE_GCLID 同じ GCLID とコンバージョン日時のコンバージョンがすでにシステムに存在します。
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID 同じオーダー ID とコンバージョン アクションの組み合わせのコンバージョンがすでにアップロードされています。
PROCESSING_ERROR_REASON_INVALID_GBRAID GBRAID をデコードできませんでした。
PROCESSING_ERROR_REASON_INVALID_GCLID Google クリック ID をデコードできませんでした。
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID 販売者 ID に数字以外の文字が含まれています。
PROCESSING_ERROR_REASON_INVALID_WBRAID wbraid をデコードできませんでした。
PROCESSING_ERROR_REASON_INTERNAL_ERROR 内部エラー。
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED 移行先のアカウントで拡張コンバージョンの利用規約に同意していません。
PROCESSING_ERROR_REASON_INVALID_EVENT イベントが無効です。
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS 一致した取引が最小しきい値を下回っています。
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS トランザクション数が最小しきい値を下回っている。
PROCESSING_ERROR_REASON_INVALID_FORMAT イベントに形式エラーがあります。
PROCESSING_ERROR_REASON_DECRYPTION_ERROR イベントに復号エラーがあります。
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR DEK を復号できませんでした。
PROCESSING_ERROR_REASON_INVALID_WIP WIP の形式が正しくないか、WIP が存在しません。
PROCESSING_ERROR_REASON_INVALID_KEK KEK が間違っているか、存在しないため、KEK でデータを復号できない。
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED 証明書条件によって拒否されたため、WIP を使用できませんでした。
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED システムに KEK へのアクセスに必要な権限がありませんでした。
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED システムが AWS で認証できませんでした。
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR DEK を使用して UserIdentifier データを復号できませんでした。
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER ユーザーが、オペレーティング アカウントの広告とは異なる広告識別子を使用してイベントを取り込もうとしました。
PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID コンバージョンのカウント方法が 1 回になっているタイプのコンバージョン アクションでは、BRAID を使用できません。
PROCESSING_ERROR_REASON_MATCH_ID_NOT_FOUND 一致 ID が見つかりません。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_MATCH_ID 照合用のウェブ商品アイテム ID のユーザー ID が見つかりません。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_GCLID GCLID のユーザー ID が見つかりません。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_DCLID DCLID のユーザー ID が見つかりません。
PROCESSING_ERROR_REASON_INVALID_AD_IDENTIFIERS 無効な広告 ID があります。
PROCESSING_ERROR_REASON_INVALID_MOBILE_ID_FORMAT モバイル ID の形式が無効です。
PROCESSING_ERROR_REASON_ORIGINAL_CONVERSIONS_NOT_FOUND 元のコンバージョンが見つかりません。
PROCESSING_ERROR_REASON_EVENT_ID_DECODE_ERROR イベント ID(dclid またはインプレッション ID)をデコードできません。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_IMPRESSION_ID 指定されたインプレッション ID のユーザー ID が見つかりません。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND ユーザー ID が見つからない。
PROCESSING_ERROR_REASON_CONVERSION_PRECEDES_CLICK イベントのタイムスタンプが、関連付けられたクリックよりも前になっています。
PROCESSING_ERROR_REASON_TOO_RECENT_CLICK クリックの発生が最近すぎます。
PROCESSING_ERROR_REASON_INVALID_CLICK イベントをクリック(GCLID)に関連付けることができません。これは、Google 広告で作成した広告キャンペーンからのクリックではないことが原因である可能性があります。
PROCESSING_ERROR_REASON_INVALID_OPERATING_ACCOUNT_FOR_CLICK イベントのクリックが、リンク先の operating_account に関連付けられていません。
PROCESSING_ERROR_REASON_CLICK_NOT_FOUND 指定された属性に一致するクリックが見つかりません。
PROCESSING_ERROR_REASON_EXTERNAL_ATTRIBUTION_DATA_MISSING 外部アトリビューション データがありません。外部アトリビューションのコンバージョン アクションの宛先にイベントを送信することはできません。
PROCESSING_ERROR_REASON_DESTINATION_TOO_RECENTLY_CREATED デスティネーションは作成されたばかりです。数時間後にもう一度お試しください。
PROCESSING_ERROR_REASON_EXPIRED_CLICK 一致したクリックが、コンバージョン アクションに設定されているクリックスルー コンバージョンのルックバック ウィンドウ(または 90 日間のクリック TTL)よりも古い。
PROCESSING_ERROR_REASON_TOO_RECENT_CALL 通話はまだ処理中です。
PROCESSING_ERROR_REASON_EXPIRED_CALL 通話の情報が古すぎるため、このコンバージョンをインポートできません。
PROCESSING_ERROR_REASON_INVALID_CALL 通話が見つかりませんでした。

ProcessingWarningReason

処理上の警告の理由。

列挙型
PROCESSING_WARNING_REASON_UNSPECIFIED 処理上の警告の理由は不明です。
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED システムに KEK へのアクセスに必要な権限がありませんでした。
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR DEK を復号できませんでした。
PROCESSING_WARNING_REASON_DECRYPTION_ERROR イベントに復号エラーがあります。
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED 証明書条件によって拒否されたため、WIP を使用できませんでした。
PROCESSING_WARNING_REASON_INVALID_WIP WIP の形式が正しくないか、WIP が存在しません。
PROCESSING_WARNING_REASON_INVALID_KEK KEK が間違っているか、存在しないため、KEK でデータを復号できない。
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR DEK を使用して UserIdentifier データを復号できませんでした。
PROCESSING_WARNING_REASON_INTERNAL_ERROR 内部エラー。
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED システムが AWS で認証できませんでした。
PROCESSING_WARNING_REASON_CUSTOM_VARIABLE_NOT_ENABLED アカウントで CustomVariable または ItemCustomVariable が有効になっていない。
PROCESSING_WARNING_REASON_CUSTOM_VARIABLE_NOT_PREDEFINED CustomVariable または ItemCustomVariable の値が、移行先のアカウントのカスタム変数に設定されている事前定義済みの許可値に含まれていないため、未分類の値に置き換えられます。

プロダクト

非推奨。代わりに AccountType を使用してください。特定の Google サービスを表します。

列挙型
PRODUCT_UNSPECIFIED 未指定のプロダクト。使用しないでください。
GOOGLE_ADS Google 広告
DISPLAY_VIDEO_PARTNER ディスプレイ&ビデオ 360 パートナー。
DISPLAY_VIDEO_ADVERTISER ディスプレイ&ビデオ 360 広告主。
DATA_PARTNER データ パートナー。

ProductAccount

特定のアカウントを表します。

フィールド
product
(deprecated)

Product

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

account_id

string

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

account_type

AccountType

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

AccountType

Google アカウントの種類を表します。アカウントと宛先の検索に使用されます。

列挙型
ACCOUNT_TYPE_UNSPECIFIED 未指定のプロダクト。使用しないでください。
GOOGLE_ADS Google 広告
DISPLAY_VIDEO_PARTNER ディスプレイ&ビデオ 360 パートナー。
DISPLAY_VIDEO_ADVERTISER ディスプレイ&ビデオ 360 広告主。
DATA_PARTNER データ パートナー。
GOOGLE_ANALYTICS_PROPERTY Google アナリティクス。
FLOODLIGHT_CONFIG Floodlight 設定。
GOOGLE_AD_MANAGER Google アド マネージャー

PseudonymousIdInfo

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

フィールド
sync_status

SyncStatus

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

billable_record_count

int64

省略可。変更不可。課金対象のレコード数(アップロード済みまたは一致したレコードなど)。

SyncStatus

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

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

RemoveAllAudienceMembersRequest

指定されたリンク先で、オーディエンスからすべてのユーザーを削除するようリクエストします。RemoveAllAudienceMembersResponse を返します。

このメソッドは、REST API Explorer で試すことができます。
フィールド
destinations[]

Destination

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

remove_as_of_time

Timestamp

省略可。削除の基準時刻。設定すると、この時刻より前に追加されたオーディエンス メンバーのみが削除されます。設定しない場合、デフォルトは現在の時刻になります。削除の基準時刻には将来の日付を指定できません。

validate_only

bool

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

RemoveAllAudienceMembersResponse

RemoveAllAudienceMembersRequest からのレスポンス。

フィールド
request_id

string

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

RemoveAudienceMembersRequest

指定された宛先のオーディエンスからユーザーを削除するリクエスト。RemoveAudienceMembersResponse を返します。

このメソッドは、REST API Explorer で試すことができます。
フィールド
destinations[]

Destination

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

audience_members[]

AudienceMember

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

validate_only

bool

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

encoding

Encoding

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

encryption_info

EncryptionInfo

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

RemoveAudienceMembersResponse

RemoveAudienceMembersRequest からのレスポンス。

フィールド
request_id

string

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

RemoveUsersRequest

指定された宛先からユーザーを削除するリクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
destinations[]

Destination

必須。取り込み先のリスト。

user_data[]

UserData

必須。削除するユーザーのキーとして機能する UserData の個々のビット。

encryption_info

EncryptionInfo

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

validate_only

bool

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

encoding

Encoding

必須。ユーザー識別子のエンコード タイプ。暗号化されたユーザー ID の場合、これは外部エンコードにのみ適用されます。

RemoveUsersResponse

RemoveUsersRequest からのレスポンス。

フィールド
request_id

string

取り込みリクエストの生成されたリクエスト ID。

RequestStatusPerDestination

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

フィールド
destination

Destination

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

request_status

RequestStatus

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

error_info

ErrorInfo

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

warning_info

WarningInfo

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

共用体フィールド status。宛先のステータス。status は次のいずれかになります。
audience_members_ingestion_status

IngestAudienceMembersStatus

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

events_ingestion_status

IngestEventsStatus

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

audience_members_removal_status

RemoveAudienceMembersStatus

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

remove_all_audience_members_status

RemoveAllAudienceMembersStatus

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

DataType

データの種類。

列挙型
DATA_TYPE_UNSPECIFIED データ型が指定されていません。
EMAIL データはメールアドレスです。
PHONE_NUMBER データが電話番号である。
ADDRESS データは住所です。
IP_ADDRESS データは IP アドレスです。

DataTypeCount

特定のデータ型の数。

フィールド
type

DataType

データの種類。

count

int64

このデータ型の数。

IngestAudienceMembersStatus

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

フィールド
共用体フィールド status。オーディエンス メンバーのエクスポート先への取り込みステータス。status は次のいずれかになります。
user_data_ingestion_status

IngestUserDataStatus

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

mobile_data_ingestion_status

IngestMobileDataStatus

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

pair_data_ingestion_status

IngestPairDataStatus

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

user_id_data_ingestion_status

IngestUserIdDataStatus

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

ppid_data_ingestion_status

IngestPpidDataStatus

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

composite_data_ingestion_status

IngestCompositeDataStatus

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

google_user_id_data_ingestion_status

IngestGoogleUserIdDataStatus

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

partner_provided_id_data_ingestion_status

IngestPartnerProvidedIdDataStatus

パートナー提供 ID の宛先へのデータ取り込みのステータス。

IngestCompositeDataStatus

宛先への複合データの取り込みのステータス。取り込みに関連する統計情報が含まれます。

フィールド
record_count

int64

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

data_type_counts[]

DataTypeCount

宛先のアップロード リクエストで送信されたデータタイプの合計数(データタイプ別)。リクエストに含まれるすべてのデータ型(正常に取り込まれたかどうかに関係なく)が含まれます。

upload_match_rate_range

MatchRateRange

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

IngestEventsStatus

宛先へのイベント取り込みのステータス。

フィールド
record_count

int64

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

IngestGoogleUserIdDataStatus

宛先への Google ユーザー ID データの取り込みステータス。取り込みに関連する統計情報が含まれます。

フィールド
record_count

int64

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

google_user_id_count

int64

アップロード リクエストで送信された、宛先の Google ユーザー ID の合計数。リクエストに含まれるすべての Google ユーザー ID が含まれます(正常に取り込まれたかどうかは関係ありません)。

IngestMobileDataStatus

取り込みに関連する統計情報を含む、宛先へのモバイルデータの取り込みのステータス。

フィールド
record_count

int64

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

mobile_id_count

int64

アップロード リクエストで送信された、宛先の Mobile ID の合計数。リクエストに含まれるすべての Mobile ID が含まれます(正常に取り込まれたかどうかは関係ありません)。

IngestPairDataStatus

宛先へのペアデータの取り込みのステータス。取り込みに関連する統計情報が含まれます。

フィールド
record_count

int64

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

pair_id_count

int64

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

IngestPartnerProvidedIdDataStatus

パートナー プロバイダが提供した ID データの宛先へのデータの取り込みステータス。取り込みに関連する統計情報が含まれます。

フィールド
record_count

int64

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

partner_provided_id_count

int64

パートナー プロバイダが提供した ID の合計数。この ID は、宛先のアップロード リクエストで送信されます。リクエストに含まれるすべてのパートナー プロバイダ提供 ID が含まれます。正常に取り込まれたかどうかは関係ありません。

IngestPpidDataStatus

宛先への PPID データの取り込みステータス。取り込みに関連する統計情報が含まれます。

フィールド
record_count

int64

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

ppid_count

int64

宛先のアップロード リクエストで送信された PPID の合計数。正常に取り込まれたかどうかに関係なく、リクエスト内のすべての ppid が含まれます。

IngestUserDataStatus

取り込みに関連する統計情報を含む、宛先へのユーザーデータの取り込みのステータス。

フィールド
record_count

int64

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

user_identifier_count

int64

アップロード リクエストで送信された、リンク先用のユーザー識別子の合計数。リクエストに含まれるすべてのユーザー識別子が含まれます(正常に取り込まれたかどうかは関係ありません)。

upload_match_rate_range

MatchRateRange

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

IngestUserIdDataStatus

取り込みに関連する統計情報を含む、宛先へのユーザー ID データの取り込みのステータス。

フィールド
record_count

int64

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

user_id_count

int64

宛先のアップロード リクエストで送信されたユーザー ID の合計数。リクエストに含まれるすべてのユーザー ID が含まれます(正常に取り込まれたかどうかは関係ありません)。

RemoveAllAudienceMembersStatus

この型にはフィールドがありません。

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

RemoveAudienceMembersStatus

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

フィールド
共用体フィールド status。エクスポート先からのオーディエンス メンバーの削除ステータス。status は次のいずれかになります。
user_data_removal_status

RemoveUserDataStatus

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

mobile_data_removal_status

RemoveMobileDataStatus

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

pair_data_removal_status

RemovePairDataStatus

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

user_id_data_removal_status

RemoveUserIdDataStatus

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

ppid_data_removal_status

RemovePpidDataStatus

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

composite_data_removal_status

RemoveCompositeDataStatus

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

google_user_id_data_removal_status

RemoveGoogleUserIdDataStatus

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

partner_provided_id_data_removal_status

RemovePartnerProvidedIdDataStatus

パートナー プロバイダ提供 ID データの宛先からの削除ステータス。

RemoveCompositeDataStatus

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

フィールド
record_count

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバー(正常に削除されたかどうかは問わない)。

data_type_counts[]

DataTypeCount

削除リクエストで送信されたデータタイプの合計数(データタイプ別)。リクエストに含まれるすべてのデータタイプ(正常に削除されたかどうかに関係なく)。

RemoveGoogleUserIdDataStatus

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

フィールド
record_count

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバー(正常に削除されたかどうかは問わない)。

google_user_id_count

int64

削除リクエストで送信された Google ユーザー ID の合計数。リクエストに含まれるすべての Google ユーザー ID(正常に削除されたかどうかは問わない)。

RemoveMobileDataStatus

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

フィールド
record_count

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバー(正常に削除されたかどうかは問わない)。

mobile_id_count

int64

削除リクエストで送信されたモバイル ID の合計数。リクエストに含まれるすべての Mobile ID が含まれます(正常に削除されたかどうかは関係ありません)。

RemovePairDataStatus

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

フィールド
record_count

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバー(正常に削除されたかどうかは問わない)。

pair_id_count

int64

削除リクエストで送信されたペア ID の合計数。リクエストに含まれるすべてのペア ID が含まれます(正常に削除されたかどうかは関係ありません)。

RemovePartnerProvidedIdDataStatus

パートナー プロバイダ提供 ID データの宛先からの削除ステータス。

フィールド
record_count

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバー(正常に削除されたかどうかは問わない)。

partner_provided_id_count

int64

削除リクエストで送信された、パートナー提供の ID の合計数。リクエストに含まれるすべてのパートナー プロバイダ提供 ID が含まれます(正常に削除されたかどうかは関係ありません)。

RemovePpidDataStatus

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

フィールド
record_count

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバー(正常に削除されたかどうかは問わない)。

ppid_count

int64

削除リクエストで送信された PPID の合計数。リクエストに含まれるすべての ppid が含まれます(正常に削除されたかどうかは関係ありません)。

RemoveUserDataStatus

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

フィールド
record_count

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバー(正常に削除されたかどうかは問わない)。

user_identifier_count

int64

削除リクエストで送信されたユーザー ID の合計数。リクエストに含まれるすべてのユーザー識別子(正常に削除されたかどうかを問わない)。

RemoveUserIdDataStatus

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

フィールド
record_count

int64

削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストに含まれるすべてのオーディエンス メンバー(正常に削除されたかどうかは問わない)。

user_id_count

int64

削除リクエストで送信されたユーザー ID の合計数。リクエストに含まれるすべてのユーザー ID が含まれます(正常に削除されたかどうかは関係ありません)。

RequestStatus

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

列挙型
REQUEST_STATUS_UNKNOWN リクエストのステータスが不明です。
SUCCESS すべてのレコードの処理がエラーなしで成功しました。ただし、warning_info フィールドに警告が表示されることがあります。
PROCESSING リクエストを処理しています。
FAILED すべてのレコードの処理に失敗しました。エラーの詳細については error_info フィールドを、警告の詳細については warning_info フィールドを確認してください。
PARTIAL_SUCCESS 一部のレコードではエラーなしで処理が正常に完了しましたが、他のレコードではエラーが発生して失敗しました。エラーの詳細については error_info フィールドを、警告の詳細については warning_info フィールドを確認してください。

RetrieveInsightsRequest

DM API MarketingDataInsightsService.RetrieveInsights のリクエスト メッセージ

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

baseline

Baseline

必須。リクエストされたインサイトのベースライン。

user_list_id

string

必須。分析情報がリクエストされているユーザーリストの ID。

RetrieveInsightsResponse

DM API MarketingDataInsightsService.RetrieveInsights のレスポンス メッセージ

フィールド
marketing_data_insights[]

MarketingDataInsight

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

MarketingDataInsight

マーケティング データの分析情報。

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

フィールド
dimension

AudienceInsightsDimension

分析情報が属するディメンション。

attributes[]

MarketingDataInsightsAttribute

特定のディメンションの値に関する分析情報。

AudienceInsightsDimension

生成インサイトの生成に使用できるディメンション。

列挙型
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED 指定されていません。
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN このバージョンでは値が不明です。
AFFINITY_USER_INTEREST アフィニティの UserInterest。
IN_MARKET_USER_INTEREST 購買意向の強いユーザーの興味 / 関心。
AGE_RANGE 年齢層。
GENDER 性別。

MarketingDataInsightsAttribute

同じディメンションの関連する属性のコレクションに関する分析情報。

フィールド
user_interest_id

int64

ユーザーの興味 / 関心 ID。

lift

float

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

age_range

AgeRange

リフトが提供されるオーディエンスの年齢層。

gender

Gender

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

RetrievePartnerMatchReportRequest

DM API ReportingService.RetrievePartnerMatchReport のリクエスト メッセージ

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

currency_code

string

省略可。費用 / 料金を返す通貨。指定しない場合、デフォルトはデータ パートナーの通貨になります。

filter

string

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

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

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

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

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

  • advertiser_account.account_type
  • advertiser_account.account_id
  • campaign.campaign_id
  • ad_group.ad_group_id
  • user_list.user_list_id
start_date

int64

必須。取得するレポートデータの開始日(指定した日も期間に含む)。取得できるのは過去 2 年間のデータのみです。開始日がそれより前の日付に設定されている場合、過去 2 年間のデータのみが返されます。YYYYMMDD の形式で指定してください。

end_date

int64

省略可。取得するレポートデータの終了日(指定した日も期間に含む)。指定しない場合のデフォルトは現在の日付です。YYYYMMDD の形式で指定してください。

page_size

int32

省略可。ページごとに返すパートナー マッチ レポート エントリの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 50 件のレポートが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

page_token

string

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

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

RetrievePartnerMatchReportResponse

DM API ReportingService.RetrievePartnerMatchReport のレスポンス メッセージ

フィールド
partner_match_report_entries[]

PartnerMatchReportEntry

パートナー マッチ レポートの行 / エントリのリスト。

next_page_token

string

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

RetrieveRequestStatusRequest

指定されたリクエスト ID の DM API へのリクエストのステータスを取得するリクエスト。RetrieveRequestStatusResponse を返します。

このメソッドは、REST API Explorer で試すことができます。
フィールド
request_id

string

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

RetrieveRequestStatusResponse

RetrieveRequestStatusRequest からのレスポンス。

フィールド
request_status_per_destination[]

RequestStatusPerDestination

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

SearchPartnerLinksRequest

PartnerLink リソースを検索するリクエスト。SearchPartnerLinksResponse を返します。

このメソッドは、REST API Explorer で試すことができます。
フィールド
parent

string

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

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

page_size

int32

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

page_token

string

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

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

filter

string

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

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

  • AND
  • =
  • !=

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

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

FEATURE_SET_AD_EVENT_MANAGEMENT 機能セットを含むパートナー リンクの場合、次のフィールドもサポートされます。

  • partner_customer_account.account_id
  • partner_link_metadata.implicit_accounts.account_id

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

SearchPartnerLinksResponse

SearchPartnerLinksRequest からのレスポンス。

フィールド
next_page_token

string

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

SizeInfo

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

フィールド
display_network_members_count

int64

出力専用。過去 30 日間に Google ディスプレイ ネットワークでこのユーザーリストに含まれていたアクティブ メンバーの推定数。

search_network_members_count

int64

出力専用。過去 30 日間に google.com ドメインでこのユーザーリストに登録されたアクティブ メンバーの推定数。これらは、検索キャンペーンでターゲティングに使用できるメンバーです。

youtube_members_count

int64

出力専用。YouTube のこのユーザーリストに含まれるメンバーの推定数。

gmail_members_count

int64

出力専用。Gmail でのこのユーザーリストの推定メンバー数。

TargetNetworkInfo

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

フィールド
eligible_for_display

bool

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

TargetingType

広告の配信に使用されたターゲティングのタイプ。

列挙型
TARGETING_TYPE_UNSPECIFIED ターゲティング タイプが指定されていません。
TARGETING_TYPE_AUDIENCE オーディエンス ターゲティング。
TARGETING_TYPE_CONTEXTUAL コンテンツ ターゲティング。
TARGETING_TYPE_DEMOGRAPHIC 年齢や性別によるターゲティング
TARGETING_TYPE_DEVICE デバイス ターゲティング。
TARGETING_TYPE_GEO 地域ターゲティング。
TARGETING_TYPE_INTEREST インタレスト ターゲティング。
TARGETING_TYPE_PURCHASE_INTENT 購入意向ターゲティング。
TARGETING_TYPE_REMARKETING リマーケティング ターゲティング。

TermsOfService

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

フィールド
customer_match_terms_of_service_status

TermsOfServiceStatus

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

TermsOfServiceStatus

利用規約に同意するかどうかに関する発信者の決定を表します。

列挙型
TERMS_OF_SERVICE_STATUS_UNSPECIFIED 指定されていません。
ACCEPTED 呼び出し元が利用規約に同意することを選択したことを示すステータス。
REJECTED 発信者が利用規約に同意しないことを選択したことを示すステータス。

UpdateUserListDirectLicenseRequest

UserListDirectLicense リソースの更新リクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
user_list_direct_license

UserListDirectLicense

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

update_mask

FieldMask

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

UpdateUserListGlobalLicenseRequest

UserListGlobalLicense リソースの更新リクエスト。

このメソッドは、REST API Explorer で試すことができます。
フィールド
user_list_global_license

UserListGlobalLicense

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

update_mask

FieldMask

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

UpdateUserListRequest

UpdateUserList のリクエスト メッセージ。

このメソッドは、REST API Explorer で試すことができます。
フィールド
user_list

UserList

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

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

update_mask

FieldMask

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

validate_only

bool

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

ユーザー

1 人のユーザーを表します。同じユーザーを参照する PII やモバイル デバイス ID などの識別子が含まれます。

フィールド
user_data

UserData

必須。ユーザーを識別する手段として使用される、複数のユーザー提供データ。

mobile_data

MobileData

必須。1 人のユーザーを表す複数のモバイル デバイス ID 文字列。

UserData

ユーザーを識別するデータ。少なくとも 1 つの識別子が必要です。

フィールド
user_identifiers[]

UserIdentifier

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

UserIdData

ユーザー ID を保持するユーザー ID データ。

フィールド
user_id

string

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

UserIdInfo

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

フィールド
data_source_type

DataSourceType

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

UserIdentifier

ユーザーの単一の識別子。

フィールド
共用体フィールド identifier。必ず 1 つ指定する必要があります。identifier は次のいずれかになります。
email_address

string

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

phone_number

string

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

address

AddressInfo

ユーザーの住所の既知の構成要素。一度にすべて照合される識別子のグループを保持します。

UserList

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

フィールド
name

string

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

id

int64

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

read_only

bool

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

membership_duration

Duration

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

access_reason

AccessReason

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

size_info

SizeInfo

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

target_network_info

TargetNetworkInfo

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

display_name

string

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

description

string

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

membership_status

MembershipStatus

省略可。このユーザーリストのメンバーシップ登録状況。

integration_code

string

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

closing_reason

ClosingReason

出力専用。このユーザーリストのメンバーシップ登録状況がクローズされている理由。

account_access_status

AccessStatus

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

共用体フィールド user_list_info。ユーザーリストに関する追加情報。user_list_info は次のいずれかになります。
ingested_user_list_info

IngestedUserListInfo

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

AccessReason

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

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

AccessStatus

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

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

ClosingReason

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

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

MembershipStatus

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

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

UserListDirectLicense

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

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

フィールド
name

string

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

user_list_display_name

string

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

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

client_account_display_name

string

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

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

pricing

UserListLicensePricing

省略可。UserListDirectLicense の料金。

historical_pricings[]

UserListLicensePricing

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

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

metrics

UserListLicenseMetrics

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

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

user_list_id

int64

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

client_account_type

UserListLicenseClientAccountType

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

client_account_id

int64

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

status

UserListLicenseStatus

省略可。UserListDirectLicense のステータス(ENABLED または DISABLED)。

UserListGlobalLicense

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

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

フィールド
name

string

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

user_list_display_name

string

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

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

pricing

UserListLicensePricing

省略可。UserListGlobalLicense の料金。

historical_pricings[]

UserListLicensePricing

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

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

metrics

UserListLicenseMetrics

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

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

user_list_id

int64

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

license_type

UserListGlobalLicenseType

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

status

UserListLicenseStatus

省略可。UserListGlobalLicense のステータス(ENABLED または DISABLED)。

UserListGlobalLicenseCustomerInfo

ユーザーリストのグローバル ライセンスのお客様に関する情報。これは、お客様がグローバル ライセンスを購入すると、システムによって自動的に作成されます。

フィールド
name

string

ID。ユーザーリストのグローバル ライセンスのお客様のリソース名。

user_list_id

int64

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

user_list_display_name

string

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

license_type

UserListGlobalLicenseType

出力専用。ユーザーリストのライセンスが付与されているクライアントのお客様の商品タイプ。

status

UserListLicenseStatus

出力専用。UserListDirectLicense のステータス(ENABLED または DISABLED)。

pricing

UserListLicensePricing

出力専用。UserListDirectLicense の料金。

client_account_type

UserListLicenseClientAccountType

出力専用。ユーザーリストのライセンスが付与されているクライアントのお客様の商品タイプ。

client_account_id

int64

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

client_account_display_name

string

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

historical_pricings[]

UserListLicensePricing

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

metrics

UserListLicenseMetrics

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

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

UserListGlobalLicenseType

ユーザーリストのグローバル ライセンス タイプ。

列挙型
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED UNSPECIFIED。
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER 販売パートナー ライセンス。
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE DataMart Sell Side ライセンス。
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE DataMart バイサイド ライセンス。

UserListLicenseClientAccountType

ユーザーリスト ライセンスのクライアント アカウントの可能性のあるプロダクト。

列挙型
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN 不明。
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS Google 広告をご利用のお客様。
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER ディスプレイ&ビデオ 360 パートナー。
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER ディスプレイ&ビデオ 360 広告主。

UserListLicenseMetrics

ユーザーリスト ライセンスに関連する指標。

フィールド
click_count

int64

出力専用。ユーザーリスト ライセンスのクリック数。

impression_count

int64

出力専用。ユーザーリスト ライセンスのインプレッション数。

revenue_usd_micros

int64

出力専用。ユーザーリスト ライセンスの収益(マイクロ米ドル単位)。

start_date

int64

出力専用。指標の開始日(この日を含む)。YYYYMMDD 形式で指定します。たとえば、20260102 は 2026 年 1 月 2 日を表します。フィルタで end_date を使用する場合は、start_date も必要です。start_date と end_date のどちらもフィルタに含まれていない場合、UserListLicenseMetrics フィールドはレスポンスに入力されません。

end_date

int64

出力専用。指標の終了日(YYYYMMDD 形式)。たとえば、20260102 は 2026 年 1 月 2 日を表します。フィルタで start_date を使用する場合は、end_date も必要です。start_date と end_date のどちらもフィルタに含まれていない場合、UserListLicenseMetrics フィールドはレスポンスに入力されません。

UserListLicensePricing

ユーザーリストのライセンス料金。

フィールド
pricing_id

int64

出力専用。この料金の ID。

start_time

Timestamp

出力専用。料金の開始時刻。

end_time

Timestamp

省略可。料金の終了時刻。

pricing_active

bool

出力専用。この料金が有効かどうか。

buyer_approval_state

UserListPricingBuyerApprovalState

出力専用。この価格設定の購入者の承認ステータス。

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

cost_micros

int64

省略可。モデルに関連付けられた費用。マイクロ単位(10^-6)で、通貨コード フィールドで指定された通貨で表されます。たとえば、currency_code が USD の場合、2000000 は 2 ドルを意味します。

currency_code

string

省略可。cost と max_cost が指定されている通貨。ISO 4217 で定義されている 3 文字の通貨コードにする必要があります。

cost_type

UserListPricingCostType

変更不可。この料金の費用タイプ。

create オペレーションでのみ設定できます。既存のライセンスでは更新できません。

max_cost_micros

int64

省略可。MEDIA_SHARE 費用タイプを使用する場合に、コマース オーディエンスに請求される最大 CPM。値はマイクロ単位(10^-6)で、通貨コード フィールドで指定された通貨で表されます。たとえば、currency_code が USD の場合、2000000 は $2 を意味します。

これは、cost_type が MEDIA_SHARE の場合にのみ関連します。cost_type が MEDIA_SHARE ではなく、このフィールドが設定されている場合、MAX_COST_NOT_ALLOWED エラーが返されます。設定されていない場合、または 0 に設定されている場合、上限はありません。

UserListPricingBuyerApprovalState

ユーザーリストの正規価格に関する購入者の承認ステータス。

列挙型
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED UNSPECIFIED。
PENDING ユーザーリスト クライアントが、ユーザーリスト オーナーによって設定された料金規約にまだ同意していません。
APPROVED ユーザーリスト クライアントが、ユーザーリスト オーナーによって設定された料金規約に同意しました。
REJECTED ユーザーリストのクライアントが、ユーザーリストの所有者によって設定された料金条件を拒否しました。

UserListPricingCostType

ユーザーリストの正規価格の費用タイプ。

列挙型
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED 指定なし。
CPC クリック単価。
CPM インプレッション単価(1,000 回のインプレッションあたりの費用)。
MEDIA_SHARE メディア共有。

UserListLicenseStatus

ユーザーリストのライセンス ステータス。

列挙型
USER_LIST_LICENSE_STATUS_UNSPECIFIED 不明。
USER_LIST_LICENSE_STATUS_ENABLED アクティブ ステータス - ユーザーリストはまだライセンスが付与されています。
USER_LIST_LICENSE_STATUS_DISABLED 無効なステータス - ユーザーリストはライセンスを付与されなくなりました。

UserProperties

イベント発生時のユーザーに関する広告主評価情報。詳しくは、https://support.google.com/google-ads/answer/14007601 をご覧ください。

フィールド
customer_type

CustomerType

省略可。イベントに関連付けられている顧客のタイプ。

customer_value_bucket

CustomerValueBucket

省略可。広告主が評価した顧客の価値。

additional_user_properties[]

UserProperty

省略可。このイベントに関連付けられたユーザーの追加のユーザー プロパティのバケット。

UserProperty

このイベントに関連付けられたユーザーの追加のユーザー プロパティのバケット。

フィールド
property_name

string

必須。使用するユーザー プロパティの名前。

value

string

必須。使用するユーザー プロパティの値の文字列表現。

ViewType

イベントのタイプ。

列挙型
VIEW_TYPE_UNSPECIFIED ビュータイプが指定されていません。
VIEW_TYPE_MRC_VIEWED MRC を表示しました。
VIEW_TYPE_MRC_RENDERED MRC レンダリング。

ViewabilityInfo

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

フィールド
view_type

ViewType

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

viewable_percent

int32

省略可。視認可能だったピクセルの割合(0 ~ 100)。

viewable_duration

Duration

省略可。広告が視認可能だった時間の長さ。

media_skippable

bool

省略可。広告メディアがスキップ可能かどうか。

media_quartile

MediaQuartile

省略可。メディアが再生された量を個別の四分位数として表したもの。

media_duration

Duration

省略可。広告メディアの長さ。

media_volume_percent

int32

省略可。メディア再生の音量の数値パーセント(0 ~ 100)。

playback_duration

Duration

省略可。広告メディアの再生時間(視認可能だったかどうかは関係なし)。

WarningCount

特定の警告理由の警告数。

フィールド
record_count

int64

警告のあるレコードの数。

reason

ProcessingWarningReason

警告の理由。

record_indices[]

int32

この警告理由を含む元のリクエストのレコードの 0 ベースのインデックス。

WarningInfo

警告の種類ごとの警告数。

フィールド
warning_counts[]

WarningCount

警告のリストと、警告の理由ごとの件数。

WarningReason

取り込み中に返された、ブロックされない警告の理由。

列挙型
WARNING_REASON_UNSPECIFIED 警告の理由が指定されていません。
WARNING_REASON_CUSTOM_VARIABLE_NOT_ENABLED custom_variables のカスタム変数がアカウントで有効になっていません。
WARNING_REASON_CUSTOM_VARIABLE_NOT_PREDEFINED custom_variables のカスタム変数の値が、移行先のアカウントでカスタム変数に設定されている事前定義済みの許可値に含まれていません。
WARNING_REASON_CART_DATA_NOT_SUPPORTED_WITH_GBRAID_OR_WBRAID cart_data は gbraid または wbraid ではサポートされていません。
WARNING_REASON_CART_DATA_ITEM_MERCHANT_PRODUCT_ID_MISSING カートの商品アイテムに merchant_product_id がありません。
WARNING_REASON_CART_DATA_ITEM_UNIT_PRICE_MISSING カートの商品アイテムに unit_price がありません。
WARNING_REASON_GENERIC 他の特定のカテゴリに該当しない問題に関する一般的な警告理由。
WARNING_REASON_INVALID_CLIENT_ID client_id が無効です。
WARNING_REASON_INVALID_SUBDIVISION_CODE subdivision_code が無効です。
WARNING_REASON_INVALID_REGION_CODE region_code が無効です。
WARNING_REASON_INVALID_SUBCONTINENT_CODE subcontinent_code が無効です。
WARNING_REASON_INVALID_CONTINENT_CODE continent_code が無効です。
WARNING_REASON_INVALID_DEVICE_CATEGORY デバイス category が無効です。
WARNING_REASON_INVALID_DEVICE_SCREEN_RESOLUTION デバイス screen_height または screen_width が無効です。
WARNING_REASON_INVALID_MERCHANT_ID merchant_id が無効です。
WARNING_REASON_INVALID_NUMBER_FORMAT 数値の形式が無効です。