Package google.ads.datamanager.v1

インデックス

• IngestionService（インターフェース）
• MarketingDataInsightsService（インターフェース）
• PartnerLinkService（インターフェース）
• UserListDirectLicenseService（インターフェース）
• UserListGlobalLicenseService（インターフェース）
• UserListService（インターフェース）
• AdIdentifiers（メッセージ）
• AddressInfo（メッセージ）
• AgeRange（列挙型）
• AudienceMember（メッセージ）
• AwsWrappedKeyInfo（メッセージ）
• AwsWrappedKeyInfo.KeyType（列挙型）
• Baseline（メッセージ）
• Baseline.Location（メッセージ）
• CartData（メッセージ）
• Consent（メッセージ）
• ConsentStatus（列挙型）
• ContactIdInfo（メッセージ）
• CreatePartnerLinkRequest（メッセージ）
• CreateUserListDirectLicenseRequest（メッセージ）
• CreateUserListGlobalLicenseRequest（メッセージ）
• CreateUserListRequest（メッセージ）
• CustomVariable（メッセージ）
• CustomerType（列挙型）
• CustomerValueBucket（列挙型）
• DataSourceType（列挙型）
• DeletePartnerLinkRequest（メッセージ）
• DeleteUserListRequest（メッセージ）
• Destination（メッセージ）
• DeviceInfo（メッセージ）
• Encoding（列挙型）
• EncryptionInfo（メッセージ）
• ErrorCount（メッセージ）
• ErrorInfo（メッセージ）
• ErrorReason（列挙型）
• Event（メッセージ）
• EventParameter（メッセージ）
• EventSource（列挙型）
• ExperimentalField（メッセージ）
• GcpWrappedKeyInfo（メッセージ）
• GcpWrappedKeyInfo.KeyType（列挙型）
• Gender（列挙型）
• GetUserListDirectLicenseRequest（メッセージ）
• GetUserListGlobalLicenseRequest（メッセージ）
• GetUserListRequest（メッセージ）
• IngestAudienceMembersRequest（メッセージ）
• IngestAudienceMembersResponse（メッセージ）
• IngestEventsRequest（メッセージ）
• IngestEventsResponse（メッセージ）
• IngestedUserListInfo（メッセージ）
• IngestedUserListInfo.UploadKeyType（列挙型）
• Item（メッセージ）
• ItemParameter（メッセージ）
• ListUserListDirectLicensesRequest（メッセージ）
• ListUserListDirectLicensesResponse（メッセージ）
• ListUserListGlobalLicenseCustomerInfosRequest（メッセージ）
• ListUserListGlobalLicenseCustomerInfosResponse（メッセージ）
• ListUserListGlobalLicensesRequest（メッセージ）
• ListUserListGlobalLicensesResponse（メッセージ）
• ListUserListsRequest（メッセージ）
• ListUserListsResponse（メッセージ）
• MatchRateRange（列挙型）
• MobileData（メッセージ）
• MobileIdInfo（メッセージ）
• MobileIdInfo.KeySpace（列挙型）
• PairData（メッセージ）
• PairIdInfo（メッセージ）
• PartnerAudienceInfo（メッセージ）
• PartnerAudienceInfo.PartnerAudienceSource（列挙型）
• PartnerLink（メッセージ）
• PpidData（メッセージ）
• ProcessingErrorReason（列挙型）
• ProcessingWarningReason（列挙型）
• Product（列挙型）（非推奨）
• ProductAccount（メッセージ）
• ProductAccount.AccountType（列挙型）
• PseudonymousIdInfo（メッセージ）
• PseudonymousIdInfo.SyncStatus（列挙型）
• RemoveAudienceMembersRequest（メッセージ）
• RemoveAudienceMembersResponse（メッセージ）
• RequestStatusPerDestination（メッセージ）
• RequestStatusPerDestination.IngestAudienceMembersStatus（メッセージ）
• RequestStatusPerDestination.IngestEventsStatus（メッセージ）
• RequestStatusPerDestination.IngestMobileDataStatus（メッセージ）
• RequestStatusPerDestination.IngestPairDataStatus（メッセージ）
• RequestStatusPerDestination.IngestPpidDataStatus（メッセージ）
• RequestStatusPerDestination.IngestUserDataStatus（メッセージ）
• RequestStatusPerDestination.IngestUserIdDataStatus（メッセージ）
• RequestStatusPerDestination.RemoveAudienceMembersStatus（メッセージ）
• RequestStatusPerDestination.RemoveMobileDataStatus（メッセージ）
• RequestStatusPerDestination.RemovePairDataStatus（メッセージ）
• RequestStatusPerDestination.RemovePpidDataStatus（メッセージ）
• RequestStatusPerDestination.RemoveUserDataStatus（メッセージ）
• RequestStatusPerDestination.RemoveUserIdDataStatus（メッセージ）
• RequestStatusPerDestination.RequestStatus（列挙型）
• RetrieveInsightsRequest（メッセージ）
• RetrieveInsightsResponse（メッセージ）
• RetrieveInsightsResponse.MarketingDataInsight（メッセージ）
• RetrieveInsightsResponse.MarketingDataInsight.AudienceInsightsDimension（列挙型）
• RetrieveInsightsResponse.MarketingDataInsight.MarketingDataInsightsAttribute（メッセージ）
• RetrieveRequestStatusRequest（メッセージ）
• RetrieveRequestStatusResponse（メッセージ）
• SearchPartnerLinksRequest（メッセージ）
• SearchPartnerLinksResponse（メッセージ）
• SizeInfo（メッセージ）
• TargetNetworkInfo（メッセージ）
• TermsOfService（メッセージ）
• TermsOfServiceStatus（列挙型）
• UpdateUserListDirectLicenseRequest（メッセージ）
• UpdateUserListGlobalLicenseRequest（メッセージ）
• UpdateUserListRequest（メッセージ）
• UserData（メッセージ）
• UserIdData（メッセージ）
• UserIdInfo（メッセージ）
• UserIdentifier（メッセージ）
• UserList（メッセージ）
• UserList.AccessReason（列挙型）
• UserList.AccessStatus（列挙型）
• UserList.ClosingReason（列挙型）
• UserList.MembershipStatus（列挙型）
• UserListDirectLicense（メッセージ）
• UserListGlobalLicense（メッセージ）
• UserListGlobalLicenseCustomerInfo（メッセージ）
• UserListGlobalLicenseType（列挙型）
• UserListLicenseClientAccountType（列挙型）
• UserListLicenseMetrics（メッセージ）
• UserListLicensePricing（メッセージ）
• UserListLicensePricing.UserListPricingBuyerApprovalState（列挙型）
• UserListLicensePricing.UserListPricingCostType（列挙型）
• UserListLicenseStatus（列挙型）
• UserProperties（メッセージ）
• UserProperty（メッセージ）
• WarningCount（メッセージ）
• WarningInfo（メッセージ）

IngestionService

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

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

RemoveAudienceMembers
rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse) 指定された Destination から AudienceMember リソースのリストを削除します。 認可スコープ 次の 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) 指定したユーザーリストのマーケティング データ分析情報を取得します。 この機能はデータ パートナーのみが利用できます。 認証ヘッダー: このメソッドは、API がリクエストのアクセスを承認する方法を定義する次のオプション ヘッダーをサポートしています。 login-account:（省略可）認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account:（省略可）login-account への商品リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/datamanager

PartnerLinkService

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

CreatePartnerLink

rpc CreatePartnerLink(CreatePartnerLinkRequest) returns (PartnerLink) 指定されたアカウントのパートナー リンクを作成します。 認証ヘッダー: このメソッドは、API がリクエストのアクセスを承認する方法を定義する次のオプション ヘッダーをサポートしています。 login-account:（省略可）認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account:（省略可）login-account への商品リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/datamanager

DeletePartnerLink

rpc DeletePartnerLink(DeletePartnerLinkRequest) returns (Empty) 指定されたアカウントのパートナー リンクを削除します。 認証ヘッダー: このメソッドは、API がリクエストのアクセスを承認する方法を定義する次のオプション ヘッダーをサポートしています。 login-account:（省略可）認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account:（省略可）login-account への商品リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/datamanager

SearchPartnerLinks

rpc SearchPartnerLinks(SearchPartnerLinksRequest) returns (SearchPartnerLinksResponse) 指定されたアカウントとの間でやり取りされるすべてのパートナー リンクを検索します。 認証ヘッダー: このメソッドは、API がリクエストのアクセスを承認する方法を定義する次のオプション ヘッダーをサポートしています。 login-account:（省略可）認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account:（省略可）login-account への商品リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 認可スコープ 次の 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) UserList を作成します。 認証ヘッダー: このメソッドは、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 を削除します。 認証ヘッダー: このメソッドは、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 を取得します。 認証ヘッダー: このメソッドは、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 を一覧表示します。 認証ヘッダー: このメソッドは、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 を更新します。 認証ヘッダー: このメソッドは、API がリクエストのアクセスを承認する方法を定義する次のオプション ヘッダーをサポートしています。 login-account:（省略可）認証情報の Google アカウントがユーザーであるアカウントのリソース名。設定しない場合、デフォルトはリクエストのアカウントになります。形式: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account:（省略可）login-account への商品リンクが確立されているアカウントのリソース名。形式: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/datamanager

AdIdentifiers

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

フィールド
session_attributes	string 省略可。イベントのアトリビューションとモデリングのセッション属性。
gclid	string 省略可。このイベントに関連付けられている Google クリック ID（gclid）。
gbraid	string 省略可。アプリイベントに関連付けられ、iOS14 以降の iOS デバイスから発生しているクリックのクリック ID。
wbraid	string 省略可。ウェブ イベントに関連付けられ、iOS14 以降の iOS デバイスから発生しているクリックのクリック ID。
landing_page_device_info	DeviceInfo 省略可。広告をクリックして広告主のサイトにアクセスしたときに使用されたデバイス（ある場合）に関する情報。

AddressInfo

ユーザーの住所情報。

フィールド
given_name	string 必須。ユーザーの（名）をすべて小文字で指定します。句読点、先頭または末尾の空白文字は使用せず、SHA-256 としてハッシュ化します。
family_name	string 必須。ユーザーの姓（ラストネーム）。すべて小文字で、句読点、先頭または末尾の空白文字は使用せず、SHA-256 としてハッシュ化します。
region_code	string 必須。ユーザーの住所の 2 文字の地域コード（ISO-3166-1 alpha-2 形式）。
postal_code	string 必須。ユーザーの住所の郵便番号。

年齢

ユーザー属性の年齢層

列挙型
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 歳以上。

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 パブリッシャー指定の識別子に関連するデータ。 この機能はデータ パートナーのみが利用できます。

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 地域コードのリスト。

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 省略可。イベントに関連付けられているアイテムのリスト。

同意

ユーザーのデジタル市場法（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 省略可。変更不可。アップロード データのソース

CreatePartnerLinkRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
parent	string 必須。このパートナー リンクのコレクションを所有する親。形式: accountTypes/{account_type}/accounts/{account}
partner_link	PartnerLink 必須。作成するパートナー リンク。

CreateUserListDirectLicenseRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
parent	string 必須。ライセンスが付与されるユーザーリストを所有するアカウント。accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} の形式にする必要があります。
user_list_direct_license	UserListDirectLicense 必須。作成するユーザーリストの直接ライセンス。

CreateUserListGlobalLicenseRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
parent	string 必須。ライセンスが付与されるユーザーリストを所有するアカウント。accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} の形式にする必要があります。
user_list_global_license	UserListGlobalLicense 必須。作成するユーザーリストのグローバル ライセンス。

CreateUserListRequest

CreateUserList に対するリクエスト メッセージ。

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
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 で試すことができます。

REST で試す

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

DeleteUserListRequest

DeleteUserList に対するリクエスト メッセージ。

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
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 の MCC アカウントや、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 などです。

DeviceInfo

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

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

エンコード

ハッシュ化された識別情報のエンコード タイプ。

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

EncryptionInfo

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

フィールド
共用体フィールド wrapped_key。データの暗号化に使用されるラップされた鍵。wrapped_key は次のいずれかになります。
gcp_wrapped_key_info	GcpWrappedKeyInfo Google Cloud Platform のラップされた鍵情報。
aws_wrapped_key_info	AwsWrappedKeyInfo Amazon Web Services のラップされた鍵情報。

ErrorCount

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

フィールド
record_count	int64 特定の理由でアップロードできなかったレコードの数。
reason	ProcessingErrorReason 失敗したレコードのエラー理由。

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	16 進数でエンコードされた値の形式が不適切です。
INVALID_BASE64_ENCODING	Base64 でエンコードされた値の形式が不適切です。
INVALID_SHA256_FORMAT	SHA256 でエンコードされた値の形式が不適切です。
INVALID_POSTAL_CODE	郵便番号が無効です。
INVALID_COUNTRY_CODE	国コードが無効です。
INVALID_ENUM_VALUE	列挙値を使用できません。
INVALID_USER_LIST_TYPE	ユーザーリストの種類はこのリクエストに適用されません。
INVALID_AUDIENCE_MEMBER	このオーディエンス メンバーは無効です。
TOO_MANY_AUDIENCE_MEMBERS	リクエストごとに許可されるオーディエンス メンバーの最大数は 10,000 です。
TOO_MANY_USER_IDENTIFIERS	オーディエンス メンバーごとに許可されるユーザー ID の最大数は 10 個です。
TOO_MANY_DESTINATIONS	リクエストごとに許可される宛先の最大数は 10 です。
INVALID_DESTINATION	この宛先は無効です。
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED	データ パートナーは、運営アカウントが所有するユーザーリストにアクセスできません。
INVALID_MOBILE_ID_FORMAT	モバイル 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	コンバージョン アクションのタイプが無効です。
INVALID_CURRENCY_CODE	通貨コードがサポートされていません。
INVALID_EVENT	このイベントは無効です。
TOO_MANY_EVENTS	リクエストごとに許可されるイベントの最大数は 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	イベントデータには、ユーザー識別子や広告識別子は含まれません。
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	フィールドの値が長すぎます。
TOO_MANY_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	最大費用は cost_type 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	アカウント タイプはユーザーリストのタイプでサポートされていません。
UNSUPPORTED_ACCOUNT_TYPE_FOR_PARTNER_LINK	パートナー リンクでは、アカウント タイプはサポートされていません。

イベント

広告主のウェブサイトまたはアプリに対するユーザーの操作を表すイベント。

フィールド
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 省略可。コンバージョン コンテナ（コンバージョン アクションまたは FL アクティビティ）に送信する追加のキーと値のペアの情報。
experimental_fields[]	ExperimentalField 省略可。最終的に API の一部に昇格する可能性のある試験運用フィールドの Key-Value ペアのリスト。
user_properties	UserProperties 省略可。イベント発生時のユーザーに関する広告主様が評価した情報。
event_name	string 省略可。イベントの名前。GA4 イベントで必須です。
client_id	string 省略可。この GA4 ウェブ ストリームのウェブ クライアントのユーザー インスタンスの一意の識別子。
user_id	string 省略可。広告主が定義したユーザーの固有識別子。
additional_event_parameters[]	EventParameter 省略可。他の構造化フィールドを使用してまだ指定されていない、イベントに含める任意のイベント パラメータのバケット。
conversion_value	double 省略可。価値に基づくコンバージョンの場合、イベントに関連付けられたコンバージョン値。

EventParameter

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

フィールド
parameter_name	string 必須。使用するパラメータの名前。
value	string 必須。設定するパラメータの値の文字列表現。

EventSource

イベントのソース。

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

ExperimentalField

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

フィールド
field	string 省略可。使用するフィールドの名前。
value	string 省略可。設定するフィールドの値。

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 で試すことができます。

REST で試す

フィールド
name	string 必須。ユーザーリストの直接ライセンスのリソース名。

GetUserListGlobalLicenseRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

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

GetUserListRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

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

IngestAudienceMembersRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
destinations[]	Destination 必須。オーディエンス メンバーの送信先リスト。
audience_members[]	AudienceMember 必須。指定されたリンク先に送信するユーザーのリスト。1 回のリクエストで送信できる AudienceMember リソースは最大 10,000 個です。
consent	Consent 省略可。リクエスト内のすべてのユーザーに適用されるリクエスト レベルの同意。ユーザーレベルの同意はリクエストレベルの同意をオーバーライドし、各 AudienceMember で指定できます。
validate_only	bool 省略可。テスト目的。true の場合、リクエストは検証されますが実行されません。結果ではなく、エラーのみが返されます。
encoding	Encoding 省略可。UserData のアップロードに必須です。ユーザー識別子のエンコード タイプ。ハッシュ化されたユーザー識別子の場合、これはハッシュ化された文字列のエンコード タイプです。暗号化されたハッシュ化ユーザー ID の場合、これは外側の暗号化された文字列のエンコード タイプですが、必ずしも内側のハッシュ化された文字列のエンコード タイプではありません。つまり、内側のハッシュ化された文字列は、外側の暗号化された文字列とは異なる方法でエンコードされる可能性があります。UserData 以外のアップロードの場合、このフィールドは無視されます。
encryption_info	EncryptionInfo 省略可。UserData アップロードの暗号化情報。設定されていない場合、アップロードされた識別情報はハッシュ化されているが暗号化されていないと見なされます。UserData 以外のアップロードの場合、このフィールドは無視されます。
terms_of_service	TermsOfService 省略可。ユーザーが同意または拒否した利用規約。

IngestAudienceMembersResponse

IngestAudienceMembersRequest からのレスポンス。

フィールド
request_id	string リクエストの自動生成 ID。

IngestEventsRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
destinations[]	Destination 必須。イベントの送信先リスト。
events[]	Event 必須。指定されたリンク先に送信するイベントのリスト。1 回のリクエストで送信できる Event リソースは最大 2,000 個です。
consent	Consent 省略可。リクエスト内のすべてのユーザーに適用されるリクエスト レベルの同意。ユーザーレベルの同意はリクエストレベルの同意をオーバーライドし、各 Event で指定できます。
validate_only	bool 省略可。テスト目的。true の場合、リクエストは検証されますが実行されません。結果ではなく、エラーのみが返されます。
encoding	Encoding 省略可。UserData のアップロードに必須です。ユーザー識別子のエンコード タイプ。ハッシュ化されたユーザー識別子の場合、これはハッシュ化された文字列のエンコード タイプです。暗号化されたハッシュ化ユーザー ID の場合、これは外側の暗号化された文字列のエンコード タイプですが、必ずしも内側のハッシュ化された文字列のエンコード タイプではありません。つまり、内側のハッシュ化された文字列は、外側の暗号化された文字列とは異なる方法でエンコードされる可能性があります。UserData 以外のアップロードの場合、このフィールドは無視されます。
encryption_info	EncryptionInfo 省略可。UserData アップロードの暗号化情報。設定されていない場合、アップロードされた識別情報はハッシュ化されているが暗号化されていないと見なされます。UserData 以外のアップロードの場合、このフィールドは無視されます。

IngestEventsResponse

IngestEventsRequest からのレスポンス。

フィールド
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	パブリッシャーの広告主の身元確認 ID。
PSEUDONYMOUS_ID	データ管理プラットフォーム ID: - Google ユーザー ID - パートナー提供 ID - パブリッシャー提供 ID - iOS IDFA - Android 広告 ID - Roku ID - Amazon Fire TV ID - Xbox または Microsoft ID

項目

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

フィールド
merchant_product_id	string 省略可。Merchant Center アカウント内の商品 ID。
quantity	int64 省略可。イベントに関連付けられているこのアイテムの数。
unit_price	double 省略可。単価。税金、送料、注文単位での割引は含みません。
item_id	string 省略可。アイテムを参照するための一意の識別子。
additional_item_parameters[]	ItemParameter 省略可。他の構造化フィールドを使用してまだ指定されていない、イベントに含めるアイテムに関連するイベント パラメータのバケット。

ItemParameter

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

フィールド
parameter_name	string 必須。使用するパラメータの名前。
value	string 必須。設定するパラメータの値の文字列表現。

ListUserListDirectLicensesRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
parent	string 必須。ライセンスのクエリ対象となるアカウント。accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} の形式にする必要があります。
filter	string 省略可。リスト リクエストに適用するフィルタ。すべてのフィールドは、各条件の左側に配置する必要があります（例: user_list_id = 123）。 サポートされているオペレーション: AND = != > >= < <= サポートされていないフィールド: 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 で試すことができます。

REST で試す

フィールド
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 = != > >= < <= サポートされていないフィールド: 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 で試すことができます。

REST で試す

フィールド
parent	string 必須。ライセンスのクエリ対象となるアカウント。accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} の形式にする必要があります。
filter	string 省略可。リスト リクエストに適用するフィルタ。すべてのフィールドは、各条件の左側に配置する必要があります（例: user_list_id = 123）。 サポートされているオペレーション: AND = != > >= < <= サポートされていないフィールド: 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 で試すことができます。

REST で試す

フィールド
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 = != > >= < <= :（あり） サポートされているフィールド: 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] の間隔）です。

MobileData

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

フィールド
mobile_ids[]	string 必須。モバイル デバイス ID（広告 ID/IDFA）のリスト。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 つのペア ID が必要です。

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

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

PairIdInfo

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

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

フィールド
match_rate_percentage	int32 出力専用。このフィールドは、このユーザーリストのメンバーシップ マッチ率を、対応するパブリッシャーのファーストパーティ データと比較した割合を示します。0 ～ 100 の範囲で指定してください。
advertiser_identifier_count	int64 出力専用。クリーンルーム プロバイダにアップロードされた広告主のファーストパーティ データレコードの数。これは、PAIR ユーザー リストのサイズを示すものではありません。
publisher_id	int64 必須。変更不可。Publisher Advertiser Identity Reconciliation ユーザー リストが照合されるパブリッシャーを識別します。このフィールドはクリーンルーム プロバイダによって提供され、そのクリーンルームのスコープ内でのみ一意です。複数のクリーンルームにわたるグローバル識別子として使用することはできません。
publisher_name	string 省略可。ターゲティングの精度を高めるために UI に表示されるパブリッシャーのわかりやすい名前。
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	パートナー オーディエンス ソースは代理店/プロバイダのオーディエンスです。

PartnerLink

所有アカウントとパートナー アカウント間のパートナー リンク。

フィールド
name	string ID。パートナー リンクの名前。形式: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
partner_link_id	string 出力専用。パートナー リンク ID。
owning_account	ProductAccount 必須。パートナー アカウントへのアクセス権を付与する所有アカウント。
partner_account	ProductAccount 必須。所有アカウントによってアクセス権が付与されたパートナー アカウント。

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_DENIED_CONSENT	広告ユーザーデータがユーザーまたは広告主様のデフォルト設定によって拒否されている。
PROCESSING_ERROR_REASON_NO_CONSENT	広告主が広告のコア プラットフォーム サービスについてサードパーティに同意を与えていない。
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT	このユーザーの全体的な同意（行レベルの同意、リクエスト レベルの同意、アカウント設定から判断）を特定できませんでした
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	ユーザーが、運用アカウントの広告のものではない広告識別子を使用してイベントを取り込もうとしました。

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 での認証に失敗しました。

プロダクト

この項目は非推奨です。

非推奨。代わりに 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 アナリティクス。
GOOGLE_AD_MANAGER_AUDIENCE_LINK	Google アド マネージャーのオーディエンス リンク。

PseudonymousIdInfo

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

フィールド
sync_status	SyncStatus 出力専用。ユーザーリストの同期ステータス。
billable_record_count	int64 省略可。変更不可。課金対象のレコード数（アップロードされたレコード数や一致したレコード数など）。

SyncStatus

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

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

RemoveAudienceMembersRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
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。

RequestStatusPerDestination

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

フィールド
destination	Destination DM API リクエスト内の宛先。
request_status	RequestStatus 宛先のリクエスト ステータス。
error_info	ErrorInfo アップロードに関連するエラーの理由とエラー数を含むエラー情報エラー。
warning_info	WarningInfo アップロードに関連する警告理由と警告数を含む警告情報。
共用体フィールド status。宛先のステータス。status は次のいずれかになります。
audience_members_ingestion_status	IngestAudienceMembersStatus オーディエンス メンバーの取り込みリクエストのステータス。
events_ingestion_status	IngestEventsStatus 取り込みイベント リクエストのステータス。
audience_members_removal_status	RemoveAudienceMembersStatus オーディエンス メンバーの削除リクエストのステータス。

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 データの取り込みステータス。

IngestEventsStatus

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

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

IngestMobileDataStatus

モバイルデータの取り込みのステータス。取り込みに関連する統計情報が含まれます。

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

IngestPairDataStatus

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

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

IngestPpidDataStatus

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

フィールド
record_count	int64 アップロード リクエストで送信された、デスティネーションのオーディエンス メンバーの合計数。リクエストには、取り込みに成功したかどうかに関係なく、すべてのオーディエンス メンバーが含まれます。
ppid_count	int64 宛先のアップロード リクエストで送信された ppids の合計数。リクエスト内のすべての 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 が含まれます。取り込みが成功したかどうかは関係ありません。

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 データの削除ステータス。

RemoveMobileDataStatus

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

フィールド
record_count	int64 削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストには、削除に成功したかどうかに関係なく、すべてのユーザーリストのメンバーが含まれます。
mobile_id_count	int64 削除リクエストで送信されたモバイル ID の合計数。リクエスト内のすべてのモバイル ID が含まれます。削除が成功したかどうかは関係ありません。

RemovePairDataStatus

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

フィールド
record_count	int64 削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストには、削除に成功したかどうかに関係なく、すべてのユーザーリストのメンバーが含まれます。
pair_id_count	int64 削除リクエストで送信されたペア ID の合計数。リクエスト内のすべてのペア ID が含まれます。削除が成功したかどうかは関係ありません。

RemovePpidDataStatus

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

フィールド
record_count	int64 削除リクエストで送信されたオーディエンス メンバーの合計数。リクエストには、削除に成功したかどうかに関係なく、すべてのユーザーリストのメンバーが含まれます。
ppid_count	int64 削除リクエストで送信された ppids の合計数。リクエスト内のすべての 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	リクエストが成功しました。
PROCESSING	リクエストを処理中です。
FAILED	リクエストが失敗しました。
PARTIAL_SUCCESS	リクエストが部分的に成功しました。

RetrieveInsightsRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
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	購買意向の強い UserInterest。
AGE_RANGE	年齢層。
GENDER	性別。

MarketingDataInsightsAttribute

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

フィールド
user_interest_id	int64 ユーザー インタレスト ID。
lift	float ベースラインと比較した、属性値に対するオーディエンスの引き上げ率の指標。範囲は [0 ～ 1] です。
age_range	AgeRange リフトが提供されるユーザーの年齢層。
gender	Gender リフトが提供されるオーディエンスの性別。

RetrieveRequestStatusRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
request_id	string 必須。必須。データマネージャー API リクエストのリクエスト ID。

RetrieveRequestStatusResponse

RetrieveRequestStatusRequest からのレスポンス。

フィールド
request_status_per_destination[]	RequestStatusPerDestination 宛先ごとのリクエスト ステータスのリスト。ステータスの順序は、元のリクエストの宛先の順序と一致します。

SearchPartnerLinksRequest

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

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
parent	string 必須。パートナー リンクを検索するアカウント。filter が指定されていない場合は、このアカウントが owning_account または partner_account のいずれかであるすべてのパートナー リンクが返されます。 形式: accountTypes/{account_type}/accounts/{account}
page_size	int32 返すパートナー リンクの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 10 個のパートナー リンクが返されます。最大値は 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 例: owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id = 987654321

SearchPartnerLinksResponse

SearchPartnerLinksRequest からのレスポンス。

フィールド
partner_links[]	PartnerLink 指定されたアカウントのパートナー リンク。
next_page_token	string 次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

SizeInfo

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

フィールド
display_network_members_count	int64 出力専用。Google ディスプレイ ネットワークでこのユーザーリストに登録されているメンバーの推定数。
search_network_members_count	int64 出力専用。google.com ドメイン内のこのユーザーリストのメンバー数の推定値。これらは、検索キャンペーンでターゲティングに使用できるメンバーです。

TargetNetworkInfo

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

フィールド
eligible_for_display	bool 出力専用。このユーザーリストが Google ディスプレイ ネットワークの対象であることを示します。
eligible_for_search	bool 省略可。このユーザーリストが Google 検索ネットワークの対象かどうかを示します。

TermsOfService

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

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

TermsOfServiceStatus

利用規約に同意するか拒否するかという発信者の決定を表します。

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

UpdateUserListDirectLicenseRequest

UserListDirectLicense リソースの更新をリクエストします。

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
user_list_direct_license	UserListDirectLicense 必須。ライセンスの name フィールドは、更新するライセンスを識別するために使用されます。
update_mask	FieldMask 省略可。更新するフィールドのリスト。特殊文字 * はサポートされていません。使用すると INVALID_UPDATE_MASK エラーがスローされます。

UpdateUserListGlobalLicenseRequest

UserListGlobalLicense リソースの更新をリクエストします。

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
user_list_global_license	UserListGlobalLicense 必須。ライセンスの name フィールドは、更新するライセンスを識別するために使用されます。
update_mask	FieldMask 省略可。更新するフィールドのリスト。特殊文字 * はサポートされていません。使用すると INVALID_UPDATE_MASK エラーがスローされます。

UpdateUserListRequest

UpdateUserList に対するリクエスト メッセージ。

このメソッドは、REST API Explorer で試すことができます。

REST で試す

フィールド
user_list	UserList 必須。更新するユーザーリスト。 ユーザーリストの name フィールドは、更新するユーザーリストを識別するために使用されます。形式: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
update_mask	FieldMask 省略可。更新するフィールドのリスト。
validate_only	bool 省略可。true の場合、リクエストは検証されますが実行されません。

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 Buy Side ライセンス。

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 広告主。
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK	Google アド マネージャーのオーディエンス リンク。

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 フィールドで指定された通貨。たとえば、currency_code が USD の場合、2000000 は $2 を意味します。
currency_code	string 省略可。費用と max_cost が指定されている通貨。ISO 4217 で定義されている 3 文字の通貨コードである必要があります。
cost_type	UserListPricingCostType 変更不可。この料金の費用タイプ。 create オペレーションでのみ設定できます。既存のライセンスでは更新できません。
max_cost_micros	int64 省略可。MEDIA_SHARE 費用タイプを使用する場合に、コマース オーディエンスに請求できる最大 CPM。値はマイクロ単位（10^-6）で、currency_code フィールドで指定された通貨で表されます。たとえば、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 必須。使用するユーザー プロパティの値の文字列表現。

WarningCount

特定の警告理由の警告数。

フィールド
record_count	int64 警告のあるレコードの数。
reason	ProcessingWarningReason 警告の理由。

WarningInfo

警告タイプごとの警告数。

フィールド
warning_counts[]	WarningCount 警告のリストと、警告の理由ごとのカウント。