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 ऑनलाइन कार्रवाइयां या विज़िट बढ़ाएं.

PerformanceGoal

ऐसी सेटिंग जो किसी कैंपेन के परफ़ॉर्मेंस लक्ष्य को कंट्रोल करती हैं.

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

enum (PerformanceGoalType)

ज़रूरी है. परफ़ॉर्मेंस लक्ष्य का टाइप.
यूनियन फ़ील्ड performance_goal_value. ज़रूरी है. किसी दिए गए performance_goal_type से जुड़ी परफ़ॉर्मेंस लक्ष्य की वैल्यू. performance_goal_value इनमें से कोई एक हो सकता है:
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

उदाहरण के लिए, 70,000 का मतलब 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 परफ़ॉर्मेंस का लक्ष्य, CPIAVC (हर इंप्रेशन पूरा होने पर सुनने और देखने की लागत) के तौर पर सेट किया गया है.
PERFORMANCE_GOAL_TYPE_CPE परफ़ॉर्मेंस का लक्ष्य, सीपीई (हर यूज़र ऐक्टिविटी की लागत) में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_CPV परफ़ॉर्मेंस का लक्ष्य, सीपीवी (हर व्यू की लागत) में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_CLICK_CVR परफ़ॉर्मेंस लक्ष्य, क्लिक कन्वर्ज़न रेट (हर क्लिक पर कन्वर्ज़न) के प्रतिशत में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR परफ़ॉर्मेंस लक्ष्य, इंप्रेशन कन्वर्ज़न रेट (हर इंप्रेशन के हिसाब से कन्वर्ज़न) के प्रतिशत में सेट किया जाता है.
PERFORMANCE_GOAL_TYPE_VCPM परफ़ॉर्मेंस का लक्ष्य, 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 Payments Center में, इस कोड के कॉम्पोनेंट फ़ील्ड को खोजा और फ़िल्टर किया जा सकता है.

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

string

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

string

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

string

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

तरीके

create

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

delete

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

get

 कैंपेन को दिखाता है.

list

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

listAssignedTargetingOptions

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

patch

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