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 の場合、これは外側の暗号化文字列のエンコード タイプですが、内側のハッシュ化文字列のエンコード タイプとは限りません。つまり、内側のハッシュ化文字列は外側の暗号化文字列とは異なる方法でエンコードされる可能性があります。UserData 以外のアップロードの場合、このフィールドは無視されます。
encryptionInfo

object (EncryptionInfo)

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

レスポンスの本文

IngestEventsRequest からのレスポンス。

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

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

string

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

認可スコープ

次の 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,
  "conversionValue": number,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  }
}
フィールド
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)

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

string

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

number

省略可。価値に基づくコンバージョンについて、イベントに関連付けられたコンバージョン値。
eventSource

enum (EventSource)

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

object (DeviceInfo)

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

object (CartData)

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

object (CustomVariable)

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

object (ExperimentalField)

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

object (UserProperties)

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

AdIdentifiers

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

JSON 表現 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  }
}
フィールド
sessionAttributes

string

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

string

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

string

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

string

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

object (DeviceInfo)

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

DeviceInfo

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

JSON 表現 
{
  "userAgent": string,
  "ipAddress": string
}
フィールド
userAgent

string

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

string

省略可。特定のコンテキストにおけるデバイスの IP アドレス。

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

EventSource

イベントのソース。

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

CartData

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

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

string

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

string

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

string

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

number

省略可。トランザクションに関連付けられたすべての割引の合計。
items[]

object (Item)

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

項目

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

JSON 表現 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number
}
フィールド
merchantProductId

string

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

string (int64 format)

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

number

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

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)
}
フィールド
customerType

enum (CustomerType)

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

enum (CustomerValueBucket)

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

CustomerType

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

列挙型
CUSTOMER_TYPE_UNSPECIFIED CustomerType が指定されていません。使用しないでください。
NEW お客様が広告主様の新規顧客である。
RETURNING お客様が広告主に返品している。
REENGAGED お客様が広告主に再アプローチした。

CustomerValueBucket

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

列挙型
CUSTOMER_VALUE_BUCKET_UNSPECIFIED 未指定の CustomerValueBucket。使用しないでください。
LOW お客様の価値が低い。
MEDIUM お客様は中程度の価値があります。
HIGH お客様は価値の高いユーザーです。