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,
  "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,
  "conversionValue": 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)

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

string

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

enum (EventSource)

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

object (DeviceInfo)

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

object (CartData)

省略可。イベントに関連付けられたトランザクションとアイテムに関する情報。
customVariables[]

object (CustomVariable)

省略可。コンバージョン コンテナ（コンバージョン アクションまたは FL アクティビティ）に送信する追加のキーと値のペアの情報。
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 アプリ ストリームのアプリ クライアントのユーザー インスタンスの一意の識別子。
conversionValue

number

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

AdIdentifiers

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

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

string

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

string

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

string

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

string

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

object (DeviceInfo)

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

string

省略可。広告主向けのモバイル広告 ID。iOS では IDFA、Android では AdID、その他のプラットフォームでは広告主向けの識別子となります。

DeviceInfo

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

JSON 表現 
{
  "userAgent": string,
  "ipAddress": string,
  "category": string,
  "languageCode": string,
  "screenHeight": integer,
  "screenWidth": integer,
  "operatingSystem": string,
  "operatingSystemVersion": string,
  "model": string,
  "brand": string,
  "browser": string,
  "browserVersion": string
}
フィールド
userAgent

string

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

string

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

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

string

省略可。デバイスのカテゴリ。例: 「パソコン」、「タブレット」、「モバイル」、「スマートテレビ」。
languageCode

string

省略可。デバイスで使用される言語（ISO 639-1 形式）。
screenHeight

integer

省略可。画面の高さ（ピクセル単位）。
screenWidth

integer

省略可。画面の幅（ピクセル単位）。
operatingSystem

string

省略可。デバイスのオペレーティング システムまたはプラットフォーム。
operatingSystemVersion

string

省略可。オペレーティング システムまたはプラットフォームのバージョン。
model

string

省略可。デバイスのモデル。
brand

string

省略可。デバイスのブランド。
browser

string

省略可。ブラウザのブランドまたはタイプ。
browserVersion

string

省略可。ブラウザのバージョン。

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

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

string

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

string

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

string

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

string

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

string

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