Package google.ads.datamanager.v1

インデックス

• IngestionService（インターフェース）
• AdIdentifiers（メッセージ）
• AddressInfo（メッセージ）
• AudienceMember（メッセージ）
• CartData（メッセージ）
• Consent（メッセージ）
• ConsentStatus（列挙型）
• CustomVariable（メッセージ）
• Destination（メッセージ）
• DeviceInfo（メッセージ）
• Encoding（列挙型）
• EncryptionInfo（メッセージ）
• Event（メッセージ）
• EventSource（列挙型）
• ExperimentalField（メッセージ）
• GcpWrappedKeyInfo（メッセージ）
• GcpWrappedKeyInfo.KeyType（列挙型）
• IngestAudienceMembersRequest（メッセージ）
• IngestAudienceMembersResponse（メッセージ）
• IngestEventsRequest（メッセージ）
• IngestEventsResponse（メッセージ）
• Item（メッセージ）
• MobileData（メッセージ）
• PairData（メッセージ）
• Product（列挙型）
• ProductAccount（メッセージ）
• RemoveAudienceMembersRequest（メッセージ）
• RemoveAudienceMembersResponse（メッセージ）
• TermsOfService（メッセージ）
• TermsOfServiceStatus（列挙型）
• UserData（メッセージ）
• UserIdentifier（メッセージ）

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

AdIdentifiers

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

フィールド
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 必須。ユーザーの住所の ISO-3166-1 alpha-2 の 2 文字の地域コード。
postal_code	string 必須。ユーザーの住所の郵便番号。

AudienceMember

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

フィールド
consent	Consent 省略可。ユーザーの同意設定。
共用体フィールド data。操作する識別データの種類。data は次のいずれかになります。
user_data	UserData ユーザーを識別するユーザー提供データ。
pair_data	PairData Publisher Advertiser Identity Reconciliation（PAIR）ID。
mobile_data	MobileData ユーザーのモバイル デバイスを特定するデータ。

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	拒否されました。

CustomVariable

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

フィールド
variable	string 省略可。設定するカスタム変数の名前。指定された宛先の変数が検出されない場合、その変数は無視されます。
value	string 省略可。カスタム変数に保存する値。

目的地

データの送信先となる Google サービス。たとえば、Google 広告アカウントなどです。

フィールド
reference	string 省略可。この Destination リソースの ID。リクエスト内で一意です。IngestEventsRequest でこの 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 など）。

DeviceInfo

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

フィールド
user_agent	string 省略可。指定されたコンテキストのデバイスのユーザー エージェント文字列。
ip_address	string 省略可。特定のコンテキストにおけるデバイスの IP アドレス。

エンコード

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

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

EncryptionInfo

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

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

イベント

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

フィールド
destination_references[]	string 省略可。宛先の決定に使用される参照文字列。
transaction_id	string 必須。このイベントの一意の識別子。
event_timestamp	Timestamp 必須。イベントの発生時間。
last_updated_timestamp	Timestamp 省略可。イベントが最後に更新された日時。
user_data	UserData 省略可。イベントに関連付けられているユーザーを表す、ユーザー提供データの断片。
consent	Consent 省略可。関連付けられたユーザーがさまざまな種類の同意を提供したかどうかに関する情報。
ad_identifiers	AdIdentifiers 省略可。コンバージョン イベントを他のオンライン アクティビティ（広告クリックなど）と照合するために使用される ID やその他の情報。
currency	string 省略可。このイベント内のすべての金銭的価値に関連付けられている通貨コード。
conversion_value	double 省略可。価値に基づくコンバージョンについて、イベントに関連付けられたコンバージョン値。
event_source	EventSource 省略可。イベントが発生した場所（ウェブ、アプリ、店舗など）を示すシグナル。
event_device_info	DeviceInfo 省略可。イベント発生時に使用されていたデバイス（ある場合）について収集された情報。
cart_data	CartData 省略可。イベントに関連付けられた取引とアイテムに関する情報。
custom_variables[]	CustomVariable 省略可。コンバージョン コンテナ（コンバージョン アクションまたは FL アクティビティ）に送信する追加のキーと値のペアの情報。
experimental_fields[]	ExperimentalField 省略可。最終的に API の一部に昇格する可能性のある試験運用フィールドの Key-Value ペアのリスト。

EventSource

イベントのソース。

列挙型
EVENT_SOURCE_UNSPECIFIED	未指定の EventSource。使用しないでください。
WEB	イベントはウェブブラウザから生成されました。

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。
encrypted_dek	string 必須。base64 でエンコードされた暗号化データ暗号鍵。

KeyType

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

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

IngestAudienceMembersRequest

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

フィールド
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 を返します。

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

項目

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

フィールド
merchant_product_id	string 省略可。Merchant Center アカウント内の商品 ID。
quantity	int64 省略可。イベントに関連付けられているこのアイテムの数。
unit_price	double 省略可。単価。税金、送料、注文単位での割引は含みません。

MobileData

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

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

PairData

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

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

プロダクト

特定の Google プロダクトを表します。アカウントと宛先を特定するために使用されます。

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

ProductAccount

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

フィールド
product	Product 必須。アカウントが属するプロダクト。例: GOOGLE_ADS
account_id	string 必須。アカウントの ID。たとえば、Google 広告アカウント ID などです。

RemoveAudienceMembersRequest

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

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

TermsOfService

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

フィールド
customer_match_terms_of_service_status	TermsOfServiceStatus 省略可。顧客一致の利用規約: https://support.google.com/adspolicy/answer/6299717。カスタマー マッチのユーザーリストにアップロードする際は、必ず同意する必要があります。

TermsOfServiceStatus

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

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

UserData

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

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

UserIdentifier

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

フィールド
共用体フィールド identifier。必ず 1 つ指定する必要があります。identifier は次のいずれかになります。
email_address	string 正規化後に SHA-256 ハッシュ関数を使用してハッシュ化されたメールアドレス。
phone_number	string 正規化（E164 規格）後に SHA-256 ハッシュ関数を使用してハッシュ化された電話番号。
address	AddressInfo ユーザーの住所の既知のコンポーネント。一度に照合される識別子のグループ化を保持します。