REST Resource: advertisers.campaigns

{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}

string

सिर्फ़ आउटपुट के लिए. कैंपेन का संसाधन नाम.

string (int64 format)

सिर्फ़ आउटपुट के लिए. विज्ञापन देने वाले उस व्यक्ति या कंपनी का यूनीक आईडी जिसका कैंपेन है.

string (int64 format)

सिर्फ़ आउटपुट के लिए. कैंपेन का यूनीक आईडी. सिस्टम से असाइन किया गया.

string

ज़रूरी है. कैंपेन का डिसप्ले नेम.

यह UTF-8 कोड में होना चाहिए और इसका साइज़ 240 बाइट से ज़्यादा नहीं होना चाहिए.

enum (EntityStatus)

ज़रूरी है. यह कंट्रोल करता है कि इस कैंपेन के तहत इंसर्शन ऑर्डर, अपना बजट खर्च कर सकते हैं या नहीं. साथ ही, यह भी कंट्रोल करता है कि वे इन्वेंट्री पर बिड लगा सकते हैं या नहीं.

• ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, और ENTITY_STATUS_PAUSED ही वैल्यू स्वीकार की जाती हैं.
• campaigns.create तरीके के लिए, ENTITY_STATUS_ARCHIVED की अनुमति नहीं है.

string (Timestamp format)

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

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

object (CampaignGoal)

ज़रूरी है. कैंपेन का लक्ष्य.

object (CampaignFlight)

ज़रूरी है. कैंपेन के लिए तय किया गया खर्च और उसकी अवधि.

object (FrequencyCap)

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

object (CampaignBudget)

इस कैंपेन के लिए उपलब्ध बजट की सूची.

अगर यह फ़ील्ड सेट नहीं है, तो कैंपेन अनलिमिटेड बजट का इस्तेमाल करता है.

{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}

enum (CampaignGoalType)

ज़रूरी है. कैंपेन के लक्ष्य का टाइप.

object (PerformanceGoal)

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

performanceGoalType के लिए ये वैल्यू डाली जा सकती हैं:

• PERFORMANCE_GOAL_TYPE_CPM
• PERFORMANCE_GOAL_TYPE_CPC
• PERFORMANCE_GOAL_TYPE_CPA
• PERFORMANCE_GOAL_TYPE_CPIAVC
• PERFORMANCE_GOAL_TYPE_CTR
• PERFORMANCE_GOAL_TYPE_VIEWABILITY
• PERFORMANCE_GOAL_TYPE_OTHER

{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}

enum (PerformanceGoalType)

ज़रूरी है. परफ़ॉर्मेंस लक्ष्य का टाइप.

string (int64 format)

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

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

• PERFORMANCE_GOAL_TYPE_CPM
• PERFORMANCE_GOAL_TYPE_CPC
• PERFORMANCE_GOAL_TYPE_CPA
• PERFORMANCE_GOAL_TYPE_CPIAVC
• PERFORMANCE_GOAL_TYPE_VCPM

उदाहरण के लिए, 1500000 वैल्यू से पता चलता है कि मुद्रा की 1.5 स्टैंडर्ड यूनिट हैं.

string (int64 format)

लक्ष्य के प्रतिशत को दशमलव के बाद के अंकों में माइक्रो में दिखाया जाता है.

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

• PERFORMANCE_GOAL_TYPE_CTR
• PERFORMANCE_GOAL_TYPE_VIEWABILITY
• PERFORMANCE_GOAL_TYPE_CLICK_CVR
• PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
• PERFORMANCE_GOAL_TYPE_VTR
• PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
• PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

उदाहरण के लिए, 70,000 का मतलब 7% (दशमलव 0.07) है.

string

परफ़ॉर्मेंस का मुख्य इंडिकेटर (केपीआई) स्ट्रिंग, जो खाली हो सकती है. यह UTF-8 कोड में होना चाहिए और इसमें 100 से ज़्यादा वर्ण नहीं होने चाहिए.

यह तब लागू होता है, जब performanceGoalType को PERFORMANCE_GOAL_TYPE_OTHER पर सेट किया जाता है.

{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}

string (int64 format)

वह रकम जिसे कैंपेन, दिए गए plannedDates के लिए खर्च कर सकता है. इससे विज्ञापन दिखाने पर कोई असर नहीं पड़ेगा. हालांकि, इसका इस्तेमाल DV360 यूज़र इंटरफ़ेस (यूआई) में खर्च को ट्रैक करने के लिए किया जाएगा.

यह रकम माइक्रो में है. यह वैल्यू 0 से ज़्यादा या इसके बराबर होनी चाहिए. उदाहरण के लिए, 500000000 का मतलब है कि मुद्रा की 500 स्टैंडर्ड यूनिट.

object (DateRange)

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

• यहां दी गई तारीखों से, विज्ञापन दिखाने पर कोई असर नहीं पड़ेगा. इनका इस्तेमाल, चेतावनियां और चेतावनियां जनरेट करने के लिए किया जाता है. उदाहरण के लिए, अगर किसी चाइल्ड इंसर्शन ऑर्डर की फ़्लाइट की तारीख, इन तारीखों की सीमा से बाहर है, तो यूज़र इंटरफ़ेस में चेतावनी दिखेगी.
• startDate की वैल्यू देना ज़रूरी है. यह तारीख, मौजूदा तारीख या उसके बाद की होनी चाहिए.
• endDate का इस्तेमाल करना ज़रूरी नहीं है. अगर यह जानकारी दी गई है, तो यह startDate या उसके बाद की होनी चाहिए.
• डाली गई कोई भी तारीख, साल 2037 से पहले की होनी चाहिए.

{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}

string (int64 format)

कैंपेन बजट का यूनीक आईडी. सिस्टम से असाइन किया गया. नए बजट के लिए सेट न करें.

campaignBudgets में बजट अपडेट करते या जोड़ते समय, इसे शामिल करना ज़रूरी है. ऐसा न करने पर, एक नया आईडी जनरेट करके असाइन किया जाएगा.

string

ज़रूरी है. बजट का डिसप्ले नेम.

यह UTF-8 कोड में होना चाहिए और इसका साइज़ 240 बाइट से ज़्यादा नहीं होना चाहिए.

enum (BudgetUnit)

ज़रूरी है. इम्यूटेबल. इससे पता चलता है कि बजट को मुद्रा या इंप्रेशन में मेज़र किया जाता है.

string (int64 format)

ज़रूरी है. लिंक किए गए इंसर्शन ऑर्डर सेगमेंट के लिए तय की गई कुल रकम.

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

object (DateRange)

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

startDate और endDate, दोनों, साल 2037 से पहले की होनी चाहिए.

enum (ExternalBudgetSource)

ज़रूरी है. बजट का बाहरी सोर्स.

string

इम्यूटेबल. यह आईडी, बाहरी सोर्स के लिए इस बजट की पहचान करता है.

अगर यह फ़ील्ड सेट है और उससे जुड़ी बिलिंग प्रोफ़ाइल का इनवॉइस की जानकारी का लेवल "बजट लेवल पीओ" पर सेट है, तो इस बजट के लिए दिखाए गए सभी इंप्रेशन में इनवॉइस पर यह आईडी शामिल होगा.

कैंपेन में यह नाम यूनीक होना चाहिए.

string

इम्यूटेबल. बजट का ग्रुप बनाने के लिए इस्तेमाल किया जाने वाला आईडी, ताकि एक ही इनवॉइस को शामिल किया जा सके.

अगर यह फ़ील्ड सेट है और उससे जुड़ी बिलिंग प्रोफ़ाइल का इनवॉइस लेवल "बजट इनवॉइस ग्रुपिंग आईडी" पर सेट है, तो एक ही invoiceGroupingId शेयर करने वाले सभी externalBudgetId को एक ही इनवॉइस में ग्रुप किया जाएगा.

object (PrismaConfig)

Mediaocean Prisma टूल के इस्तेमाल के लिए अतिरिक्त मेटाडेटा.

Mediaocean के बजट के लिए ज़रूरी है.

यह सिर्फ़ विज्ञापन देने वाले prismaEnabled पर लागू होता है.

{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}

enum (PrismaType)

ज़रूरी है. Prisma का टाइप.

object (PrismaCpeCode)

ज़रूरी है. Mediaocean Prisma टूल से मिले काम के क्लाइंट, प्रॉडक्ट, और अनुमान कोड.

string

ज़रूरी है. इकाई ने यह बजट (डीएसपी, साइट वगैरह) तय किया है.

{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}

string

Prisma का क्लाइंट कोड.

string

Prisma का प्रॉडक्ट कोड.

string

Prisma का अनुमान कोड.