Method: adEvents.ingest

AdEvent リソースのリストを Google アナリティクスにアップロードします。

この機能は、許可リストに登録されているアカウントでのみ利用できます。

HTTP リクエスト

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

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

リクエストの本文

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

JSON 表現 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
フィールド
adEvents[]

object (AdEvent)

必須。必須（少なくとも 1 つ）。広告イベントのリスト。
encryptionInfo

object (EncryptionInfo)

省略可。データの暗号化に使用される暗号鍵に関する情報。
validateOnly

boolean

省略可。true の場合、リクエストは検証されますが、実行されません。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

認可スコープ

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

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

AdEvent

広告イベント。

JSON 表現 
{
  "advertiserId": string,
  "eventType": enum (EventType),
  "timestamp": string,
  "eventId": string,
  "userData": {
    object (UserData)
  },
  "deviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "campaignId": string,
  "campaignName": string,
  "adGroupId": string,
  "adId": string,
  "adHeight": integer,
  "adWidth": integer,
  "regionCode": string,
  "source": string,
  "medium": string,
  "attributionHint": enum (AttributionHint),
  "viewabilityInfo": {
    object (ViewabilityInfo)
  },

  // Union field event_subtype_oneof can be only one of the following:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of list of possible types for union field event_subtype_oneof.

  // Union field ad_type_oneof can be only one of the following:
  "adType": enum (AdType),
  "adTypeString": string
  // End of list of possible types for union field ad_type_oneof.

  // Union field ad_format_oneof can be only one of the following:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of list of possible types for union field ad_format_oneof.

  // Union field ad_placement_oneof can be only one of the following:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of list of possible types for union field ad_placement_oneof.

  // Union field targeting_type_oneof can be only one of the following:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of list of possible types for union field targeting_type_oneof.

  // Union field platform_type_oneof can be only one of the following:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of list of possible types for union field platform_type_oneof.

  // Union field platform_oneof can be only one of the following:
  "platform": enum (Platform),
  "platformString": string
  // End of list of possible types for union field platform_oneof.
  "measurementAllowed": boolean
}
フィールド
advertiserId

string

必須。広告イベントの広告主の ID。

これは、リンクフローで送信された ID と一致している必要があります。
eventType

enum (EventType)

必須。イベントのタイプ。
timestamp

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"。
eventId

string

省略可。このイベントを一意に識別する、呼び出し元が作成して管理する ID。

複数のリクエストに含まれる広告イベントを重複除去する場合は必須です。それ以外の場合は省略可能です。
userData

object (UserData)

省略可。イベントに関連付けられているユーザーを表す、複数のユーザー提供データ。

同じ種類のデータ（メールアドレスなど）を複数指定できます。指定するデータが多いほど、一致する可能性が高くなります。
deviceInfo

object (DeviceInfo)

省略可。広告イベントが発生したときに使用されていたデバイスに関する情報。
mobileDeviceId

string

省略可。広告が配信されたデバイスのデバイス ID。
campaignId

string

必須。関連付けられたキャンペーンの ID。
campaignName

string

必須。関連付けられたキャンペーンの名前。
adGroupId

string

省略可。関連付けられた広告グループの ID。
adId

string

省略可。グループ内の関連付けられた広告の ID。
adHeight

integer

省略可。広告の高さ（ピクセル単位）。
adWidth

integer

省略可。広告の幅（ピクセル単位）。
regionCode

string

必須。ISO 3166-2 の国と地域。
source

string

必須。Google アナリティクスの参照元に似た、広告のプラットフォーム参照元。
medium

string

必須。Google アナリティクスのメディアと同様に、広告のメディア。
attributionHint

enum (AttributionHint)

省略可。この広告イベントのパートナーが想定するアトリビューション ステータス。

これは、パートナーが想定したアトリビューションがどのように機能したかを示すシグナルとしてのみ機能し、最終レポートで最終結果を強制することはありません。
viewabilityInfo

object (ViewabilityInfo)

必須。配信された広告の視認性の詳細。

共用体フィールド event_subtype_oneof。省略可。広告イベントのタイプに関する追加の分類。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。event_subtype_oneof は次のいずれかになります。
eventSubtype

enum (EventSubtype)

イベント サブタイプの列挙値。
eventSubtypeString

string

イベント サブタイプの文字列値。

共用体フィールド ad_type_oneof。省略可。配信された広告のタイプ。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。ad_type_oneof は次のいずれかになります。
adType

enum (AdType)

広告タイプの列挙値。
adTypeString

string

広告タイプの文字列値。

共用体フィールド ad_format_oneof。省略可。配信された広告のタイプ。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。ad_format_oneof は次のいずれかになります。
adFormat

enum (AdFormat)

広告フォーマットの列挙値。
adFormatString

string

広告フォーマットの文字列値。

共用体フィールド ad_placement_oneof。省略可。配信された広告のプレースメント。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。ad_placement_oneof は次のいずれかになります。
adPlacement

enum (AdPlacement)

広告プレースメントの列挙値。
adPlacementString

string

広告プレースメントの文字列値。

共用体フィールド targeting_type_oneof。省略可。広告の配信に使用されたターゲティングのタイプ。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。targeting_type_oneof は次のいずれかになります。
targetingType

enum (TargetingType)

ターゲティング タイプの列挙値。
targetingTypeString

string

ターゲティング タイプの文字列値。

共用体フィールド platform_type_oneof。省略可。広告が配信されたプラットフォームのタイプ。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。platform_type_oneof は次のいずれかになります。
platformType

enum (PlatformType)

プラットフォーム タイプの列挙値。
platformTypeString

string

プラットフォーム タイプの文字列値。

共用体フィールド platform_oneof。省略可。広告が配信されたプラットフォームの詳細。

純粋な列挙型以外の値を処理するために、未加工の文字列が受け入れられます。可能であれば、列挙型を使用することをおすすめします。platform_oneof は次のいずれかになります。
platform

enum (Platform)

プラットフォームの列挙値。
platformString

string

プラットフォームの文字列値。
measurementAllowed

boolean

省略可。地域の管轄内の適用されるプライバシー法に準拠して、行を測定目的で使用できるかどうかを表します。

EventType

イベントのタイプ。

列挙型
EVENT_TYPE_UNSPECIFIED イベントタイプが指定されていません。
EVENT_TYPE_VIEW イベントを表示します。
EVENT_TYPE_CLICK クリック イベント。

EventSubtype

広告イベントのタイプに関する追加の分類。

列挙型
EVENT_SUBTYPE_UNSPECIFIED イベントのサブタイプが指定されていません。
EVENT_SUBTYPE_IMPRESSION インプレッション イベント。
EVENT_SUBTYPE_ENGAGED_VIEW エンゲージ ビュー イベント。
EVENT_SUBTYPE_ONSITE_CLICK サイト内クリック イベント。
EVENT_SUBTYPE_OUTBOUND_CLICK 離脱クリック イベント。

AdType

配信された広告のタイプ。

列挙型
AD_TYPE_UNSPECIFIED 広告タイプが指定されていません。
AD_TYPE_DISPLAY ディスプレイ広告。
AD_TYPE_TEXT テキスト広告] を選択します。
AD_TYPE_IMAGE イメージ広告。
AD_TYPE_RICH_MEDIA リッチメディア広告。
AD_TYPE_HTML HTML 広告。
AD_TYPE_AUDIO オーディオ広告。
AD_TYPE_VIDEO 動画広告。

AdFormat

配信された広告のフォーマット。

列挙型
AD_FORMAT_UNSPECIFIED 広告フォーマットが指定されていません。
AD_FORMAT_AR AR 広告。
AD_FORMAT_AUDIO オーディオ広告。
AD_FORMAT_BANNER バナー広告。
AD_FORMAT_BUMPER バンパー広告。
AD_FORMAT_COLLECTION コレクションの広告。
AD_FORMAT_IMAGE イメージ広告。
AD_FORMAT_INTERACTIVE インタラクティブ広告。
AD_FORMAT_INTERSTITIAL インタースティシャル広告。
AD_FORMAT_IN_FEED インフィード広告。
AD_FORMAT_IN_STREAM インストリーム広告。
AD_FORMAT_IN_STREAM_SKIPPABLE スキップ可能なインストリーム広告。
AD_FORMAT_IN_STREAM_NON_SKIPPABLE インストリーム スキップ不可広告。
AD_FORMAT_NATIVE ネイティブ広告。
AD_FORMAT_SHORTS YouTube ショート広告。
AD_FORMAT_STORY ストーリー広告。
AD_FORMAT_SPONSORED スポンサー広告。
AD_FORMAT_VIDEO 動画広告。

AdPlacement

配信された広告のプレースメント。

列挙型
AD_PLACEMENT_UNSPECIFIED 広告プレースメントが指定されていません。
AD_PLACEMENT_DISCOVER プレースメントの検出。
AD_PLACEMENT_FEED フィードの配置。
AD_PLACEMENT_HEADER ヘッダーの配置。
AD_PLACEMENT_HOME ホームの配置。
AD_PLACEMENT_IN_CONTENT インコンテンツ プレースメント。
AD_PLACEMENT_PROMOTED プロモーションの掲載位置。
AD_PLACEMENT_STORY ストーリーの配置。

TargetingType

広告の配信に使用されたターゲティングのタイプ。

列挙型
TARGETING_TYPE_UNSPECIFIED ターゲティング タイプが指定されていません。
TARGETING_TYPE_AUDIENCE オーディエンス ターゲティング。
TARGETING_TYPE_CONTEXTUAL コンテンツ ターゲティング。
TARGETING_TYPE_DEMOGRAPHIC 年齢や性別によるターゲティング。
TARGETING_TYPE_DEVICE デバイス ターゲティング。
TARGETING_TYPE_GEO 地域ターゲティング。
TARGETING_TYPE_INTEREST インタレスト ターゲティング。
TARGETING_TYPE_PURCHASE_INTENT 購入意向に基づくターゲティング。
TARGETING_TYPE_REMARKETING リマーケティング ターゲティング。

PlatformType

広告が配信されたプラットフォームのタイプ。

列挙型
PLATFORM_TYPE_UNSPECIFIED プラットフォーム タイプが指定されていません。
PLATFORM_TYPE_MOBILE モバイル プラットフォーム。
PLATFORM_TYPE_DESKTOP デスクトップ プラットフォーム。
PLATFORM_TYPE_CTV CTV プラットフォーム。
PLATFORM_TYPE_PHONE 電話プラットフォーム。
PLATFORM_TYPE_TABLET タブレット プラットフォーム。

プラットフォーム

広告が配信されたプラットフォームの詳細。

列挙型
PLATFORM_UNSPECIFIED プラットフォームが指定されていません。
PLATFORM_IOS iOS プラットフォーム。
PLATFORM_ANDROID Android プラットフォーム。
PLATFORM_WEB ウェブ プラットフォーム。

AttributionHint

この広告イベントのパートナーが想定するアトリビューション ステータス。

列挙型
ATTRIBUTION_HINT_UNSPECIFIED アトリビューション ステータスが不明です。
ATTRIBUTION_HINT_CONVERTED 変換済みのステータス。
ATTRIBUTION_HINT_NOT_CONVERTED 未変換のステータス。

ViewabilityInfo

配信された広告の視認性の詳細。

JSON 表現 
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
フィールド
viewType

enum (ViewType)

必須。イベントのタイプ。
viewablePercent

integer

省略可。視認可能だったピクセルの割合（0 ～ 100）を示す数値。
viewableDuration

string (Duration format)

省略可。広告が視認可能だった時間の長さ。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
mediaSkippable

boolean

省略可。広告メディアがスキップ可能かどうか。
mediaQuartile

enum (MediaQuartile)

省略可。メディアが再生された量を 4 分割した値。
mediaDuration

string (Duration format)

省略可。広告メディアの長さ。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
mediaVolumePercent

integer

省略可。メディア再生の音量の数値パーセント（0 ～ 100）。
playbackDuration

string (Duration format)

省略可。広告メディアの再生時間（視認可能かどうかは関係なし）。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

ViewType

イベントのタイプ。

列挙型
VIEW_TYPE_UNSPECIFIED ビュータイプが指定されていません。
VIEW_TYPE_MRC_VIEWED MRC 閲覧済み。
VIEW_TYPE_MRC_RENDERED MRC レンダリング。

MediaQuartile

メディアが再生された量を 4 分割した値。

列挙型
MEDIA_QUARTILE_UNSPECIFIED メディアの四分位数が指定されていません。
MEDIA_QUARTILE_START 開始] をタップします。
MEDIA_QUARTILE_FIRST_QUARTILE 第 1 四分位。
MEDIA_QUARTILE_MIDPOINT 中間点。
MEDIA_QUARTILE_THIRD_QUARTILE 第 3 四分位。
MEDIA_QUARTILE_COMPLETE 完全である。