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 ओवर-द-टॉप.

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 इस कैंपेन के लिए केपीआई, सीआईपीएवीसी (वीडियो पूरा होने पर सुनाई देने और दिखने वाले हर इंप्रेशन की लागत) है.
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 में बदलाव किया जा सकता है, लेकिन startDate में बदलाव नहीं किया जा सकता. हालांकि, endDate में बदलाव किया जा सकता है.
  • 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

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