REST Resource: advertisers.campaigns

संसाधन: कैंपेन

एक कैंपेन.

JSON के काेड में दिखाना 
{
  "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)
    }
  ]
}
फ़ील्ड
name

string

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

string (int64 format)

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

string (int64 format)

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

string

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

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

enum (EntityStatus)

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

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

string (Timestamp format)

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

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
campaignGoal

object (CampaignGoal)

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

object (CampaignFlight)

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

object (FrequencyCap)

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

object (CampaignBudget)

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

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

CampaignGoal

कैंपेन के लक्ष्य को कंट्रोल करने वाली सेटिंग.

JSON के काेड में दिखाना 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
फ़ील्ड
campaignGoalType

enum (CampaignGoalType)

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

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

CampaignGoalType

कैंपेन के लक्ष्यों के संभावित टाइप.

Enums
CAMPAIGN_GOAL_TYPE_UNSPECIFIED इस वर्शन में, लक्ष्य की वैल्यू नहीं दी गई है या इसकी जानकारी नहीं है.
CAMPAIGN_GOAL_TYPE_APP_INSTALL ऐप्लिकेशन इंस्टॉल या यूज़र ऐक्टिविटी बढ़ाएं.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS किसी ब्रैंड या प्रॉडक्ट के बारे में जागरूकता बढ़ाना.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION ऑफ़लाइन या स्टोर में होने वाली बिक्री बढ़ाएं.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION ऑनलाइन कार्रवाइयां या विज़िट बढ़ाएं.

PerformanceGoal

कैंपेन की परफ़ॉर्मेंस के लक्ष्य को कंट्रोल करने वाली सेटिंग.

JSON के काेड में दिखाना 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
फ़ील्ड
performanceGoalType

enum (PerformanceGoalType)

ज़रूरी है. परफ़ॉर्मेंस के लक्ष्य का टाइप.
ज़रूरी है. दी गई performance_goal_type के हिसाब से, परफ़ॉर्मेंस के लक्ष्य की वैल्यू. यहां उन फ़ील्ड की सूची दी गई है जिन्हें एक साथ इस्तेमाल नहीं किया जा सकता. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
performanceGoalAmountMicros

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 स्टैंडर्ड यूनिट है.
performanceGoalPercentageMicros

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

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

string

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

यह तब लागू होता है, जब performanceGoalType को PERFORMANCE_GOAL_TYPE_OTHER पर सेट किया जाता है.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

PerformanceGoalType

परफ़ॉर्मेंस के लक्ष्यों के संभावित टाइप.

Enums
PERFORMANCE_GOAL_TYPE_UNSPECIFIED इस वर्शन में, परफ़ॉर्मेंस के लक्ष्य का टाइप नहीं बताया गया है या इसकी जानकारी मौजूद नहीं है.
PERFORMANCE_GOAL_TYPE_CPM परफ़ॉर्मेंस का लक्ष्य, सीपीएम (हर हज़ार इंप्रेशन की लागत) में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_CPC परफ़ॉर्मेंस का लक्ष्य, सीपीसी (हर क्लिक की लागत) में सेट किया गया हो.
PERFORMANCE_GOAL_TYPE_CPA परफ़ॉर्मेंस का लक्ष्य, सीपीए (हर कार्रवाई की लागत) में सेट किया गया हो.
PERFORMANCE_GOAL_TYPE_CTR परफ़ॉर्मेंस का लक्ष्य, क्लिक मिलने की दर (सीटीआर) के प्रतिशत में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_VIEWABILITY परफ़ॉर्मेंस का लक्ष्य, विज्ञापन दिखने के प्रतिशत के हिसाब से सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_CPIAVC परफ़ॉर्मेंस का लक्ष्य, सीपीआईएवीसी (वीडियो पूरा होने पर, सुनाई देने और दिखने वाले इंप्रेशन की लागत) के तौर पर सेट किया गया हो.
PERFORMANCE_GOAL_TYPE_CPE परफ़ॉर्मेंस का लक्ष्य, सीपीई (हर जुड़ाव की लागत) में सेट किया गया हो.
PERFORMANCE_GOAL_TYPE_CPV परफ़ॉर्मेंस का लक्ष्य, सीपीवी (हर व्यू की लागत) में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_CLICK_CVR परफ़ॉर्मेंस का लक्ष्य, क्लिक कन्वर्ज़न रेट (हर क्लिक पर कन्वर्ज़न) के प्रतिशत में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR परफ़ॉर्मेंस का लक्ष्य, इंप्रेशन कन्वर्ज़न रेट (हर इंप्रेशन पर कन्वर्ज़न) के प्रतिशत में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_VCPM परफ़ॉर्मेंस का लक्ष्य, वीसीपीएम (दिखने वाले हर हज़ार इंप्रेशन की लागत) में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_VTR परफ़ॉर्मेंस का लक्ष्य, YouTube पर देखे जाने की दर (हर इंप्रेशन पर YouTube व्यू) के प्रतिशत में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE परफ़ॉर्मेंस का लक्ष्य, ऑडियो को पूरा सुनने की दर (हर इंप्रेशन के लिए, ऑडियो को पूरा सुनने की संख्या) के प्रतिशत में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE परफ़ॉर्मेंस का लक्ष्य, वीडियो को पूरा देखे जाने की दर (हर इंप्रेशन पर वीडियो को पूरा देखे जाने की संख्या) के प्रतिशत में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_OTHER परफ़ॉर्मेंस का लक्ष्य, 'अन्य' पर सेट हो.

CampaignFlight

ऐसी सेटिंग जो कैंपेन के लिए तय किए गए खर्च और अवधि को ट्रैक करती हैं.

JSON के काेड में दिखाना 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
फ़ील्ड
plannedSpendAmountMicros

string (int64 format)

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

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

object (DateRange)

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

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

CampaignBudget

कैंपेन का बजट तय करने के तरीके को कंट्रोल करने वाली सेटिंग.

JSON के काेड में दिखाना 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
फ़ील्ड
budgetId

string (int64 format)

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

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

string

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

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

enum (BudgetUnit)

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

string (int64 format)

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

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

object (DateRange)

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

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

enum (ExternalBudgetSource)

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

string

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

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

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

string

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

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

object (PrismaConfig)

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

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

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

ExternalBudgetSource

कैंपेन के बजट सेगमेंट के लिए बाहरी सोर्स.

Enums
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED इस वर्शन में, बाहरी बजट सोर्स की वैल्यू नहीं दी गई है या इसकी जानकारी नहीं है.
EXTERNAL_BUDGET_SOURCE_NONE बजट का कोई बाहरी सोर्स नहीं है.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN बजट का सोर्स Mediaocean है.

PrismaConfig

Mediaocean Prisma टूल के लिए खास सेटिंग.

JSON के काेड में दिखाना 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
फ़ील्ड
prismaType

enum (PrismaType)

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

object (PrismaCpeCode)

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

string

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

PrismaType

Prisma बजट के संभावित टाइप.

Enums
PRISMA_TYPE_UNSPECIFIED इस वर्शन में टाइप की जानकारी नहीं दी गई है या इसके बारे में पता नहीं है.
PRISMA_TYPE_DISPLAY डिसप्ले का टाइप.
PRISMA_TYPE_VIDEO वीडियो का टाइप.
PRISMA_TYPE_AUDIO ऑडियो का टाइप.
PRISMA_TYPE_SOCIAL सोशल टाइप.
PRISMA_TYPE_FEE शुल्क का टाइप.

PrismaCpeCode

Google पेमेंट्स सेंटर, इस कोड के कॉम्पोनेंट फ़ील्ड को खोजने और फ़िल्टर करने की सुविधा देता है.

JSON के काेड में दिखाना 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
फ़ील्ड
prismaClientCode

string

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

string

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

string

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

तरीके

create

 नया कैंपेन बनाता है.

delete

 किसी कैंपेन को हमेशा के लिए मिटाता है.

get

 कैंपेन की जानकारी मिलती है.

list

 विज्ञापन देने वाले व्यक्ति या कंपनी के कैंपेन की सूची दिखाता है.

patch

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