Method: adEvents.ingest

Google Analytics'e AdEvent kaynak listesi yükler.

Bu özellik yalnızca izin verilenler listesindeki hesaplarda kullanılabilir.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
Alanlar
adEvents[]

object (AdEvent)

Zorunlu. Zorunlu (en az 1). Reklam etkinliklerinin listesi.
encryptionInfo

object (EncryptionInfo)

İsteğe bağlı. Verileri şifrelemek için kullanılan şifreleme anahtarları hakkında bilgiler. Reklam etkinlikleri UserData içerdiğinde bu alan sağlanmalıdır.
validateOnly
(deprecated)

boolean

İsteğe bağlı. Doğruysa istek doğrulanır ancak yürütülmez.

Yanıt metni

Başarılı olursa yanıt gövdesi boş olur.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

AdEvent

Reklam etkinliği.

JSON gösterimi 
{
  "advertiserId": string,
  "eventType": enum (EventType),
  "timestamp": string,
  "eventId": string,
  "userData": {
    object (UserData)
  },
  "deviceInfo": {
    object (DeviceInfo)
  },
  "ipAddress": string,
  "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)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adType": enum (AdType),
  "adTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platform": enum (Platform),
  "platformString": string
  // End of mutually exclusive fields.
  "measurementAllowed": boolean
}
Alanlar
advertiserId

string

Zorunlu. Reklam etkinliği için reklamverenin kimliği.

Bu değer, bağlantı akışında gönderilen kimlikle eşleşmelidir.
eventType

enum (EventType)

Zorunlu. Etkinliğin türü.
timestamp

string (Timestamp format)

Zorunlu. Etkinliğin gerçekleştiği zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
eventId

string

İsteğe bağlı. Arayan tarafından oluşturulan ve yönetilen, bu etkinliği benzersiz şekilde tanımlayan bir kimlik.

Birden fazla isteğe dahil edilen reklam etkinliklerinin yinelenenlerini kaldırmak istiyorsanız zorunludur. Aksi takdirde bu alan isteğe bağlıdır.
userData

object (UserData)

İsteğe bağlı. Etkinliğin ilişkilendirildiği kullanıcıyı temsil eden, kullanıcı tarafından sağlanan birden fazla veri parçası.

Aynı türde verilerin (ör. e-posta adresi) birden fazla örneğini sağlamak mümkündür. Ne kadar çok veri sağlanırsa eşleşme bulunma olasılığı o kadar yüksek olur.
deviceInfo

object (DeviceInfo)

Zorunlu. Reklam etkinliği gerçekleştiğinde kullanılan cihaz hakkında toplanan bilgiler.
ipAddress

string

İsteğe bağlı. Ölçüm için kullanılan IP adresi. Bu, DeviceInfo.ip_address ile aynı değer olmalıdır. Ölçüm için IP paylaşmak istemiyorsanız boş bırakın.
mobileDeviceId

string

İsteğe bağlı. Reklamın yayınlandığı cihazın cihaz kimliği.
campaignId

string

Zorunlu. İlişkilendirilmiş kampanyanın kimliği.
campaignName

string

Zorunlu. İlişkili kampanyanın adı.
adGroupId

string

İsteğe bağlı. İlişkili reklam grubunun kimliği.
adId

string

İsteğe bağlı. Gruptaki ilişkili reklamın kimliği.
adHeight

integer

İsteğe bağlı. Reklamın piksel cinsinden yüksekliği.
adWidth

integer

İsteğe bağlı. Reklamın piksel cinsinden genişliği.
regionCode

string

İsteğe bağlı. ISO 3166-2 ülke ve alt bölümü.
source

string

Zorunlu. Google Analytics kaynağına benzer şekilde, reklamın platform kaynağı.
medium

string

Zorunlu. Google Analytics aracına benzer şekilde, reklamın aracı.
attributionHint

enum (AttributionHint)

İsteğe bağlı. Bu reklam etkinliği için iş ortağı tarafından varsayılan ilişkilendirme durumu.

Bu yalnızca iş ortağının ilişkilendirmenin nasıl gerçekleştiğini varsaydığına dair bir sinyal olarak işlev görür ve nihai raporlarda bir sonuç dayatmaz.
viewabilityInfo

object (ViewabilityInfo)

Zorunlu. Yayınlanan reklamın görüntülenebilirliğiyle ilgili ayrıntılar.

İsteğe bağlı. Reklam etkinliğinin türüyle ilgili ek sınıflandırma.

Saf numaralandırmalar dışındaki değerleri işlemek için ham dize kabul edilir. Mümkünse enum tercih edilir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
eventSubtype

enum (EventSubtype)

Etkinlik alt türü için sıralama değeri.
eventSubtypeString

string

Etkinlik alt türü için dize değeri.
Karşılıklı olarak hariç tutulan alanların sonu.

İsteğe bağlı. Sunulan reklamın türü.

Saf numaralandırmalar dışındaki değerleri işlemek için ham dize kabul edilir. Mümkünse enum tercih edilir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
adType

enum (AdType)

Reklam türü için enum değeri.
adTypeString

string

Reklam türü için dize değeri.
Karşılıklı olarak hariç tutulan alanların sonu.

İsteğe bağlı. Sunulan reklamın türü.

Saf numaralandırmalar dışındaki değerleri işlemek için ham dize kabul edilir. Mümkünse enum tercih edilir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
adFormat

enum (AdFormat)

Reklam biçimi için numaralandırma değeri.
adFormatString

string

Reklam biçimi için dize değeri.
Karşılıklı olarak hariç tutulan alanların sonu.

İsteğe bağlı. Sunulan reklamın yerleşimi.

Saf numaralandırmalar dışındaki değerleri işlemek için ham dize kabul edilir. Mümkünse enum tercih edilir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
adPlacement

enum (AdPlacement)

Reklam yerleşimi için enum değeri.
adPlacementString

string

Reklam yerleşimi için dize değeri.
Karşılıklı olarak hariç tutulan alanların sonu.

İsteğe bağlı. Reklamı yayınlamak için kullanılan hedefleme türü.

Saf numaralandırmalar dışındaki değerleri işlemek için ham dize kabul edilir. Mümkünse enum tercih edilir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
targetingType

enum (TargetingType)

Hedefleme türü için enum değeri.
targetingTypeString

string

Hedefleme türü için dize değeri.
Karşılıklı olarak hariç tutulan alanların sonu.

İsteğe bağlı. Reklamın yayınlandığı platformun türü.

Saf numaralandırmalar dışındaki değerleri işlemek için ham dize kabul edilir. Mümkünse enum tercih edilir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
platformType

enum (PlatformType)

Platform türü için enum değeri.
platformTypeString

string

Platform türü için dize değeri.
Karşılıklı olarak hariç tutulan alanların sonu.

İsteğe bağlı. Reklamın yayınlandığı platformla ilgili daha fazla ayrıntı.

Saf numaralandırmalar dışındaki değerleri işlemek için ham dize kabul edilir. Mümkünse enum tercih edilir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
platform

enum (Platform)

Platform için numaralandırma değeri.
platformString

string

Platform için dize değeri.
Karşılıklı olarak hariç tutulan alanların sonu.
measurementAllowed

boolean

İsteğe bağlı. Satırın, bölgesel yargı alanındaki geçerli gizlilik yasaları uyarınca ölçüm amacıyla kullanılmasına izin verilip verilmediğini gösterir.

EventType

Etkinliğin türü.

Sıralamalar
EVENT_TYPE_UNSPECIFIED Belirtilmemiş etkinlik türü.
EVENT_TYPE_VIEW Etkinliği görüntüleyin.
EVENT_TYPE_CLICK Tıklama etkinliği.

EventSubtype

Reklam etkinliğinin türüyle ilgili ek sınıflandırma.

Sıralamalar
EVENT_SUBTYPE_UNSPECIFIED Belirtilmemiş etkinlik alt türü.
EVENT_SUBTYPE_IMPRESSION Gösterim etkinliği.
EVENT_SUBTYPE_ENGAGED_VIEW Etkileşimli görüntüleme etkinliği.
EVENT_SUBTYPE_ONSITE_CLICK Site içi tıklama etkinliği.
EVENT_SUBTYPE_OUTBOUND_CLICK Giden tıklama etkinliği.

AdType

Sunulan reklamın türü.

Sıralamalar
AD_TYPE_UNSPECIFIED Belirtilmemiş reklam türü.
AD_TYPE_DISPLAY Görüntülü reklam.
AD_TYPE_TEXT Metin reklam'ı seçin.
AD_TYPE_IMAGE Resim reklam.
AD_TYPE_RICH_MEDIA Rich media reklamı.
AD_TYPE_HTML HTML reklam.
AD_TYPE_AUDIO İşitsel reklam.
AD_TYPE_VIDEO Video reklam.

AdFormat

Yayınlanan reklamın biçimi.

Sıralamalar
AD_FORMAT_UNSPECIFIED Belirtilmemiş reklam biçimi.
AD_FORMAT_AR AR reklamı.
AD_FORMAT_AUDIO İşitsel reklam.
AD_FORMAT_BANNER Banner reklam.
AD_FORMAT_BUMPER Bumper reklam
AD_FORMAT_COLLECTION Koleksiyon reklamı.
AD_FORMAT_IMAGE Resim reklam.
AD_FORMAT_INTERACTIVE Etkileşimli reklam.
AD_FORMAT_INTERSTITIAL Geçiş reklamı.
AD_FORMAT_IN_FEED Feed içi reklam.
AD_FORMAT_IN_STREAM Yayın içi reklam
AD_FORMAT_IN_STREAM_SKIPPABLE Yayın içi atlanabilir reklam.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Yayın içi atlanamayan reklam.
AD_FORMAT_NATIVE Doğal reklam.
AD_FORMAT_SHORTS Shorts reklamı.
AD_FORMAT_STORY Hikaye reklamı.
AD_FORMAT_SPONSORED Sponsorlu reklam.
AD_FORMAT_VIDEO Video reklam.

AdPlacement

Sunulan reklamın yerleşimi.

Sıralamalar
AD_PLACEMENT_UNSPECIFIED Belirtilmemiş reklam yerleşimi.
AD_PLACEMENT_DISCOVER Yerleşimi keşfedin.
AD_PLACEMENT_FEED Feed yerleşimi.
AD_PLACEMENT_HEADER Üstbilgi yerleşimi.
AD_PLACEMENT_HOME Ana sayfa yerleşimi.
AD_PLACEMENT_IN_CONTENT İçeriğe yerleştirme
AD_PLACEMENT_PROMOTED Tanıtılan yerleşim.
AD_PLACEMENT_STORY Yazı yerleşimi.

TargetingType

Reklamı yayınlamak için kullanılan hedefleme türü.

Sıralamalar
TARGETING_TYPE_UNSPECIFIED Belirtilmemiş hedefleme türü.
TARGETING_TYPE_AUDIENCE Kitle hedefleme.
TARGETING_TYPE_CONTEXTUAL İçeriğe dayalı hedefleme
TARGETING_TYPE_DEMOGRAPHIC Demografik hedefleme.
TARGETING_TYPE_DEVICE Cihaz hedefleme
TARGETING_TYPE_GEO Coğrafi hedefleme.
TARGETING_TYPE_INTEREST Kullanıcıların ilgilerine dayalı hedefleme.
TARGETING_TYPE_PURCHASE_INTENT Satın alma amacı hedefleme.
TARGETING_TYPE_REMARKETING Yeniden pazarlama hedeflemesi.

PlatformType

Reklamın yayınlandığı platformun türü.

Sıralamalar
PLATFORM_TYPE_UNSPECIFIED Belirtilmemiş platform türü.
PLATFORM_TYPE_MOBILE Mobil platform.
PLATFORM_TYPE_DESKTOP Masaüstü platformu.
PLATFORM_TYPE_CTV CTV platformu.
PLATFORM_TYPE_PHONE Telefon platformu.
PLATFORM_TYPE_TABLET Tablet platformu.

Platform

Reklamın yayınlandığı platformla ilgili daha fazla ayrıntı.

Sıralamalar
PLATFORM_UNSPECIFIED Platform belirtilmedi.
PLATFORM_IOS iOS platformu.
PLATFORM_ANDROID Android platformu.
PLATFORM_WEB Web platformu.

AttributionHint

Bu reklam etkinliği için iş ortağı tarafından varsayılan ilişkilendirme durumu.

Sıralamalar
ATTRIBUTION_HINT_UNSPECIFIED İlişkilendirme durumu bilinmiyor.
ATTRIBUTION_HINT_CONVERTED Dönüştürüldü durumu.
ATTRIBUTION_HINT_NOT_CONVERTED Dönüştürülmedi durumu.

ViewabilityInfo

Yayınlanan reklamın görüntülenebilirliğiyle ilgili ayrıntılar.

JSON gösterimi 
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
Alanlar
viewType

enum (ViewType)

Zorunlu. Etkinliğin türü.
viewablePercent

integer

İsteğe bağlı. Görüntülenebilir piksellerin sayısal yüzdesi (0-100).
viewableDuration

string (Duration format)

İsteğe bağlı. Reklamın görüntülenebilir olduğu süre.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".
mediaSkippable

boolean

İsteğe bağlı. Reklam medyasının atlanabilir olup olmadığı.
mediaQuartile

enum (MediaQuartile)

İsteğe bağlı. Medyanın ayrı çeyrekler halinde oynatılan kısmı.
mediaDuration

string (Duration format)

İsteğe bağlı. Reklam medyasının süresi.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".
mediaVolumePercent

integer

İsteğe bağlı. Medya oynatmanın ses düzeyinin sayısal yüzdesi (0-100).
playbackDuration

string (Duration format)

İsteğe bağlı. Görüntülenebilir olup olmadığına bakılmaksızın, reklam medyasının oynatma süresi.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".

ViewType

Etkinliğin türü.

Sıralamalar
VIEW_TYPE_UNSPECIFIED Belirtilmemiş görünüm türü.
VIEW_TYPE_MRC_VIEWED MRC tarafından görüntülendi.
VIEW_TYPE_MRC_RENDERED MRC tarafından oluşturulmuş.

MediaQuartile

Medyanın ayrı çeyrekler halinde oynatılan kısmı.

Sıralamalar
MEDIA_QUARTILE_UNSPECIFIED Belirtilmemiş medya dörtte birlik dilimi.
MEDIA_QUARTILE_START Başlat.
MEDIA_QUARTILE_FIRST_QUARTILE İlk çeyrek.
MEDIA_QUARTILE_MIDPOINT Orta nokta.
MEDIA_QUARTILE_THIRD_QUARTILE Üçüncü çeyrek.
MEDIA_QUARTILE_COMPLETE Tamamlandı.