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)
  },
  "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)

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

आरएफ़सी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)

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

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

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

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

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

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

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