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

सिर्फ़ आउटपुट के लिए. इंसर्शन ऑर्डर का रिज़र्वेशन टाइप.
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

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

string (int64 format)

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

OptimizationObjective

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

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

तरीके

create

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

delete

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

get

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

list

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

listAssignedTargetingOptions

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

patch

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