REST Resource: advertisers.insertionOrders

संसाधन: InsertionOrder

एक इंसर्शन ऑर्डर.

JSON के काेड में दिखाना 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. इंसर्शन ऑर्डर के संसाधन का नाम.
advertiserId

string (int64 format)

सिर्फ़ आउटपुट के लिए. विज्ञापन देने वाले उस व्यक्ति या कंपनी का यूनीक आईडी जिससे इंसर्शन ऑर्डर जुड़ा है.
campaignId

string (int64 format)

ज़रूरी है. इम्यूटेबल. उस कैंपेन का यूनीक आईडी जिससे इंसर्शन ऑर्डर जुड़ा है.
insertionOrderId

string (int64 format)

सिर्फ़ आउटपुट के लिए. इंसर्शन ऑर्डर का यूनीक आईडी. सिस्टम ने असाइन किया है.
displayName

string

ज़रूरी है. इंसर्शन ऑर्डर का डिसप्ले नेम.

यह UTF-8 कोड में होना चाहिए और इसका साइज़ ज़्यादा से ज़्यादा 240 बाइट होना चाहिए.
insertionOrderType

enum (InsertionOrderType)

ज़रूरी नहीं. इंसर्शन ऑर्डर का टाइप.

अगर कैंपेन बनाते समय इस फ़ील्ड की वैल्यू तय नहीं की जाती है, तो डिफ़ॉल्ट रूप से RTB वैल्यू सेट हो जाती है.
entityStatus

enum (EntityStatus)

ज़रूरी है. इससे यह कंट्रोल किया जाता है कि इंसर्शन ऑर्डर, अपने बजट को खर्च कर सकता है या नहीं और इन्वेंट्री पर बिड कर सकता है या नहीं.

  • insertionOrders.create के लिए, सिर्फ़ ENTITY_STATUS_DRAFT का इस्तेमाल किया जा सकता है. किसी इंसर्शन ऑर्डर को चालू करने के लिए, insertionOrders.patch तरीके का इस्तेमाल करें. साथ ही, इंसर्शन ऑर्डर बनाने के बाद, स्टेटस को ENTITY_STATUS_ACTIVE पर अपडेट करें.
  • किसी इंसर्शन ऑर्डर को किसी अन्य स्टेटस से बदलकर, वापस ENTITY_STATUS_DRAFT स्टेटस पर सेट नहीं किया जा सकता.
  • अगर किसी इंसर्शन ऑर्डर का पैरंट कैंपेन चालू नहीं है, तो उसे ENTITY_STATUS_ACTIVE पर सेट नहीं किया जा सकता.
updateTime

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".
partnerCosts[]

object (PartnerCost)

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

अगर insertionOrders.create तरीके में यह मौजूद नहीं है या खाली है, तो नए इंसर्शन ऑर्डर में पार्टनर की सेटिंग से पार्टनर की लागतें अपने-आप लागू हो जाएंगी.
pacing

object (Pacing)

ज़रूरी है. इंसर्ट ऑर्डर के बजट खर्च की स्पीड की सेटिंग.

pacingType PACING_TYPE_ASAP, pacingPeriod PACING_PERIOD_FLIGHT के साथ काम नहीं करता.
frequencyCap

object (FrequencyCap)

ज़रूरी है. इंसर्शन ऑर्डर की फ़्रीक्वेंसी कैपिंग सेटिंग.
integrationDetails

object (IntegrationDetails)

ज़रूरी नहीं. इंसर्शन ऑर्डर के इंटिग्रेशन की अन्य जानकारी.
kpi

object (Kpi)

ज़रूरी है. इंसर्शन ऑर्डर के लिए परफ़ॉर्मेंस का मुख्य मापदंड (केपीआई).

इसे Display & Video 360 इंटरफ़ेस में"लक्ष्य " के तौर पर दिखाया जाता है.
budget

object (InsertionOrderBudget)

ज़रूरी है. इंसर्ट ऑर्डर के लिए, बजट असाइन करने की सेटिंग.
bidStrategy

object (BiddingStrategy)

ज़रूरी नहीं. इंसर्शन ऑर्डर की बिडिंग की रणनीति. डिफ़ॉल्ट रूप से, fixedBid सेट होता है.

अगर budget फ़ील्ड automationType को INSERTION_ORDER_AUTOMATION_TYPE_BUDGET या INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET पर सेट किया जाता है, तो इंसर्शन ऑर्डर अपने लाइन आइटम पर बिडिंग की यह रणनीति लागू करेगा. अगर लागू की गई बिडिंग की रणनीति, लाइन आइटम की enableOptimizedTargeting सेटिंग के साथ काम नहीं करती है, तो ऑप्टिमाइज़ की गई टारगेटिंग की सेटिंग अपडेट हो जाएगी.
reservationType

enum (ReservationType)

सिर्फ़ आउटपुट के लिए. इंसर्शन ऑर्डर के रिज़र्वेशन का टाइप.
optimizationObjective

enum (OptimizationObjective)

ज़रूरी है. इंसर्शन ऑर्डर के ऑप्टिमाइज़ेशन का मकसद.

InsertionOrderType

इंसर्शन ऑर्डर के संभावित टाइप.

इंसर्शन ऑर्डर के टाइप से यह तय होता है कि कौनसी सेटिंग और विकल्प लागू होंगे. जैसे, विज्ञापनों का फ़ॉर्मैट या टारगेटिंग के विकल्प.

Enums
INSERTION_ORDER_TYPE_UNSPECIFIED इंसर्शन ऑर्डर का टाइप नहीं बताया गया है या इसकी जानकारी नहीं है.
RTB रीयल-टाइम बिडिंग.
OVER_THE_TOP ओवर-द-टॉप.
OUT_OF_HOME आउट-ऑफ़-होम.

Kpi

ऐसी सेटिंग जो किसी इंसर्शन ऑर्डर के परफ़ॉर्मेंस के मुख्य मापदंड या केपीआई को कंट्रोल करती हैं.

JSON के काेड में दिखाना 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of mutually exclusive fields.
}
फ़ील्ड
kpiType

enum (KpiType)

ज़रूरी है. केपीआई का टाइप.
kpiAlgorithmId

string (int64 format)

ज़रूरी नहीं. KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST से जुड़ा कस्टम बिडिंग एल्गोरिदम आईडी. अगर सही केपीआई नहीं चुना जाता है, तो इस फ़ील्ड को अनदेखा कर दिया जाता है.
ज़रूरी है. केपीआई की वैल्यू. काम का फ़ील्ड, kpi_type से जुड़ा होता है. यहां उन फ़ील्ड की सूची दी गई है जिन्हें एक साथ इस्तेमाल नहीं किया जा सकता. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
kpiAmountMicros

string (int64 format)

विज्ञापन देने वाले की मुद्रा के माइक्रोस में, लक्ष्य की रकम.

यह तब लागू होता है, जब kpiType इनमें से कोई एक हो:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

उदाहरण के लिए: 1500000, मुद्रा की 1.5 स्टैंडर्ड यूनिट को दिखाता है.
kpiPercentageMicros

string (int64 format)

माइक्रो में लक्ष्य के प्रतिशत को दशमलव में दिखाने का तरीका.

यह तब लागू होता है, जब kpiType इनमें से कोई एक हो:

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

उदाहरण के लिए: 70000 का मतलब 7% (दशमलव 0.07) है.
kpiString

string

केपीआई स्ट्रिंग, जिसे खाली छोड़ा जा सकता है. यह UTF-8 कोड में बदला गया होना चाहिए और इसमें 100 से ज़्यादा वर्ण नहीं होने चाहिए.

kpiType के KPI_TYPE_OTHER होने पर लागू होता है.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

KpiType

परफ़ॉर्मेंस के मुख्य मापदंड (केपीआई) के संभावित टाइप.

Enums
KPI_TYPE_UNSPECIFIED इस वर्शन में केपीआई टाइप की जानकारी नहीं दी गई है या इसके बारे में जानकारी नहीं है.
KPI_TYPE_CPM केपीआई, सीपीएम (हर हज़ार इंप्रेशन की लागत) है.
KPI_TYPE_CPC केपीआई, सीपीसी (हर क्लिक की लागत) है.
KPI_TYPE_CPA केपीआई, सीपीए (हर कार्रवाई की लागत) है.
KPI_TYPE_CTR केपीआई, क्लिक मिलने की दर (सीटीआर) का प्रतिशत है.
KPI_TYPE_VIEWABILITY केपीआई, विज्ञापन दिखने का प्रतिशत है.
KPI_TYPE_CPIAVC केपीआई, CPIAVC (वीडियो पूरा होने पर, सुनाई और दिखाई देने वाले हर इंप्रेशन की लागत) है.
KPI_TYPE_CPE इस कैंपेन के लिए केपीआई, सीपीई (हर जुड़ाव की लागत) है.
KPI_TYPE_CPV केपीआई को सीपीवी (हर व्यू की लागत) में सेट किया गया है.
KPI_TYPE_CLICK_CVR केपीआई, क्लिक कन्वर्ज़न रेट (हर क्लिक पर कन्वर्ज़न) का प्रतिशत है.
KPI_TYPE_IMPRESSION_CVR केपीआई, इंप्रेशन कन्वर्ज़न रेट (हर इंप्रेशन पर कन्वर्ज़न) का प्रतिशत होता है.
KPI_TYPE_VCPM केपीआई, वीसीपीएम (दिखने वाले हर हज़ार इंप्रेशन की लागत) है.
KPI_TYPE_VTR केपीआई, YouTube पर देखे जाने की दर (हर इंप्रेशन पर YouTube व्यू) का प्रतिशत है.
KPI_TYPE_AUDIO_COMPLETION_RATE केपीआई, ऑडियो को पूरा सुनने की दर (हर इंप्रेशन पर पूरा ऑडियो सुनने की संख्या) का प्रतिशत है.
KPI_TYPE_VIDEO_COMPLETION_RATE केपीआई, वीडियो को पूरा देखे जाने की दर (हर इंप्रेशन पर वीडियो को पूरा देखे जाने की संख्या) का प्रतिशत है.
KPI_TYPE_CPCL केपीआई को सीपीसीएल (पूरा ऑडियो सुनने की लागत) में सेट किया जाता है.
KPI_TYPE_CPCV केपीआई को सीपीसीवी (हर बार पूरा वीडियो देखे जाने की लागत) में सेट किया गया है.
KPI_TYPE_TOS10 केपीआई को स्क्रीन पर 10 सेकंड से ज़्यादा समय तक दिखने की दर के हिसाब से सेट किया जाता है. यह मेज़र किए जा सकने वाले और स्किप न किए जा सकने वाले उन इंप्रेशन का प्रतिशत होता है जो कम से कम 10 सेकंड तक स्क्रीन पर दिखे.
KPI_TYPE_MAXIMIZE_PACING केपीआई को इस तरह सेट किया जाता है कि ब्रैंड पर पड़ने वाले असर को ज़्यादा से ज़्यादा बढ़ाया जा सके. साथ ही, पूरे बजट को खर्च करने को प्राथमिकता दी जा सके.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST केपीआई को कस्टम इंप्रेशन वैल्यू को लागत से भाग देकर सेट किया जाता है.
KPI_TYPE_OTHER केपीआई कोई अन्य वैल्यू है.

InsertionOrderBudget

ऐसी सेटिंग जिनसे यह कंट्रोल किया जाता है कि इंसर्शन ऑर्डर का बजट कैसे तय किया जाए.

JSON के काेड में दिखाना 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
फ़ील्ड
budgetUnit

enum (BudgetUnit)

ज़रूरी है. इम्यूटेबल. बजट यूनिट से पता चलता है कि बजट, मुद्रा पर आधारित है या इंप्रेशन पर.
automationType

enum (InsertionOrderAutomationType)

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

अगर कैंपेन बनाते समय इस फ़ील्ड की वैल्यू तय नहीं की जाती है, तो डिफ़ॉल्ट रूप से INSERTION_ORDER_AUTOMATION_TYPE_NONE वैल्यू सेट हो जाती है.
budgetSegments[]

object (InsertionOrderBudgetSegment)

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

InsertionOrderAutomationType

इंसर्शन ऑर्डर की बिड और बजट को ऑटोमेट करने के लिए, ये विकल्प उपलब्ध हैं.

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED इस वर्शन में, इंसर्शन ऑर्डर को ऑटोमेट करने का विकल्प नहीं दिया गया है या इसके बारे में जानकारी नहीं है.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET बजट का अपने-आप बंटवारा होना. सिस्टम को लाइन आइटम के लिए बजट अपने-आप ट्रांसफ़र करने की अनुमति दें, ताकि kpi के हिसाब से परफ़ॉर्मेंस को ऑप्टिमाइज़ किया जा सके. बिड की सेटिंग के लिए ऑटोमेशन की सुविधा नहीं है.
INSERTION_ORDER_AUTOMATION_TYPE_NONE इंसर्ट करने के क्रम के लेवल पर, बिड या बजट को अपने-आप सेट होने की सुविधा नहीं मिलती. बिड और बजट को लाइन आइटम के लेवल पर मैन्युअल तरीके से कॉन्फ़िगर करना होगा.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET सिस्टम को बिड में अपने-आप बदलाव करने और बजट को लाइन आइटम के मालिकाना हक में शिफ़्ट करने की अनुमति दें, ताकि bidStrategy के हिसाब से परफ़ॉर्मेंस को ऑप्टिमाइज़ किया जा सके.

InsertionOrderBudgetSegment

ऐसी सेटिंग जो बजट के किसी एक सेगमेंट के बजट को कंट्रोल करती हैं.

JSON के काेड में दिखाना 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
फ़ील्ड
budgetAmountMicros

string (int64 format)

ज़रूरी है. दी गई dateRange के लिए, इंसर्शन ऑर्डर के तहत खर्च किया जाने वाला बजट. यह रकम माइक्रो में है. 0 से ज़्यादा होना चाहिए. उदाहरण के लिए, 500000000 का मतलब है कि मुद्रा की 500 स्टैंडर्ड यूनिट.
description

string

ज़रूरी नहीं. बजट सेगमेंट का ब्यौरा. इसका इस्तेमाल, हर बजट सेगमेंट के लिए परचेज़ ऑर्डर (पीओ) की जानकारी डालने और उसे इनवॉइस पर प्रिंट करने के लिए किया जा सकता है.

यह UTF-8 कोड में होना चाहिए.
dateRange

object (DateRange)

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

  • बजट का नया सेगमेंट बनाते समय, startDate और endDate, दोनों की तारीखें भविष्य की होनी चाहिए.
  • मौजूदा बजट सेगमेंट में, बीते समय में startDate के साथ endDate में बदलाव किया जा सकता है, लेकिन startDate में बदलाव नहीं किया जा सकता.
  • endDate, startDate या उसके बाद की तारीख होनी चाहिए. हालांकि, यह साल 2037 से पहले की होनी चाहिए.
campaignBudgetId

string (int64 format)

ज़रूरी नहीं. कैंपेन के बजट का budgetId, जिसका यह इंसर्शन ऑर्डर बजट सेगमेंट हिस्सा है.

OptimizationObjective

ऑप्टिमाइज़ेशन के मकसद के संभावित टाइप.

Enums
OPTIMIZATION_OBJECTIVE_UNSPECIFIED इस वर्शन में, टाइप की वैल्यू नहीं दी गई है या इसकी जानकारी मौजूद नहीं है.
CONVERSION बिक्री और कन्वर्ज़न बढ़ाने वाले इंप्रेशन को प्राथमिकता दें.
CLICK वेबसाइट, ऐप्लिकेशन, और ऐप स्टोर पर ट्रैफ़िक बढ़ाने वाले इंप्रेशन को प्राथमिकता दें.
BRAND_AWARENESS किसी खास क्वालिटी के इंप्रेशन को प्राथमिकता दें.
CUSTOM मकसद, असाइन किए गए कस्टम बिडिंग एल्गोरिदम से तय होता है.
NO_OBJECTIVE मकसद तय नहीं किया गया है. किसी भी केपीआई या बिडिंग की रणनीति का इस्तेमाल किया जा सकता है.

तरीके

create

 इससे नया इंसर्शन ऑर्डर बनता है.

delete

 किसी इंसर्शन ऑर्डर को मिटाता है.

get

 इससे कोई इंसर्शन ऑर्डर मिलता है.

list

 विज्ञापन देने वाले के लिस्ट इंसर्शन ऑर्डर की सूची दिखाता है.

patch

 किसी मौजूदा इंसर्शन ऑर्डर को अपडेट करता है.