Google Ads Events API

The Events API from Google Ads — 1 operation(s) for events.

GitHub OpenAPI

Operations 1

POST /v1/events:ingest Ingest events #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/google-ads:google-ads-events-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

google-ads-events-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Data Manager Events API
  version: v1
  description: Generated from Google's published Discovery document for Data Manager API (datamanager v1, revision 20261106). 1 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://datamanager.googleapis.com
tags:
- name: Events
paths:
  /v1/events:ingest:
    post:
      operationId: datamanager.events.ingest
      summary: Ingest events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IngestEventsRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestEventsResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/datamanager
      - apiKey: []
      tags:
      - Events
components:
  schemas:
    EncryptionInfo:
      properties:
        coordinatorKeyInfo:
          $ref: '#/components/schemas/CoordinatorKeyInfo'
        gcpWrappedKeyInfo:
          $ref: '#/components/schemas/GcpWrappedKeyInfo'
        awsWrappedKeyInfo:
          $ref: '#/components/schemas/AwsWrappedKeyInfo'
      type: object
    Destination:
      properties:
        reference:
          type: string
        productDestinationId:
          type: string
        loginAccount:
          $ref: '#/components/schemas/ProductAccount'
        linkedAccount:
          $ref: '#/components/schemas/ProductAccount'
        operatingAccount:
          $ref: '#/components/schemas/ProductAccount'
      type: object
    ItemCustomVariable:
      type: object
      properties:
        value:
          type: string
        variable:
          type: string
        destinationReferences:
          type: array
          items:
            type: string
    EventLocation:
      properties:
        regionCode:
          type: string
        subcontinentCode:
          type: string
        city:
          type: string
        storeId:
          type: string
        continentCode:
          type: string
        subdivisionCode:
          type: string
      type: object
    EncryptedUserId:
      type: object
      properties:
        entityType:
          type: string
          enum:
          - ENCRYPTION_ENTITY_TYPE_UNSPECIFIED
          - CAMPAIGN_MANAGER_ACCOUNT
          - CAMPAIGN_MANAGER_ADVERTISER
          - DISPLAY_VIDEO_PARTNER
          - DISPLAY_VIDEO_ADVERTISER
          - GOOGLE_ADS_CUSTOMER
          - GOOGLE_AD_MANAGER_NETWORK_CODE
        encryptedId:
          type: string
        entityId:
          format: int64
          type: string
        source:
          type: string
          enum:
          - ENCRYPTION_SOURCE_UNSPECIFIED
          - AD_SERVING
          - DATA_TRANSFER
    ItemParameter:
      type: object
      properties:
        parameterName:
          type: string
        value:
          type: string
    ProductAccount:
      type: object
      properties:
        product:
          type: string
          enum:
          - PRODUCT_UNSPECIFIED
          - GOOGLE_ADS
          - DISPLAY_VIDEO_PARTNER
          - DISPLAY_VIDEO_ADVERTISER
          - DATA_PARTNER
          deprecated: true
        accountId:
          type: string
        accountType:
          type: string
          enum:
          - ACCOUNT_TYPE_UNSPECIFIED
          - GOOGLE_ADS
          - DISPLAY_VIDEO_PARTNER
          - DISPLAY_VIDEO_ADVERTISER
          - DATA_PARTNER
          - GOOGLE_ANALYTICS_PROPERTY
          - GOOGLE_AD_MANAGER_AUDIENCE_LINK
          - FLOODLIGHT_CONFIG
          - GOOGLE_AD_MANAGER
    EventParameter:
      properties:
        value:
          type: string
        parameterName:
          type: string
      type: object
    CoordinatorKeyInfo:
      properties:
        keyId:
          type: string
      type: object
    CallInfo:
      properties:
        startTimestamp:
          type: string
          format: google-datetime
      type: object
    AdIdentifiers:
      properties:
        landingPageDeviceInfo:
          $ref: '#/components/schemas/DeviceInfo'
        impressionId:
          type: string
        ppid:
          type: string
        gbraid:
          type: string
        matchId:
          type: string
        mobileDeviceId:
          type: string
        leadId:
          type: string
        wbraid:
          type: string
        sessionAttributes:
          type: string
        dclid:
          type: string
        gclid:
          type: string
        encryptedUserIds:
          items:
            $ref: '#/components/schemas/EncryptedUserId'
          type: array
        visitorPpid:
          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
    FieldWarning:
      type: object
      properties:
        description:
          type: string
        field:
          type: string
        reason:
          type: string
          enum:
          - WARNING_REASON_UNSPECIFIED
          - WARNING_REASON_CUSTOM_VARIABLE_NOT_ENABLED
          - WARNING_REASON_CUSTOM_VARIABLE_NOT_PREDEFINED
          - WARNING_REASON_CART_DATA_NOT_SUPPORTED_WITH_GBRAID_OR_WBRAID
          - WARNING_REASON_CART_DATA_ITEM_MERCHANT_PRODUCT_ID_MISSING
          - WARNING_REASON_CART_DATA_ITEM_UNIT_PRICE_MISSING
          - WARNING_REASON_GENERIC
          - WARNING_REASON_INVALID_CLIENT_ID
          - WARNING_REASON_INVALID_SUBDIVISION_CODE
          - WARNING_REASON_INVALID_REGION_CODE
          - WARNING_REASON_INVALID_SUBCONTINENT_CODE
          - WARNING_REASON_INVALID_CONTINENT_CODE
          - WARNING_REASON_INVALID_DEVICE_CATEGORY
          - WARNING_REASON_INVALID_DEVICE_SCREEN_RESOLUTION
          - WARNING_REASON_INVALID_MERCHANT_ID
          - WARNING_REASON_INVALID_NUMBER_FORMAT
          - WARNING_REASON_INVALID_SHA256_FORMAT
          - WARNING_REASON_INVALID_MERCHANT_FEED_LANGUAGE_CODE
          - WARNING_REASON_FIELD_VALUE_TOO_LONG
          - WARNING_REASON_FIELD_VALUE_TOO_SHORT
          - WARNING_REASON_VALUE_TOO_HIGH
          - WARNING_REASON_VALUE_TOO_LOW
          - WARNING_REASON_TOO_MANY_ELEMENTS
          - WARNING_REASON_DUPLICATE_ELEMENTS
          - WARNING_REASON_CUSTOM_VARIABLES_NOT_SUPPORTED_WITH_GBRAID_OR_WBRAID
          - WARNING_REASON_ADIDENTIFIER_NOT_USED
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    IngestEventsRequest:
      properties:
        encoding:
          type: string
          enum:
          - ENCODING_UNSPECIFIED
          - HEX
          - BASE64
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
        encryptionInfo:
          $ref: '#/components/schemas/EncryptionInfo'
        consent:
          $ref: '#/components/schemas/Consent'
        destinations:
          items:
            $ref: '#/components/schemas/Destination'
          type: array
        validateOnly:
          type: boolean
      type: object
    UserIdentifier:
      type: object
      properties:
        phoneNumber:
          type: string
        emailAddress:
          type: string
        address:
          $ref: '#/components/schemas/AddressInfo'
    GcpWrappedKeyInfo:
      properties:
        keyType:
          type: string
          enum:
          - KEY_TYPE_UNSPECIFIED
          - XCHACHA20_POLY1305
        kekUri:
          type: string
        wipProvider:
          type: string
        encryptedDek:
          type: string
      type: object
    IngestEventsResponse:
      properties:
        requestId:
          type: string
        fieldWarnings:
          items:
            $ref: '#/components/schemas/FieldWarning'
          type: array
      type: object
    CartData:
      type: object
      properties:
        merchantFeedLanguageCode:
          type: string
        transactionDiscount:
          type: number
          format: double
        couponCodes:
          items:
            type: string
          type: array
        merchantFeedLabel:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item'
        merchantId:
          type: string
    Consent:
      type: object
      properties:
        adUserData:
          type: string
          enum:
          - CONSENT_STATUS_UNSPECIFIED
          - CONSENT_GRANTED
          - CONSENT_DENIED
        adPersonalization:
          type: string
          enum:
          - CONSENT_STATUS_UNSPECIFIED
          - CONSENT_GRANTED
          - CONSENT_DENIED
    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
    Event:
      type: object
      properties:
        thirdPartyUserData:
          $ref: '#/components/schemas/UserData'
        userId:
          type: string
        eventDeviceInfo:
          $ref: '#/components/schemas/DeviceInfo'
        experimentalFields:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentalField'
        consent:
          $ref: '#/components/schemas/Consent'
        cartData:
          $ref: '#/components/schemas/CartData'
        additionalEventParameters:
          items:
            $ref: '#/components/schemas/EventParameter'
          type: array
        eventName:
          type: string
        eventTimestamp:
          type: string
          format: google-datetime
        userData:
          $ref: '#/components/schemas/UserData'
        adIdentifiers:
          $ref: '#/components/schemas/AdIdentifiers'
        appInstanceId:
          type: string
        eventSource:
          type: string
          enum:
          - EVENT_SOURCE_UNSPECIFIED
          - WEB
          - APP
          - IN_STORE
          - PHONE
          - MESSAGE
          - OTHER
        eventLocation:
          $ref: '#/components/schemas/EventLocation'
        customVariables:
          type: array
          items:
            $ref: '#/components/schemas/CustomVariable'
        userProperties:
          $ref: '#/components/schemas/UserProperties'
        destinationReferences:
          items:
            type: string
          type: array
        currency:
          type: string
        conversionValue:
          type: number
          format: double
        callInfo:
          $ref: '#/components/schemas/CallInfo'
        conversionCount:
          format: double
          type: number
        lastUpdatedTimestamp:
          type: string
          format: google-datetime
        transactionId:
          type: string
        clientId:
          type: string
    UserData:
      properties:
        userIdentifiers:
          items:
            $ref: '#/components/schemas/UserIdentifier'
          type: array
      type: object
    Item:
      properties:
        merchantFeedLanguageCode:
          type: string
        itemId:
          type: string
        additionalItemParameters:
          items:
            $ref: '#/components/schemas/ItemParameter'
          type: array
        customVariables:
          type: array
          items:
            $ref: '#/components/schemas/ItemCustomVariable'
        conversionValue:
          type: number
          format: double
        quantity:
          format: int64
          type: string
        merchantId:
          type: string
        merchantFeedLabel:
          type: string
        merchantProductId:
          type: string
        unitPrice:
          format: double
          type: number
      type: object
    UserProperty:
      properties:
        propertyName:
          type: string
        value:
          type: string
      type: object
    UserProperties:
      properties:
        additionalUserProperties:
          type: array
          items:
            $ref: '#/components/schemas/UserProperty'
        customerValueBucket:
          type: string
          enum:
          - CUSTOMER_VALUE_BUCKET_UNSPECIFIED
          - LOW
          - MEDIUM
          - HIGH
        customerType:
          type: string
          enum:
          - CUSTOMER_TYPE_UNSPECIFIED
          - NEW
          - RETURNING
          - REENGAGED
      type: object
    ExperimentalField:
      type: object
      properties:
        field:
          type: string
        value:
          type: string
    CustomVariable:
      properties:
        variable:
          type: string
        destinationReferences:
          items:
            type: string
          type: array
        value:
          type: string
      type: object
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/datamanager: See, edit, create, import, or delete your customer data in Google Ads, Google Marketing Platform (Campaign Manager 360, Search Ads 360, Display & Video 360), and Google Analytics
            https://www.googleapis.com/auth/datamanager.partnerlink: View, create, or delete your partner links in Google Ads, Marketing Platform (Campaign Manager 360, Search Ads 360, Display & Video 360), and Analytics
externalDocs:
  url: https://developers.google.com/data-manager
x-provenance:
  method: harvested
  publisher: Google
  source: https://datamanager.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261106)