REST Resource: advertisers.insertionOrders

रिसॉर्स: इंसर्शन ऑर्डर

सिंगल इंसर्शन ऑर्डर.

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 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "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)

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

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

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (OptimizationObjective)

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

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

InsertionOrderType

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

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

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

Kpi

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

JSON के काेड में दिखाना 
{
  "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_IMPRESSION_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

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

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, साल 2037 से पहले की startDate या उसके बाद की तारीख होनी चाहिए.
campaignBudgetId

string (int64 format)

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

OptimizationObjective

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

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

तरीके

create

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

delete

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

get

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

list

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

listAssignedTargetingOptions

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

patch

 मौजूदा इंसर्शन ऑर्डर में बदलाव करता है.