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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
फ़ील्ड
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)

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

object (PerformanceGoal)

ज़रूरी है. इंसर्शन ऑर्डर का परफ़ॉर्मेंस लक्ष्य.
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (BillableOutcome)

इम्यूटेबल. इंसर्शन ऑर्डर का बिल करने लायक नतीजा.

नतीजे के हिसाब से खरीदारी की सुविधा अब काम नहीं करती. BILLABLE_OUTCOME_PAY_PER_IMPRESSION ही मान्य वैल्यू है.

InsertionOrderType

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

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

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

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 बजट का अपने-आप बंटवारा. performanceGoal के तय किए गए परफ़ॉर्मेंस को ऑप्टिमाइज़ करने के लिए, सिस्टम को अपने-आप बजट को लाइन आइटम के मालिकाना हक वाले लाइन में शिफ़्ट करने की अनुमति दें. बोली सेटिंग पर कोई ऑटोमेशन नहीं.
INSERTION_ORDER_AUTOMATION_TYPE_NONE इंसर्शन ऑर्डर के लेवल पर, बिड या बजट का कोई ऑटोमेशन नहीं है. बिड और बजट, लाइन आइटम के लेवल पर मैन्युअल तरीके से कॉन्फ़िगर किए जाने चाहिए.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET performanceGoal के मुताबिक परफ़ॉर्मेंस को ऑप्टिमाइज़ करने के लिए, सिस्टम को अपने-आप बिड घटाने या बढ़ाने की अनुमति दें. साथ ही, बजट को लाइन आइटम के मालिकाना हक वाले लाइन आइटम में शिफ़्ट करने दें.

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, जिसका हिस्सा यह इंसर्शन ऑर्डर बजट सेगमेंट है.

BillableOutcome

इंसर्शन ऑर्डर के लिए, बिल करने लायक संभावित नतीजे.

Enums
BILLABLE_OUTCOME_UNSPECIFIED बिल करने लायक नतीजा नहीं बताया गया है.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION हर इंप्रेशन के लिए पैसे चुकाना.
BILLABLE_OUTCOME_PAY_PER_CLICK

हर क्लिक का पेमेंट.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

हर ऐक्टिव व्यू के हिसाब से पैसे चुकाएं.

तरीके

bulkListInsertionOrderAssignedTargetingOptions

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

create

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

delete

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

get

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

list

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

patch

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