blob: dbc34d73b2d2c3a6ef2bf0a58bb57658cadcf784 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.campaigns.html">campaigns</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070079<p class="firstline">Creates a new campaign. Returns the newly created campaign if successful.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070080<p class="toc_element">
81 <code><a href="#delete">delete(advertiserId, campaignId, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070082<p class="firstline">Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070083<p class="toc_element">
84 <code><a href="#get">get(advertiserId, campaignId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a campaign.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#list">list(advertiserId, orderBy=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070089<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(advertiserId, campaignId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070094<p class="firstline">Updates an existing campaign. Returns the updated campaign if successful.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070095<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070098 <pre>Creates a new campaign. Returns the newly created campaign if successful.
Bu Sun Kim65020912020-05-20 12:08:20 -070099
100Args:
101 advertiserId: string, Output only. The unique ID of the advertiser the campaign belongs to. (required)
102 body: object, The request body.
103 The object takes the form of:
104
105{ # A single campaign.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700106 &quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign. Assigned by the system.
107 &quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign.
108 &quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.
109 &quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
110 &quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.
111 &quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59
112 },
113 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the campaign belongs to.
114 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the campaign.
115 &quot;campaignGoal&quot;: { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
116 &quot;campaignGoalType&quot;: &quot;A String&quot;, # Required. The type of the campaign goal.
117 &quot;performanceGoal&quot;: { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `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`
118 &quot;performanceGoalType&quot;: &quot;A String&quot;, # Required. The type of the performance goal.
119 &quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` For example 1500000 represents 1.5 standard units of the currency.
120 &quot;performanceGoalString&quot;: &quot;A String&quot;, # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
121 &quot;performanceGoalPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` For example, 70000 represents 7% (decimal 0.07).
Bu Sun Kim65020912020-05-20 12:08:20 -0700122 },
123 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700124 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the campaign was last updated. Assigned by the system.
125 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
126 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
127 &quot;campaignFlight&quot;: { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
128 &quot;plannedSpendAmountMicros&quot;: &quot;A String&quot;, # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
129 &quot;plannedDates&quot;: { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser&#x27;s time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
130 &quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
131 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
132 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
133 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
134 },
135 &quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
136 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
137 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
138 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
139 },
140 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700141 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700142 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700143
144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149Returns:
150 An object of the form:
151
152 { # A single campaign.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700153 &quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign. Assigned by the system.
154 &quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign.
155 &quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.
156 &quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
157 &quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.
158 &quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59
159 },
160 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the campaign belongs to.
161 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the campaign.
162 &quot;campaignGoal&quot;: { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
163 &quot;campaignGoalType&quot;: &quot;A String&quot;, # Required. The type of the campaign goal.
164 &quot;performanceGoal&quot;: { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `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`
165 &quot;performanceGoalType&quot;: &quot;A String&quot;, # Required. The type of the performance goal.
166 &quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` For example 1500000 represents 1.5 standard units of the currency.
167 &quot;performanceGoalString&quot;: &quot;A String&quot;, # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
168 &quot;performanceGoalPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` For example, 70000 represents 7% (decimal 0.07).
Bu Sun Kim65020912020-05-20 12:08:20 -0700169 },
170 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700171 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the campaign was last updated. Assigned by the system.
172 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
173 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
174 &quot;campaignFlight&quot;: { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
175 &quot;plannedSpendAmountMicros&quot;: &quot;A String&quot;, # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
176 &quot;plannedDates&quot;: { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser&#x27;s time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
177 &quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
178 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
179 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
180 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
181 },
182 &quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
183 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
184 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
185 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
186 },
187 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700188 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700189 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700190</div>
191
192<div class="method">
193 <code class="details" id="delete">delete(advertiserId, campaignId, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700194 <pre>Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.
Bu Sun Kim65020912020-05-20 12:08:20 -0700195
196Args:
197 advertiserId: string, The ID of the advertiser this campaign belongs to. (required)
198 campaignId: string, The ID of the campaign we need to delete. (required)
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204Returns:
205 An object of the form:
206
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700207 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700208 }</pre>
209</div>
210
211<div class="method">
212 <code class="details" id="get">get(advertiserId, campaignId, x__xgafv=None)</code>
213 <pre>Gets a campaign.
214
215Args:
216 advertiserId: string, Required. The ID of the advertiser this campaign belongs to. (required)
217 campaignId: string, Required. The ID of the campaign to fetch. (required)
218 x__xgafv: string, V1 error format.
219 Allowed values
220 1 - v1 error format
221 2 - v2 error format
222
223Returns:
224 An object of the form:
225
226 { # A single campaign.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700227 &quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign. Assigned by the system.
228 &quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign.
229 &quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.
230 &quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
231 &quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.
232 &quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59
233 },
234 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the campaign belongs to.
235 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the campaign.
236 &quot;campaignGoal&quot;: { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
237 &quot;campaignGoalType&quot;: &quot;A String&quot;, # Required. The type of the campaign goal.
238 &quot;performanceGoal&quot;: { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `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`
239 &quot;performanceGoalType&quot;: &quot;A String&quot;, # Required. The type of the performance goal.
240 &quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` For example 1500000 represents 1.5 standard units of the currency.
241 &quot;performanceGoalString&quot;: &quot;A String&quot;, # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
242 &quot;performanceGoalPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` For example, 70000 represents 7% (decimal 0.07).
Bu Sun Kim65020912020-05-20 12:08:20 -0700243 },
244 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700245 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the campaign was last updated. Assigned by the system.
246 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
247 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
248 &quot;campaignFlight&quot;: { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
249 &quot;plannedSpendAmountMicros&quot;: &quot;A String&quot;, # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
250 &quot;plannedDates&quot;: { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser&#x27;s time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
251 &quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
252 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
253 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
254 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
255 },
256 &quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
257 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
258 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
259 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
260 },
261 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700262 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700263 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700264</div>
265
266<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700267 <code class="details" id="list">list(advertiserId, orderBy=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
268 <pre>Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700269
270Args:
271 advertiserId: string, The ID of the advertiser to list campaigns for. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700272 orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix &quot;desc&quot; should be added to the field name. Example: `displayName desc`.
273 filter: string, Allows filtering by campaign properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus=&quot;ENTITY_STATUS_ACTIVE&quot; OR entityStatus=&quot;ENTITY_STATUS_PAUSED&quot;)` The length of this field should be no more than 500 characters.
274 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`.
275 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700276 x__xgafv: string, V1 error format.
277 Allowed values
278 1 - v1 error format
279 2 - v2 error format
280
281Returns:
282 An object of the form:
283
284 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700285 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCampaigns` method to retrieve the next page of results.
286 &quot;campaigns&quot;: [ # The list of campaigns. This list will be absent if empty.
Bu Sun Kim65020912020-05-20 12:08:20 -0700287 { # A single campaign.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700288 &quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign. Assigned by the system.
289 &quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign.
290 &quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.
291 &quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
292 &quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.
293 &quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59
294 },
295 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the campaign belongs to.
296 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the campaign.
297 &quot;campaignGoal&quot;: { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
298 &quot;campaignGoalType&quot;: &quot;A String&quot;, # Required. The type of the campaign goal.
299 &quot;performanceGoal&quot;: { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `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`
300 &quot;performanceGoalType&quot;: &quot;A String&quot;, # Required. The type of the performance goal.
301 &quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` For example 1500000 represents 1.5 standard units of the currency.
302 &quot;performanceGoalString&quot;: &quot;A String&quot;, # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
303 &quot;performanceGoalPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` For example, 70000 represents 7% (decimal 0.07).
Bu Sun Kim65020912020-05-20 12:08:20 -0700304 },
305 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700306 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the campaign was last updated. Assigned by the system.
307 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
308 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
309 &quot;campaignFlight&quot;: { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
310 &quot;plannedSpendAmountMicros&quot;: &quot;A String&quot;, # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
311 &quot;plannedDates&quot;: { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser&#x27;s time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
312 &quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
313 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
314 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
315 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
316 },
317 &quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
318 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
319 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
320 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
321 },
322 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700323 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700324 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700325 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700326 }</pre>
327</div>
328
329<div class="method">
330 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
331 <pre>Retrieves the next page of results.
332
333Args:
334 previous_request: The request for the previous page. (required)
335 previous_response: The response from the request for the previous page. (required)
336
337Returns:
338 A request object that you can call &#x27;execute()&#x27; on to request the next
339 page. Returns None if there are no more items in the collection.
340 </pre>
341</div>
342
343<div class="method">
344 <code class="details" id="patch">patch(advertiserId, campaignId, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700345 <pre>Updates an existing campaign. Returns the updated campaign if successful.
Bu Sun Kim65020912020-05-20 12:08:20 -0700346
347Args:
348 advertiserId: string, Output only. The unique ID of the advertiser the campaign belongs to. (required)
349 campaignId: string, Output only. The unique ID of the campaign. Assigned by the system. (required)
350 body: object, The request body.
351 The object takes the form of:
352
353{ # A single campaign.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700354 &quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign. Assigned by the system.
355 &quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign.
356 &quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.
357 &quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
358 &quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.
359 &quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59
360 },
361 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the campaign belongs to.
362 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the campaign.
363 &quot;campaignGoal&quot;: { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
364 &quot;campaignGoalType&quot;: &quot;A String&quot;, # Required. The type of the campaign goal.
365 &quot;performanceGoal&quot;: { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `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`
366 &quot;performanceGoalType&quot;: &quot;A String&quot;, # Required. The type of the performance goal.
367 &quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` For example 1500000 represents 1.5 standard units of the currency.
368 &quot;performanceGoalString&quot;: &quot;A String&quot;, # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
369 &quot;performanceGoalPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` For example, 70000 represents 7% (decimal 0.07).
Bu Sun Kim65020912020-05-20 12:08:20 -0700370 },
371 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700372 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the campaign was last updated. Assigned by the system.
373 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
374 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
375 &quot;campaignFlight&quot;: { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
376 &quot;plannedSpendAmountMicros&quot;: &quot;A String&quot;, # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
377 &quot;plannedDates&quot;: { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser&#x27;s time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
378 &quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
379 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
380 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
381 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
382 },
383 &quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
384 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
385 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
386 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
387 },
388 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700389 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700390 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700391
392 updateMask: string, Required. The mask to control which fields to update.
393 x__xgafv: string, V1 error format.
394 Allowed values
395 1 - v1 error format
396 2 - v2 error format
397
398Returns:
399 An object of the form:
400
401 { # A single campaign.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700402 &quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign. Assigned by the system.
403 &quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency cap setting of the campaign.
404 &quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.
405 &quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
406 &quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.
407 &quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59
408 },
409 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the campaign belongs to.
410 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the campaign.
411 &quot;campaignGoal&quot;: { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
412 &quot;campaignGoalType&quot;: &quot;A String&quot;, # Required. The type of the campaign goal.
413 &quot;performanceGoal&quot;: { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `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`
414 &quot;performanceGoalType&quot;: &quot;A String&quot;, # Required. The type of the performance goal.
415 &quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` For example 1500000 represents 1.5 standard units of the currency.
416 &quot;performanceGoalString&quot;: &quot;A String&quot;, # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.
417 &quot;performanceGoalPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` For example, 70000 represents 7% (decimal 0.07).
Bu Sun Kim65020912020-05-20 12:08:20 -0700418 },
419 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700420 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the campaign was last updated. Assigned by the system.
421 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
422 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
423 &quot;campaignFlight&quot;: { # Settings that track the planned spend and duration of a campaign. # Required. The planned spend and duration of the campaign.
424 &quot;plannedSpendAmountMicros&quot;: &quot;A String&quot;, # The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
425 &quot;plannedDates&quot;: { # A date range. # Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser&#x27;s time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037.
426 &quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
427 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
428 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
429 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
430 },
431 &quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
432 &quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
433 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
434 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
435 },
436 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700437 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700438 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700439</div>
440
441</body></html>