Method: adEvents.ingest

Carica un elenco di risorse AdEvent su Google Analytics.

Questa funzionalità è disponibile solo per gli account in una lista consentita.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
Campi
adEvents[]

object (AdEvent)

Obbligatorio. Obbligatorio (almeno 1). Un elenco di eventi pubblicitari.
encryptionInfo

object (EncryptionInfo)

Facoltativo. Informazioni sulle chiavi di crittografia utilizzate per criptare i dati.
validateOnly

boolean

Facoltativo. Se impostato su true, la richiesta viene convalidata, ma non eseguita.

Corpo della risposta

In caso di esito positivo, il corpo della risposta è vuoto.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

AdEvent

Un evento dell'annuncio.

Rappresentazione 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
}
Campi
advertiserId

string

Obbligatorio. L'ID dell'inserzionista per l'evento dell'annuncio.

Deve corrispondere all'ID inviato nel flusso di collegamento.
eventType

enum (EventType)

Obbligatorio. Il tipo di evento.
timestamp

string (Timestamp format)

Obbligatorio. L'ora in cui si è verificato l'evento.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
eventId

string

Facoltativo. Un ID creato e gestito dal chiamante che identifica in modo univoco questo evento.

Obbligatorio se vuoi eliminare i duplicati degli eventi pubblicitari inclusi in più richieste. In caso contrario, questo campo è facoltativo.
userData

object (UserData)

Facoltativo. Più dati forniti dall'utente, che rappresentano l'utente a cui è associato l'evento.

È possibile fornire più istanze dello stesso tipo di dati (ad es. indirizzo email). Più dati vengono forniti, maggiore è la probabilità di trovare una corrispondenza.
deviceInfo

object (DeviceInfo)

Facoltativo. Informazioni raccolte sul dispositivo utilizzato quando si è verificato l'evento dell'annuncio.
mobileDeviceId

string

Facoltativo. L'ID dispositivo a cui è stato pubblicato l'annuncio.
campaignId

string

Obbligatorio. L'ID della campagna associata.
campaignName

string

Obbligatorio. Il nome della campagna associata.
adGroupId

string

Facoltativo. L'ID del gruppo di annunci associato.
adId

string

Facoltativo. L'ID dell'annuncio associato all'interno del gruppo.
adHeight

integer

Facoltativo. L'altezza dell'annuncio in pixel.
adWidth

integer

Facoltativo. La larghezza dell'annuncio in pixel.
regionCode

string

Obbligatorio. Il paese e la suddivisione ISO 3166-2.
source

string

Obbligatorio. La sorgente della piattaforma dell'annuncio, simile alla sorgente di Google Analytics.
medium

string

Obbligatorio. Il mezzo dell'annuncio, simile al mezzo di Google Analytics.
attributionHint

enum (AttributionHint)

Facoltativo. Lo stato di attribuzione presunta del partner per questo evento dell'annuncio.

Questo valore funge solo da indicatore di come è stata eseguita l'attribuzione presunta del partner e non impone un risultato finale nei report.
viewabilityInfo

object (ViewabilityInfo)

Obbligatorio. Dettagli sulla visibilità dell'annuncio pubblicato.

Campo unione event_subtype_oneof. Facoltativo. Classificazione aggiuntiva del tipo di evento dell'annuncio.

Per gestire valori diversi dalle enumerazioni pure, viene accettata una stringa non elaborata. Se possibile, è preferibile utilizzare l'enumerazione. event_subtype_oneof può essere solo uno dei seguenti tipi:
eventSubtype

enum (EventSubtype)

Valore enum per il sottotipo di evento.
eventSubtypeString

string

Valore stringa per il sottotipo di evento.

Campo unione ad_type_oneof. Facoltativo. Il tipo di annuncio pubblicato.

Per gestire valori diversi dalle enumerazioni pure, viene accettata una stringa non elaborata. Se possibile, è preferibile utilizzare l'enumerazione. ad_type_oneof può essere solo uno dei seguenti tipi:
adType

enum (AdType)

Valore enum per il tipo di annuncio.
adTypeString

string

Valore stringa per il tipo di annuncio.

Campo unione ad_format_oneof. Facoltativo. Il tipo di annuncio pubblicato.

Per gestire valori diversi dalle enumerazioni pure, viene accettata una stringa non elaborata. Se possibile, è preferibile utilizzare l'enumerazione. ad_format_oneof può essere solo uno dei seguenti tipi:
adFormat

enum (AdFormat)

Valore enum per il formato dell'annuncio.
adFormatString

string

Valore stringa per il formato dell'annuncio.

Campo unione ad_placement_oneof. Facoltativo. Il posizionamento dell'annuncio pubblicato.

Per gestire valori diversi dalle enumerazioni pure, viene accettata una stringa non elaborata. Se possibile, è preferibile utilizzare l'enumerazione. ad_placement_oneof può essere solo uno dei seguenti tipi:
adPlacement

enum (AdPlacement)

Valore enum per il posizionamento dell'annuncio.
adPlacementString

string

Valore stringa per il posizionamento dell'annuncio.

Campo unione targeting_type_oneof. Facoltativo. Il tipo di targeting utilizzato per pubblicare l'annuncio.

Per gestire valori diversi dalle enumerazioni pure, viene accettata una stringa non elaborata. Se possibile, è preferibile utilizzare l'enumerazione. targeting_type_oneof può essere solo uno dei seguenti tipi:
targetingType

enum (TargetingType)

Valore enum per il tipo di targeting.
targetingTypeString

string

Valore stringa per il tipo di targeting.

Campo unione platform_type_oneof. Facoltativo. Il tipo di piattaforma su cui è stato pubblicato l'annuncio.

Per gestire valori diversi dalle enumerazioni pure, viene accettata una stringa non elaborata. Se possibile, è preferibile utilizzare l'enumerazione. platform_type_oneof può essere solo uno dei seguenti tipi:
platformType

enum (PlatformType)

Valore enum per il tipo di piattaforma.
platformTypeString

string

Valore stringa per il tipo di piattaforma.

Campo unione platform_oneof. Facoltativo. Ulteriori dettagli sulla piattaforma su cui è stato pubblicato l'annuncio.

Per gestire valori diversi dalle enumerazioni pure, viene accettata una stringa non elaborata. Se possibile, è preferibile utilizzare l'enumerazione. platform_oneof può essere solo uno dei seguenti tipi:
platform

enum (Platform)

Valore enum per la piattaforma.
platformString

string

Valore stringa per la piattaforma.
measurementAllowed

boolean

Facoltativo. Indica se la riga può essere utilizzata a fini di misurazione, in conformità alle leggi sulla privacy vigenti all'interno della giurisdizione regionale.

EventType

Il tipo di evento.

Enum
EVENT_TYPE_UNSPECIFIED Tipo di evento non specificato.
EVENT_TYPE_VIEW Visualizza evento.
EVENT_TYPE_CLICK Evento di clic.

EventSubtype

Classificazione aggiuntiva del tipo di evento dell'annuncio.

Enum
EVENT_SUBTYPE_UNSPECIFIED Sottotipo di evento non specificato.
EVENT_SUBTYPE_IMPRESSION Evento impressione.
EVENT_SUBTYPE_ENGAGED_VIEW Evento di visualizzazione "engaged".
EVENT_SUBTYPE_ONSITE_CLICK Evento di clic sul sito.
EVENT_SUBTYPE_OUTBOUND_CLICK Evento di clic in uscita.

AdType

Il tipo di annuncio pubblicato.

Enum
AD_TYPE_UNSPECIFIED Tipo di annuncio non specificato.
AD_TYPE_DISPLAY Annuncio display.
AD_TYPE_TEXT Annuncio di testo.
AD_TYPE_IMAGE Annuncio illustrato.
AD_TYPE_RICH_MEDIA Annuncio rich media.
AD_TYPE_HTML Annuncio HTML.
AD_TYPE_AUDIO Annuncio audio.
AD_TYPE_VIDEO Annuncio video.

AdFormat

Il formato dell'annuncio pubblicato.

Enum
AD_FORMAT_UNSPECIFIED Formato dell'annuncio non specificato.
AD_FORMAT_AR Annuncio AR.
AD_FORMAT_AUDIO Annuncio audio.
AD_FORMAT_BANNER Annuncio banner.
AD_FORMAT_BUMPER Annuncio bumper.
AD_FORMAT_COLLECTION Annuncio raccolta.
AD_FORMAT_IMAGE Annuncio illustrato.
AD_FORMAT_INTERACTIVE Annuncio interattivo.
AD_FORMAT_INTERSTITIAL Annuncio interstitial.
AD_FORMAT_IN_FEED Annuncio in-feed.
AD_FORMAT_IN_STREAM Annuncio in-stream.
AD_FORMAT_IN_STREAM_SKIPPABLE Annuncio in-stream ignorabile.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Annuncio in-stream non ignorabile.
AD_FORMAT_NATIVE Annuncio nativo.
AD_FORMAT_SHORTS Annuncio di Shorts
AD_FORMAT_STORY Annuncio storia.
AD_FORMAT_SPONSORED Annuncio sponsorizzato.
AD_FORMAT_VIDEO Annuncio video.

AdPlacement

Il posizionamento dell'annuncio pubblicato.

Enum
AD_PLACEMENT_UNSPECIFIED Posizionamento dell'annuncio non specificato.
AD_PLACEMENT_DISCOVER Scopri il posizionamento.
AD_PLACEMENT_FEED Posizionamento del feed.
AD_PLACEMENT_HEADER Posizionamento dell'intestazione.
AD_PLACEMENT_HOME Posizionamento nella home page.
AD_PLACEMENT_IN_CONTENT Posizionamento all'interno dei contenuti.
AD_PLACEMENT_PROMOTED Posizionamento promozionale.
AD_PLACEMENT_STORY Posizionamento della storia.

TargetingType

Il tipo di targeting utilizzato per pubblicare l'annuncio.

Enum
TARGETING_TYPE_UNSPECIFIED Tipo di targeting non specificato.
TARGETING_TYPE_AUDIENCE Targeting per pubblico.
TARGETING_TYPE_CONTEXTUAL Targeting contestuale.
TARGETING_TYPE_DEMOGRAPHIC Targeting demografico.
TARGETING_TYPE_DEVICE Targeting per dispositivo.
TARGETING_TYPE_GEO Targeting geografico.
TARGETING_TYPE_INTEREST Targeting per interesse.
TARGETING_TYPE_PURCHASE_INTENT Targeting in base all'intenzione di acquisto.
TARGETING_TYPE_REMARKETING Targeting per il remarketing.

Tipo di piattaforma

Il tipo di piattaforma su cui è stato pubblicato l'annuncio.

Enum
PLATFORM_TYPE_UNSPECIFIED Tipo di piattaforma non specificato.
PLATFORM_TYPE_MOBILE Piattaforma mobile.
PLATFORM_TYPE_DESKTOP Piattaforma desktop.
PLATFORM_TYPE_CTV piattaforma TV connessa a internet (CTV).
PLATFORM_TYPE_PHONE Piattaforma per smartphone.
PLATFORM_TYPE_TABLET Piattaforma tablet.

Piattaforma

Ulteriori dettagli sulla piattaforma su cui è stato pubblicato l'annuncio.

Enum
PLATFORM_UNSPECIFIED Piattaforma non specificata.
PLATFORM_IOS Piattaforma iOS.
PLATFORM_ANDROID Piattaforma Android.
PLATFORM_WEB Piattaforma web.

AttributionHint

Lo stato di attribuzione presunta del partner per questo evento dell'annuncio.

Enum
ATTRIBUTION_HINT_UNSPECIFIED Stato dell'attribuzione sconosciuto.
ATTRIBUTION_HINT_CONVERTED Stato convertito.
ATTRIBUTION_HINT_NOT_CONVERTED Stato Conversione non completata.

ViewabilityInfo

Dettagli sulla visibilità dell'annuncio pubblicato.

Rappresentazione JSON 
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
Campi
viewType

enum (ViewType)

Obbligatorio. Il tipo di evento.
viewablePercent

integer

Facoltativo. La percentuale numerica (0-100) dei pixel visibili.
viewableDuration

string (Duration format)

Facoltativo. Il periodo di tempo durante il quale l'annuncio è stato visibile.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
mediaSkippable

boolean

Facoltativo. Indica se i contenuti multimediali dell'annuncio erano ignorabili o meno.
mediaQuartile

enum (MediaQuartile)

Facoltativo. La quantità di contenuti multimediali riprodotti come quartili discreti.
mediaDuration

string (Duration format)

Facoltativo. La durata dei contenuti multimediali dell'annuncio.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
mediaVolumePercent

integer

Facoltativo. La percentuale numerica (0-100) del volume della riproduzione dei contenuti multimediali.
playbackDuration

string (Duration format)

Facoltativo. La durata della riproduzione dei contenuti multimediali dell'annuncio, indipendentemente dal fatto che fossero visibili o meno.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

ViewType

Il tipo di evento.

Enum
VIEW_TYPE_UNSPECIFIED Tipo di visualizzazione non specificato.
VIEW_TYPE_MRC_VIEWED Visualizzazione MRC.
VIEW_TYPE_MRC_RENDERED MRC rendered.

MediaQuartile

La quantità di contenuti multimediali riprodotti come quartili discreti.

Enum
MEDIA_QUARTILE_UNSPECIFIED Quartile dei media non specificato.
MEDIA_QUARTILE_START Avvia.
MEDIA_QUARTILE_FIRST_QUARTILE Primo quartile.
MEDIA_QUARTILE_MIDPOINT Punto medio.
MEDIA_QUARTILE_THIRD_QUARTILE Terzo quartile.
MEDIA_QUARTILE_COMPLETE Completato.