Package google.ads.datamanager.v1

インデックス

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

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

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

string

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

AudienceMember

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

フィールド
destination_references[]

string

省略可。オーディエンス メンバーを送信する Destination を定義します。
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

省略可。カスタム変数に保存する値。
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 お客様は価値の高いユーザーです。

目的地

データの送信先となる 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 のラップされた鍵情報。

ErrorCount

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

フィールド
record_count

int64

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

ProcessingErrorReason

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

ErrorInfo

各タイプのエラーのエラー数。

フィールド
error_counts[]

ErrorCount

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

イベント

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

フィールド
destination_references[]

string

省略可。宛先の決定に使用される参照文字列。空の場合、イベントはリクエスト内のすべての destinations に送信されます。
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 ペアのリスト。
user_properties

UserProperties

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

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

string

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

KeyType

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

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

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。

項目

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

フィールド
merchant_product_id

string

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

int64

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

double

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

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 個です。

PairData

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

フィールド
pair_ids[]

string

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

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_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 内部エラーです。

商品

非推奨です。代わりに 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 データ パートナー。

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

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

IngestEventsStatus

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

フィールド
record_count

int64

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

IngestMobileDataStatus

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

フィールド
record_count

int64

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

int64

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

IngestPairDataStatus

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

フィールド
record_count

int64

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

int64

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

IngestUserDataStatus

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

フィールド
record_count

int64

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

int64

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

MatchRateRange

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

RemoveAudienceMembersStatus

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

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

RemoveUserDataStatus

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

RemoveMobileDataStatus

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

RemovePairDataStatus

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

RemoveMobileDataStatus

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

フィールド
record_count

int64

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

int64

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

RemovePairDataStatus

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

フィールド
record_count

int64

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

int64

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

RemoveUserDataStatus

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

フィールド
record_count

int64

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

int64

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

RequestStatus

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

列挙型
REQUEST_STATUS_UNKNOWN リクエストのステータスは不明です。
SUCCESS リクエストが成功しました。
PROCESSING リクエストを処理中です。
FAILED リクエストが失敗しました。
PARTIAL_SUCCESS リクエストが部分的に成功しました。

RetrieveRequestStatusRequest

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

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

string

必須。必須。データマネージャー API リクエストのリクエスト ID。

RetrieveRequestStatusResponse

RetrieveRequestStatusRequest からのレスポンス。

フィールド
request_status_per_destination[]

RequestStatusPerDestination

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

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 発信者が利用規約を拒否したことを示すステータス。

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

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

UserProperties

イベント発生時のユーザーに関する広告主様が評価した情報。詳しくは、https://support.google.com/google-ads/answer/14007601 をご覧ください。

フィールド
customer_type

CustomerType

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

CustomerValueBucket

省略可。広告主様が評価した顧客の価値。

WarningCount

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

フィールド
record_count

int64

警告のあるレコードの数。
reason

ProcessingWarningReason

警告の理由。

WarningInfo

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

フィールド
warning_counts[]

WarningCount

警告のリストと、警告理由ごとのカウント。