Method: adEvents.ingest

यह फ़ंक्शन, Google Analytics में AdEvent संसाधनों की सूची अपलोड करता है.

यह सुविधा सिर्फ़ उन खातों के लिए उपलब्ध है जिन्हें अनुमति दी गई है.

एचटीटीपी अनुरोध

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

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
फ़ील्ड
adEvents[]

object (AdEvent)

ज़रूरी है. ज़रूरी है (कम से कम एक). विज्ञापन इवेंट की सूची.
encryptionInfo

object (EncryptionInfo)

ज़रूरी नहीं. डेटा को एन्क्रिप्ट (सुरक्षित) करने के लिए इस्तेमाल की जाने वाली एन्क्रिप्शन कुंजियों के बारे में जानकारी. अगर विज्ञापन इवेंट में UserData शामिल है, तो इस फ़ील्ड की वैल्यू देना ज़रूरी है.
validateOnly
(deprecated)

boolean

ज़रूरी नहीं. अगर यह सही है, तो अनुरोध की पुष्टि की जाती है, लेकिन उसे पूरा नहीं किया जाता.

जवाब का मुख्य भाग

अगर अनुरोध पूरा हो जाता है, तो जवाब का मुख्य हिस्सा खाली होता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

AdEvent

विज्ञापन का इवेंट.

JSON के काेड में दिखाना 
{
  "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
}
फ़ील्ड
advertiserId

string

ज़रूरी है. विज्ञापन के इवेंट के लिए, विज्ञापन देने वाले व्यक्ति या कंपनी का आईडी.

यह आईडी, खाते लिंक करने के फ़्लो में भेजे गए आईडी से मेल खाना चाहिए.
eventType

enum (EventType)

ज़रूरी है. इवेंट का टाइप.
timestamp

string (Timestamp format)

ज़रूरी है. इवेंट होने का समय.

यह आरएफ़सी 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

ज़रूरी नहीं. यह आईडी, कॉल करने वाला व्यक्ति बनाता और मैनेज करता है. यह आईडी, इस इवेंट की यूनीक पहचान करता है.

अगर आपको एक से ज़्यादा अनुरोधों में शामिल विज्ञापन इवेंट से डुप्लीकेट इवेंट हटाने हैं, तो यह पैरामीटर ज़रूरी है. हालांकि, यह फ़ील्ड ज़रूरी नहीं है.
userData

object (UserData)

ज़रूरी नहीं. उपयोगकर्ता से मिले डेटा के कई हिस्से, जिनसे यह पता चलता है कि इवेंट किस उपयोगकर्ता से जुड़ा है.

एक ही तरह के डेटा के कई इंस्टेंस दिए जा सकते हैं. उदाहरण के लिए, ईमेल पता. जितना ज़्यादा डेटा दिया जाएगा, मैच मिलने की संभावना उतनी ही ज़्यादा होगी.
deviceInfo

object (DeviceInfo)

ज़रूरी है. विज्ञापन इवेंट के दौरान इस्तेमाल किए जा रहे डिवाइस के बारे में इकट्ठा की गई जानकारी.
ipAddress

string

ज़रूरी नहीं. मेज़रमेंट के लिए इस्तेमाल किया गया आईपी पता. यह DeviceInfo.ip_address के बराबर होना चाहिए. अगर आपको मेज़रमेंट के लिए आईपी पता शेयर नहीं करना है, तो इसे खाली छोड़ दें.
mobileDeviceId

string

ज़रूरी नहीं. जिस डिवाइस पर विज्ञापन दिखाया गया था उसका डिवाइस आईडी.
campaignId

string

ज़रूरी है. जुड़े हुए कैंपेन का आईडी.
campaignName

string

ज़रूरी है. इससे जुड़े कैंपेन का नाम.
adGroupId

string

ज़रूरी नहीं. विज्ञापन ग्रुप का आईडी.
adId

string

ज़रूरी नहीं. ग्रुप में मौजूद विज्ञापन का आईडी.
adHeight

integer

ज़रूरी नहीं. पिक्सल में विज्ञापन की ऊंचाई.
adWidth

integer

ज़रूरी नहीं. पिक्सल में विज्ञापन की चौड़ाई.
regionCode

string

ज़रूरी नहीं. ISO 3166-2 के मुताबिक देश और सबडिविज़न.
source

string

ज़रूरी है. विज्ञापन का प्लैटफ़ॉर्म सोर्स, जो Google Analytics के सोर्स जैसा होता है.
medium

string

ज़रूरी है. विज्ञापन का मीडियम, जो Google Analytics के मीडियम जैसा होता है.
attributionHint

enum (AttributionHint)

ज़रूरी नहीं. इस विज्ञापन के इवेंट के लिए, पार्टनर के हिसाब से एट्रिब्यूशन की स्थिति.

यह सिर्फ़ एक सिग्नल के तौर पर काम करता है, जिससे यह पता चलता है कि पार्टनर ने एट्रिब्यूशन को किस तरह से माना है. साथ ही, यह फ़ाइनल रिपोर्ट में किसी नतीजे को लागू नहीं करता.
viewabilityInfo

object (ViewabilityInfo)

ज़रूरी है. दिखाए गए विज्ञापन के दिखने की संभावना के बारे में जानकारी.

ज़रूरी नहीं. विज्ञापन इवेंट के टाइप के बारे में अतिरिक्त क्लासिफ़िकेशन.

प्योर एनम के अलावा अन्य वैल्यू को हैंडल करने के लिए, रॉ स्ट्रिंग स्वीकार की जाती है. अगर हो सके, तो enum का इस्तेमाल करें. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
eventSubtype

enum (EventSubtype)

इवेंट के सबटाइप के लिए, सूची में दी गई वैल्यू.
eventSubtypeString

string

इवेंट के सबटाइप के लिए स्ट्रिंग वैल्यू.
एक-दूसरे से अलग फ़ील्ड के आखिर में.

ज़रूरी नहीं. दिखाए गए विज्ञापन का टाइप.

प्योर एनम के अलावा अन्य वैल्यू को हैंडल करने के लिए, रॉ स्ट्रिंग स्वीकार की जाती है. अगर हो सके, तो enum का इस्तेमाल करें. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
adType

enum (AdType)

विज्ञापन के टाइप के लिए enum वैल्यू.
adTypeString

string

विज्ञापन के टाइप के लिए स्ट्रिंग वैल्यू.
एक-दूसरे से अलग फ़ील्ड के आखिर में.

ज़रूरी नहीं. दिखाए गए विज्ञापन का टाइप.

प्योर एनम के अलावा अन्य वैल्यू को हैंडल करने के लिए, रॉ स्ट्रिंग स्वीकार की जाती है. अगर हो सके, तो enum का इस्तेमाल करें. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
adFormat

enum (AdFormat)

विज्ञापन फ़ॉर्मैट के लिए enum वैल्यू.
adFormatString

string

विज्ञापन फ़ॉर्मैट के लिए स्ट्रिंग वैल्यू.
एक-दूसरे से अलग फ़ील्ड के आखिर में.

ज़रूरी नहीं. दिखाए गए विज्ञापन का प्लेसमेंट.

प्योर एनम के अलावा अन्य वैल्यू को हैंडल करने के लिए, रॉ स्ट्रिंग स्वीकार की जाती है. अगर हो सके, तो enum का इस्तेमाल करें. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
adPlacement

enum (AdPlacement)

विज्ञापन प्लेसमेंट के लिए enum वैल्यू.
adPlacementString

string

विज्ञापन प्लेसमेंट के लिए स्ट्रिंग वैल्यू.
एक-दूसरे से अलग फ़ील्ड के आखिर में.

ज़रूरी नहीं. विज्ञापन दिखाने के लिए इस्तेमाल की गई टारगेटिंग का टाइप.

प्योर एनम के अलावा अन्य वैल्यू को हैंडल करने के लिए, रॉ स्ट्रिंग स्वीकार की जाती है. अगर हो सके, तो enum का इस्तेमाल करें. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
targetingType

enum (TargetingType)

टारगेटिंग टाइप के लिए enum वैल्यू.
targetingTypeString

string

टारगेटिंग टाइप के लिए स्ट्रिंग वैल्यू.
एक-दूसरे से अलग फ़ील्ड के आखिर में.

ज़रूरी नहीं. विज्ञापन दिखाने वाले प्लैटफ़ॉर्म का टाइप.

प्योर एनम के अलावा अन्य वैल्यू को हैंडल करने के लिए, रॉ स्ट्रिंग स्वीकार की जाती है. अगर हो सके, तो enum का इस्तेमाल करें. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
platformType

enum (PlatformType)

प्लैटफ़ॉर्म टाइप के लिए ईनम वैल्यू.
platformTypeString

string

प्लैटफ़ॉर्म टाइप के लिए स्ट्रिंग वैल्यू.
एक-दूसरे से अलग फ़ील्ड के आखिर में.

ज़रूरी नहीं. उस प्लैटफ़ॉर्म के बारे में ज़्यादा जानकारी जिस पर विज्ञापन दिखाया गया था.

प्योर एनम के अलावा अन्य वैल्यू को हैंडल करने के लिए, रॉ स्ट्रिंग स्वीकार की जाती है. अगर हो सके, तो enum का इस्तेमाल करें. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
platform

enum (Platform)

प्लैटफ़ॉर्म के लिए enum वैल्यू.
platformString

string

प्लैटफ़ॉर्म के लिए स्ट्रिंग वैल्यू.
एक-दूसरे से अलग फ़ील्ड के आखिर में.
measurementAllowed

boolean

ज़रूरी नहीं. इससे पता चलता है कि क्या लाइन का इस्तेमाल मेज़रमेंट के लिए किया जा सकता है. यह इस बात से नियंत्रित होता है कि क्षेत्र के अधिकार क्षेत्र में लागू होने वाले निजता कानून क्या कहते हैं.

EventType

इवेंट का टाइप.

Enums
EVENT_TYPE_UNSPECIFIED इवेंट किस तरह का है, इसकी जानकारी नहीं है.
EVENT_TYPE_VIEW इवेंट देखें.
EVENT_TYPE_CLICK इवेंट पर क्लिक करें.

EventSubtype

विज्ञापन इवेंट के टाइप के बारे में अतिरिक्त क्लासिफ़िकेशन.

Enums
EVENT_SUBTYPE_UNSPECIFIED इवेंट के सबटाइप की जानकारी नहीं दी गई है.
EVENT_SUBTYPE_IMPRESSION इंप्रेशन इवेंट.
EVENT_SUBTYPE_ENGAGED_VIEW जुड़ाव वाला व्यू इवेंट.
EVENT_SUBTYPE_ONSITE_CLICK साइट पर क्लिक करने से जुड़ा इवेंट.
EVENT_SUBTYPE_OUTBOUND_CLICK आउटबाउंड क्लिक इवेंट.

AdType

दिखाए गए विज्ञापन का टाइप.

Enums
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 वीडियो विज्ञापन.

AdFormat

दिखाए गए विज्ञापन का फ़ॉर्मैट.

Enums
AD_FORMAT_UNSPECIFIED विज्ञापन फ़ॉर्मैट की जानकारी नहीं दी गई है.
AD_FORMAT_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 Shorts में दिखने वाला विज्ञापन.
AD_FORMAT_STORY कहानी विज्ञापन.
AD_FORMAT_SPONSORED प्रायोजित विज्ञापन.
AD_FORMAT_VIDEO वीडियो विज्ञापन.

AdPlacement

दिखाए गए विज्ञापन का प्लेसमेंट.

Enums
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

विज्ञापन दिखाने के लिए इस्तेमाल की गई टारगेटिंग का टाइप.

Enums
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

विज्ञापन दिखाने वाले प्लैटफ़ॉर्म का टाइप.

Enums
PLATFORM_TYPE_UNSPECIFIED प्लैटफ़ॉर्म के टाइप की जानकारी नहीं दी गई है.
PLATFORM_TYPE_MOBILE मोबाइल प्लैटफ़ॉर्म.
PLATFORM_TYPE_DESKTOP डेस्कटॉप प्लैटफ़ॉर्म.
PLATFORM_TYPE_CTV सीटीवी प्लैटफ़ॉर्म.
PLATFORM_TYPE_PHONE फ़ोन प्लैटफ़ॉर्म.
PLATFORM_TYPE_TABLET टैबलेट प्लैटफ़ॉर्म.

प्लैटफ़ॉर्म

उस प्लैटफ़ॉर्म के बारे में ज़्यादा जानकारी जिस पर विज्ञापन दिखाया गया था.

Enums
PLATFORM_UNSPECIFIED प्लैटफ़ॉर्म की जानकारी नहीं दी गई है.
PLATFORM_IOS iOS प्लैटफ़ॉर्म.
PLATFORM_ANDROID Android प्लैटफ़ॉर्म.
PLATFORM_WEB वेब प्लैटफ़ॉर्म.

AttributionHint

इस विज्ञापन के इवेंट के लिए, पार्टनर के हिसाब से एट्रिब्यूशन की स्थिति.

Enums
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' होता है. उदाहरण: "3.5s".
mediaSkippable

boolean

ज़रूरी नहीं. विज्ञापन मीडिया स्किप किया जा सकने वाला था या नहीं.
mediaQuartile

enum (MediaQuartile)

ज़रूरी नहीं. अलग-अलग क्वार्टाइल के हिसाब से, मीडिया के चलने की अवधि.
mediaDuration

string (Duration format)

ज़रूरी नहीं. विज्ञापन मीडिया की अवधि.

सेकंड में अवधि, जिसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".
mediaVolumePercent

integer

ज़रूरी नहीं. मीडिया के प्लेबैक की आवाज़ का प्रतिशत (0 से 100 तक).
playbackDuration

string (Duration format)

ज़रूरी नहीं. विज्ञापन मीडिया को चलाने की अवधि. भले ही, वह दिख रहा हो या नहीं.

सेकंड में अवधि, जिसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".

ViewType

इवेंट का टाइप.

Enums
VIEW_TYPE_UNSPECIFIED व्यू टाइप की जानकारी नहीं दी गई है.
VIEW_TYPE_MRC_VIEWED MRC ने देखा.
VIEW_TYPE_MRC_RENDERED MRC रेंडर किया गया.

MediaQuartile

अलग-अलग क्वार्टाइल के हिसाब से, मीडिया के चलने की अवधि.

Enums
MEDIA_QUARTILE_UNSPECIFIED मीडिया क्वार्टाइल के बारे में जानकारी नहीं दी गई है.
MEDIA_QUARTILE_START शुरू करें.
MEDIA_QUARTILE_FIRST_QUARTILE पहला क्वार्टाइल.
MEDIA_QUARTILE_MIDPOINT मिडपॉइंट.
MEDIA_QUARTILE_THIRD_QUARTILE तीसरा क्वार्टाइल.
MEDIA_QUARTILE_COMPLETE पूरा हो गया.