REST Resource: advertisers.insertionOrders

संसाधन: इंसर्शनऑर्डर

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

जेएसओएन के काेड में दिखाना 
{
  "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)
}
फ़ील्ड
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)

सिर्फ़ आउटपुट के लिए. इंसर्ट करने के ऑर्डर को आखिरी बार अपडेट किए जाने का टाइमस्टैंप. सिस्टम ने असाइन किया है.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
partnerCosts[]

object (PartnerCost)

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

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

object (Pacing)

ज़रूरी है. इंसर्शन ऑर्डर के लिए, बजट खर्च करने की स्पीड की सेटिंग.
frequencyCap

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (Kpi)

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

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

object (InsertionOrderBudget)

ज़रूरी है. इंसर्शन ऑर्डर के बजट के बंटवारे की सेटिंग.
bidStrategy

object (BiddingStrategy)

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

enum (ReservationType)

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

InsertionOrderType

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

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

Enums
INSERTION_ORDER_TYPE_UNSPECIFIED इंसर्शन ऑर्डर टाइप की जानकारी नहीं दी गई है या इसकी जानकारी नहीं है.
RTB रीयल-टाइम बिडिंग.
OVER_THE_TOP ओवर–द–टॉप.

Kpi

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

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

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
फ़ील्ड
kpiType

enum (KpiType)

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

string (int64 format)

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

string (int64 format)

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

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

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

उदाहरण के लिए: 15,00,000, मुद्रा की 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 केपीआई, सीपीएम (हर 1,000 व्यू) की लागत होती है.
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 केपीआई, 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

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

जेएसओएन के काेड में दिखाना 
{
  "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 kpi से तय परफ़ॉर्मेंस को ऑप्टिमाइज़ करने के लिए, सिस्टम को अपने-आप बिड में बदलाव करने और बजट को लाइन आइटम के मालिकाना हक पर शिफ़्ट करने दें.

InsertionOrderBudgetSegment

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

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

string (int64 format)

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

string

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

कोड में UTF-8 कोड में बदलना ज़रूरी है.
dateRange

object (DateRange)

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

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

string (int64 format)

कैंपेन के बजट का budgetId, जिसका इंसर्ट करने के ऑर्डर के बजट का सेगमेंट एक हिस्सा है.

तरीके

create

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

delete

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

get

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

list

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

listAssignedTargetingOptions

 सभी टारगेटिंग टाइप में, इंसर्शन ऑर्डर के लिए असाइन किए गए टारगेटिंग विकल्पों की सूची दिखाता है.

patch

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