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)
    }
  ]
}
फ़ील्ड
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)

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

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

object (CampaignGoal)

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

object (CampaignFlight)

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

object (FrequencyCap)

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

object (CampaignBudget)

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

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

CampaignGoal

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

जेएसओएन के काेड में दिखाना 
{
  "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 ऑनलाइन कार्रवाई या विज़िट बढ़ाएं.

CampaignFlight

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

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

string (int64 format)

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

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

object (DateRange)

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

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

CampaignBudget

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

जेएसओएन के काेड में दिखाना 
{
  "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 से ज़्यादा होना चाहिए. उदाहरण के लिए, 50,00,00,000, मुद्रा की 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 टूल के लिए खास सेटिंग.

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

enum (PrismaType)

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

object (PrismaCpeCode)

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

string

ज़रूरी है. इस बजट को आबंटित इकाई (DSP, साइट, वगैरह).

PrismaType

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

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

PrismaCpeCode

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

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

string

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

string

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

string

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

तरीके

create

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

delete

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

get

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

list

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

listAssignedTargetingOptions

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

patch

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