Method: events.ingest

इस फ़ंक्शन की मदद से, दी गई Destination से Event रिसॉर्स की सूची अपलोड की जाती है.

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

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

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

अनुरोध का मुख्य हिस्सा

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

JSON के काेड में दिखाना
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
फ़ील्ड
destinations[]

object (Destination)

ज़रूरी है. उन डेस्टिनेशन की सूची जहां इवेंट भेजे जाने हैं.

events[]

object (Event)

ज़रूरी है. चुने गए डेस्टिनेशन पर भेजे जाने वाले इवेंट की सूची. एक अनुरोध में ज़्यादा से ज़्यादा 2,000 Event संसाधन भेजे जा सकते हैं.

consent

object (Consent)

ज़रूरी नहीं. अनुरोध के स्तर पर सहमति, ताकि अनुरोध में शामिल सभी उपयोगकर्ताओं पर लागू हो सके. उपयोगकर्ता-लेवल की सहमति, अनुरोध-लेवल की सहमति को बदल देती है. इसे हर Event में तय किया जा सकता है.

validateOnly

boolean

ज़रूरी नहीं. इसका इस्तेमाल सिर्फ़ जांच के लिए किया जाता है. अगर true है, तो अनुरोध की पुष्टि की जाती है, लेकिन उसे पूरा नहीं किया जाता. सिर्फ़ गड़बड़ियां दिखती हैं, नतीजे नहीं.

encoding

enum (Encoding)

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

encryptionInfo

object (EncryptionInfo)

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

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

IngestEventsRequest से मिला जवाब.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना
{
  "requestId": string
}
फ़ील्ड
requestId

string

अनुरोध का अपने-आप जनरेट हुआ आईडी.

अनुमति के स्कोप

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

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

इवेंट

यह इवेंट, विज्ञापन देने वाले व्यक्ति या कंपनी की वेबसाइट या ऐप्लिकेशन पर उपयोगकर्ता के इंटरैक्शन को दिखाता है.

JSON के काेड में दिखाना
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "conversionValue": number,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  }
}
फ़ील्ड
destinationReferences[]

string

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

transactionId

string

ज़रूरी है. इस इवेंट के लिए यूनीक आइडेंटिफ़ायर.

eventTimestamp

string (Timestamp format)

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

यह RFC 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".

lastUpdatedTimestamp

string (Timestamp format)

ज़रूरी नहीं. इवेंट को पिछली बार इस समय अपडेट किया गया था.

यह RFC 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".

userData

object (UserData)

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

consent

object (Consent)

ज़रूरी नहीं. इस कुकी से यह पता चलता है कि उपयोगकर्ता ने अलग-अलग तरह की सहमति दी है या नहीं.

adIdentifiers

object (AdIdentifiers)

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

currency

string

ज़रूरी नहीं. इस इवेंट में मौजूद सभी मॉनेटरी वैल्यू से जुड़ा मुद्रा कोड.

conversionValue

number

ज़रूरी नहीं. वैल्यू के आधार पर कन्वर्ज़न के लिए, इवेंट से जुड़ी कन्वर्ज़न वैल्यू.

eventSource

enum (EventSource)

ज़रूरी नहीं. यह सिग्नल बताता है कि इवेंट कहां हुआ (वेब, ऐप्लिकेशन, स्टोर में वगैरह).

eventDeviceInfo

object (DeviceInfo)

ज़रूरी नहीं. इवेंट के ट्रिगर होने पर, इस्तेमाल किए जा रहे डिवाइस के बारे में इकट्ठा की गई जानकारी (अगर कोई जानकारी इकट्ठा की गई हो).

cartData

object (CartData)

ज़रूरी नहीं. लेन-देन और इवेंट से जुड़े आइटम के बारे में जानकारी.

customVariables[]

object (CustomVariable)

ज़रूरी नहीं. कन्वर्ज़न कंटेनर (कन्वर्ज़न ऐक्शन या FL गतिविधि) को भेजने के लिए, अतिरिक्त कुंजी/वैल्यू पेयर की जानकारी.

experimentalFields[]

object (ExperimentalField)

ज़रूरी नहीं. एक्सपेरिमेंट के तौर पर उपलब्ध फ़ील्ड के लिए, कुंजी/वैल्यू पेयर की सूची. ऐसा हो सकता है कि ये फ़ील्ड, एपीआई का हिस्सा बन जाएं.

userProperties

object (UserProperties)

ज़रूरी नहीं. विज्ञापन देने वाले व्यक्ति या कंपनी की ओर से, इवेंट के समय उपयोगकर्ता के बारे में इकट्ठा की गई जानकारी.

AdIdentifiers

इस कुकी में आइडेंटिफ़ायर और अन्य जानकारी होती है. इसका इस्तेमाल, कन्वर्ज़न इवेंट को अन्य ऑनलाइन गतिविधि (जैसे कि विज्ञापन पर क्लिक) से मैच करने के लिए किया जाता है.

JSON के काेड में दिखाना
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  }
}
फ़ील्ड
sessionAttributes

string

ज़रूरी नहीं. इवेंट एट्रिब्यूशन और मॉडलिंग के लिए सेशन एट्रिब्यूट.

gclid

string

ज़रूरी नहीं. इस इवेंट से जुड़ा Google क्लिक आईडी (gclid).

gbraid

string

ज़रूरी नहीं. iOS डिवाइसों से होने वाले ऐप्लिकेशन इवेंट से जुड़े क्लिक के लिए क्लिक आइडेंटिफ़ायर. ये डिवाइस, iOS14 या इसके बाद के वर्शन वाले होते हैं.

wbraid

string

ज़रूरी नहीं. iOS डिवाइसों से होने वाले वेब इवेंट से जुड़े क्लिक के लिए क्लिक आइडेंटिफ़ायर. ये डिवाइस, iOS14 या इसके बाद के वर्शन वाले होते हैं.

landingPageDeviceInfo

object (DeviceInfo)

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

DeviceInfo

इवेंट के होने पर इस्तेमाल किए जा रहे डिवाइस के बारे में जानकारी.

JSON के काेड में दिखाना
{
  "userAgent": string,
  "ipAddress": string
}
फ़ील्ड
userAgent

string

ज़रूरी नहीं. दिए गए कॉन्टेक्स्ट के लिए, डिवाइस की उपयोगकर्ता-एजेंट स्ट्रिंग.

ipAddress

string

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

ध्यान दें: Google Ads, यूरोपियन इकनॉमिक एरिया (ईईए), यूनाइटेड किंगडम (यूके) या स्विट्ज़रलैंड (सीएच) में रहने वाले असली उपयोगकर्ताओं के लिए, आईपी पते के मिलान की सुविधा उपलब्ध नहीं कराता. इन देशों/इलाकों के उपयोगकर्ताओं के आईपी पते शेयर न करने के लिए, लॉजिक जोड़ें. साथ ही, पक्का करें कि उपयोगकर्ताओं को आपकी साइटों, ऐप्लिकेशन, और अन्य प्रॉपर्टी पर इकट्ठा किए जाने वाले डेटा के बारे में पूरी और सही जानकारी दी जा रही हो. साथ ही, जहां कानूनी तौर पर या Google की लागू होने वाली किसी नीति के तहत ज़रूरी हो वहां उनकी सहमति भी ली जा रही हो. ज़्यादा जानकारी के लिए, ऑफ़लाइन कन्वर्ज़न इंपोर्ट के बारे में जानकारी पेज देखें.

EventSource

इवेंट का सोर्स.

Enums
EVENT_SOURCE_UNSPECIFIED EventSource की जानकारी नहीं दी गई है. इसका इस्तेमाल कभी नहीं किया जाना चाहिए.
WEB यह इवेंट, वेब ब्राउज़र से जनरेट किया गया था.
APP यह इवेंट किसी ऐप्लिकेशन से जनरेट किया गया था.
IN_STORE यह इवेंट, स्टोर में हुए लेन-देन से जनरेट हुआ था.
PHONE यह इवेंट, फ़ोन कॉल से जनरेट किया गया था.
OTHER यह इवेंट, दूसरे सोर्स से जनरेट किया गया था.

CartData

इवेंट से जुड़ा कार्ट डेटा.

JSON के काेड में दिखाना
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ]
}
फ़ील्ड
merchantId

string

ज़रूरी नहीं. आइटम से जुड़ा Merchant Center आईडी.

merchantFeedLabel

string

ज़रूरी नहीं. आइटम के फ़ीड से जुड़ा Merchant Center का फ़ीड लेबल.

merchantFeedLanguageCode

string

ज़रूरी नहीं. Merchant Center के उस फ़ीड से जुड़ा आईएसओ 639-1 भाषा कोड जिसमें आपके आइटम अपलोड किए जाते हैं.

transactionDiscount

number

ज़रूरी नहीं. लेन-देन से जुड़ी सभी छूटों का योग.

items[]

object (Item)

ज़रूरी नहीं. इवेंट से जुड़े आइटम की सूची.

आइटम

यह इवेंट से जुड़े कार्ट में मौजूद किसी आइटम को दिखाता है.

JSON के काेड में दिखाना
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number
}
फ़ील्ड
merchantProductId

string

ज़रूरी नहीं. Merchant Center खाते में मौजूद प्रॉडक्ट आईडी.

quantity

string (int64 format)

ज़रूरी नहीं. इवेंट से जुड़े इस आइटम की संख्या.

unitPrice

number

ज़रूरी नहीं. यूनिट की कीमत. इसमें टैक्स, शिपिंग, और लेन-देन पर मिलने वाली किसी भी तरह की छूट शामिल नहीं है.

कस्टम वैरिएबल

विज्ञापन कन्वर्ज़न के लिए कस्टम वैरिएबल.

JSON के काेड में दिखाना
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
फ़ील्ड
variable

string

ज़रूरी नहीं. सेट किए जाने वाले कस्टम वैरिएबल का नाम. अगर दिए गए डेस्टिनेशन के लिए वैरिएबल नहीं मिलता है, तो इसे अनदेखा कर दिया जाएगा.

value

string

ज़रूरी नहीं. कस्टम वैरिएबल के लिए सेव की जाने वाली वैल्यू.

destinationReferences[]

string

ज़रूरी नहीं. रेफ़रंस स्ट्रिंग का इस्तेमाल यह तय करने के लिए किया जाता है कि कस्टम वैरिएबल को Event.destination_references में से किस पर भेजा जाना चाहिए. अगर यह फ़ील्ड खाली है, तो Event.destination_references का इस्तेमाल किया जाएगा.

ExperimentalField

यह एक्सपेरिमेंटल फ़ील्ड, अनौपचारिक फ़ील्ड के बारे में बताता है.

JSON के काेड में दिखाना
{
  "field": string,
  "value": string
}
फ़ील्ड
field

string

ज़रूरी नहीं. इस्तेमाल किए जाने वाले फ़ील्ड का नाम.

value

string

ज़रूरी नहीं. फ़ील्ड की वैल्यू सेट करें.

UserProperties

विज्ञापन देने वाले व्यक्ति या कंपनी की ओर से, इवेंट के समय उपयोगकर्ता के बारे में इकट्ठा की गई जानकारी. ज़्यादा जानकारी के लिए, https://support.google.com/google-ads/answer/14007601 पर जाएं.

JSON के काेड में दिखाना
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket)
}
फ़ील्ड
customerType

enum (CustomerType)

ज़रूरी नहीं. इवेंट से जुड़े ग्राहक का टाइप.

customerValueBucket

enum (CustomerValueBucket)

ज़रूरी नहीं. विज्ञापन देने वाले व्यक्ति या कंपनी के हिसाब से ग्राहक की वैल्यू.

CustomerType

इवेंट से जुड़े ग्राहक का टाइप.

Enums
CUSTOMER_TYPE_UNSPECIFIED CustomerType की जानकारी नहीं दी गई है. इसका इस्तेमाल कभी नहीं किया जाना चाहिए.
NEW खरीदार, विज्ञापन देने वाले व्यक्ति या कंपनी के लिए नया है.
RETURNING खरीदार, विज्ञापन देने वाले व्यक्ति या कंपनी की वेबसाइट पर वापस आ रहा है.
REENGAGED ग्राहक ने विज्ञापन देने वाले व्यक्ति या कंपनी के साथ फिर से इंटरैक्ट किया है.

CustomerValueBucket

विज्ञापन देने वाले व्यक्ति या कंपनी के हिसाब से ग्राहक की वैल्यू.

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED CustomerValueBucket तय नहीं किया गया है. इसका इस्तेमाल कभी नहीं किया जाना चाहिए.
LOW ग्राहक की वैल्यू कम है.
MEDIUM ग्राहक, कारोबार के हिसाब से न कम न ज़्यादा खास है.
HIGH ग्राहक, कारोबार के हिसाब से ज़्यादा अहम है.