Blame - docs/dyn/displayvideo_v1.partners.html - platform/external/python/google-api-python-client

<p class="firstline">Bulk edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .</p>

90

91

<code><a href="#close">close()</a></code></p>

92

<p class="firstline">Close httplib2 connections.</p>

93

94

<code><a href="#get">get(partnerId, x__xgafv=None)</a></code></p>

95

<p class="firstline">Gets a partner.</p>

96

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

97

<code><a href="#list">list(orderBy=None, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

98

<p class="firstline">Lists partners that are accessible to the current user. The order is defined by the order_by parameter.</p>

99

100

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

101

<p class="firstline">Retrieves the next page of results.</p>

102

<h3>Method Details</h3>

103

104

<code class="details" id="bulkEditPartnerAssignedTargetingOptions">bulkEditPartnerAssignedTargetingOptions(partnerId, body=None, x__xgafv=None)</code>

105

<pre>Bulk edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .

106

107

Args:

108

partnerId: string, Required. The ID of the partner. (required)

109

body: object, The request body.

110

The object takes the form of:

111

112

{ # Request message for BulkEditPartnerAssignedTargetingOptions.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

113

"deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`

114

{ # A request listing which assigned targeting options of a given targeting type should be deleted.

115

"assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete.

116

"A String",

117

],

118

"targetingType": "A String", # Required. Identifies the type of this assigned targeting option.

119

},

120

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

121

"createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`

122

{ # A request listing which assigned targeting options of a given targeting type should be created and added.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

123

"targetingType": "A String", # Required. Identifies the type of this assigned targeting option.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

124

"assignedTargetingOptions": [ # Required. The assigned targeting options to create and add.

125

{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

126

"subExchangeDetails": { # 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`.

127

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

128

},

129

"householdIncomeDetails": { # 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`.

130

"householdIncome": "A String", # Output only. The household income of the audience.

131

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.

132

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

133

"keywordDetails": { # 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.

134

"keyword": "A String", # 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.

135

"negative": True or False, # Indicates if this option is being negatively targeted.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

136

},

137

"browserDetails": { # 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`.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

138

"displayName": "A String", # Output only. The display name of the browser.

139

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

140

"negative": 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.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

141

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

142

"onScreenPositionDetails": { # 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`.

143

"onScreenPosition": "A String", # Output only. The on screen position.

144

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.

145

},

146

"inventorySourceGroupDetails": { # 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`.

147

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.

148

},

149

"contentInstreamPositionDetails": { # 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`.

150

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

151

"contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads.

152

},

153

"videoPlayerSizeDetails": { # 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`.

154

"videoPlayerSize": "A String", # Output only. The video player size.

155

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

156

},

157

"negativeKeywordListDetails": { # 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.

158

"negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.

159

},

160

"channelDetails": { # 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`.

161

"negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.

162

"channelId": "A String", # 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.

163

},

164

"dayAndTimeDetails": { # 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`.

165

"startHour": 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).

166

"endHour": 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).

167

"timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.

168

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.

169

},

170

"name": "A String", # Output only. The resource name for this assigned targeting option.

171

"regionalLocationListDetails": { # 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`.

172

"negative": True or False, # Indicates if this option is being negatively targeted.

173

"regionalLocationListId": "A String", # 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`.

174

},

175

"exchangeDetails": { # 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`.

176

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`.

177

},

178

"genderDetails": { # 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`.

179

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`.

180

"gender": "A String", # Output only. The gender of the audience.

181

},

182

"inventorySourceDetails": { # 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`.

183

"inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.

184

},

185

"targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.

186

"digitalContentLabelExclusionDetails": { # 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't visible in line item settings). Line item settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.

187

"contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier.

188

"excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

189

},

190

"parentalStatusDetails": { # 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`.

191

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.

192

"parentalStatus": "A String", # Output only. The parental status of the audience.

193

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

194

"deviceMakeModelDetails": { # 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`.

195

"displayName": "A String", # Output only. The display name of the device make and model.

196

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

197

"negative": True or False, # Indicates if this option is being negatively targeted.

198

},

199

"geoRegionDetails": { # 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`.

200

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.

201

"negative": True or False, # Indicates if this option is being negatively targeted.

202

"geoRegionType": "A String", # Output only. The type of geographic region targeting.

203

"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").

204

},

205

"viewabilityDetails": { # 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.

206

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).

207

"viewability": "A String", # Output only. The predicted viewability percentage.

208

},

209

"thirdPartyVerifierDetails": { # 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`.

210

"doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.

211

"brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.

212

"avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.

213

"A String",

214

],

215

"avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.

216

"avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.

"A String",

],

},

"appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.

221

"avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.

222

"avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.

223

},

224

"fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.

225

"avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.

226

"avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.

227

},

228

"videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).

229

"videoIab": "A String", # Target web inventory to maximize IAB viewable rate.

230

"playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.

231

"videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.

232

},

233

"customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic

234

"avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.

235

"A String",

236

],

237

"displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).

238

"viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.

239

"iab": "A String", # Target web and app inventory to maximize IAB viewable rate.

240

},

241

},

242

"integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.

243

"excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.

244

"excludedAdFraudRisk": "A String", # Ad Fraud settings.

245

"videoViewability": "A String", # Video Viewability Section (applicable to video line items only).

246

"excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.

247

"excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.

248

"excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.

249

"excludedViolenceRisk": "A String", # Brand Safety - **Violence**.

250

"excludedAdultRisk": "A String", # Brand Safety - **Adult content**.

251

"excludeUnrateable": True or False, # Brand Safety - **Unrateable**.

252

"excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.

253

"displayViewability": "A String", # Display Viewability section (applicable to display line items only).

254

"traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).

255

"customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive.

256

"A String",

257

],

258

"excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.

259

},

260

"adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox.

261

"excludedAdlooxCategories": [ # Adloox's brand safety settings.

"A String",

],

},

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

266

"appDetails": { # 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`.

267

"negative": True or False, # Indicates if this option is being negatively targeted.

268

"appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.

269

"displayName": "A String", # Output only. The display name of the app.

270

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

271

"deviceTypeDetails": { # 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`.

272

"targetingOptionId": "A String", # Required. ID of the device type.

273

"deviceType": "A String", # Output only. The display name of the device type.

274

},

275

"urlDetails": { # 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`.

276

"negative": True or False, # Indicates if this option is being negatively targeted.

277

"url": "A String", # 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`.

278

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

279

"carrierAndIspDetails": { # 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`.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

280

"negative": 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.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

281

"displayName": "A String", # Output only. The display name of the carrier or ISP.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

282

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.

283

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

284

"authorizedSellerStatusDetails": { # 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't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.

285

"authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.

286

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

287

},

288

"ageRangeDetails": { # 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`.

289

"ageRange": "A String", # 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.

290

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.

291

},

292

"inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.

293

"userRewardedContentDetails": { # 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`.

294

"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.

295

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.

296

},

297

"categoryDetails": { # 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.

298

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.

299

"negative": True or False, # Indicates if this option is being negatively targeted.

300

"displayName": "A String", # Output only. The display name of the category.

301

},

302

"operatingSystemDetails": { # 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`.

303

"negative": True or False, # Indicates if this option is being negatively targeted.

304

"displayName": "A String", # Output only. The display name of the operating system.

305

"targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.

306

},

307

"assignedTargetingOptionId": "A String", # 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.

308

"sensitiveCategoryExclusionDetails": { # 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't visible in line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.

309

"excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED.

310

"sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.

311

},

312

"appCategoryDetails": { # 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`.

313

"displayName": "A String", # Output only. The display name of the app category.

314

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.

315

"negative": True or False, # Indicates if this option is being negatively targeted.

316

},

317

"contentOutstreamPositionDetails": { # 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`.

318

"contentOutstreamPosition": "A String", # Output only. The content outstream position.

319

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

320

},

321

"environmentDetails": { # 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`.

322

"environment": "A String", # Output only. The serving environment.

323

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).

324

},

325

"languageDetails": { # 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`.

326

"negative": 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.

327

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.

328

"displayName": "A String", # Output only. The display name of the language (e.g., "French").

329

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

330

"audienceGroupDetails": { # 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'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.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

331

"includedCustomListGroup": { # 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.

332

"settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.

333

{ # Details of custom list targeting setting.

334

"customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.

335

},

336

],

337

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

338

"excludedGoogleAudienceGroup": { # 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'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.

339

"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.

340

{ # Details of Google audience targeting setting.

341

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

},

],

},

"excludedFirstAndThirdPartyAudienceGroup": { # 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.

346

"settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.

347

{ # Details of first and third party audience targeting setting.

348

"firstAndThirdPartyAudienceId": "A String", # 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.

349

"recency": "A String", # 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.

},

],

},

"includedGoogleAudienceGroup": { # 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.

354

"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.

355

{ # Details of Google audience targeting setting.

356

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.

357

},

358

],

359

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

360

"includedCombinedAudienceGroup": { # 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.

361

"settings": [ # 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.

362

{ # Details of combined audience targeting setting.

363

"combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.

364

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

365

],

366

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

367

"includedFirstAndThirdPartyAudienceGroups": [ # 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'ed with other audience groups. Repeated groups with same settings will be ignored.

368

{ # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.

369

"settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.

370

{ # Details of first and third party audience targeting setting.

371

"firstAndThirdPartyAudienceId": "A String", # 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.

372

"recency": "A String", # 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.

373

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

374

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

375

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

376

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

377

},

378

"proximityLocationListDetails": { # 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`.

379

"proximityLocationListId": "A String", # 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`.

380

"proximityRadiusRange": "A String", # 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.

381

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

382

},

383

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

395

396

{

397

"createdAssignedTargetingOptions": [ # The list of assigned targeting options that have been successfully created. This list will be absent if empty.

398

{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

399

"subExchangeDetails": { # 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`.

400

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

401

},

402

"householdIncomeDetails": { # 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`.

403

"householdIncome": "A String", # Output only. The household income of the audience.

404

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.

405

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

406

"keywordDetails": { # 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.

407

"keyword": "A String", # 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.

408

"negative": True or False, # Indicates if this option is being negatively targeted.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

409

},

410

"browserDetails": { # 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`.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

411

"displayName": "A String", # Output only. The display name of the browser.

412

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

413

"negative": 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.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

414

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

415

"onScreenPositionDetails": { # 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`.

416

"onScreenPosition": "A String", # Output only. The on screen position.

417

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.

418

},

419

"inventorySourceGroupDetails": { # 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`.

420

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.

421

},

422

"contentInstreamPositionDetails": { # 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`.

423

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.

424

"contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads.

425

},

426

"videoPlayerSizeDetails": { # 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`.

427

"videoPlayerSize": "A String", # Output only. The video player size.

428

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.

429

},

430

"negativeKeywordListDetails": { # 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.

431

"negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.

432

},

433

"channelDetails": { # 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`.

434

"negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.

435

"channelId": "A String", # 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.

436

},

437

"dayAndTimeDetails": { # 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`.

438

"startHour": 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).

439

"endHour": 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).

440

"timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.

441

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.

442

},

443

"name": "A String", # Output only. The resource name for this assigned targeting option.

444

"regionalLocationListDetails": { # 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`.

445

"negative": True or False, # Indicates if this option is being negatively targeted.

446

"regionalLocationListId": "A String", # 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`.

447

},

448

"exchangeDetails": { # 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`.

449

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`.

450

},

451

"genderDetails": { # 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`.

452

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`.

453

"gender": "A String", # Output only. The gender of the audience.

454

},

455

"inventorySourceDetails": { # 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`.

456

"inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.

457

},

458

"targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.

459

"digitalContentLabelExclusionDetails": { # 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't visible in line item settings). Line item settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.

460

"contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier.

461

"excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

462

},

463

"parentalStatusDetails": { # 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`.

464

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.

465

"parentalStatus": "A String", # Output only. The parental status of the audience.

466

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

467

"deviceMakeModelDetails": { # 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`.

468

"displayName": "A String", # Output only. The display name of the device make and model.

469

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.

470

"negative": True or False, # Indicates if this option is being negatively targeted.

471

},

472

"geoRegionDetails": { # 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`.

473

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.

474

"negative": True or False, # Indicates if this option is being negatively targeted.

475

"geoRegionType": "A String", # Output only. The type of geographic region targeting.

476

"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").

477

},

478

"viewabilityDetails": { # 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.

479

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).

480

"viewability": "A String", # Output only. The predicted viewability percentage.

481

},

482

"thirdPartyVerifierDetails": { # 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`.

483

"doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.

484

"brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.

485

"avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.

486

"A String",

487

],

488

"avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.

489

"avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.

"A String",

],

},

"appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.

494

"avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.

495

"avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.

496

},

497

"fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.

498

"avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.

499

"avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.

500

},

501

"videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).

502

"videoIab": "A String", # Target web inventory to maximize IAB viewable rate.

503

"playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.

504

"videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.

505

},

506

"customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic

507

"avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.

508

"A String",

509

],

510

"displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).

511

"viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.

512

"iab": "A String", # Target web and app inventory to maximize IAB viewable rate.

513

},

514

},

515

"integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.

516

"excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.

517

"excludedAdFraudRisk": "A String", # Ad Fraud settings.

518

"videoViewability": "A String", # Video Viewability Section (applicable to video line items only).

519

"excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.

520

"excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.

521

"excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.

522

"excludedViolenceRisk": "A String", # Brand Safety - **Violence**.

523

"excludedAdultRisk": "A String", # Brand Safety - **Adult content**.

524

"excludeUnrateable": True or False, # Brand Safety - **Unrateable**.

525

"excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.

526

"displayViewability": "A String", # Display Viewability section (applicable to display line items only).

527

"traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).

528

"customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive.

529

"A String",

530

],

531

"excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.

532

},

533

"adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox.

534

"excludedAdlooxCategories": [ # Adloox's brand safety settings.

"A String",

],

},

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

539

"appDetails": { # 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`.

540

"negative": True or False, # Indicates if this option is being negatively targeted.

541

"appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.

542

"displayName": "A String", # Output only. The display name of the app.

543

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

544

"deviceTypeDetails": { # 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`.

545

"targetingOptionId": "A String", # Required. ID of the device type.

546

"deviceType": "A String", # Output only. The display name of the device type.

547

},

548

"urlDetails": { # 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`.

549

"negative": True or False, # Indicates if this option is being negatively targeted.

550

"url": "A String", # 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`.

551

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

552

"carrierAndIspDetails": { # 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`.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

553

"negative": 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.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

554

"displayName": "A String", # Output only. The display name of the carrier or ISP.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

555

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.

556

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

557

"authorizedSellerStatusDetails": { # 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't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.

558

"authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.

559

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.

560

},

561

"ageRangeDetails": { # 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`.

562

"ageRange": "A String", # 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.

563

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.

564

},

565

"inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.

566

"userRewardedContentDetails": { # 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`.

567

"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.

568

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.

569

},

570

"categoryDetails": { # 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.

571

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.

572

"negative": True or False, # Indicates if this option is being negatively targeted.

573

"displayName": "A String", # Output only. The display name of the category.

574

},

575

"operatingSystemDetails": { # 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`.

576

"negative": True or False, # Indicates if this option is being negatively targeted.

577

"displayName": "A String", # Output only. The display name of the operating system.

578

"targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.

579

},

580

"assignedTargetingOptionId": "A String", # 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.

581

"sensitiveCategoryExclusionDetails": { # 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't visible in line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.

582

"excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED.

583

"sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier.

584

},

585

"appCategoryDetails": { # 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`.

586

"displayName": "A String", # Output only. The display name of the app category.

587

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.

588

"negative": True or False, # Indicates if this option is being negatively targeted.

589

},

590

"contentOutstreamPositionDetails": { # 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`.

591

"contentOutstreamPosition": "A String", # Output only. The content outstream position.

592

"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.

593

},

594

"environmentDetails": { # 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`.

595

"environment": "A String", # Output only. The serving environment.

596

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).

597

},

598

"languageDetails": { # 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`.

599

"negative": 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.

600

"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.

601

"displayName": "A String", # Output only. The display name of the language (e.g., "French").

602

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

603

"audienceGroupDetails": { # 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'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.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

604

"includedCustomListGroup": { # 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.

605

"settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.

606

{ # Details of custom list targeting setting.

607

"customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.

608

},

609

],

610

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

611

"excludedGoogleAudienceGroup": { # 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'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.

612

"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.

613

{ # Details of Google audience targeting setting.

614

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

},

],

},

"excludedFirstAndThirdPartyAudienceGroup": { # 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.

619

"settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.

620

{ # Details of first and third party audience targeting setting.

621

"firstAndThirdPartyAudienceId": "A String", # 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.

622

"recency": "A String", # 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.

},

],

},

"includedGoogleAudienceGroup": { # 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.

627

"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.

628

{ # Details of Google audience targeting setting.

629

"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.

630

},

631

],

632

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

633

"includedCombinedAudienceGroup": { # 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.

634

"settings": [ # 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.

635

{ # Details of combined audience targeting setting.

636

"combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.

637

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

638

],

639

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

640

"includedFirstAndThirdPartyAudienceGroups": [ # 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'ed with other audience groups. Repeated groups with same settings will be ignored.

641

{ # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.

642

"settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.

643

{ # Details of first and third party audience targeting setting.

644

"firstAndThirdPartyAudienceId": "A String", # 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.

645

"recency": "A String", # 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.

646

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

647

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

648

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

649

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

650

},

651

"proximityLocationListDetails": { # 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`.

652

"proximityLocationListId": "A String", # 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`.

653

"proximityRadiusRange": "A String", # 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.

654

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="close">close()</code>

662

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="get">get(partnerId, x__xgafv=None)</code>

<pre>Gets a partner.

Args:

partnerId: string, Required. The ID of the partner to fetch. (required)

671

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

678

679

{ # A single partner in Display & Video 360 (DV360).

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

680

"exchangeConfig": { # Settings that control which exchanges are enabled for a partner. # Settings that control which exchanges are enabled for the partner.

681

"enabledExchanges": [ # All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored.

682

{ # An enabled exchange in the partner.

683

"seatId": "A String", # Output only. Seat ID of the enabled exchange.

684

"googleAdManagerAgencyId": "A String", # Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.

685

"exchange": "A String", # The enabled exchange.

686

"googleAdManagerBuyerNetworkId": "A String", # Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.

687

},

688

],

689

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

690

"entityStatus": "A String", # Output only. The status of the partner.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

691

"displayName": "A String", # The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

692

"partnerId": "A String", # Output only. The unique ID of the partner. Assigned by the system.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

693

"adServerConfig": { # Ad server related settings of a partner. # Ad server related settings of the partner.

694

"measurementConfig": { # Measurement settings of a partner. # Measurement settings of a partner.

695

"dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.

696

"dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.

697

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

698

},

699

"dataAccessConfig": { # Settings that control how partner related data may be accessed. # Settings that control how partner data may be accessed.

700

"sdfConfig": { # Structured Data File (SDF) related settings. # Structured Data Files (SDF) settings for the partner. The SDF configuration for the partner.

701

"adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.

702

"version": "A String", # Required. The version of SDF being used.

703

},

704

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

705

"name": "A String", # Output only. The resource name of the partner.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

706

"generalConfig": { # General settings of a partner. # General settings of the partner.

707

"timeZone": "A String", # Immutable. The standard TZ database name of the partner's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

708

"currencyCode": "A String", # Immutable. Partner's currency in ISO 4217 format.

709

},

710

"updateTime": "A String", # Output only. The timestamp when the partner was last updated. Assigned by the system.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

715

<code class="details" id="list">list(orderBy=None, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

716

<pre>Lists partners that are accessible to the current user. The order is defined by the order_by parameter.

717

718

Args:

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

719

orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

720

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 `ListPartners` method. If not specified, the first page of results will be returned.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

721

filter: string, Allows filtering by partner properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

722

pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

723

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

730

731

{

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

732

"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListPartners` method to retrieve the next page of results.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

733

"partners": [ # The list of partners. This list will be absent if empty.

734

{ # A single partner in Display & Video 360 (DV360).

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

735

"exchangeConfig": { # Settings that control which exchanges are enabled for a partner. # Settings that control which exchanges are enabled for the partner.

736

"enabledExchanges": [ # All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored.

737

{ # An enabled exchange in the partner.

738

"seatId": "A String", # Output only. Seat ID of the enabled exchange.

739

"googleAdManagerAgencyId": "A String", # Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.

740

"exchange": "A String", # The enabled exchange.

741

"googleAdManagerBuyerNetworkId": "A String", # Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.

742

},

743

],

744

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

745

"entityStatus": "A String", # Output only. The status of the partner.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

746

"displayName": "A String", # The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

747

"partnerId": "A String", # Output only. The unique ID of the partner. Assigned by the system.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

748

"adServerConfig": { # Ad server related settings of a partner. # Ad server related settings of the partner.

749

"measurementConfig": { # Measurement settings of a partner. # Measurement settings of a partner.

750

"dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.

751

"dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.

752

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

753

},

754

"dataAccessConfig": { # Settings that control how partner related data may be accessed. # Settings that control how partner data may be accessed.

755

"sdfConfig": { # Structured Data File (SDF) related settings. # Structured Data Files (SDF) settings for the partner. The SDF configuration for the partner.

756

"adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.

757

"version": "A String", # Required. The version of SDF being used.

758

},

759

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

760

"name": "A String", # Output only. The resource name of the partner.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

761

"generalConfig": { # General settings of a partner. # General settings of the partner.

762

"timeZone": "A String", # Immutable. The standard TZ database name of the partner's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

763

"currencyCode": "A String", # Immutable. Partner's currency in ISO 4217 format.

764

},

765

"updateTime": "A String", # Output only. The timestamp when the partner was last updated. Assigned by the system.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

766

},