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

2020-07-22 17:02:09 -0700

[diff] [blame]

84

<p class="firstline">Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

85

Dmitry Frenkel

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

[diff] [blame^]

86

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

87

<p class="firstline">Lists assigned targeting options of a line item across targeting types.</p>

88

89

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

90

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

91

Dmitry Frenkel

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

[diff] [blame^]

92

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

93

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

94

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

95

<code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

96

<p class="firstline">Creates a new line item. Returns the newly created line item if successful.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

97

98

<code><a href="#delete">delete(advertiserId, lineItemId, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

99

<p class="firstline">Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

100

101

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

102

103

Dmitry Frenkel

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

[diff] [blame^]

104

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

105

<p class="firstline">Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

106

107

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

108

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

109

110

<code><a href="#patch">patch(advertiserId, lineItemId, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

111

<p class="firstline">Updates an existing line item. Returns the updated line item if successful.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

112

<h3>Method Details</h3>

113

114

<code class="details" id="bulkEditLineItemAssignedTargetingOptions">bulkEditLineItemAssignedTargetingOptions(advertiserId, lineItemId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

115

<pre>Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

116

117

Args:

118

advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)

119

lineItemId: string, Required. The ID of the line item the assigned targeting option will belong to. (required)

120

body: object, The request body.

121

The object takes the form of:

122

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

123

{ # Request message for BulkEditLineItemAssignedTargetingOptions.

124

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

125

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

126

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

127

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

Dmitry Frenkel

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

[diff] [blame^]

128

"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`.

129

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

130

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

131

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

132

},

Dmitry Frenkel

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

[diff] [blame^]

133

"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`.

134

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

135

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

136

},

137

"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`.

138

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

139

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

140

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

141

},

142

"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`.

143

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

144

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

145

"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`.

146

"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`.

147

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

148

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

149

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

150

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

151

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

152

},

153

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

Dmitry Frenkel

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

[diff] [blame^]

154

"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`.

155

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

156

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

157

},

158

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

159

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

160

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

161

},

162

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

163

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

164

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

165

},

166

"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`.

167

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

168

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

169

},

170

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

171

"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`.

172

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

173

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

174

},

175

"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`.

176

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

177

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

178

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

179

},

180

"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`.

181

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

182

},

183

"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`.

184

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

185

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

186

},

187

"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`.

188

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

189

"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`.

190

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

191

},

192

"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`.

193

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

194

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

195

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

196

},

197

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

198

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

199

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

200

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

201

{ # Details of Google audience targeting setting.

202

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

203

},

204

],

205

},

Dmitry Frenkel

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

[diff] [blame^]

206

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

207

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

208

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

209

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

210

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

211

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

},

],

},

],

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

217

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

218

{ # Details of custom list targeting setting.

219

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

},

],

},

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

224

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

225

{ # Details of combined audience targeting setting.

226

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

},

],

},

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

231

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

232

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

233

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

234

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

239

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

240

{ # Details of Google audience targeting setting.

241

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

242

},

243

],

244

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

245

},

Dmitry Frenkel

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

[diff] [blame^]

246

"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`.

247

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

248

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

249

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

250

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

251

},

Dmitry Frenkel

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

[diff] [blame^]

252

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

253

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

254

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

255

},

Dmitry Frenkel

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

[diff] [blame^]

256

"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`.

257

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

258

},

259

"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`.

260

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

261

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

262

},

263

"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`.

264

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

265

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

266

},

267

"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`.

268

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

269

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

270

"A String",

271

],

272

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

273

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

Dmitry Frenkel

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

[diff] [blame^]

274

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

275

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

276

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

277

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

278

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

279

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

280

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

Dmitry Frenkel

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

[diff] [blame^]

281

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

282

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

Dmitry Frenkel

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

[diff] [blame^]

283

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

284

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

285

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

286

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

287

},

288

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

289

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

290

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

291

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

292

},

Dmitry Frenkel

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

[diff] [blame^]

293

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

294

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

295

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

296

},

Dmitry Frenkel

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

[diff] [blame^]

297

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

298

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

299

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

300

},

301

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

302

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

303

"A String",

304

],

305

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

306

"A String",

307

],

308

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

309

},

310

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

311

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

312

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

313

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

314

},

315

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

316

"A String",

317

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

318

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

319

},

Dmitry Frenkel

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

[diff] [blame^]

320

"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`.

321

"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`.

322

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

323

},

324

"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`.

325

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

326

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

327

},

Dmitry Frenkel

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

[diff] [blame^]

328

"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`.

329

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

330

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

331

},

Dmitry Frenkel

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

[diff] [blame^]

332

"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`.

333

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

334

},

335

"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`.

336

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

337

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

338

},

339

"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`.

340

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

341

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

342

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

343

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

344

},

345

"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`.

346

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

347

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

348

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

349

},

350

"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`.

351

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

352

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

353

},

354

"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`.

355

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

356

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

357

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

358

},

359

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

360

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

361

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

362

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

363

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

364

},

365

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

366

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

367

},

368

"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`.

369

"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`.

370

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

371

},

372

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

373

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

374

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

375

},

376

"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`.

377

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

378

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

379

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

380

},

381

],

Dmitry Frenkel

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

[diff] [blame^]

382

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

383

},

384

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

385

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

386

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

387

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

388

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

"A String",

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

393

}

394

395

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

402

403

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

404

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

405

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

Dmitry Frenkel

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

[diff] [blame^]

406

"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`.

407

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

408

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

409

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

410

},

Dmitry Frenkel

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

[diff] [blame^]

411

"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`.

412

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

413

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

414

},

415

"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`.

416

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

417

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

418

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

419

},

420

"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`.

421

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

422

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

423

"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`.

424

"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`.

425

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

426

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

427

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

428

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

429

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

430

},

431

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

Dmitry Frenkel

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

[diff] [blame^]

432

"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`.

433

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

434

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

435

},

436

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

437

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

438

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

439

},

440

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

441

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

442

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

443

},

444

"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`.

445

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

446

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

447

},

448

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

449

"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`.

450

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

451

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

452

},

453

"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`.

454

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

455

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

456

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

457

},

458

"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`.

459

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

460

},

461

"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`.

462

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

463

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

464

},

465

"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`.

466

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

467

"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`.

468

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

469

},

470

"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`.

471

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

472

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

473

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

474

},

475

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

476

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

477

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

478

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

479

{ # Details of Google audience targeting setting.

480

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

481

},

482

],

483

},

Dmitry Frenkel

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

[diff] [blame^]

484

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

485

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

486

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

487

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

488

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

489

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

},

],

},

],

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

495

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

496

{ # Details of custom list targeting setting.

497

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

},

],

},

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

502

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

503

{ # Details of combined audience targeting setting.

504

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

},

],

},

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

509

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

510

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

511

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

512

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

517

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

518

{ # Details of Google audience targeting setting.

519

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

520

},

521

],

522

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

523

},

Dmitry Frenkel

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

[diff] [blame^]

524

"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`.

525

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

526

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

527

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

528

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

529

},

Dmitry Frenkel

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

[diff] [blame^]

530

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

531

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

532

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

533

},

Dmitry Frenkel

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

[diff] [blame^]

534

"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`.

535

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

536

},

537

"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`.

538

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

539

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

540

},

541

"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`.

542

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

543

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

544

},

545

"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`.

546

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

547

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

548

"A String",

549

],

550

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

551

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

Dmitry Frenkel

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

[diff] [blame^]

552

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

553

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

554

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

555

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

556

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

557

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

558

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

Dmitry Frenkel

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

[diff] [blame^]

559

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

560

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

Dmitry Frenkel

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

[diff] [blame^]

561

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

562

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

563

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

564

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

565

},

566

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

567

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

568

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

569

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

570

},

Dmitry Frenkel

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

[diff] [blame^]

571

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

572

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

573

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

574

},

Dmitry Frenkel

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

[diff] [blame^]

575

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

576

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

577

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

578

},

579

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

580

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

581

"A String",

582

],

583

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

584

"A String",

585

],

586

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

587

},

588

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

589

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

590

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

591

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

592

},

593

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

594

"A String",

595

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

596

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

597

},

Dmitry Frenkel

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

[diff] [blame^]

598

"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`.

599

"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`.

600

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

601

},

602

"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`.

603

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

604

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

605

},

Dmitry Frenkel

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

[diff] [blame^]

606

"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`.

607

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

608

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

609

},

Dmitry Frenkel

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

[diff] [blame^]

610

"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`.

611

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

612

},

613

"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`.

614

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

615

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

616

},

617

"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`.

618

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

619

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

620

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

621

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

622

},

623

"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`.

624

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

625

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

626

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

627

},

628

"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`.

629

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

630

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

631

},

632

"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`.

633

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

634

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

635

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

636

},

637

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

638

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

639

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

640

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

641

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

642

},

643

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

644

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

645

},

646

"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`.

647

"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`.

648

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

649

},

650

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

651

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

652

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

653

},

654

"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`.

655

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

656

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

657

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

664

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

665

<pre>Lists assigned targeting options of a line item across targeting types.

666

667

Args:

668

advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)

669

lineItemId: string, Required. The ID of the line item to list assigned targeting options for. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

670

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` on the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters.

Dmitry Frenkel

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

[diff] [blame^]

671

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 "desc" should be added to the field name. Example: `targetingType desc`.

672

pageSize: integer, Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

673

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

674

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

681

682

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

683

"assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.

684

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

Dmitry Frenkel

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

[diff] [blame^]

685

"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`.

686

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

687

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

688

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

689

},

Dmitry Frenkel

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

[diff] [blame^]

690

"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`.

691

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

692

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

693

},

694

"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`.

695

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

696

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

697

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

698

},

699

"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`.

700

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

701

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

702

"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`.

703

"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`.

704

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

705

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

706

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

707

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

708

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

709

},

710

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

Dmitry Frenkel

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

[diff] [blame^]

711

"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`.

712

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

713

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

714

},

715

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

716

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

717

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

718

},

719

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

720

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

721

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

722

},

723

"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`.

724

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

725

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

726

},

727

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

728

"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`.

729

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

730

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

731

},

732

"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`.

733

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

734

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

735

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

736

},

737

"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`.

738

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

739

},

740

"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`.

741

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

742

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

743

},

744

"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`.

745

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

746

"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`.

747

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

748

},

749

"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`.

750

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

751

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

752

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

753

},

754

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

755

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

756

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

757

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

758

{ # Details of Google audience targeting setting.

759

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

760

},

761

],

762

},

Dmitry Frenkel

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

[diff] [blame^]

763

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

764

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

765

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

766

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

767

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

768

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

},

],

},

],

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

774

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

775

{ # Details of custom list targeting setting.

776

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

},

],

},

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

781

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

782

{ # Details of combined audience targeting setting.

783

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

},

],

},

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

788

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

789

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

790

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

791

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

796

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

797

{ # Details of Google audience targeting setting.

798

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

799

},

800

],

801

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

802

},

Dmitry Frenkel

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

[diff] [blame^]

803

"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`.

804

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

805

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

806

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

807

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

808

},

Dmitry Frenkel

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

[diff] [blame^]

809

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

810

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

811

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

812

},

Dmitry Frenkel

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

[diff] [blame^]

813

"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`.

814

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

815

},

816

"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`.

817

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

818

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

819

},

820

"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`.

821

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

822

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

823

},

824

"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`.

825

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

826

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

827

"A String",

828

],

829

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

830

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

Dmitry Frenkel

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

[diff] [blame^]

831

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

832

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

833

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

834

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

835

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

836

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

837

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

Dmitry Frenkel

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

[diff] [blame^]

838

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

839

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

Dmitry Frenkel

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

[diff] [blame^]

840

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

841

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

842

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

843

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

844

},

845

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

846

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

847

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

848

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

849

},

Dmitry Frenkel

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

[diff] [blame^]

850

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

851

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

852

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

853

},

Dmitry Frenkel

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

[diff] [blame^]

854

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

855

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

856

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

857

},

858

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

859

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

860

"A String",

861

],

862

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

863

"A String",

864

],

865

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

866

},

867

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

868

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

869

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

870

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

871

},

872

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

873

"A String",

874

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

875

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

876

},

Dmitry Frenkel

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

[diff] [blame^]

877

"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`.

878

"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`.

879

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

880

},

881

"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`.

882

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

883

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

884

},

Dmitry Frenkel

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

[diff] [blame^]

885

"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`.

886

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

887

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

888

},

Dmitry Frenkel

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

[diff] [blame^]

889

"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`.

890

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

891

},

892

"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`.

893

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

894

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

895

},

896

"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`.

897

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

898

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

899

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

900

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

901

},

902

"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`.

903

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

904

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

905

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

906

},

907

"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`.

908

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

909

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

910

},

911

"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`.

912

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

913

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

914

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

915

},

916

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

917

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

918

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

919

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

920

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

921

},

922

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

923

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

924

},

925

"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`.

926

"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`.

927

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

928

},

929

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

930

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

931

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

932

},

933

"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`.

934

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

935

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

936

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

937

},

938

],

Dmitry Frenkel

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

[diff] [blame^]

939

"nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListLineItemAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="bulkListLineItemAssignedTargetingOptions_next">bulkListLineItemAssignedTargetingOptions_next(previous_request, previous_response)</code>

945

<pre>Retrieves the next page of results.

946

947

Args:

948

previous_request: The request for the previous page. (required)

949

previous_response: The response from the request for the previous page. (required)

950

951

Returns:

952

A request object that you can call 'execute()' on to request the next

953

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

958

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

959

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

963

<code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

964

<pre>Creates a new line item. Returns the newly created line item if successful.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

965

966

Args:

967

advertiserId: string, Output only. The unique ID of the advertiser the line item belongs to. (required)

968

body: object, The request body.

969

The object takes the form of:

970

971

{ # A single line item.

Dmitry Frenkel

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

[diff] [blame^]

972

"partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.

973

{ # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.

974

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.

975

"invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.

976

"feeType": "A String", # Required. The fee type for this partner cost.

977

"costType": "A String", # Required. The type of the partner cost.

978

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

979

},

980

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

981

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

Dmitry Frenkel

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

[diff] [blame^]

982

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

983

"conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.

984

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.

985

{ # Settings that control the behavior of a single Floodlight activity config.

986

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.

987

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.

988

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

989

},

990

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

991

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.

992

},

Dmitry Frenkel

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

[diff] [blame^]

993

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

994

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

995

"frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the line item.

996

"timeUnit": "A String", # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.

997

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.

998

"timeUnitCount": 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59

999

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.

1000

},

1001

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

1002

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

1003

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.

1004

"budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.

1005

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.

1006

},

1007

"bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.

1008

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

1009

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1010

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.

1011

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1012

},

Dmitry Frenkel

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

[diff] [blame^]

1013

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.

1014

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1015

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1016

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.

1017

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.

1018

},

1019

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

1020

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.

1021

},

1022

},

1023

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1024

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

1025

"markupType": "A String", # Required. The markup type of the partner revenue model.

1026

"markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).

1027

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1028

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

1029

"A String",

1030

],

Dmitry Frenkel

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

[diff] [blame^]

1031

"creativeIds": [ # The IDs of the creatives associated with the line item.

1032

"A String",

1033

],

1034

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

1035

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

1036

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

1037

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via auto_budget_allocation, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.

1038

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.

1039

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period.

1040

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.

1041

},

1042

"lineItemType": "A String", # Required. Immutable. The type of the line item.

1043

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

1044

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

1045

"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.

1046

},

1047

"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.

1048

"A String",

1049

],

1050

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

1051

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.

1052

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1053

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1054

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1055

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1056

},

1057

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1058

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1059

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1060

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1061

},

1062

},

1063

"flightDateType": "A String", # Required. The type of the line item's flight dates.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1074

1075

{ # A single line item.

1076

"partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.

1077

{ # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.

1078

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.

1079

"invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.

1080

"feeType": "A String", # Required. The fee type for this partner cost.

1081

"costType": "A String", # Required. The type of the partner cost.

1082

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.

1083

},

1084

],

1085

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

1086

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.

1087

"conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.

1088

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.

1089

{ # Settings that control the behavior of a single Floodlight activity config.

1090

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.

1091

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.

1092

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

1093

},

1094

],

1095

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.

1096

},

1097

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

1098

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

1099

"frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the line item.

1100

"timeUnit": "A String", # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.

1101

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.

1102

"timeUnitCount": 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59

1103

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.

1104

},

1105

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

1106

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

1107

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.

1108

"budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.

1109

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.

1110

},

1111

"bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.

1112

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

1113

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1114

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.

1115

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.

1116

},

1117

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.

1118

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1119

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1120

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.

1121

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.

1122

},

1123

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

1124

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.

1125

},

1126

},

1127

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

1128

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

1129

"markupType": "A String", # Required. The markup type of the partner revenue model.

1130

"markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).

1131

},

1132

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

1133

"A String",

1134

],

1135

"creativeIds": [ # The IDs of the creatives associated with the line item.

1136

"A String",

1137

],

1138

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

1139

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

1140

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

1141

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via auto_budget_allocation, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.

1142

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.

1143

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period.

1144

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.

1145

},

1146

"lineItemType": "A String", # Required. Immutable. The type of the line item.

1147

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

1148

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

1149

"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.

1150

},

1151

"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.

1152

"A String",

1153

],

1154

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

1155

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.

1156

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1157

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1158

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1159

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1160

},

1161

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1162

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1163

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1164

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1165

},

1166

},

1167

"flightDateType": "A String", # Required. The type of the line item's flight dates.

1168

},

1169

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

<code class="details" id="delete">delete(advertiserId, lineItemId, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1174

<pre>Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1175

1176

Args:

1177

advertiserId: string, The ID of the advertiser this line item belongs to. (required)

1178

lineItemId: string, The ID of the line item we need to fetch. (required)

1179

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1186

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1187

{ # 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 Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

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

1193

<pre>Gets a line item.

1194

1195

Args:

1196

advertiserId: string, Required. The ID of the advertiser this line item belongs to. (required)

1197

lineItemId: string, Required. The ID of the line item to fetch. (required)

1198

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1205

1206

{ # A single line item.

Dmitry Frenkel

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

[diff] [blame^]

1207

"partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.

1208

{ # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.

1209

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.

1210

"invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.

1211

"feeType": "A String", # Required. The fee type for this partner cost.

1212

"costType": "A String", # Required. The type of the partner cost.

1213

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1214

},

1215

],

Dmitry Frenkel

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

[diff] [blame^]

1216

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

1217

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.

1218

"conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.

1219

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.

1220

{ # Settings that control the behavior of a single Floodlight activity config.

1221

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.

1222

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.

1223

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

1224

},

1225

],

1226

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1227

},

Dmitry Frenkel

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

[diff] [blame^]

1228

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

1229

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

1230

"frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the line item.

1231

"timeUnit": "A String", # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.

1232

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.

1233

"timeUnitCount": 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59

1234

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.

1235

},

1236

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

1237

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

1238

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.

1239

"budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.

1240

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.

1241

},

1242

"bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.

1243

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

1244

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1245

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.

1246

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.

1247

},

1248

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.

1249

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1250

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1251

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.

1252

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.

1253

},

1254

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

1255

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.

1256

},

1257

},

1258

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

1259

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

1260

"markupType": "A String", # Required. The markup type of the partner revenue model.

1261

"markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).

1262

},

1263

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

1264

"A String",

1265

],

1266

"creativeIds": [ # The IDs of the creatives associated with the line item.

1267

"A String",

1268

],

1269

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

1270

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

1271

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

1272

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via auto_budget_allocation, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.

1273

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.

1274

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period.

1275

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.

1276

},

1277

"lineItemType": "A String", # Required. Immutable. The type of the line item.

1278

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

1279

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

1280

"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.

1281

},

1282

"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.

1283

"A String",

1284

],

1285

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

1286

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.

1287

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1288

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1289

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1290

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1291

},

1292

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1293

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1294

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1295

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1296

},

1297

},

1298

"flightDateType": "A String", # Required. The type of the line item's flight dates.

1299

},

1300

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame^]

1304

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1305

<pre>Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1306

1307

Args:

1308

advertiserId: string, Required. The ID of the advertiser to list line items for. (required)

Dmitry Frenkel

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

[diff] [blame^]

1309

filter: string, Allows filtering by line item 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 used on `flight.dateRange.endDate` must be LESS THAN (<). * The operators used on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose flight dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` The length of this field should be no more than 500 characters.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1310

pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

Dmitry Frenkel

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

[diff] [blame^]

1311

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

1312

orderBy: string, Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * “flight.dateRange.endDate” The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1313

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1320

1321

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1322

"lineItems": [ # The list of line items. This list will be absent if empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1323

{ # A single line item.

Dmitry Frenkel

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

[diff] [blame^]

1324

"partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.

1325

{ # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.

1326

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.

1327

"invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.

1328

"feeType": "A String", # Required. The fee type for this partner cost.

1329

"costType": "A String", # Required. The type of the partner cost.

1330

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1331

},

1332

],

Dmitry Frenkel

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

[diff] [blame^]

1333

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

1334

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.

1335

"conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.

1336

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.

1337

{ # Settings that control the behavior of a single Floodlight activity config.

1338

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.

1339

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.

1340

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

1341

},

1342

],

1343

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1344

},

Dmitry Frenkel

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

[diff] [blame^]

1345

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

1346

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

1347

"frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the line item.

1348

"timeUnit": "A String", # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.

1349

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.

1350

"timeUnitCount": 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59

1351

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.

1352

},

1353

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

1354

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

1355

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.

1356

"budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.

1357

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.

1358

},

1359

"bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.

1360

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

1361

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1362

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.

1363

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.

1364

},

1365

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.

1366

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1367

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1368

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.

1369

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.

1370

},

1371

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

1372

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.

1373

},

1374

},

1375

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

1376

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

1377

"markupType": "A String", # Required. The markup type of the partner revenue model.

1378

"markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).

1379

},

1380

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

1381

"A String",

1382

],

1383

"creativeIds": [ # The IDs of the creatives associated with the line item.

1384

"A String",

1385

],

1386

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

1387

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

1388

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

1389

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via auto_budget_allocation, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.

1390

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.

1391

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period.

1392

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.

1393

},

1394

"lineItemType": "A String", # Required. Immutable. The type of the line item.

1395

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

1396

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

1397

"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.

1398

},

1399

"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.

1400

"A String",

1401

],

1402

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

1403

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.

1404

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1405

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1406

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1407

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1408

},

1409

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1410

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1411

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1412

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1413

},

1414

},

1415

"flightDateType": "A String", # Required. The type of the line item's flight dates.

1416

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1417

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1418

],

Dmitry Frenkel

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

[diff] [blame^]

1419

"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 `ListLineItems` method to retrieve the next page of results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1425

<pre>Retrieves the next page of results.

1426

1427

Args:

1428

previous_request: The request for the previous page. (required)

1429

previous_response: The response from the request for the previous page. (required)

1430

1431

Returns:

1432

A request object that you can call 'execute()' on to request the next

1433

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(advertiserId, lineItemId, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1439

<pre>Updates an existing line item. Returns the updated line item if successful.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1440

1441

Args:

1442

advertiserId: string, Output only. The unique ID of the advertiser the line item belongs to. (required)

1443

lineItemId: string, Output only. The unique ID of the line item. Assigned by the system. (required)

1444

body: object, The request body.

1445

The object takes the form of:

1446

1447

{ # A single line item.

Dmitry Frenkel

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

[diff] [blame^]

1448

"partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.

1449

{ # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.

1450

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.

1451

"invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.

1452

"feeType": "A String", # Required. The fee type for this partner cost.

1453

"costType": "A String", # Required. The type of the partner cost.

1454

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1455

},

1456

],

Dmitry Frenkel

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

[diff] [blame^]

1457

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

1458

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.

1459

"conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.

1460

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.

1461

{ # Settings that control the behavior of a single Floodlight activity config.

1462

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.

1463

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.

1464

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

1465

},

1466

],

1467

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1468

},

Dmitry Frenkel

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

[diff] [blame^]

1469

"campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.

1470

"lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.

1471

"frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The frequency capping setting of the line item.

1472

"timeUnit": "A String", # The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`.

1473

"maxImpressions": 42, # The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`.

1474

"timeUnitCount": 42, # The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59

1475

"unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.

1476

},

1477

"insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.

1478

"budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.

1479

"maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.

1480

"budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.

1481

"budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.

1482

},

1483

"bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.

1484

"maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.

1485

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1486

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.

1487

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.

1488

},

1489

"performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.

1490

"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1491

"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

1492

"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.

1493

"performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.

1494

},

1495

"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.

1496

"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.

1497

},

1498

},

1499

"entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.

1500

"partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.

1501

"markupType": "A String", # Required. The markup type of the partner revenue model.

1502

"markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).

1503

},

1504

"inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item.

1505

"A String",

1506

],

1507

"creativeIds": [ # The IDs of the creatives associated with the line item.

1508

"A String",

1509

],

1510

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

1511

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

1512

"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.

1513

"pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via auto_budget_allocation, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.

1514

"dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.

1515

"pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period.

1516

"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.

1517

},

1518

"lineItemType": "A String", # Required. Immutable. The type of the line item.

1519

"integrationDetails": { # Integration details of an entry. # Integration details of the line item.

1520

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

1521

"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.

1522

},

1523

"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.

1524

"A String",

1525

],

1526

"flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.

1527

"dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.

1528

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1529

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1530

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1531

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1532

},

1533

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.

1534

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

1535

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

1536

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

1537

},

1538

},

1539

"flightDateType": "A String", # Required. The type of the line item's flight dates.

1540

},

1541

}

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1542

1543

updateMask: string, Required. The mask to control which fields to update.

1544

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1551

1552

{ # A single line item.

Dmitry Frenkel

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

[diff] [blame^]

1553

"partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.

1554

{ # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.

1555

"feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.

1556

"invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.

1557

"feeType": "A String", # Required. The fee type for this partner cost.

1558

"costType": "A String", # Required. The type of the partner cost.

1559

"feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1560

},

1561

],

Dmitry Frenkel

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

[diff] [blame^]

1562

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

1563

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.

1564

"conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.

1565

"floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.

1566

{ # Settings that control the behavior of a single Floodlight activity config.

1567

"postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.

1568

"postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.

1569

"floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.

1570

},

1571

],

1572

"postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1573

},

Dmitry Frenkel