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

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

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

listAssignedTargetingOptions

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

patch

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