Method: events.ingest

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

HTTP リクエスト

POST https://datamanager.googleapis.com/v1/events:ingest

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
フィールド
destinations[]

object (Destination)

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

object (Event)

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

object (Consent)

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

boolean

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

enum (Encoding)

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

object (EncryptionInfo)

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

レスポンスの本文

IngestEventsRequest からのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "requestId": string,
  "fieldWarnings": [
    {
      object (FieldWarning)
    }
  ]
}
フィールド
requestId

string

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

object (FieldWarning)

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

認可スコープ

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

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

イベント

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

JSON 表現 
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  },
  "eventName": string,
  "clientId": string,
  "userId": string,
  "additionalEventParameters": [
    {
      object (EventParameter)
    }
  ],
  "thirdPartyUserData": {
    object (UserData)
  },
  "eventLocation": {
    object (EventLocation)
  },
  "appInstanceId": string,
  "callInfo": {
    object (CallInfo)
  },
  "conversionValue": number,
  "conversionCount": number
}
フィールド
destinationReferences[]

string

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

string

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

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
lastUpdatedTimestamp

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
userData

object (UserData)

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

object (Consent)

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

object (AdIdentifiers)

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

string

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

enum (EventSource)

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

object (DeviceInfo)

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

object (CartData)

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

object (CustomVariable)

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

object (ExperimentalField)

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

object (UserProperties)

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

string

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

string

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

string

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

object (EventParameter)

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

object (UserData)

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

object (EventLocation)

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

string

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

object (CallInfo)

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

number

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

number

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

AdIdentifiers

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

JSON 表現 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "dclid": string,
  "impressionId": string,
  "matchId": string,
  "encryptedUserIds": [
    {
      object (EncryptedUserId)
    }
  ],
  "ppid": string,
  "visitorPpid": string,
  "leadId": string
}
フィールド
sessionAttributes

string

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

string

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

string

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

string

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

object (DeviceInfo)

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

string

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

string

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

string

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

string

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

object (EncryptedUserId)

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

string

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

string

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

string

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

EncryptedUserId

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

JSON 表現 
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
フィールド
encryptedId

string

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

enum (EncryptionEntityType)

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

string (int64 format)

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

enum (EncryptionSource)

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

EncryptionEntityType

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

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

EncryptionSource

暗号化ソース。

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

EventSource

イベントのソース。

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

CartData

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

JSON 表現 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ],
  "couponCodes": [
    string
  ]
}
フィールド
merchantId

string

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

string

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

string

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

number

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

object (Item)

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

string

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

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

項目

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

JSON 表現 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number,
  "itemId": string,
  "additionalItemParameters": [
    {
      object (ItemParameter)
    }
  ],
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "customVariables": [
    {
      object (ItemCustomVariable)
    }
  ],
  "conversionValue": number
}
フィールド
merchantProductId

string

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

string (int64 format)

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

number

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

string

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

object (ItemParameter)

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

string

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

string

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

string

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

object (ItemCustomVariable)

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

number

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

ItemParameter

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

JSON 表現 
{
  "parameterName": string,
  "value": string
}
フィールド
parameterName

string

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

string

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

ItemCustomVariable

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

JSON 表現 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
フィールド
variable

string

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

string

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

string

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

CustomVariable

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

JSON 表現 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
フィールド
variable

string

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

string

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

string

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

ExperimentalField

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

JSON 表現 
{
  "field": string,
  "value": string
}
フィールド
field

string

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

string

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

UserProperties

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

JSON 表現 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
フィールド
customerType

enum (CustomerType)

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

enum (CustomerValueBucket)

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

object (UserProperty)

省略可。このイベントに関連付けられたユーザーの追加のユーザー プロパティのバケット。

CustomerType

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

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

CustomerValueBucket

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

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

UserProperty

このイベントに関連付けられたユーザーの追加のユーザー プロパティのバケット。

JSON 表現 
{
  "propertyName": string,
  "value": string
}
フィールド
propertyName

string

必須。使用するユーザー プロパティの名前。
value

string

必須。使用するユーザー プロパティの値の文字列表現。

EventParameter

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

JSON 表現 
{
  "parameterName": string,
  "value": string
}
フィールド
parameterName

string

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

string

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

EventLocation

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

JSON 表現 
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
フィールド
storeId

string

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

string

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

string

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

string

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

string

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

string

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

CallInfo

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

JSON 表現 
{
  "startTimestamp": string
}
フィールド
startTimestamp

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" または "2014-10-02T15:01:23+05:30"