blob: 1363f177943bb0fcb1bbeef7bbb9c4e4d1cee2c4 [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="displayvideo_v1.advertisers.assets.html">assets()</a></code>
79</p>
80<p class="firstline">Returns the assets Resource.</p>
81
82<p class="toc_element">
83 <code><a href="displayvideo_v1.advertisers.campaigns.html">campaigns()</a></code>
84</p>
85<p class="firstline">Returns the campaigns Resource.</p>
86
87<p class="toc_element">
88 <code><a href="displayvideo_v1.advertisers.channels.html">channels()</a></code>
89</p>
90<p class="firstline">Returns the channels Resource.</p>
91
92<p class="toc_element">
93 <code><a href="displayvideo_v1.advertisers.creatives.html">creatives()</a></code>
94</p>
95<p class="firstline">Returns the creatives Resource.</p>
96
97<p class="toc_element">
98 <code><a href="displayvideo_v1.advertisers.insertionOrders.html">insertionOrders()</a></code>
99</p>
100<p class="firstline">Returns the insertionOrders Resource.</p>
101
102<p class="toc_element">
103 <code><a href="displayvideo_v1.advertisers.lineItems.html">lineItems()</a></code>
104</p>
105<p class="firstline">Returns the lineItems Resource.</p>
106
107<p class="toc_element">
108 <code><a href="displayvideo_v1.advertisers.locationLists.html">locationLists()</a></code>
109</p>
110<p class="firstline">Returns the locationLists Resource.</p>
111
112<p class="toc_element">
113 <code><a href="displayvideo_v1.advertisers.negativeKeywordLists.html">negativeKeywordLists()</a></code>
114</p>
115<p class="firstline">Returns the negativeKeywordLists Resource.</p>
116
117<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700118 <code><a href="displayvideo_v1.advertisers.targetingTypes.html">targetingTypes()</a></code>
119</p>
120<p class="firstline">Returns the targetingTypes Resource.</p>
121
122<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700123 <code><a href="#audit">audit(advertiserId, readMask=None, x__xgafv=None)</a></code></p>
124<p class="firstline">Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.</p>
125<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700126 <code><a href="#bulkEditAdvertiserAssignedTargetingOptions">bulkEditAdvertiserAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)</a></code></p>
127<p class="firstline">Bulk edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .</p>
128<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700129 <code><a href="#bulkListAdvertiserAssignedTargetingOptions">bulkListAdvertiserAssignedTargetingOptions(advertiserId, pageSize=None, orderBy=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700130<p class="firstline">Lists assigned targeting options of an advertiser across targeting types.</p>
131<p class="toc_element">
132 <code><a href="#bulkListAdvertiserAssignedTargetingOptions_next">bulkListAdvertiserAssignedTargetingOptions_next(previous_request, previous_response)</a></code></p>
133<p class="firstline">Retrieves the next page of results.</p>
134<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700135 <code><a href="#close">close()</a></code></p>
136<p class="firstline">Close httplib2 connections.</p>
137<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700138 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700139<p class="firstline">Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700140<p class="toc_element">
141 <code><a href="#delete">delete(advertiserId, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700142<p class="firstline">Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700143<p class="toc_element">
144 <code><a href="#get">get(advertiserId, x__xgafv=None)</a></code></p>
145<p class="firstline">Gets an advertiser.</p>
146<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700147 <code><a href="#list">list(pageSize=None, orderBy=None, pageToken=None, filter=None, partnerId=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700148<p class="firstline">Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700149<p class="toc_element">
150 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
151<p class="firstline">Retrieves the next page of results.</p>
152<p class="toc_element">
153 <code><a href="#patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700154<p class="firstline">Updates an existing advertiser. Returns the updated advertiser if successful.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700155<h3>Method Details</h3>
156<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700157 <code class="details" id="audit">audit(advertiserId, readMask=None, x__xgafv=None)</code>
158 <pre>Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.
159
160Args:
161 advertiserId: string, Required. The ID of the advertiser to audit. (required)
162 readMask: string, Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168Returns:
169 An object of the form:
170
171 { # Response message for AdvertiserService.AuditAdvertiser.
172 &quot;negativelyTargetedChannelsCount&quot;: &quot;A String&quot;, # The number of negatively targeted channels created under this advertiser. These negatively targeted channels count towards the limit of 5 negatively targeted channels per advertiser.
173 &quot;usedLineItemsCount&quot;: &quot;A String&quot;, # The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9999 line items per advertiser.
174 &quot;usedCampaignsCount&quot;: &quot;A String&quot;, # The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser.
175 &quot;channelsCount&quot;: &quot;A String&quot;, # The number of channels created under this advertiser. These channels count towards the limit of 1000 channels per advertiser.
176 &quot;usedInsertionOrdersCount&quot;: &quot;A String&quot;, # The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9999 insertion orders per advertiser.
177 &quot;negativeKeywordListsCount&quot;: &quot;A String&quot;, # The number of negative keyword lists created under this advertiser. These negative keyword lists count towards the limit of 20 negative keyword lists per advertiser.
178 &quot;adGroupCriteriaCount&quot;: &quot;A String&quot;, # The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 4500000 ad group targeting options per advertiser. Qualifying Targeting types: * Channels, URLs, apps, and collections * Demographic * Google Audiences, including Affinity, Custom Affinity, and In-market audiences * Inventory source * Keyword * Mobile app category * User lists * Video targeting * Viewability
179 &quot;campaignCriteriaCount&quot;: &quot;A String&quot;, # The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 900000 campaign targeting options per advertiser. Qualifying Targeting types: * Position * Browser * Connection speed * Day and time * Device and operating system * Digital content label * Sensitive categories * Environment * Geography, including business chains and proximity * ISP * Language * Third-party verification
180 }</pre>
181</div>
182
183<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700184 <code class="details" id="bulkEditAdvertiserAssignedTargetingOptions">bulkEditAdvertiserAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)</code>
185 <pre>Bulk edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
186
187Args:
188 advertiserId: string, Required. The ID of the advertiser. (required)
189 body: object, The request body.
190 The object takes the form of:
191
192{ # Request message for BulkEditAdvertiserAssignedTargetingOptions.
193 &quot;deleteRequests&quot;: [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`.
194 { # A request listing which assigned targeting options of a given targeting type should be deleted.
195 &quot;targetingType&quot;: &quot;A String&quot;, # Required. Identifies the type of this assigned targeting option.
196 &quot;assignedTargetingOptionIds&quot;: [ # Required. The assigned targeting option IDs to delete.
197 &quot;A String&quot;,
198 ],
199 },
200 ],
201 &quot;createRequests&quot;: [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`.
202 { # A request listing which assigned targeting options of a given targeting type should be created and added.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700203 &quot;assignedTargetingOptions&quot;: [ # Required. The assigned targeting options to create and add.
204 { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700205 &quot;operatingSystemDetails&quot;: { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`.
206 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the operating system.
207 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
208 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700209 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700210 &quot;genderDetails&quot;: { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_GENDER`. # Gender details. This field will be populated when the TargetingType is `TARGETING_TYPE_GENDER`.
211 &quot;gender&quot;: &quot;A String&quot;, # Output only. The gender of the audience.
212 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`.
213 },
214 &quot;languageDetails&quot;: { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the TargetingType is `TARGETING_TYPE_LANGUAGE`.
215 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same line item must have the same value for this field.
216 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the language (e.g., &quot;French&quot;).
217 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700218 },
219 &quot;inventorySourceGroupDetails&quot;: { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
220 &quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
221 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700222 &quot;regionalLocationListDetails&quot;: { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
223 &quot;regionalLocationListId&quot;: &quot;A String&quot;, # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
224 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
225 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700226 &quot;sensitiveCategoryExclusionDetails&quot;: { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren&#x27;t visible in line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can&#x27;t override them.
227 &quot;sensitiveCategory&quot;: &quot;A String&quot;, # Output only. An enum for the DV360 Sensitive category content classifier.
228 &quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the sensitive category to be EXCLUDED.
229 },
230 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this assigned targeting option.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700231 &quot;contentOutstreamPositionDetails&quot;: { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
232 &quot;contentOutstreamPosition&quot;: &quot;A String&quot;, # Output only. The content outstream position.
233 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
234 },
235 &quot;viewabilityDetails&quot;: { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the TargetingType is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per line item.
236 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., &quot;509010&quot; for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).
237 &quot;viewability&quot;: &quot;A String&quot;, # Output only. The predicted viewability percentage.
238 },
239 &quot;keywordDetails&quot;: { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the TargetingType is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a line item. No limit on number of positive keywords that can be assigned.
240 &quot;keyword&quot;: &quot;A String&quot;, # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
241 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
242 },
243 &quot;householdIncomeDetails&quot;: { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
244 &quot;householdIncome&quot;: &quot;A String&quot;, # Output only. The household income of the audience.
245 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.
246 },
247 &quot;inheritance&quot;: &quot;A String&quot;, # Output only. The inheritance status of the assigned targeting option.
248 &quot;videoPlayerSizeDetails&quot;: { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
249 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
250 &quot;videoPlayerSize&quot;: &quot;A String&quot;, # Output only. The video player size.
251 },
252 &quot;browserDetails&quot;: { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the TargetingType is `TARGETING_TYPE_BROWSER`.
253 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same line item must have the same value for this field.
254 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the browser.
255 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
256 },
257 &quot;subExchangeDetails&quot;: { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`.
258 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
259 },
260 &quot;parentalStatusDetails&quot;: { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`.
261 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.
262 &quot;parentalStatus&quot;: &quot;A String&quot;, # Output only. The parental status of the audience.
263 },
264 &quot;appDetails&quot;: { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the TargetingType is `TARGETING_TYPE_APP`.
265 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
266 &quot;appId&quot;: &quot;A String&quot;, # Required. The ID of the app. Android&#x27;s Play store app uses bundle ID, for example `com.google.android.gm`. Apple&#x27;s App store app ID uses 9 digit string, for example `422689480`.
267 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app.
268 },
269 &quot;carrierAndIspDetails&quot;: { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`.
270 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the carrier or ISP.
271 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same line item must have the same value for this field.
272 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
273 },
274 &quot;targetingType&quot;: &quot;A String&quot;, # Output only. Identifies the type of this assigned targeting option.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700275 &quot;audienceGroupDetails&quot;: { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is UNION&#x27;ed with other groups. # Audience targeting details. This field will be populated when the TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per line item.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700276 &quot;excludedGoogleAudienceGroup&quot;: { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. It&#x27;s COMPLEMENT is used to UNION other audience groups. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
277 &quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
278 { # Details of Google audience targeting setting.
279 &quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
280 },
281 ],
282 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700283 &quot;includedFirstAndThirdPartyAudienceGroups&quot;: [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION&#x27;ed with other audience groups. Repeated groups with same settings will be ignored.
284 { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.
285 &quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
286 { # Details of first and third party audience targeting setting.
287 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
288 &quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
289 },
290 ],
291 },
292 ],
293 &quot;includedCustomListGroup&quot;: { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only.
294 &quot;settings&quot;: [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.
295 { # Details of custom list targeting setting.
296 &quot;customListId&quot;: &quot;A String&quot;, # Required. Custom id of custom list targeting setting. This id is custom_list_id.
297 },
298 ],
299 },
300 &quot;includedCombinedAudienceGroup&quot;: { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only.
301 &quot;settings&quot;: [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
302 { # Details of combined audience targeting setting.
303 &quot;combinedAudienceId&quot;: &quot;A String&quot;, # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
304 },
305 ],
306 },
307 &quot;excludedFirstAndThirdPartyAudienceGroup&quot;: { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. Its COMPLEMENT is used to UNION other audience groups.
308 &quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
309 { # Details of first and third party audience targeting setting.
310 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
311 &quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
312 },
313 ],
314 },
315 &quot;includedGoogleAudienceGroup&quot;: { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only.
316 &quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
317 { # Details of Google audience targeting setting.
318 &quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
319 },
320 ],
321 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700322 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700323 &quot;dayAndTimeDetails&quot;: { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the TargetingType is `TARGETING_TYPE_DAY_AND_TIME`.
324 &quot;dayOfWeek&quot;: &quot;A String&quot;, # Required. The day of the week for this day and time targeting setting.
325 &quot;startHour&quot;: 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
326 &quot;endHour&quot;: 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
327 &quot;timeZoneResolution&quot;: &quot;A String&quot;, # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700328 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700329 &quot;authorizedSellerStatusDetails&quot;: { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status details. This field will be populated when the TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per line item. If a line item doesn&#x27;t have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
330 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
331 &quot;authorizedSellerStatus&quot;: &quot;A String&quot;, # Output only. The authorized seller status to target.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700332 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700333 &quot;exchangeDetails&quot;: { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the TargetingType is `TARGETING_TYPE_EXCHANGE`.
334 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`.
335 },
336 &quot;channelDetails&quot;: { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the TargetingType is `TARGETING_TYPE_CHANNEL`.
337 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
338 &quot;channelId&quot;: &quot;A String&quot;, # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
339 },
340 &quot;userRewardedContentDetails&quot;: { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the TargetingType is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
341 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
342 &quot;userRewardedContent&quot;: &quot;A String&quot;, # Output only. User rewarded content status for video ads.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700343 },
344 &quot;thirdPartyVerifierDetails&quot;: { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
345 &quot;adloox&quot;: { # Details of Adloox settings. # Third party brand verifier -- Adloox.
346 &quot;excludedAdlooxCategories&quot;: [ # Adloox&#x27;s brand safety settings.
347 &quot;A String&quot;,
348 ],
349 },
350 &quot;integralAdScience&quot;: { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700351 &quot;excludedGamblingRisk&quot;: &quot;A String&quot;, # Brand Safety - **Gambling**.
352 &quot;videoViewability&quot;: &quot;A String&quot;, # Video Viewability Section (applicable to video line items only).
353 &quot;excludedAlcoholRisk&quot;: &quot;A String&quot;, # Brand Safety - **Alcohol**.
354 &quot;excludedHateSpeechRisk&quot;: &quot;A String&quot;, # Brand Safety - **Hate speech**.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700355 &quot;excludedDrugsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Drugs**.
356 &quot;excludedAdFraudRisk&quot;: &quot;A String&quot;, # Ad Fraud settings.
357 &quot;traqScoreOption&quot;: &quot;A String&quot;, # True advertising quality (applicable to Display line items only).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700358 &quot;displayViewability&quot;: &quot;A String&quot;, # Display Viewability section (applicable to display line items only).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700359 &quot;excludedIllegalDownloadsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Illegal downloads**.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700360 &quot;excludeUnrateable&quot;: True or False, # Brand Safety - **Unrateable**.
361 &quot;excludedViolenceRisk&quot;: &quot;A String&quot;, # Brand Safety - **Violence**.
362 &quot;excludedAdultRisk&quot;: &quot;A String&quot;, # Brand Safety - **Adult content**.
363 &quot;excludedOffensiveLanguageRisk&quot;: &quot;A String&quot;, # Brand Safety - **Offensive language**.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700364 },
365 &quot;doubleVerify&quot;: { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700366 &quot;fraudInvalidTraffic&quot;: { # DoubleVerify Fraud &amp; Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud &amp; IVT Rates.
367 &quot;avoidedFraudOption&quot;: &quot;A String&quot;, # Avoid Sites and Apps with historical Fraud &amp; IVT.
368 &quot;avoidInsufficientOption&quot;: True or False, # Insufficient Historical Fraud &amp; IVT Stats.
369 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700370 &quot;appStarRating&quot;: { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
371 &quot;avoidInsufficientStarRating&quot;: True or False, # Avoid bidding on apps with insufficient star ratings.
372 &quot;avoidedStarRating&quot;: &quot;A String&quot;, # Avoid bidding on apps with the star ratings.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700373 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700374 &quot;displayViewability&quot;: { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
375 &quot;iab&quot;: &quot;A String&quot;, # Target web and app inventory to maximize IAB viewable rate.
376 &quot;viewableDuring&quot;: &quot;A String&quot;, # Target web and app inventory to maximize 100% viewable duration.
377 },
378 &quot;brandSafetyCategories&quot;: { # Settings for brand safety controls. # DV Brand Safety Controls.
379 &quot;avoidedMediumSeverityCategories&quot;: [ # Brand safety medium severity avoidance categories.
380 &quot;A String&quot;,
381 ],
382 &quot;avoidedHighSeverityCategories&quot;: [ # Brand safety high severity avoidance categories.
383 &quot;A String&quot;,
384 ],
385 &quot;avoidUnknownBrandSafetyCategory&quot;: True or False, # Unknown or unrateable.
386 },
387 &quot;videoViewability&quot;: { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
388 &quot;playerImpressionRate&quot;: &quot;A String&quot;, # Target inventory to maximize impressions with 400x300 or greater player size.
389 &quot;videoIab&quot;: &quot;A String&quot;, # Target web inventory to maximize IAB viewable rate.
390 &quot;videoViewableRate&quot;: &quot;A String&quot;, # Target web inventory to maximize fully viewable rate.
391 },
392 &quot;avoidedAgeRatings&quot;: [ # Avoid bidding on apps with the age rating.
393 &quot;A String&quot;,
394 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700395 },
396 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700397 &quot;proximityLocationListDetails&quot;: { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the TargetingType is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
398 &quot;proximityLocationListId&quot;: &quot;A String&quot;, # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
399 &quot;proximityRadiusRange&quot;: &quot;A String&quot;, # Required. Radius range for proximity location list. This represents the size of the area around a chosen location that will be targeted. `All` proximity location targeting under a single line item must have the same radius range value. Set this value to match any existing targeting. If updated, this field will change the radius range for all proximity targeting under the line item.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700400 },
401 &quot;contentInstreamPositionDetails&quot;: { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
402 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
403 &quot;contentInstreamPosition&quot;: &quot;A String&quot;, # Output only. The content instream position for video or audio ads.
404 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700405 &quot;environmentDetails&quot;: { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the TargetingType is `TARGETING_TYPE_ENVIRONMENT`.
406 &quot;environment&quot;: &quot;A String&quot;, # Output only. The serving environment.
407 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., &quot;508010&quot; for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700408 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700409 &quot;inventorySourceDetails&quot;: { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`.
410 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
411 },
412 &quot;deviceTypeDetails&quot;: { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the TargetingType is `TARGETING_TYPE_DEVICE_TYPE`.
413 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the device type.
414 &quot;deviceType&quot;: &quot;A String&quot;, # Output only. The display name of the device type.
415 },
416 &quot;geoRegionDetails&quot;: { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the TargetingType is `TARGETING_TYPE_GEO_REGION`.
417 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region (e.g., &quot;Ontario, Canada&quot;).
418 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
419 &quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of geographic region targeting.
420 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
421 },
422 &quot;appCategoryDetails&quot;: { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the TargetingType is `TARGETING_TYPE_APP_CATEGORY`.
423 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
424 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
425 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app category.
426 },
427 &quot;ageRangeDetails&quot;: { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the TargetingType is `TARGETING_TYPE_AGE_RANGE`.
428 &quot;ageRange&quot;: &quot;A String&quot;, # Output only. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
429 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.
430 },
431 &quot;deviceMakeModelDetails&quot;: { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
432 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
433 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the device make and model.
434 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
435 },
436 &quot;assignedTargetingOptionId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts.
437 &quot;categoryDetails&quot;: { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the TargetingType is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
438 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the category.
439 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
440 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
441 },
442 &quot;negativeKeywordListDetails&quot;: { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a line item.
443 &quot;negativeKeywordListId&quot;: &quot;A String&quot;, # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
444 },
445 &quot;urlDetails&quot;: { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the TargetingType is `TARGETING_TYPE_URL`.
446 &quot;url&quot;: &quot;A String&quot;, # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
447 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
448 },
449 &quot;digitalContentLabelExclusionDetails&quot;: { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren&#x27;t visible in line item settings). Line item settings can exclude content labels in addition to advertiser exclusions, but can&#x27;t override them. A line item won&#x27;t serve if all the digital content labels are excluded.
450 &quot;contentRatingTier&quot;: &quot;A String&quot;, # Output only. The display name of the digital content label rating tier.
451 &quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the digital content label to be EXCLUDED.
452 },
453 &quot;onScreenPositionDetails&quot;: { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`.
454 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
455 &quot;onScreenPosition&quot;: &quot;A String&quot;, # Output only. The on screen position.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700456 },
457 },
458 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700459 &quot;targetingType&quot;: &quot;A String&quot;, # Required. Identifies the type of this assigned targeting option.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700460 },
461 ],
462 }
463
464 x__xgafv: string, V1 error format.
465 Allowed values
466 1 - v1 error format
467 2 - v2 error format
468
469Returns:
470 An object of the form:
471
472 {
473 &quot;createdAssignedTargetingOptions&quot;: [ # The list of assigned targeting options that have been successfully created. This list will be absent if empty.
474 { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700475 &quot;operatingSystemDetails&quot;: { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`.
476 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the operating system.
477 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
478 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700479 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700480 &quot;genderDetails&quot;: { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_GENDER`. # Gender details. This field will be populated when the TargetingType is `TARGETING_TYPE_GENDER`.
481 &quot;gender&quot;: &quot;A String&quot;, # Output only. The gender of the audience.
482 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`.
483 },
484 &quot;languageDetails&quot;: { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the TargetingType is `TARGETING_TYPE_LANGUAGE`.
485 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same line item must have the same value for this field.
486 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the language (e.g., &quot;French&quot;).
487 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700488 },
489 &quot;inventorySourceGroupDetails&quot;: { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
490 &quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
491 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700492 &quot;regionalLocationListDetails&quot;: { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
493 &quot;regionalLocationListId&quot;: &quot;A String&quot;, # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
494 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
495 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700496 &quot;sensitiveCategoryExclusionDetails&quot;: { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren&#x27;t visible in line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can&#x27;t override them.
497 &quot;sensitiveCategory&quot;: &quot;A String&quot;, # Output only. An enum for the DV360 Sensitive category content classifier.
498 &quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the sensitive category to be EXCLUDED.
499 },
500 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this assigned targeting option.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700501 &quot;contentOutstreamPositionDetails&quot;: { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
502 &quot;contentOutstreamPosition&quot;: &quot;A String&quot;, # Output only. The content outstream position.
503 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
504 },
505 &quot;viewabilityDetails&quot;: { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the TargetingType is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per line item.
506 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., &quot;509010&quot; for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).
507 &quot;viewability&quot;: &quot;A String&quot;, # Output only. The predicted viewability percentage.
508 },
509 &quot;keywordDetails&quot;: { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the TargetingType is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a line item. No limit on number of positive keywords that can be assigned.
510 &quot;keyword&quot;: &quot;A String&quot;, # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
511 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
512 },
513 &quot;householdIncomeDetails&quot;: { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
514 &quot;householdIncome&quot;: &quot;A String&quot;, # Output only. The household income of the audience.
515 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.
516 },
517 &quot;inheritance&quot;: &quot;A String&quot;, # Output only. The inheritance status of the assigned targeting option.
518 &quot;videoPlayerSizeDetails&quot;: { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
519 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
520 &quot;videoPlayerSize&quot;: &quot;A String&quot;, # Output only. The video player size.
521 },
522 &quot;browserDetails&quot;: { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the TargetingType is `TARGETING_TYPE_BROWSER`.
523 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same line item must have the same value for this field.
524 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the browser.
525 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
526 },
527 &quot;subExchangeDetails&quot;: { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`.
528 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
529 },
530 &quot;parentalStatusDetails&quot;: { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`.
531 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.
532 &quot;parentalStatus&quot;: &quot;A String&quot;, # Output only. The parental status of the audience.
533 },
534 &quot;appDetails&quot;: { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the TargetingType is `TARGETING_TYPE_APP`.
535 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
536 &quot;appId&quot;: &quot;A String&quot;, # Required. The ID of the app. Android&#x27;s Play store app uses bundle ID, for example `com.google.android.gm`. Apple&#x27;s App store app ID uses 9 digit string, for example `422689480`.
537 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app.
538 },
539 &quot;carrierAndIspDetails&quot;: { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`.
540 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the carrier or ISP.
541 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same line item must have the same value for this field.
542 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
543 },
544 &quot;targetingType&quot;: &quot;A String&quot;, # Output only. Identifies the type of this assigned targeting option.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700545 &quot;audienceGroupDetails&quot;: { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is UNION&#x27;ed with other groups. # Audience targeting details. This field will be populated when the TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per line item.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700546 &quot;excludedGoogleAudienceGroup&quot;: { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. It&#x27;s COMPLEMENT is used to UNION other audience groups. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
547 &quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
548 { # Details of Google audience targeting setting.
549 &quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
550 },
551 ],
552 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700553 &quot;includedFirstAndThirdPartyAudienceGroups&quot;: [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION&#x27;ed with other audience groups. Repeated groups with same settings will be ignored.
554 { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.
555 &quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
556 { # Details of first and third party audience targeting setting.
557 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
558 &quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
559 },
560 ],
561 },
562 ],
563 &quot;includedCustomListGroup&quot;: { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only.
564 &quot;settings&quot;: [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.
565 { # Details of custom list targeting setting.
566 &quot;customListId&quot;: &quot;A String&quot;, # Required. Custom id of custom list targeting setting. This id is custom_list_id.
567 },
568 ],
569 },
570 &quot;includedCombinedAudienceGroup&quot;: { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only.
571 &quot;settings&quot;: [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
572 { # Details of combined audience targeting setting.
573 &quot;combinedAudienceId&quot;: &quot;A String&quot;, # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
574 },
575 ],
576 },
577 &quot;excludedFirstAndThirdPartyAudienceGroup&quot;: { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. Its COMPLEMENT is used to UNION other audience groups.
578 &quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
579 { # Details of first and third party audience targeting setting.
580 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
581 &quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
582 },
583 ],
584 },
585 &quot;includedGoogleAudienceGroup&quot;: { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only.
586 &quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
587 { # Details of Google audience targeting setting.
588 &quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
589 },
590 ],
591 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700592 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700593 &quot;dayAndTimeDetails&quot;: { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the TargetingType is `TARGETING_TYPE_DAY_AND_TIME`.
594 &quot;dayOfWeek&quot;: &quot;A String&quot;, # Required. The day of the week for this day and time targeting setting.
595 &quot;startHour&quot;: 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
596 &quot;endHour&quot;: 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
597 &quot;timeZoneResolution&quot;: &quot;A String&quot;, # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700598 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700599 &quot;authorizedSellerStatusDetails&quot;: { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status details. This field will be populated when the TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per line item. If a line item doesn&#x27;t have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
600 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
601 &quot;authorizedSellerStatus&quot;: &quot;A String&quot;, # Output only. The authorized seller status to target.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700602 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700603 &quot;exchangeDetails&quot;: { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the TargetingType is `TARGETING_TYPE_EXCHANGE`.
604 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`.
605 },
606 &quot;channelDetails&quot;: { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the TargetingType is `TARGETING_TYPE_CHANNEL`.
607 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
608 &quot;channelId&quot;: &quot;A String&quot;, # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
609 },
610 &quot;userRewardedContentDetails&quot;: { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the TargetingType is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
611 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
612 &quot;userRewardedContent&quot;: &quot;A String&quot;, # Output only. User rewarded content status for video ads.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700613 },
614 &quot;thirdPartyVerifierDetails&quot;: { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
615 &quot;adloox&quot;: { # Details of Adloox settings. # Third party brand verifier -- Adloox.
616 &quot;excludedAdlooxCategories&quot;: [ # Adloox&#x27;s brand safety settings.
617 &quot;A String&quot;,
618 ],
619 },
620 &quot;integralAdScience&quot;: { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700621 &quot;excludedGamblingRisk&quot;: &quot;A String&quot;, # Brand Safety - **Gambling**.
622 &quot;videoViewability&quot;: &quot;A String&quot;, # Video Viewability Section (applicable to video line items only).
623 &quot;excludedAlcoholRisk&quot;: &quot;A String&quot;, # Brand Safety - **Alcohol**.
624 &quot;excludedHateSpeechRisk&quot;: &quot;A String&quot;, # Brand Safety - **Hate speech**.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700625 &quot;excludedDrugsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Drugs**.
626 &quot;excludedAdFraudRisk&quot;: &quot;A String&quot;, # Ad Fraud settings.
627 &quot;traqScoreOption&quot;: &quot;A String&quot;, # True advertising quality (applicable to Display line items only).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700628 &quot;displayViewability&quot;: &quot;A String&quot;, # Display Viewability section (applicable to display line items only).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700629 &quot;excludedIllegalDownloadsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Illegal downloads**.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700630 &quot;excludeUnrateable&quot;: True or False, # Brand Safety - **Unrateable**.
631 &quot;excludedViolenceRisk&quot;: &quot;A String&quot;, # Brand Safety - **Violence**.
632 &quot;excludedAdultRisk&quot;: &quot;A String&quot;, # Brand Safety - **Adult content**.
633 &quot;excludedOffensiveLanguageRisk&quot;: &quot;A String&quot;, # Brand Safety - **Offensive language**.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700634 },
635 &quot;doubleVerify&quot;: { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700636 &quot;fraudInvalidTraffic&quot;: { # DoubleVerify Fraud &amp; Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud &amp; IVT Rates.
637 &quot;avoidedFraudOption&quot;: &quot;A String&quot;, # Avoid Sites and Apps with historical Fraud &amp; IVT.
638 &quot;avoidInsufficientOption&quot;: True or False, # Insufficient Historical Fraud &amp; IVT Stats.
639 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700640 &quot;appStarRating&quot;: { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
641 &quot;avoidInsufficientStarRating&quot;: True or False, # Avoid bidding on apps with insufficient star ratings.
642 &quot;avoidedStarRating&quot;: &quot;A String&quot;, # Avoid bidding on apps with the star ratings.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700643 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700644 &quot;displayViewability&quot;: { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
645 &quot;iab&quot;: &quot;A String&quot;, # Target web and app inventory to maximize IAB viewable rate.
646 &quot;viewableDuring&quot;: &quot;A String&quot;, # Target web and app inventory to maximize 100% viewable duration.
647 },
648 &quot;brandSafetyCategories&quot;: { # Settings for brand safety controls. # DV Brand Safety Controls.
649 &quot;avoidedMediumSeverityCategories&quot;: [ # Brand safety medium severity avoidance categories.
650 &quot;A String&quot;,
651 ],
652 &quot;avoidedHighSeverityCategories&quot;: [ # Brand safety high severity avoidance categories.
653 &quot;A String&quot;,
654 ],
655 &quot;avoidUnknownBrandSafetyCategory&quot;: True or False, # Unknown or unrateable.
656 },
657 &quot;videoViewability&quot;: { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
658 &quot;playerImpressionRate&quot;: &quot;A String&quot;, # Target inventory to maximize impressions with 400x300 or greater player size.
659 &quot;videoIab&quot;: &quot;A String&quot;, # Target web inventory to maximize IAB viewable rate.
660 &quot;videoViewableRate&quot;: &quot;A String&quot;, # Target web inventory to maximize fully viewable rate.
661 },
662 &quot;avoidedAgeRatings&quot;: [ # Avoid bidding on apps with the age rating.
663 &quot;A String&quot;,
664 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700665 },
666 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700667 &quot;proximityLocationListDetails&quot;: { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the TargetingType is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
668 &quot;proximityLocationListId&quot;: &quot;A String&quot;, # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
669 &quot;proximityRadiusRange&quot;: &quot;A String&quot;, # Required. Radius range for proximity location list. This represents the size of the area around a chosen location that will be targeted. `All` proximity location targeting under a single line item must have the same radius range value. Set this value to match any existing targeting. If updated, this field will change the radius range for all proximity targeting under the line item.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700670 },
671 &quot;contentInstreamPositionDetails&quot;: { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
672 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
673 &quot;contentInstreamPosition&quot;: &quot;A String&quot;, # Output only. The content instream position for video or audio ads.
674 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700675 &quot;environmentDetails&quot;: { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the TargetingType is `TARGETING_TYPE_ENVIRONMENT`.
676 &quot;environment&quot;: &quot;A String&quot;, # Output only. The serving environment.
677 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., &quot;508010&quot; for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700678 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700679 &quot;inventorySourceDetails&quot;: { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`.
680 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
681 },
682 &quot;deviceTypeDetails&quot;: { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the TargetingType is `TARGETING_TYPE_DEVICE_TYPE`.
683 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the device type.
684 &quot;deviceType&quot;: &quot;A String&quot;, # Output only. The display name of the device type.
685 },
686 &quot;geoRegionDetails&quot;: { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the TargetingType is `TARGETING_TYPE_GEO_REGION`.
687 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region (e.g., &quot;Ontario, Canada&quot;).
688 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
689 &quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of geographic region targeting.
690 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
691 },
692 &quot;appCategoryDetails&quot;: { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the TargetingType is `TARGETING_TYPE_APP_CATEGORY`.
693 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
694 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
695 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app category.
696 },
697 &quot;ageRangeDetails&quot;: { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the TargetingType is `TARGETING_TYPE_AGE_RANGE`.
698 &quot;ageRange&quot;: &quot;A String&quot;, # Output only. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
699 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.
700 },
701 &quot;deviceMakeModelDetails&quot;: { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
702 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
703 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the device make and model.
704 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
705 },
706 &quot;assignedTargetingOptionId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts.
707 &quot;categoryDetails&quot;: { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the TargetingType is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
708 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the category.
709 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
710 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
711 },
712 &quot;negativeKeywordListDetails&quot;: { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a line item.
713 &quot;negativeKeywordListId&quot;: &quot;A String&quot;, # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
714 },
715 &quot;urlDetails&quot;: { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the TargetingType is `TARGETING_TYPE_URL`.
716 &quot;url&quot;: &quot;A String&quot;, # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
717 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
718 },
719 &quot;digitalContentLabelExclusionDetails&quot;: { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren&#x27;t visible in line item settings). Line item settings can exclude content labels in addition to advertiser exclusions, but can&#x27;t override them. A line item won&#x27;t serve if all the digital content labels are excluded.
720 &quot;contentRatingTier&quot;: &quot;A String&quot;, # Output only. The display name of the digital content label rating tier.
721 &quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the digital content label to be EXCLUDED.
722 },
723 &quot;onScreenPositionDetails&quot;: { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`.
724 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
725 &quot;onScreenPosition&quot;: &quot;A String&quot;, # Output only. The on screen position.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700726 },
727 },
728 ],
729 }</pre>
730</div>
731
732<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700733 <code class="details" id="bulkListAdvertiserAssignedTargetingOptions">bulkListAdvertiserAssignedTargetingOptions(advertiserId, pageSize=None, orderBy=None, pageToken=None, filter=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700734 <pre>Lists assigned targeting options of an advertiser across targeting types.
735
736Args:
737 advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)
738 pageSize: integer, Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is &#x27;5000&#x27;. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700739 orderBy: string, Field by which to sort the list. Acceptable values are: * `targetingType` (default) 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: `targetingType desc`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700740 pageToken: string, A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700741 filter: string, Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`.. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType=&quot;TARGETING_TYPE_CHANNEL&quot;` The length of this field should be no more than 500 characters.
742 x__xgafv: string, V1 error format.
743 Allowed values
744 1 - v1 error format
745 2 - v2 error format
746
747Returns:
748 An object of the form:
749
750 {
751 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
752 &quot;assignedTargetingOptions&quot;: [ # The list of assigned targeting options. This list will be absent if empty.
753 { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700754 &quot;operatingSystemDetails&quot;: { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`.
755 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the operating system.
756 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
757 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700758 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700759 &quot;genderDetails&quot;: { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_GENDER`. # Gender details. This field will be populated when the TargetingType is `TARGETING_TYPE_GENDER`.
760 &quot;gender&quot;: &quot;A String&quot;, # Output only. The gender of the audience.
761 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`.
762 },
763 &quot;languageDetails&quot;: { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the TargetingType is `TARGETING_TYPE_LANGUAGE`.
764 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same line item must have the same value for this field.
765 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the language (e.g., &quot;French&quot;).
766 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700767 },
768 &quot;inventorySourceGroupDetails&quot;: { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
769 &quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
770 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700771 &quot;regionalLocationListDetails&quot;: { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
772 &quot;regionalLocationListId&quot;: &quot;A String&quot;, # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
773 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
774 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700775 &quot;sensitiveCategoryExclusionDetails&quot;: { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren&#x27;t visible in line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can&#x27;t override them.
776 &quot;sensitiveCategory&quot;: &quot;A String&quot;, # Output only. An enum for the DV360 Sensitive category content classifier.
777 &quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the sensitive category to be EXCLUDED.
778 },
779 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this assigned targeting option.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700780 &quot;contentOutstreamPositionDetails&quot;: { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
781 &quot;contentOutstreamPosition&quot;: &quot;A String&quot;, # Output only. The content outstream position.
782 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
783 },
784 &quot;viewabilityDetails&quot;: { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the TargetingType is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per line item.
785 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., &quot;509010&quot; for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).
786 &quot;viewability&quot;: &quot;A String&quot;, # Output only. The predicted viewability percentage.
787 },
788 &quot;keywordDetails&quot;: { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the TargetingType is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a line item. No limit on number of positive keywords that can be assigned.
789 &quot;keyword&quot;: &quot;A String&quot;, # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
790 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
791 },
792 &quot;householdIncomeDetails&quot;: { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
793 &quot;householdIncome&quot;: &quot;A String&quot;, # Output only. The household income of the audience.
794 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.
795 },
796 &quot;inheritance&quot;: &quot;A String&quot;, # Output only. The inheritance status of the assigned targeting option.
797 &quot;videoPlayerSizeDetails&quot;: { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
798 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
799 &quot;videoPlayerSize&quot;: &quot;A String&quot;, # Output only. The video player size.
800 },
801 &quot;browserDetails&quot;: { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the TargetingType is `TARGETING_TYPE_BROWSER`.
802 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same line item must have the same value for this field.
803 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the browser.
804 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
805 },
806 &quot;subExchangeDetails&quot;: { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`.
807 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
808 },
809 &quot;parentalStatusDetails&quot;: { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`.
810 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.
811 &quot;parentalStatus&quot;: &quot;A String&quot;, # Output only. The parental status of the audience.
812 },
813 &quot;appDetails&quot;: { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the TargetingType is `TARGETING_TYPE_APP`.
814 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
815 &quot;appId&quot;: &quot;A String&quot;, # Required. The ID of the app. Android&#x27;s Play store app uses bundle ID, for example `com.google.android.gm`. Apple&#x27;s App store app ID uses 9 digit string, for example `422689480`.
816 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app.
817 },
818 &quot;carrierAndIspDetails&quot;: { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`.
819 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the carrier or ISP.
820 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same line item must have the same value for this field.
821 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
822 },
823 &quot;targetingType&quot;: &quot;A String&quot;, # Output only. Identifies the type of this assigned targeting option.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700824 &quot;audienceGroupDetails&quot;: { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is UNION&#x27;ed with other groups. # Audience targeting details. This field will be populated when the TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per line item.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700825 &quot;excludedGoogleAudienceGroup&quot;: { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. It&#x27;s COMPLEMENT is used to UNION other audience groups. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
826 &quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
827 { # Details of Google audience targeting setting.
828 &quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
829 },
830 ],
831 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700832 &quot;includedFirstAndThirdPartyAudienceGroups&quot;: [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION&#x27;ed with other audience groups. Repeated groups with same settings will be ignored.
833 { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.
834 &quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
835 { # Details of first and third party audience targeting setting.
836 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
837 &quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
838 },
839 ],
840 },
841 ],
842 &quot;includedCustomListGroup&quot;: { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only.
843 &quot;settings&quot;: [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.
844 { # Details of custom list targeting setting.
845 &quot;customListId&quot;: &quot;A String&quot;, # Required. Custom id of custom list targeting setting. This id is custom_list_id.
846 },
847 ],
848 },
849 &quot;includedCombinedAudienceGroup&quot;: { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only.
850 &quot;settings&quot;: [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
851 { # Details of combined audience targeting setting.
852 &quot;combinedAudienceId&quot;: &quot;A String&quot;, # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
853 },
854 ],
855 },
856 &quot;excludedFirstAndThirdPartyAudienceGroup&quot;: { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. Its COMPLEMENT is used to UNION other audience groups.
857 &quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
858 { # Details of first and third party audience targeting setting.
859 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
860 &quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
861 },
862 ],
863 },
864 &quot;includedGoogleAudienceGroup&quot;: { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only.
865 &quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
866 { # Details of Google audience targeting setting.
867 &quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
868 },
869 ],
870 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700871 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700872 &quot;dayAndTimeDetails&quot;: { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the TargetingType is `TARGETING_TYPE_DAY_AND_TIME`.
873 &quot;dayOfWeek&quot;: &quot;A String&quot;, # Required. The day of the week for this day and time targeting setting.
874 &quot;startHour&quot;: 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
875 &quot;endHour&quot;: 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
876 &quot;timeZoneResolution&quot;: &quot;A String&quot;, # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700877 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700878 &quot;authorizedSellerStatusDetails&quot;: { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Authorized seller status details. This field will be populated when the TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per line item. If a line item doesn&#x27;t have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
879 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
880 &quot;authorizedSellerStatus&quot;: &quot;A String&quot;, # Output only. The authorized seller status to target.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700881 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700882 &quot;exchangeDetails&quot;: { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the TargetingType is `TARGETING_TYPE_EXCHANGE`.
883 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`.
884 },
885 &quot;channelDetails&quot;: { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the TargetingType is `TARGETING_TYPE_CHANNEL`.
886 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
887 &quot;channelId&quot;: &quot;A String&quot;, # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
888 },
889 &quot;userRewardedContentDetails&quot;: { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the TargetingType is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
890 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
891 &quot;userRewardedContent&quot;: &quot;A String&quot;, # Output only. User rewarded content status for video ads.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700892 },
893 &quot;thirdPartyVerifierDetails&quot;: { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
894 &quot;adloox&quot;: { # Details of Adloox settings. # Third party brand verifier -- Adloox.
895 &quot;excludedAdlooxCategories&quot;: [ # Adloox&#x27;s brand safety settings.
896 &quot;A String&quot;,
897 ],
898 },
899 &quot;integralAdScience&quot;: { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700900 &quot;excludedGamblingRisk&quot;: &quot;A String&quot;, # Brand Safety - **Gambling**.
901 &quot;videoViewability&quot;: &quot;A String&quot;, # Video Viewability Section (applicable to video line items only).
902 &quot;excludedAlcoholRisk&quot;: &quot;A String&quot;, # Brand Safety - **Alcohol**.
903 &quot;excludedHateSpeechRisk&quot;: &quot;A String&quot;, # Brand Safety - **Hate speech**.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700904 &quot;excludedDrugsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Drugs**.
905 &quot;excludedAdFraudRisk&quot;: &quot;A String&quot;, # Ad Fraud settings.
906 &quot;traqScoreOption&quot;: &quot;A String&quot;, # True advertising quality (applicable to Display line items only).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700907 &quot;displayViewability&quot;: &quot;A String&quot;, # Display Viewability section (applicable to display line items only).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700908 &quot;excludedIllegalDownloadsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Illegal downloads**.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700909 &quot;excludeUnrateable&quot;: True or False, # Brand Safety - **Unrateable**.
910 &quot;excludedViolenceRisk&quot;: &quot;A String&quot;, # Brand Safety - **Violence**.
911 &quot;excludedAdultRisk&quot;: &quot;A String&quot;, # Brand Safety - **Adult content**.
912 &quot;excludedOffensiveLanguageRisk&quot;: &quot;A String&quot;, # Brand Safety - **Offensive language**.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700913 },
914 &quot;doubleVerify&quot;: { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700915 &quot;fraudInvalidTraffic&quot;: { # DoubleVerify Fraud &amp; Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud &amp; IVT Rates.
916 &quot;avoidedFraudOption&quot;: &quot;A String&quot;, # Avoid Sites and Apps with historical Fraud &amp; IVT.
917 &quot;avoidInsufficientOption&quot;: True or False, # Insufficient Historical Fraud &amp; IVT Stats.
918 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700919 &quot;appStarRating&quot;: { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
920 &quot;avoidInsufficientStarRating&quot;: True or False, # Avoid bidding on apps with insufficient star ratings.
921 &quot;avoidedStarRating&quot;: &quot;A String&quot;, # Avoid bidding on apps with the star ratings.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700922 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700923 &quot;displayViewability&quot;: { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
924 &quot;iab&quot;: &quot;A String&quot;, # Target web and app inventory to maximize IAB viewable rate.
925 &quot;viewableDuring&quot;: &quot;A String&quot;, # Target web and app inventory to maximize 100% viewable duration.
926 },
927 &quot;brandSafetyCategories&quot;: { # Settings for brand safety controls. # DV Brand Safety Controls.
928 &quot;avoidedMediumSeverityCategories&quot;: [ # Brand safety medium severity avoidance categories.
929 &quot;A String&quot;,
930 ],
931 &quot;avoidedHighSeverityCategories&quot;: [ # Brand safety high severity avoidance categories.
932 &quot;A String&quot;,
933 ],
934 &quot;avoidUnknownBrandSafetyCategory&quot;: True or False, # Unknown or unrateable.
935 },
936 &quot;videoViewability&quot;: { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
937 &quot;playerImpressionRate&quot;: &quot;A String&quot;, # Target inventory to maximize impressions with 400x300 or greater player size.
938 &quot;videoIab&quot;: &quot;A String&quot;, # Target web inventory to maximize IAB viewable rate.
939 &quot;videoViewableRate&quot;: &quot;A String&quot;, # Target web inventory to maximize fully viewable rate.
940 },
941 &quot;avoidedAgeRatings&quot;: [ # Avoid bidding on apps with the age rating.
942 &quot;A String&quot;,
943 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700944 },
945 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700946 &quot;proximityLocationListDetails&quot;: { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the TargetingType is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
947 &quot;proximityLocationListId&quot;: &quot;A String&quot;, # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
948 &quot;proximityRadiusRange&quot;: &quot;A String&quot;, # Required. Radius range for proximity location list. This represents the size of the area around a chosen location that will be targeted. `All` proximity location targeting under a single line item must have the same radius range value. Set this value to match any existing targeting. If updated, this field will change the radius range for all proximity targeting under the line item.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700949 },
950 &quot;contentInstreamPositionDetails&quot;: { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
951 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
952 &quot;contentInstreamPosition&quot;: &quot;A String&quot;, # Output only. The content instream position for video or audio ads.
953 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700954 &quot;environmentDetails&quot;: { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the TargetingType is `TARGETING_TYPE_ENVIRONMENT`.
955 &quot;environment&quot;: &quot;A String&quot;, # Output only. The serving environment.
956 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., &quot;508010&quot; for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700957 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700958 &quot;inventorySourceDetails&quot;: { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`.
959 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
960 },
961 &quot;deviceTypeDetails&quot;: { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the TargetingType is `TARGETING_TYPE_DEVICE_TYPE`.
962 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the device type.
963 &quot;deviceType&quot;: &quot;A String&quot;, # Output only. The display name of the device type.
964 },
965 &quot;geoRegionDetails&quot;: { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the TargetingType is `TARGETING_TYPE_GEO_REGION`.
966 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region (e.g., &quot;Ontario, Canada&quot;).
967 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
968 &quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of geographic region targeting.
969 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
970 },
971 &quot;appCategoryDetails&quot;: { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the TargetingType is `TARGETING_TYPE_APP_CATEGORY`.
972 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
973 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
974 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app category.
975 },
976 &quot;ageRangeDetails&quot;: { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the TargetingType is `TARGETING_TYPE_AGE_RANGE`.
977 &quot;ageRange&quot;: &quot;A String&quot;, # Output only. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
978 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.
979 },
980 &quot;deviceMakeModelDetails&quot;: { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
981 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
982 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the device make and model.
983 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
984 },
985 &quot;assignedTargetingOptionId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts.
986 &quot;categoryDetails&quot;: { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the TargetingType is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
987 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the category.
988 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
989 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
990 },
991 &quot;negativeKeywordListDetails&quot;: { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a line item.
992 &quot;negativeKeywordListId&quot;: &quot;A String&quot;, # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
993 },
994 &quot;urlDetails&quot;: { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the TargetingType is `TARGETING_TYPE_URL`.
995 &quot;url&quot;: &quot;A String&quot;, # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
996 &quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
997 },
998 &quot;digitalContentLabelExclusionDetails&quot;: { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren&#x27;t visible in line item settings). Line item settings can exclude content labels in addition to advertiser exclusions, but can&#x27;t override them. A line item won&#x27;t serve if all the digital content labels are excluded.
999 &quot;contentRatingTier&quot;: &quot;A String&quot;, # Output only. The display name of the digital content label rating tier.
1000 &quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the digital content label to be EXCLUDED.
1001 },
1002 &quot;onScreenPositionDetails&quot;: { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`.
1003 &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
1004 &quot;onScreenPosition&quot;: &quot;A String&quot;, # Output only. The on screen position.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001005 },
1006 },
1007 ],
1008 }</pre>
1009</div>
1010
1011<div class="method">
1012 <code class="details" id="bulkListAdvertiserAssignedTargetingOptions_next">bulkListAdvertiserAssignedTargetingOptions_next(previous_request, previous_response)</code>
1013 <pre>Retrieves the next page of results.
1014
1015Args:
1016 previous_request: The request for the previous page. (required)
1017 previous_response: The response from the request for the previous page. (required)
1018
1019Returns:
1020 A request object that you can call &#x27;execute()&#x27; on to request the next
1021 page. Returns None if there are no more items in the collection.
1022 </pre>
1023</div>
1024
1025<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001026 <code class="details" id="close">close()</code>
1027 <pre>Close httplib2 connections.</pre>
1028</div>
1029
1030<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -07001031 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001032 <pre>Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.
Bu Sun Kim65020912020-05-20 12:08:20 -07001033
1034Args:
1035 body: object, The request body.
1036 The object takes the form of:
1037
1038{ # A single advertiser in Display &amp; Video 360 (DV360).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001039 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
1040 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
1041 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
1042 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display &amp; Video 360 advertiser to provide reporting and features related to the advertiser&#x27;s television campaigns. Applicable only when the advertiser has a CM hybrid ad server configuration.
1043 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
1044 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
1045 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag containing this ID to the creative tag.
1046 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001047 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001048 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
1049 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the same as that of the associated CM account; for third-party only advertisers, the time zone is the same as that of the parent partner.
1050 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
1051 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001052 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001053 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001054 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
1055 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
1056 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
1057 },
1058 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager (CM) and third-party ad servers.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001059 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001060 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display &amp; Video 360 advertiser.
1061 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM site. Removing sites from this list may cause DV360 creatives synced from CM to be deleted. At least one site must be specified.
1062 &quot;A String&quot;,
1063 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001064 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001065 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001066 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 advertiser.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001067 },
1068 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001069 &quot;servingConfig&quot;: { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
1070 &quot;exemptTvFromViewabilityTargeting&quot;: True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
1071 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001072 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
1073 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
1074 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
1075 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
1076 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
1077 },
1078 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
1079 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
1080 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
1081 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports will be sent.
1082 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
1083 },
1084 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
1085 },
1086 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001087 }
Bu Sun Kim65020912020-05-20 12:08:20 -07001088
1089 x__xgafv: string, V1 error format.
1090 Allowed values
1091 1 - v1 error format
1092 2 - v2 error format
1093
1094Returns:
1095 An object of the form:
1096
1097 { # A single advertiser in Display &amp; Video 360 (DV360).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001098 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
1099 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
1100 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
1101 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display &amp; Video 360 advertiser to provide reporting and features related to the advertiser&#x27;s television campaigns. Applicable only when the advertiser has a CM hybrid ad server configuration.
1102 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
1103 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
1104 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag containing this ID to the creative tag.
1105 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001106 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001107 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
1108 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the same as that of the associated CM account; for third-party only advertisers, the time zone is the same as that of the parent partner.
1109 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
1110 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001111 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001112 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001113 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
1114 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
1115 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
1116 },
1117 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager (CM) and third-party ad servers.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001118 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001119 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display &amp; Video 360 advertiser.
1120 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM site. Removing sites from this list may cause DV360 creatives synced from CM to be deleted. At least one site must be specified.
1121 &quot;A String&quot;,
1122 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001123 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001124 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001125 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 advertiser.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001126 },
1127 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001128 &quot;servingConfig&quot;: { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
1129 &quot;exemptTvFromViewabilityTargeting&quot;: True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
1130 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001131 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
1132 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
1133 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
1134 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
1135 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
1136 },
1137 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
1138 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
1139 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
1140 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports will be sent.
1141 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
1142 },
1143 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
1144 },
1145 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001146 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -07001147</div>
1148
1149<div class="method">
1150 <code class="details" id="delete">delete(advertiserId, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001151 <pre>Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.
Bu Sun Kim65020912020-05-20 12:08:20 -07001152
1153Args:
1154 advertiserId: string, The ID of the advertiser we need to delete. (required)
1155 x__xgafv: string, V1 error format.
1156 Allowed values
1157 1 - v1 error format
1158 2 - v2 error format
1159
1160Returns:
1161 An object of the form:
1162
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001163 { # 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 -07001164 }</pre>
1165</div>
1166
1167<div class="method">
1168 <code class="details" id="get">get(advertiserId, x__xgafv=None)</code>
1169 <pre>Gets an advertiser.
1170
1171Args:
1172 advertiserId: string, Required. The ID of the advertiser to fetch. (required)
1173 x__xgafv: string, V1 error format.
1174 Allowed values
1175 1 - v1 error format
1176 2 - v2 error format
1177
1178Returns:
1179 An object of the form:
1180
1181 { # A single advertiser in Display &amp; Video 360 (DV360).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001182 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
1183 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
1184 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
1185 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display &amp; Video 360 advertiser to provide reporting and features related to the advertiser&#x27;s television campaigns. Applicable only when the advertiser has a CM hybrid ad server configuration.
1186 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
1187 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
1188 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag containing this ID to the creative tag.
1189 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001190 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001191 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
1192 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the same as that of the associated CM account; for third-party only advertisers, the time zone is the same as that of the parent partner.
1193 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
1194 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001195 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001196 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001197 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
1198 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
1199 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
1200 },
1201 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager (CM) and third-party ad servers.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001202 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001203 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display &amp; Video 360 advertiser.
1204 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM site. Removing sites from this list may cause DV360 creatives synced from CM to be deleted. At least one site must be specified.
1205 &quot;A String&quot;,
1206 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001207 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001208 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001209 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 advertiser.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001210 },
1211 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001212 &quot;servingConfig&quot;: { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
1213 &quot;exemptTvFromViewabilityTargeting&quot;: True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
1214 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001215 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
1216 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
1217 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
1218 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
1219 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
1220 },
1221 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
1222 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
1223 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
1224 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports will be sent.
1225 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
1226 },
1227 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
1228 },
1229 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001230 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -07001231</div>
1232
1233<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001234 <code class="details" id="list">list(pageSize=None, orderBy=None, pageToken=None, filter=None, partnerId=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001235 <pre>Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.
Bu Sun Kim65020912020-05-20 12:08:20 -07001236
1237Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001238 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001239 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. For example, `displayName desc`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001240 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 `ListAdvertisers` method. If not specified, the first page of results will be returned.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001241 filter: string, Allows filtering by advertiser 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: - `advertiserId` - `displayName` - `entityStatus` Examples: * All active advertisers under a partner: `entityStatus=&quot;ENTITY_STATUS_ACTIVE&quot;` The length of this field should be no more than 500 characters.
1242 partnerId: string, Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.
Bu Sun Kim65020912020-05-20 12:08:20 -07001243 x__xgafv: string, V1 error format.
1244 Allowed values
1245 1 - v1 error format
1246 2 - v2 error format
1247
1248Returns:
1249 An object of the form:
1250
1251 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001252 &quot;advertisers&quot;: [ # The list of advertisers. This list will be absent if empty.
Bu Sun Kim65020912020-05-20 12:08:20 -07001253 { # A single advertiser in Display &amp; Video 360 (DV360).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001254 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
1255 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
1256 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
1257 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display &amp; Video 360 advertiser to provide reporting and features related to the advertiser&#x27;s television campaigns. Applicable only when the advertiser has a CM hybrid ad server configuration.
1258 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
1259 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
1260 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag containing this ID to the creative tag.
1261 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001262 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001263 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
1264 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the same as that of the associated CM account; for third-party only advertisers, the time zone is the same as that of the parent partner.
1265 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
1266 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001267 },
1268 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001269 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
1270 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
1271 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
1272 },
1273 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager (CM) and third-party ad servers.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001274 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001275 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display &amp; Video 360 advertiser.
1276 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM site. Removing sites from this list may cause DV360 creatives synced from CM to be deleted. At least one site must be specified.
1277 &quot;A String&quot;,
1278 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001279 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001280 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001281 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 advertiser.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001282 },
1283 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001284 &quot;servingConfig&quot;: { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
1285 &quot;exemptTvFromViewabilityTargeting&quot;: True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001286 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001287 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
1288 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
1289 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
1290 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
1291 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
1292 },
1293 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
1294 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
1295 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
1296 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports will be sent.
1297 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
1298 },
1299 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
1300 },
1301 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001302 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001303 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001304 &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 `ListAdvertisers` method to retrieve the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -07001305 }</pre>
1306</div>
1307
1308<div class="method">
1309 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1310 <pre>Retrieves the next page of results.
1311
1312Args:
1313 previous_request: The request for the previous page. (required)
1314 previous_response: The response from the request for the previous page. (required)
1315
1316Returns:
1317 A request object that you can call &#x27;execute()&#x27; on to request the next
1318 page. Returns None if there are no more items in the collection.
1319 </pre>
1320</div>
1321
1322<div class="method">
1323 <code class="details" id="patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001324 <pre>Updates an existing advertiser. Returns the updated advertiser if successful.
Bu Sun Kim65020912020-05-20 12:08:20 -07001325
1326Args:
1327 advertiserId: string, Output only. The unique ID of the advertiser. Assigned by the system. (required)
1328 body: object, The request body.
1329 The object takes the form of:
1330
1331{ # A single advertiser in Display &amp; Video 360 (DV360).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001332 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
1333 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
1334 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
1335 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display &amp; Video 360 advertiser to provide reporting and features related to the advertiser&#x27;s television campaigns. Applicable only when the advertiser has a CM hybrid ad server configuration.
1336 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
1337 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
1338 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag containing this ID to the creative tag.
1339 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001340 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001341 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
1342 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the same as that of the associated CM account; for third-party only advertisers, the time zone is the same as that of the parent partner.
1343 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
1344 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001345 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001346 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001347 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
1348 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
1349 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
1350 },
1351 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager (CM) and third-party ad servers.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001352 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001353 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display &amp; Video 360 advertiser.
1354 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM site. Removing sites from this list may cause DV360 creatives synced from CM to be deleted. At least one site must be specified.
1355 &quot;A String&quot;,
1356 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001357 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001358 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001359 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 advertiser.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001360 },
1361 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001362 &quot;servingConfig&quot;: { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
1363 &quot;exemptTvFromViewabilityTargeting&quot;: True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
1364 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001365 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
1366 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
1367 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
1368 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
1369 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
1370 },
1371 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
1372 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
1373 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
1374 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports will be sent.
1375 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
1376 },
1377 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
1378 },
1379 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001380 }
Bu Sun Kim65020912020-05-20 12:08:20 -07001381
1382 updateMask: string, Required. The mask to control which fields to update.
1383 x__xgafv: string, V1 error format.
1384 Allowed values
1385 1 - v1 error format
1386 2 - v2 error format
1387
1388Returns:
1389 An object of the form:
1390
1391 { # A single advertiser in Display &amp; Video 360 (DV360).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001392 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
1393 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
1394 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
1395 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display &amp; Video 360 advertiser to provide reporting and features related to the advertiser&#x27;s television campaigns. Applicable only when the advertiser has a CM hybrid ad server configuration.
1396 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
1397 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
1398 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag containing this ID to the creative tag.
1399 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001400 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001401 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
1402 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the same as that of the associated CM account; for third-party only advertisers, the time zone is the same as that of the parent partner.
1403 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
1404 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001405 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001406 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001407 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
1408 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
1409 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
1410 },
1411 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager (CM) and third-party ad servers.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001412 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001413 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display &amp; Video 360 advertiser.
1414 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM site. Removing sites from this list may cause DV360 creatives synced from CM to be deleted. At least one site must be specified.
1415 &quot;A String&quot;,
1416 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001417 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001418 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001419 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 advertiser.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001420 },
1421 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001422 &quot;servingConfig&quot;: { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
1423 &quot;exemptTvFromViewabilityTargeting&quot;: True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
1424 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001425 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
1426 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
1427 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
1428 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
1429 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
1430 },
1431 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
1432 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
1433 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
1434 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports will be sent.
1435 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
1436 },
1437 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
1438 },
1439 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001440 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -07001441</div>
1442
1443</body></html>