{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-ingest-ad-events-request-schema.json",
  "title": "IngestAdEventsRequest",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-datamanager-ad-events-api-openapi.yml#/components/schemas/IngestAdEventsRequest",
  "type": "object",
  "properties": {
    "encryptionInfo": {
      "$ref": "#/$defs/EncryptionInfo"
    },
    "validateOnly": {
      "type": "boolean",
      "deprecated": true
    },
    "adEvents": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AdEvent"
      }
    }
  },
  "$defs": {
    "AdEvent": {
      "properties": {
        "measurementAllowed": {
          "type": "boolean"
        },
        "adPlacementString": {
          "type": "string"
        },
        "advertiserId": {
          "type": "string"
        },
        "campaignName": {
          "type": "string"
        },
        "mobileDeviceId": {
          "type": "string"
        },
        "campaignId": {
          "type": "string"
        },
        "adTypeString": {
          "type": "string"
        },
        "adFormat": {
          "type": "string",
          "enum": [
            "AD_FORMAT_UNSPECIFIED",
            "AD_FORMAT_AR",
            "AD_FORMAT_AUDIO",
            "AD_FORMAT_BANNER",
            "AD_FORMAT_BUMPER",
            "AD_FORMAT_CAROUSEL",
            "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",
            "AD_FORMAT_STORY",
            "AD_FORMAT_SPONSORED",
            "AD_FORMAT_VIDEO"
          ]
        },
        "eventId": {
          "type": "string"
        },
        "ipAddress": {
          "type": "string"
        },
        "deviceInfo": {
          "$ref": "#/$defs/DeviceInfo"
        },
        "eventType": {
          "type": "string",
          "enum": [
            "EVENT_TYPE_UNSPECIFIED",
            "EVENT_TYPE_VIEW",
            "EVENT_TYPE_CLICK"
          ]
        },
        "regionCode": {
          "type": "string"
        },
        "viewabilityInfo": {
          "$ref": "#/$defs/ViewabilityInfo"
        },
        "targetingTypeString": {
          "type": "string"
        },
        "medium": {
          "type": "string"
        },
        "platformType": {
          "type": "string",
          "enum": [
            "PLATFORM_TYPE_UNSPECIFIED",
            "PLATFORM_TYPE_MOBILE",
            "PLATFORM_TYPE_DESKTOP",
            "PLATFORM_TYPE_CTV",
            "PLATFORM_TYPE_PHONE",
            "PLATFORM_TYPE_TABLET"
          ]
        },
        "adFormatString": {
          "type": "string"
        },
        "timestamp": {
          "type": "string",
          "format": "google-datetime"
        },
        "platform": {
          "type": "string",
          "enum": [
            "PLATFORM_UNSPECIFIED",
            "PLATFORM_IOS",
            "PLATFORM_ANDROID",
            "PLATFORM_WEB"
          ]
        },
        "platformString": {
          "type": "string"
        },
        "adPlacement": {
          "type": "string",
          "enum": [
            "AD_PLACEMENT_UNSPECIFIED",
            "AD_PLACEMENT_DISCOVER",
            "AD_PLACEMENT_FEED",
            "AD_PLACEMENT_FOOTER",
            "AD_PLACEMENT_HEADER",
            "AD_PLACEMENT_HOME",
            "AD_PLACEMENT_IN_CONTENT",
            "AD_PLACEMENT_PROMOTED",
            "AD_PLACEMENT_SEARCH",
            "AD_PLACEMENT_STORY"
          ]
        },
        "attributionHint": {
          "type": "string",
          "enum": [
            "ATTRIBUTION_HINT_UNSPECIFIED",
            "ATTRIBUTION_HINT_CONVERTED",
            "ATTRIBUTION_HINT_NOT_CONVERTED"
          ]
        },
        "adHeight": {
          "type": "integer",
          "format": "int32"
        },
        "eventSubtypeString": {
          "type": "string"
        },
        "adGroupId": {
          "type": "string"
        },
        "source": {
          "type": "string"
        },
        "adId": {
          "type": "string"
        },
        "adWidth": {
          "type": "integer",
          "format": "int32"
        },
        "targetingType": {
          "type": "string",
          "enum": [
            "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"
          ]
        },
        "adType": {
          "type": "string",
          "enum": [
            "AD_TYPE_UNSPECIFIED",
            "AD_TYPE_DISPLAY",
            "AD_TYPE_TEXT",
            "AD_TYPE_IMAGE",
            "AD_TYPE_RICH_MEDIA",
            "AD_TYPE_HTML",
            "AD_TYPE_AUDIO",
            "AD_TYPE_VIDEO"
          ]
        },
        "userData": {
          "$ref": "#/$defs/UserData"
        },
        "platformTypeString": {
          "type": "string"
        },
        "eventSubtype": {
          "type": "string",
          "enum": [
            "EVENT_SUBTYPE_UNSPECIFIED",
            "EVENT_SUBTYPE_IMPRESSION",
            "EVENT_SUBTYPE_ENGAGED_VIEW",
            "EVENT_SUBTYPE_ONSITE_CLICK",
            "EVENT_SUBTYPE_OUTBOUND_CLICK"
          ]
        }
      },
      "type": "object"
    },
    "AddressInfo": {
      "properties": {
        "addressLine": {
          "type": "string"
        },
        "familyName": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "administrativeArea": {
          "type": "string"
        },
        "regionCode": {
          "type": "string"
        },
        "givenName": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "AwsWrappedKeyInfo": {
      "properties": {
        "encryptedDek": {
          "type": "string"
        },
        "kekUri": {
          "type": "string"
        },
        "roleArn": {
          "type": "string"
        },
        "keyType": {
          "type": "string",
          "enum": [
            "KEY_TYPE_UNSPECIFIED",
            "XCHACHA20_POLY1305"
          ]
        }
      },
      "type": "object"
    },
    "CoordinatorKeyInfo": {
      "properties": {
        "keyId": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "DeviceInfo": {
      "type": "object",
      "properties": {
        "brand": {
          "type": "string"
        },
        "languageCode": {
          "type": "string"
        },
        "browserVersion": {
          "type": "string"
        },
        "ipAddress": {
          "type": "string"
        },
        "model": {
          "type": "string"
        },
        "screenHeight": {
          "format": "int32",
          "type": "integer"
        },
        "operatingSystem": {
          "type": "string"
        },
        "screenWidth": {
          "type": "integer",
          "format": "int32"
        },
        "userAgent": {
          "type": "string"
        },
        "category": {
          "type": "string"
        },
        "operatingSystemVersion": {
          "type": "string"
        },
        "browser": {
          "type": "string"
        }
      }
    },
    "EncryptionInfo": {
      "properties": {
        "coordinatorKeyInfo": {
          "$ref": "#/$defs/CoordinatorKeyInfo"
        },
        "gcpWrappedKeyInfo": {
          "$ref": "#/$defs/GcpWrappedKeyInfo"
        },
        "awsWrappedKeyInfo": {
          "$ref": "#/$defs/AwsWrappedKeyInfo"
        }
      },
      "type": "object"
    },
    "GcpWrappedKeyInfo": {
      "properties": {
        "keyType": {
          "type": "string",
          "enum": [
            "KEY_TYPE_UNSPECIFIED",
            "XCHACHA20_POLY1305"
          ]
        },
        "kekUri": {
          "type": "string"
        },
        "wipProvider": {
          "type": "string"
        },
        "encryptedDek": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "UserData": {
      "properties": {
        "userIdentifiers": {
          "items": {
            "$ref": "#/$defs/UserIdentifier"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "UserIdentifier": {
      "type": "object",
      "properties": {
        "phoneNumber": {
          "type": "string"
        },
        "emailAddress": {
          "type": "string"
        },
        "address": {
          "$ref": "#/$defs/AddressInfo"
        }
      }
    },
    "ViewabilityInfo": {
      "type": "object",
      "properties": {
        "mediaVolumePercent": {
          "format": "int32",
          "type": "integer"
        },
        "viewablePercent": {
          "format": "int32",
          "type": "integer"
        },
        "mediaDuration": {
          "type": "string",
          "format": "google-duration"
        },
        "mediaSkippable": {
          "type": "boolean"
        },
        "viewableDuration": {
          "format": "google-duration",
          "type": "string"
        },
        "playbackDuration": {
          "format": "google-duration",
          "type": "string"
        },
        "viewType": {
          "type": "string",
          "enum": [
            "VIEW_TYPE_UNSPECIFIED",
            "VIEW_TYPE_MRC_VIEWED",
            "VIEW_TYPE_MRC_RENDERED"
          ]
        },
        "mediaQuartile": {
          "type": "string",
          "enum": [
            "MEDIA_QUARTILE_UNSPECIFIED",
            "MEDIA_QUARTILE_START",
            "MEDIA_QUARTILE_FIRST_QUARTILE",
            "MEDIA_QUARTILE_MIDPOINT",
            "MEDIA_QUARTILE_THIRD_QUARTILE",
            "MEDIA_QUARTILE_COMPLETE"
          ]
        }
      }
    }
  }
}