blob: 2e1b1a297d963fce91a65d5c8bb8defe31e9ef9d [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.lineItems.html">lineItems</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="displayvideo_v1.advertisers.lineItems.targetingTypes.html">targetingTypes()</a></code>
</p>
<p class="firstline">Returns the targetingTypes Resource.</p>
<p class="toc_element">
<code><a href="#bulkEditLineItemAssignedTargetingOptions">bulkEditLineItemAssignedTargetingOptions(advertiserId, lineItemId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Bulk edits targeting options under a single line item.</p>
<p class="toc_element">
<code><a href="#bulkListLineItemAssignedTargetingOptions">bulkListLineItemAssignedTargetingOptions(advertiserId, lineItemId, filter=None, pageToken=None, pageSize=None, orderBy=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists assigned targeting options of a line item across targeting types.</p>
<p class="toc_element">
<code><a href="#bulkListLineItemAssignedTargetingOptions_next">bulkListLineItemAssignedTargetingOptions_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new line item.</p>
<p class="toc_element">
<code><a href="#delete">delete(advertiserId, lineItemId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a line item.</p>
<p class="toc_element">
<code><a href="#get">get(advertiserId, lineItemId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a line item.</p>
<p class="toc_element">
<code><a href="#list">list(advertiserId, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists line items in an advertiser.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(advertiserId, lineItemId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing line item.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="bulkEditLineItemAssignedTargetingOptions">bulkEditLineItemAssignedTargetingOptions(advertiserId, lineItemId, body=None, x__xgafv=None)</code>
<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 .
Args:
advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)
lineItemId: string, Required. The ID of the line item the assigned targeting option will belong to. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for
# BulkEditLineItemAssignedTargetingOptions.
&quot;deleteRequests&quot;: [ # The assigned targeting options to delete in batch, specified as a list of
# `DeleteAssignedTargetingOptionsRequest`.
{ # A request listing which assigned targeting options of a given targeting type
# should be deleted.
&quot;targetingType&quot;: &quot;A String&quot;, # Required. Identifies the type of this assigned targeting option.
&quot;assignedTargetingOptionIds&quot;: [ # Required. The assigned targeting option IDs to delete.
&quot;A String&quot;,
],
},
],
&quot;createRequests&quot;: [ # The assigned targeting options to create in batch, specified as a list of
# `CreateAssignedTargetingOptionsRequest`.
{ # A request listing which assigned targeting options of a given targeting type
# should be created and added.
&quot;targetingType&quot;: &quot;A String&quot;, # Required. Identifies the type of this assigned targeting option.
&quot;assignedTargetingOptions&quot;: [ # Required. The assigned targeting options to create and add.
{ # A single assigned targeting option, which defines the state of a targeting
# option for an entity with targeting settings, such as a Line Item or
# Insertion Order.
&quot;appDetails&quot;: { # Details for assigned app targeting option. This will be populated in the # App details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_APP`.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_APP`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app.
&quot;appId&quot;: &quot;A String&quot;, # Required. The ID of the app.
#
# Android&#x27;s Play store app uses bundle ID, for example
# `com.google.android.gm`. Apple&#x27;s App store app ID uses 9 digit string, for
# example `422689480`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;parentalStatusDetails&quot;: { # Details for assigned parental status targeting option. This will be # Parental status details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARTGETING_TYPE_PARENTAL_STATUS`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.
&quot;parentalStatus&quot;: &quot;A String&quot;, # Output only. The parental status of the audience.
},
&quot;targetingType&quot;: &quot;A String&quot;, # Output only. Identifies the type of this assigned targeting option.
&quot;urlDetails&quot;: { # Details for assigned URL targeting option. This will be populated in the # URL details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_URL`.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_URL`.
&quot;url&quot;: &quot;A String&quot;, # Required. The URL, for example `example.com`.
#
# DV360 supports two levels of subdirectory targeting, for example
# `www.example.com/one-subdirectory-level/second-level`, and five levels of
# subdomain targeting, for example `five.four.three.two.one.example.com`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;onScreenPositionDetails&quot;: { # On screen position targeting option details. This will be # On screen position details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`.
# populated in the
# on_screen_position_details
# field when
# targeting_type is
# `TARGETING_TYPE_ON_SCREEN_POSITION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_ON_SCREEN_POSITION`.
&quot;onScreenPosition&quot;: &quot;A String&quot;, # Output only. The on screen position.
},
&quot;videoPlayerSizeDetails&quot;: { # Video player size targeting option details. This will be populated in the # Video player size details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
# 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.
&quot;videoPlayerSize&quot;: &quot;A String&quot;, # Output only. The video player size.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
},
&quot;channelDetails&quot;: { # Details for assigned channel targeting option. This will be populated in # Channel details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CHANNEL`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_CHANNEL`.
&quot;channelId&quot;: &quot;A String&quot;, # Required. ID of the channel. Should refer to the channel ID
# field on a
# [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or
# [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id)
# resource.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. For advertiser
# level assigned targeting option, this field must be true.
},
&quot;operatingSystemDetails&quot;: { # Assigned operating system targeting option details. This will be # Operating system details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`.
# populated in the
# operating_system_details
# field when
# targeting_type is
# `TARGETING_TYPE_OPERATING_SYSTEM`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the operating system.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting option ID populated in
# targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_OPERATING_SYSTEM`.
},
&quot;thirdPartyVerifierDetails&quot;: { # Assigned third party verifier targeting option details. This will be # Third party verification details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
&quot;integralAdScience&quot;: { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
&quot;excludedAdFraudRisk&quot;: &quot;A String&quot;, # Ad Fraud settings.
&quot;displayViewability&quot;: &quot;A String&quot;, # Display Viewability section (applicable to display line items only).
&quot;excludedHateSpeechRisk&quot;: &quot;A String&quot;, # Brand Safety - **Hate speech**.
&quot;excludedOffensiveLanguageRisk&quot;: &quot;A String&quot;, # Brand Safety - **Offensive language**.
&quot;excludedDrugsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Drugs**.
&quot;excludedAdultRisk&quot;: &quot;A String&quot;, # Brand Safety - **Adult content**.
&quot;traqScoreOption&quot;: &quot;A String&quot;, # True advertising quality (applicable to Display line items only).
&quot;videoViewability&quot;: &quot;A String&quot;, # Video Viewability Section (applicable to video line items only).
&quot;excludedAlcoholRisk&quot;: &quot;A String&quot;, # Brand Safety - **Alcohol**.
&quot;excludedGamblingRisk&quot;: &quot;A String&quot;, # Brand Safety - **Gambling**.
&quot;excludeUnrateable&quot;: True or False, # Brand Safety - **Unrateable**.
&quot;excludedIllegalDownloadsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Illegal downloads**.
&quot;excludedViolenceRisk&quot;: &quot;A String&quot;, # Brand Safety - **Violence**.
},
&quot;doubleVerify&quot;: { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
&quot;videoViewability&quot;: { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
&quot;playerImpressionRate&quot;: &quot;A String&quot;, # Target inventory to maximize impressions with 400x300 or greater player
# size.
&quot;videoIab&quot;: &quot;A String&quot;, # Target web inventory to maximize IAB viewable rate.
&quot;videoViewableRate&quot;: &quot;A String&quot;, # Target web inventory to maximize fully viewable rate.
},
&quot;avoidedAgeRatings&quot;: [ # Avoid bidding on apps with the age rating.
&quot;A String&quot;,
],
&quot;fraudInvalidTraffic&quot;: { # DoubleVerify Fraud &amp; Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud &amp; IVT Rates.
&quot;avoidInsufficientOption&quot;: True or False, # Insufficient Historical Fraud &amp; IVT Stats.
&quot;avoidedFraudOption&quot;: &quot;A String&quot;, # Avoid Sites and Apps with historical Fraud &amp; IVT.
},
&quot;brandSafetyCategories&quot;: { # Settings for brand safety controls. # DV Brand Safety Controls.
&quot;avoidedMediumSeverityCategories&quot;: [ # Brand safety medium severity avoidance categories.
&quot;A String&quot;,
],
&quot;avoidedHighSeverityCategories&quot;: [ # Brand safety high severity avoidance categories.
&quot;A String&quot;,
],
&quot;avoidUnknownBrandSafetyCategory&quot;: True or False, # Unknown or unrateable.
},
&quot;appStarRating&quot;: { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
&quot;avoidedStarRating&quot;: &quot;A String&quot;, # Avoid bidding on apps with the star ratings.
&quot;avoidInsufficientStarRating&quot;: True or False, # Avoid bidding on apps with insufficient star ratings.
},
&quot;displayViewability&quot;: { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
&quot;viewableDuring&quot;: &quot;A String&quot;, # Target web and app inventory to maximize 100% viewable duration.
&quot;iab&quot;: &quot;A String&quot;, # Target web and app inventory to maximize IAB viewable rate.
},
},
&quot;adloox&quot;: { # Details of Adloox settings. # Third party brand verifier -- Adloox.
&quot;excludedAdlooxCategories&quot;: [ # Adloox&#x27;s brand safety settings.
&quot;A String&quot;,
],
},
},
&quot;proximityLocationListDetails&quot;: { # Targeting details for proximity location list. This will be # Proximity location list details. This field will be populated when the
# TargetingType is
# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
&quot;proximityRadiusRange&quot;: &quot;A String&quot;, # Required. Radius range for proximity location list.
# This represents the size of the area around a chosen location that will be
# targeted.
#
# `All` proximity location targeting under a single line item must have the
# same radius range value. Set this value to match any existing targeting.
# If updated, this field will change the radius range for all proximity
# targeting under the line item.
&quot;proximityLocationListId&quot;: &quot;A String&quot;, # Required. ID of the proximity location list. Should refer to the
# location_list_id field of a
# LocationList resource whose type is
# `TARGETING_LOCATION_TYPE_PROXIMITY`.
},
&quot;ageRangeDetails&quot;: { # Represents a targetable age range. This will be populated in the details # Age range details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_AGE_RANGE`.
# field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_AGE_RANGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.
&quot;ageRange&quot;: &quot;A String&quot;, # Output only. The age range of an audience. We only support targeting a continuous age
# range of an audience. Thus, the age range represented in this field can be
# 1) targeted solely, or, 2) part of a larger continuous age range. The reach
# of a continuous age range targeting can be expanded by also targeting an
# audience of an unknown age.
},
&quot;subExchangeDetails&quot;: { # Details for assigned sub-exchange targeting option. This will be populated in # Sub-exchange details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_SUB_EXCHANGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
},
&quot;keywordDetails&quot;: { # Details for assigned keyword targeting option. This will be populated in the # 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.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_KEYWORD`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;keyword&quot;: &quot;A String&quot;, # Required. The keyword, for example `car insurance`.
#
# Positive keyword cannot be offensive word.
# Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number
# of characters is 80. Maximum number of words is 10.
},
&quot;deviceMakeModelDetails&quot;: { # Assigned device make and model targeting option details. This will be # Device make and model details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
# populated in the
# device_make_model_details
# field when
# targeting_type is
# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the device make and model.
},
&quot;digitalContentLabelExclusionDetails&quot;: { # Targeting details for digital content label. This will be # Digital content label details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
#
# Digital content labels are targeting exclusions. Advertiser level digital
# content label exclusions, if set, are always applied in serving (even
# though they aren&#x27;t visible in line item settings). Line item settings can
# exclude content labels in addition to advertiser exclusions, but can&#x27;t
# override them. A line item won&#x27;t serve if all the digital content labels
# are excluded.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
&quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the digital content label to be EXCLUDED.
&quot;contentRatingTier&quot;: &quot;A String&quot;, # Output only. The display name of the digital content label rating tier.
},
&quot;browserDetails&quot;: { # Details for assigned browser targeting option. This will be populated in # Browser details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_BROWSER`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_BROWSER`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_BROWSER`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the browser.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned browser
# targeting options on the same line item must have the same value for this
# field.
},
&quot;appCategoryDetails&quot;: { # Details for assigned app category targeting option. This will be # App category details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_APP_CATEGORY`.
# populated in the
# app_category_details field of
# an AssignedTargetingOption when
# targeting_type
# is `TARGETING_TYPE_APP_CATEGORY`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_APP_CATEGORY`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app category.
},
&quot;contentOutstreamPositionDetails&quot;: { # Assigned content outstream position targeting option details. This will be # Content outstream position details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
# populated in the
# content_outstream_position_details
# field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
&quot;contentOutstreamPosition&quot;: &quot;A String&quot;, # Output only. The content outstream position.
},
&quot;negativeKeywordListDetails&quot;: { # Targeting details for negative keyword list. This will be populated in the # 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.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.
&quot;negativeKeywordListId&quot;: &quot;A String&quot;, # Required. ID of the negative keyword list. Should refer to the
# negative_keyword_list_id
# field of a NegativeKeywordList resource.
},
&quot;genderDetails&quot;: { # Details for assigned gender targeting option. This will be populated in # Gender details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_GENDER`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARTGETING_TYPE_GENDER`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_GENDER`.
&quot;gender&quot;: &quot;A String&quot;, # Output only. The gender of the audience.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this assigned targeting option.
&quot;inventorySourceDetails&quot;: { # Targeting details for inventory source. This will be # Inventory source details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_INVENTORY_SOURCE`.
&quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. ID of the inventory source. Should refer to the
# inventory_source_id field of an
# InventorySource resource.
},
&quot;sensitiveCategoryExclusionDetails&quot;: { # Targeting details for sensitive category. This will be populated in the # Sensitive category details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
#
# Sensitive categories are targeting exclusions. Advertiser level sensitive
# category exclusions, if set, are always applied in serving (even though
# they aren&#x27;t visible in line item settings). Line item settings can
# exclude sensitive categories in addition to advertiser exclusions, but
# can&#x27;t override them.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
&quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the sensitive category to be EXCLUDED.
&quot;sensitiveCategory&quot;: &quot;A String&quot;, # Output only. An enum for the DV360 Sensitive category content classifier.
},
&quot;audienceGroupDetails&quot;: { # Assigned audience group targeting option details. This will be populated in # 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.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_AUDIENCE_GROUP`.
# The relation between each group is UNION, except for
# excluded_first_and_third_party_audience_group and
# excluded_google_audience_group, of which COMPLEMENT is UNION&#x27;ed with other
# groups.
&quot;includedFirstAndThirdPartyAudienceGroups&quot;: [ # The first and third party audience ids and recencies of included first
# and third party audience groups. Each first and third party audience group
# contains first and third party audience ids only.
# The relation between each first and third party audience group is
# INTERSECTION, and the result is UNION&#x27;ed with other audience groups.
# Repeated groups with same settings will be ignored.
{ # Details of first and third party audience group.
# All first and third party audience targeting settings are logically ‘OR’ of
# each other.
&quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and
# third party audience group.
# Repeated settings with same id are not allowed.
{ # Details of first and third party audience targeting setting.
&quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting.
# Only applicable to first party audiences, otherwise
# will be ignored. For more info, refer to
# https://support.google.com/displayvideo/answer/2949947#recency
# When unspecified, no recency limit will be used.
&quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience
# targeting setting. This id is
# first_and_third_party_audience_id.
},
],
},
],
&quot;includedCombinedAudienceGroup&quot;: { # Details of combined audience group. # The combined audience ids of the included combined audience group.
# Contains combined audience ids only.
# All combined audience targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All combined audience targeting settings in combined audience group.
# Repeated settings with same id will be ignored.
# The number of combined audience settings should be no more than five, error
# will be thrown otherwise.
{ # Details of combined audience targeting setting.
&quot;combinedAudienceId&quot;: &quot;A String&quot;, # Required. Combined audience id of combined audience targeting setting.
# This id is combined_audience_id.
},
],
},
&quot;includedCustomListGroup&quot;: { # Details of custom list group. # The custom list ids of the included custom list group.
# Contains custom list ids only.
# All custom list targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All custom list targeting settings in custom list group.
# Repeated settings with same id will be ignored.
{ # Details of custom list targeting setting.
&quot;customListId&quot;: &quot;A String&quot;, # Required. Custom id of custom list targeting setting.
# This id is custom_list_id.
},
],
},
&quot;excludedFirstAndThirdPartyAudienceGroup&quot;: { # Details of first and third party audience group. # 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.
# All first and third party audience targeting settings are logically ‘OR’ of
# each other.
&quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and
# third party audience group.
# Repeated settings with same id are not allowed.
{ # Details of first and third party audience targeting setting.
&quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting.
# Only applicable to first party audiences, otherwise
# will be ignored. For more info, refer to
# https://support.google.com/displayvideo/answer/2949947#recency
# When unspecified, no recency limit will be used.
&quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience
# targeting setting. This id is
# first_and_third_party_audience_id.
},
],
},
&quot;includedGoogleAudienceGroup&quot;: { # Details of Google audience group. # The Google audience ids of the included Google audience group.
# Contains Google audience ids only.
# All Google audience targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group.
# Repeated settings with same id will be ignored.
{ # Details of Google audience targeting setting.
&quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting.
# This id is google_audience_id.
},
],
},
&quot;excludedGoogleAudienceGroup&quot;: { # Details of Google audience group. # The Google audience ids of the excluded Google audience group.
# Used for negative targeting. It&#x27;s COMPLEMENT is used to UNION other
# audience groups.
# Only contains Affinity, In-market and Installed-apps type Google audiences.
# All items are logically ‘OR’ of each other.
# All Google audience targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group.
# Repeated settings with same id will be ignored.
{ # Details of Google audience targeting setting.
&quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting.
# This id is google_audience_id.
},
],
},
},
&quot;userRewardedContentDetails&quot;: { # User rewarded content targeting option details. This will be populated in # User rewarded content details. This field will be populated when the
# TargetingType is
# `TARGETING_TYPE_USER_REWARDED_CONTENT`.
# the
# user_rewarded_content_details
# field when
# targeting_type is
# `TARGETING_TYPE_USER_REWARDED_CONTENT`.
&quot;userRewardedContent&quot;: &quot;A String&quot;, # Output only. User rewarded content status for video ads.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_USER_REWARDED_CONTENT`.
},
&quot;languageDetails&quot;: { # Details for assigned language targeting option. This will be populated in the # Language details. This field will be populated when the TargetingType is
# `TARGETING_TYPE_LANGUAGE`.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_LANGUAGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the language (e.g., &quot;French&quot;).
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned
# language targeting options on the same line item must have the same value
# for this field.
},
&quot;authorizedSellerStatusDetails&quot;: { # Represents an assigned authorized seller status. This will be populated in # Authorized seller status details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
#
# You can only target one authorized seller status option per line item.
#
# If a line item doesn&#x27;t have an authorized seller status option, all
# authorized sellers indicated as DIRECT or RESELLER in the ads.txt file
# are targeted by default.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
&quot;authorizedSellerStatus&quot;: &quot;A String&quot;, # Output only. The authorized seller status to target.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
},
&quot;dayAndTimeDetails&quot;: { # Representation of a segment of time defined on a specific day of the week and # Day and time details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_DAY_AND_TIME`.
# with a start and end time.
# The time represented by `start_hour` must be before the time represented by
# `end_hour`.
&quot;dayOfWeek&quot;: &quot;A String&quot;, # Required. The day of the week for this day and time targeting setting.
&quot;startHour&quot;: 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day)
# and 23 (1 hour before end of day).
&quot;endHour&quot;: 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after
# start of day) and 24 (end of day).
&quot;timeZoneResolution&quot;: &quot;A String&quot;, # Required. The mechanism used to determine which timezone to use for this day and time
# targeting setting.
},
&quot;inheritance&quot;: &quot;A String&quot;, # Output only. The inheritance status of the assigned targeting option.
&quot;environmentDetails&quot;: { # Assigned environment targeting option details. This will be populated # Environment details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_ENVIRONMENT`.
# in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_ENVIRONMENT`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., &quot;508010&quot;
# for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).
&quot;environment&quot;: &quot;A String&quot;, # Output only. The serving environment.
},
&quot;geoRegionDetails&quot;: { # Details for assigned geographic region targeting option. This will be # Geographic region details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_GEO_REGION`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_GEO_REGION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region (e.g., &quot;Ontario, Canada&quot;).
&quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of geographic region targeting.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;deviceTypeDetails&quot;: { # Targeting details for device type. This will be # Device Type details. This field will be populated when the
# TargetingType is
# `TARGETING_TYPE_DEVICE_TYPE`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_DEVICE_TYPE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the device type.
&quot;deviceType&quot;: &quot;A String&quot;, # Output only. The display name of the device type.
},
&quot;exchangeDetails&quot;: { # Details for assigned exchange targeting option. This will be populated in # Exchange details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_EXCHANGE`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_EXCHANGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_EXCHANGE`.
},
&quot;assignedTargetingOptionId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned targeting option. The ID is only unique
# within a given line item and targeting type. It may be reused in other
# contexts.
&quot;householdIncomeDetails&quot;: { # Details for assigned household income targeting option. This will be # Household income details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_HOUSEHOLD_INCOME`.
&quot;householdIncome&quot;: &quot;A String&quot;, # Output only. The household income of the audience.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.
},
&quot;contentInstreamPositionDetails&quot;: { # Assigned content instream position targeting option details. This will be # Content instream position details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
# populated in the
# content_instream_position_details
# field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
&quot;contentInstreamPosition&quot;: &quot;A String&quot;, # Output only. The content instream position for video or audio ads.
},
&quot;categoryDetails&quot;: { # Assigned category targeting option details. This will be populated in the # 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.
# category_details field when
# targeting_type is
# `TARGETING_TYPE_CATEGORY`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_CATEGORY`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the category.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;inventorySourceGroupDetails&quot;: { # Targeting details for inventory source group. This will be # Inventory source group details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
&quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Required. ID of the inventory source group. Should refer to the
# inventory_source_group_id
# field of an InventorySourceGroup resource.
},
&quot;regionalLocationListDetails&quot;: { # Targeting details for regional location list. This will be # Regional location list details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
&quot;regionalLocationListId&quot;: &quot;A String&quot;, # Required. ID of the regional location list. Should refer to the
# location_list_id field of a
# LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;carrierAndIspDetails&quot;: { # Details for assigned carrier and ISP targeting option. This will be populated # Carrier and ISP details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`.
# in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_CARRIER_AND_ISP`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned carrier
# and ISP targeting options on the same line item must have the same value
# for this field.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the carrier or ISP.
},
&quot;viewabilityDetails&quot;: { # Assigned viewability targeting option details. This will be populated in the # Viewability details. This field will be populated when the TargetingType
# is `TARGETING_TYPE_VIEWABILITY`.
#
# You can only target one viewability option per line item.
# viewability_details field of
# an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_VIEWABILITY`.
&quot;viewability&quot;: &quot;A String&quot;, # Output only. The predicted viewability percentage.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., &quot;509010&quot;
# for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).
},
},
],
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;createdAssignedTargetingOptions&quot;: [ # The list of assigned targeting options that have been successfully created.
#
# This list will be absent if empty.
{ # A single assigned targeting option, which defines the state of a targeting
# option for an entity with targeting settings, such as a Line Item or
# Insertion Order.
&quot;appDetails&quot;: { # Details for assigned app targeting option. This will be populated in the # App details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_APP`.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_APP`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app.
&quot;appId&quot;: &quot;A String&quot;, # Required. The ID of the app.
#
# Android&#x27;s Play store app uses bundle ID, for example
# `com.google.android.gm`. Apple&#x27;s App store app ID uses 9 digit string, for
# example `422689480`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;parentalStatusDetails&quot;: { # Details for assigned parental status targeting option. This will be # Parental status details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARTGETING_TYPE_PARENTAL_STATUS`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.
&quot;parentalStatus&quot;: &quot;A String&quot;, # Output only. The parental status of the audience.
},
&quot;targetingType&quot;: &quot;A String&quot;, # Output only. Identifies the type of this assigned targeting option.
&quot;urlDetails&quot;: { # Details for assigned URL targeting option. This will be populated in the # URL details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_URL`.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_URL`.
&quot;url&quot;: &quot;A String&quot;, # Required. The URL, for example `example.com`.
#
# DV360 supports two levels of subdirectory targeting, for example
# `www.example.com/one-subdirectory-level/second-level`, and five levels of
# subdomain targeting, for example `five.four.three.two.one.example.com`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;onScreenPositionDetails&quot;: { # On screen position targeting option details. This will be # On screen position details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`.
# populated in the
# on_screen_position_details
# field when
# targeting_type is
# `TARGETING_TYPE_ON_SCREEN_POSITION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_ON_SCREEN_POSITION`.
&quot;onScreenPosition&quot;: &quot;A String&quot;, # Output only. The on screen position.
},
&quot;videoPlayerSizeDetails&quot;: { # Video player size targeting option details. This will be populated in the # Video player size details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
# 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.
&quot;videoPlayerSize&quot;: &quot;A String&quot;, # Output only. The video player size.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
},
&quot;channelDetails&quot;: { # Details for assigned channel targeting option. This will be populated in # Channel details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CHANNEL`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_CHANNEL`.
&quot;channelId&quot;: &quot;A String&quot;, # Required. ID of the channel. Should refer to the channel ID
# field on a
# [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or
# [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id)
# resource.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. For advertiser
# level assigned targeting option, this field must be true.
},
&quot;operatingSystemDetails&quot;: { # Assigned operating system targeting option details. This will be # Operating system details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`.
# populated in the
# operating_system_details
# field when
# targeting_type is
# `TARGETING_TYPE_OPERATING_SYSTEM`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the operating system.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting option ID populated in
# targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_OPERATING_SYSTEM`.
},
&quot;thirdPartyVerifierDetails&quot;: { # Assigned third party verifier targeting option details. This will be # Third party verification details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
&quot;integralAdScience&quot;: { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
&quot;excludedAdFraudRisk&quot;: &quot;A String&quot;, # Ad Fraud settings.
&quot;displayViewability&quot;: &quot;A String&quot;, # Display Viewability section (applicable to display line items only).
&quot;excludedHateSpeechRisk&quot;: &quot;A String&quot;, # Brand Safety - **Hate speech**.
&quot;excludedOffensiveLanguageRisk&quot;: &quot;A String&quot;, # Brand Safety - **Offensive language**.
&quot;excludedDrugsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Drugs**.
&quot;excludedAdultRisk&quot;: &quot;A String&quot;, # Brand Safety - **Adult content**.
&quot;traqScoreOption&quot;: &quot;A String&quot;, # True advertising quality (applicable to Display line items only).
&quot;videoViewability&quot;: &quot;A String&quot;, # Video Viewability Section (applicable to video line items only).
&quot;excludedAlcoholRisk&quot;: &quot;A String&quot;, # Brand Safety - **Alcohol**.
&quot;excludedGamblingRisk&quot;: &quot;A String&quot;, # Brand Safety - **Gambling**.
&quot;excludeUnrateable&quot;: True or False, # Brand Safety - **Unrateable**.
&quot;excludedIllegalDownloadsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Illegal downloads**.
&quot;excludedViolenceRisk&quot;: &quot;A String&quot;, # Brand Safety - **Violence**.
},
&quot;doubleVerify&quot;: { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
&quot;videoViewability&quot;: { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
&quot;playerImpressionRate&quot;: &quot;A String&quot;, # Target inventory to maximize impressions with 400x300 or greater player
# size.
&quot;videoIab&quot;: &quot;A String&quot;, # Target web inventory to maximize IAB viewable rate.
&quot;videoViewableRate&quot;: &quot;A String&quot;, # Target web inventory to maximize fully viewable rate.
},
&quot;avoidedAgeRatings&quot;: [ # Avoid bidding on apps with the age rating.
&quot;A String&quot;,
],
&quot;fraudInvalidTraffic&quot;: { # DoubleVerify Fraud &amp; Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud &amp; IVT Rates.
&quot;avoidInsufficientOption&quot;: True or False, # Insufficient Historical Fraud &amp; IVT Stats.
&quot;avoidedFraudOption&quot;: &quot;A String&quot;, # Avoid Sites and Apps with historical Fraud &amp; IVT.
},
&quot;brandSafetyCategories&quot;: { # Settings for brand safety controls. # DV Brand Safety Controls.
&quot;avoidedMediumSeverityCategories&quot;: [ # Brand safety medium severity avoidance categories.
&quot;A String&quot;,
],
&quot;avoidedHighSeverityCategories&quot;: [ # Brand safety high severity avoidance categories.
&quot;A String&quot;,
],
&quot;avoidUnknownBrandSafetyCategory&quot;: True or False, # Unknown or unrateable.
},
&quot;appStarRating&quot;: { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
&quot;avoidedStarRating&quot;: &quot;A String&quot;, # Avoid bidding on apps with the star ratings.
&quot;avoidInsufficientStarRating&quot;: True or False, # Avoid bidding on apps with insufficient star ratings.
},
&quot;displayViewability&quot;: { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
&quot;viewableDuring&quot;: &quot;A String&quot;, # Target web and app inventory to maximize 100% viewable duration.
&quot;iab&quot;: &quot;A String&quot;, # Target web and app inventory to maximize IAB viewable rate.
},
},
&quot;adloox&quot;: { # Details of Adloox settings. # Third party brand verifier -- Adloox.
&quot;excludedAdlooxCategories&quot;: [ # Adloox&#x27;s brand safety settings.
&quot;A String&quot;,
],
},
},
&quot;proximityLocationListDetails&quot;: { # Targeting details for proximity location list. This will be # Proximity location list details. This field will be populated when the
# TargetingType is
# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
&quot;proximityRadiusRange&quot;: &quot;A String&quot;, # Required. Radius range for proximity location list.
# This represents the size of the area around a chosen location that will be
# targeted.
#
# `All` proximity location targeting under a single line item must have the
# same radius range value. Set this value to match any existing targeting.
# If updated, this field will change the radius range for all proximity
# targeting under the line item.
&quot;proximityLocationListId&quot;: &quot;A String&quot;, # Required. ID of the proximity location list. Should refer to the
# location_list_id field of a
# LocationList resource whose type is
# `TARGETING_LOCATION_TYPE_PROXIMITY`.
},
&quot;ageRangeDetails&quot;: { # Represents a targetable age range. This will be populated in the details # Age range details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_AGE_RANGE`.
# field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_AGE_RANGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.
&quot;ageRange&quot;: &quot;A String&quot;, # Output only. The age range of an audience. We only support targeting a continuous age
# range of an audience. Thus, the age range represented in this field can be
# 1) targeted solely, or, 2) part of a larger continuous age range. The reach
# of a continuous age range targeting can be expanded by also targeting an
# audience of an unknown age.
},
&quot;subExchangeDetails&quot;: { # Details for assigned sub-exchange targeting option. This will be populated in # Sub-exchange details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_SUB_EXCHANGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
},
&quot;keywordDetails&quot;: { # Details for assigned keyword targeting option. This will be populated in the # 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.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_KEYWORD`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;keyword&quot;: &quot;A String&quot;, # Required. The keyword, for example `car insurance`.
#
# Positive keyword cannot be offensive word.
# Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number
# of characters is 80. Maximum number of words is 10.
},
&quot;deviceMakeModelDetails&quot;: { # Assigned device make and model targeting option details. This will be # Device make and model details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
# populated in the
# device_make_model_details
# field when
# targeting_type is
# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the device make and model.
},
&quot;digitalContentLabelExclusionDetails&quot;: { # Targeting details for digital content label. This will be # Digital content label details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
#
# Digital content labels are targeting exclusions. Advertiser level digital
# content label exclusions, if set, are always applied in serving (even
# though they aren&#x27;t visible in line item settings). Line item settings can
# exclude content labels in addition to advertiser exclusions, but can&#x27;t
# override them. A line item won&#x27;t serve if all the digital content labels
# are excluded.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
&quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the digital content label to be EXCLUDED.
&quot;contentRatingTier&quot;: &quot;A String&quot;, # Output only. The display name of the digital content label rating tier.
},
&quot;browserDetails&quot;: { # Details for assigned browser targeting option. This will be populated in # Browser details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_BROWSER`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_BROWSER`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_BROWSER`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the browser.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned browser
# targeting options on the same line item must have the same value for this
# field.
},
&quot;appCategoryDetails&quot;: { # Details for assigned app category targeting option. This will be # App category details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_APP_CATEGORY`.
# populated in the
# app_category_details field of
# an AssignedTargetingOption when
# targeting_type
# is `TARGETING_TYPE_APP_CATEGORY`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_APP_CATEGORY`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app category.
},
&quot;contentOutstreamPositionDetails&quot;: { # Assigned content outstream position targeting option details. This will be # Content outstream position details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
# populated in the
# content_outstream_position_details
# field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
&quot;contentOutstreamPosition&quot;: &quot;A String&quot;, # Output only. The content outstream position.
},
&quot;negativeKeywordListDetails&quot;: { # Targeting details for negative keyword list. This will be populated in the # 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.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.
&quot;negativeKeywordListId&quot;: &quot;A String&quot;, # Required. ID of the negative keyword list. Should refer to the
# negative_keyword_list_id
# field of a NegativeKeywordList resource.
},
&quot;genderDetails&quot;: { # Details for assigned gender targeting option. This will be populated in # Gender details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_GENDER`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARTGETING_TYPE_GENDER`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_GENDER`.
&quot;gender&quot;: &quot;A String&quot;, # Output only. The gender of the audience.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this assigned targeting option.
&quot;inventorySourceDetails&quot;: { # Targeting details for inventory source. This will be # Inventory source details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_INVENTORY_SOURCE`.
&quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. ID of the inventory source. Should refer to the
# inventory_source_id field of an
# InventorySource resource.
},
&quot;sensitiveCategoryExclusionDetails&quot;: { # Targeting details for sensitive category. This will be populated in the # Sensitive category details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
#
# Sensitive categories are targeting exclusions. Advertiser level sensitive
# category exclusions, if set, are always applied in serving (even though
# they aren&#x27;t visible in line item settings). Line item settings can
# exclude sensitive categories in addition to advertiser exclusions, but
# can&#x27;t override them.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
&quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the sensitive category to be EXCLUDED.
&quot;sensitiveCategory&quot;: &quot;A String&quot;, # Output only. An enum for the DV360 Sensitive category content classifier.
},
&quot;audienceGroupDetails&quot;: { # Assigned audience group targeting option details. This will be populated in # 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.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_AUDIENCE_GROUP`.
# The relation between each group is UNION, except for
# excluded_first_and_third_party_audience_group and
# excluded_google_audience_group, of which COMPLEMENT is UNION&#x27;ed with other
# groups.
&quot;includedFirstAndThirdPartyAudienceGroups&quot;: [ # The first and third party audience ids and recencies of included first
# and third party audience groups. Each first and third party audience group
# contains first and third party audience ids only.
# The relation between each first and third party audience group is
# INTERSECTION, and the result is UNION&#x27;ed with other audience groups.
# Repeated groups with same settings will be ignored.
{ # Details of first and third party audience group.
# All first and third party audience targeting settings are logically ‘OR’ of
# each other.
&quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and
# third party audience group.
# Repeated settings with same id are not allowed.
{ # Details of first and third party audience targeting setting.
&quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting.
# Only applicable to first party audiences, otherwise
# will be ignored. For more info, refer to
# https://support.google.com/displayvideo/answer/2949947#recency
# When unspecified, no recency limit will be used.
&quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience
# targeting setting. This id is
# first_and_third_party_audience_id.
},
],
},
],
&quot;includedCombinedAudienceGroup&quot;: { # Details of combined audience group. # The combined audience ids of the included combined audience group.
# Contains combined audience ids only.
# All combined audience targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All combined audience targeting settings in combined audience group.
# Repeated settings with same id will be ignored.
# The number of combined audience settings should be no more than five, error
# will be thrown otherwise.
{ # Details of combined audience targeting setting.
&quot;combinedAudienceId&quot;: &quot;A String&quot;, # Required. Combined audience id of combined audience targeting setting.
# This id is combined_audience_id.
},
],
},
&quot;includedCustomListGroup&quot;: { # Details of custom list group. # The custom list ids of the included custom list group.
# Contains custom list ids only.
# All custom list targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All custom list targeting settings in custom list group.
# Repeated settings with same id will be ignored.
{ # Details of custom list targeting setting.
&quot;customListId&quot;: &quot;A String&quot;, # Required. Custom id of custom list targeting setting.
# This id is custom_list_id.
},
],
},
&quot;excludedFirstAndThirdPartyAudienceGroup&quot;: { # Details of first and third party audience group. # 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.
# All first and third party audience targeting settings are logically ‘OR’ of
# each other.
&quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and
# third party audience group.
# Repeated settings with same id are not allowed.
{ # Details of first and third party audience targeting setting.
&quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting.
# Only applicable to first party audiences, otherwise
# will be ignored. For more info, refer to
# https://support.google.com/displayvideo/answer/2949947#recency
# When unspecified, no recency limit will be used.
&quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience
# targeting setting. This id is
# first_and_third_party_audience_id.
},
],
},
&quot;includedGoogleAudienceGroup&quot;: { # Details of Google audience group. # The Google audience ids of the included Google audience group.
# Contains Google audience ids only.
# All Google audience targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group.
# Repeated settings with same id will be ignored.
{ # Details of Google audience targeting setting.
&quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting.
# This id is google_audience_id.
},
],
},
&quot;excludedGoogleAudienceGroup&quot;: { # Details of Google audience group. # The Google audience ids of the excluded Google audience group.
# Used for negative targeting. It&#x27;s COMPLEMENT is used to UNION other
# audience groups.
# Only contains Affinity, In-market and Installed-apps type Google audiences.
# All items are logically ‘OR’ of each other.
# All Google audience targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group.
# Repeated settings with same id will be ignored.
{ # Details of Google audience targeting setting.
&quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting.
# This id is google_audience_id.
},
],
},
},
&quot;userRewardedContentDetails&quot;: { # User rewarded content targeting option details. This will be populated in # User rewarded content details. This field will be populated when the
# TargetingType is
# `TARGETING_TYPE_USER_REWARDED_CONTENT`.
# the
# user_rewarded_content_details
# field when
# targeting_type is
# `TARGETING_TYPE_USER_REWARDED_CONTENT`.
&quot;userRewardedContent&quot;: &quot;A String&quot;, # Output only. User rewarded content status for video ads.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_USER_REWARDED_CONTENT`.
},
&quot;languageDetails&quot;: { # Details for assigned language targeting option. This will be populated in the # Language details. This field will be populated when the TargetingType is
# `TARGETING_TYPE_LANGUAGE`.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_LANGUAGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the language (e.g., &quot;French&quot;).
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned
# language targeting options on the same line item must have the same value
# for this field.
},
&quot;authorizedSellerStatusDetails&quot;: { # Represents an assigned authorized seller status. This will be populated in # Authorized seller status details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
#
# You can only target one authorized seller status option per line item.
#
# If a line item doesn&#x27;t have an authorized seller status option, all
# authorized sellers indicated as DIRECT or RESELLER in the ads.txt file
# are targeted by default.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
&quot;authorizedSellerStatus&quot;: &quot;A String&quot;, # Output only. The authorized seller status to target.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
},
&quot;dayAndTimeDetails&quot;: { # Representation of a segment of time defined on a specific day of the week and # Day and time details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_DAY_AND_TIME`.
# with a start and end time.
# The time represented by `start_hour` must be before the time represented by
# `end_hour`.
&quot;dayOfWeek&quot;: &quot;A String&quot;, # Required. The day of the week for this day and time targeting setting.
&quot;startHour&quot;: 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day)
# and 23 (1 hour before end of day).
&quot;endHour&quot;: 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after
# start of day) and 24 (end of day).
&quot;timeZoneResolution&quot;: &quot;A String&quot;, # Required. The mechanism used to determine which timezone to use for this day and time
# targeting setting.
},
&quot;inheritance&quot;: &quot;A String&quot;, # Output only. The inheritance status of the assigned targeting option.
&quot;environmentDetails&quot;: { # Assigned environment targeting option details. This will be populated # Environment details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_ENVIRONMENT`.
# in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_ENVIRONMENT`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., &quot;508010&quot;
# for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).
&quot;environment&quot;: &quot;A String&quot;, # Output only. The serving environment.
},
&quot;geoRegionDetails&quot;: { # Details for assigned geographic region targeting option. This will be # Geographic region details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_GEO_REGION`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_GEO_REGION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region (e.g., &quot;Ontario, Canada&quot;).
&quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of geographic region targeting.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;deviceTypeDetails&quot;: { # Targeting details for device type. This will be # Device Type details. This field will be populated when the
# TargetingType is
# `TARGETING_TYPE_DEVICE_TYPE`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_DEVICE_TYPE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the device type.
&quot;deviceType&quot;: &quot;A String&quot;, # Output only. The display name of the device type.
},
&quot;exchangeDetails&quot;: { # Details for assigned exchange targeting option. This will be populated in # Exchange details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_EXCHANGE`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_EXCHANGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_EXCHANGE`.
},
&quot;assignedTargetingOptionId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned targeting option. The ID is only unique
# within a given line item and targeting type. It may be reused in other
# contexts.
&quot;householdIncomeDetails&quot;: { # Details for assigned household income targeting option. This will be # Household income details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_HOUSEHOLD_INCOME`.
&quot;householdIncome&quot;: &quot;A String&quot;, # Output only. The household income of the audience.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.
},
&quot;contentInstreamPositionDetails&quot;: { # Assigned content instream position targeting option details. This will be # Content instream position details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
# populated in the
# content_instream_position_details
# field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
&quot;contentInstreamPosition&quot;: &quot;A String&quot;, # Output only. The content instream position for video or audio ads.
},
&quot;categoryDetails&quot;: { # Assigned category targeting option details. This will be populated in the # 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.
# category_details field when
# targeting_type is
# `TARGETING_TYPE_CATEGORY`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_CATEGORY`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the category.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;inventorySourceGroupDetails&quot;: { # Targeting details for inventory source group. This will be # Inventory source group details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
&quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Required. ID of the inventory source group. Should refer to the
# inventory_source_group_id
# field of an InventorySourceGroup resource.
},
&quot;regionalLocationListDetails&quot;: { # Targeting details for regional location list. This will be # Regional location list details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
&quot;regionalLocationListId&quot;: &quot;A String&quot;, # Required. ID of the regional location list. Should refer to the
# location_list_id field of a
# LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;carrierAndIspDetails&quot;: { # Details for assigned carrier and ISP targeting option. This will be populated # Carrier and ISP details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`.
# in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_CARRIER_AND_ISP`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned carrier
# and ISP targeting options on the same line item must have the same value
# for this field.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the carrier or ISP.
},
&quot;viewabilityDetails&quot;: { # Assigned viewability targeting option details. This will be populated in the # Viewability details. This field will be populated when the TargetingType
# is `TARGETING_TYPE_VIEWABILITY`.
#
# You can only target one viewability option per line item.
# viewability_details field of
# an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_VIEWABILITY`.
&quot;viewability&quot;: &quot;A String&quot;, # Output only. The predicted viewability percentage.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., &quot;509010&quot;
# for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="bulkListLineItemAssignedTargetingOptions">bulkListLineItemAssignedTargetingOptions(advertiserId, lineItemId, filter=None, pageToken=None, pageSize=None, orderBy=None, x__xgafv=None)</code>
<pre>Lists assigned targeting options of a line item across targeting types.
Args:
advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)
lineItemId: string, Required. The ID of the line item to list assigned targeting options for. (required)
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=&quot;TARGETING_TYPE_PROXIMITY_LOCATION_LIST&quot; OR
targetingType=&quot;TARGETING_TYPE_CHANNEL&quot;`
* AssignedTargetingOptions with inheritance status of NOT_INHERITED or
INHERITED_FROM_PARTNER
`inheritance=&quot;NOT_INHERITED&quot; OR inheritance=&quot;INHERITED_FROM_PARTNER&quot;`
The length of this field should be no more than 500 characters.
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.
pageSize: integer, Requested page size.
The size must be an integer between `1` and `5000`. If unspecified,
the default is &#x27;5000&#x27;. Returns error code `INVALID_ARGUMENT` if an invalid
value is specified.
orderBy: string, Field by which to sort the list.
Acceptable values are:
* `targetingType` (default)
The default sorting order is ascending. To specify descending order for
a field, a suffix &quot;desc&quot; should be added to the field name. Example:
`targetingType desc`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying the next page of results. This value should be
# specified as the
# pageToken in
# a subsequent BulkListLineItemAssignedTargetingOptionsRequest to fetch
# the next page of results. This token will be absent if there are no more
# assigned_targeting_options
# to return.
&quot;assignedTargetingOptions&quot;: [ # The list of assigned targeting options.
#
# This list will be absent if empty.
{ # A single assigned targeting option, which defines the state of a targeting
# option for an entity with targeting settings, such as a Line Item or
# Insertion Order.
&quot;appDetails&quot;: { # Details for assigned app targeting option. This will be populated in the # App details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_APP`.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_APP`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app.
&quot;appId&quot;: &quot;A String&quot;, # Required. The ID of the app.
#
# Android&#x27;s Play store app uses bundle ID, for example
# `com.google.android.gm`. Apple&#x27;s App store app ID uses 9 digit string, for
# example `422689480`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;parentalStatusDetails&quot;: { # Details for assigned parental status targeting option. This will be # Parental status details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARTGETING_TYPE_PARENTAL_STATUS`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.
&quot;parentalStatus&quot;: &quot;A String&quot;, # Output only. The parental status of the audience.
},
&quot;targetingType&quot;: &quot;A String&quot;, # Output only. Identifies the type of this assigned targeting option.
&quot;urlDetails&quot;: { # Details for assigned URL targeting option. This will be populated in the # URL details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_URL`.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_URL`.
&quot;url&quot;: &quot;A String&quot;, # Required. The URL, for example `example.com`.
#
# DV360 supports two levels of subdirectory targeting, for example
# `www.example.com/one-subdirectory-level/second-level`, and five levels of
# subdomain targeting, for example `five.four.three.two.one.example.com`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;onScreenPositionDetails&quot;: { # On screen position targeting option details. This will be # On screen position details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`.
# populated in the
# on_screen_position_details
# field when
# targeting_type is
# `TARGETING_TYPE_ON_SCREEN_POSITION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_ON_SCREEN_POSITION`.
&quot;onScreenPosition&quot;: &quot;A String&quot;, # Output only. The on screen position.
},
&quot;videoPlayerSizeDetails&quot;: { # Video player size targeting option details. This will be populated in the # Video player size details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
# 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.
&quot;videoPlayerSize&quot;: &quot;A String&quot;, # Output only. The video player size.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
},
&quot;channelDetails&quot;: { # Details for assigned channel targeting option. This will be populated in # Channel details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CHANNEL`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_CHANNEL`.
&quot;channelId&quot;: &quot;A String&quot;, # Required. ID of the channel. Should refer to the channel ID
# field on a
# [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or
# [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id)
# resource.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. For advertiser
# level assigned targeting option, this field must be true.
},
&quot;operatingSystemDetails&quot;: { # Assigned operating system targeting option details. This will be # Operating system details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`.
# populated in the
# operating_system_details
# field when
# targeting_type is
# `TARGETING_TYPE_OPERATING_SYSTEM`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the operating system.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting option ID populated in
# targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_OPERATING_SYSTEM`.
},
&quot;thirdPartyVerifierDetails&quot;: { # Assigned third party verifier targeting option details. This will be # Third party verification details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
&quot;integralAdScience&quot;: { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
&quot;excludedAdFraudRisk&quot;: &quot;A String&quot;, # Ad Fraud settings.
&quot;displayViewability&quot;: &quot;A String&quot;, # Display Viewability section (applicable to display line items only).
&quot;excludedHateSpeechRisk&quot;: &quot;A String&quot;, # Brand Safety - **Hate speech**.
&quot;excludedOffensiveLanguageRisk&quot;: &quot;A String&quot;, # Brand Safety - **Offensive language**.
&quot;excludedDrugsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Drugs**.
&quot;excludedAdultRisk&quot;: &quot;A String&quot;, # Brand Safety - **Adult content**.
&quot;traqScoreOption&quot;: &quot;A String&quot;, # True advertising quality (applicable to Display line items only).
&quot;videoViewability&quot;: &quot;A String&quot;, # Video Viewability Section (applicable to video line items only).
&quot;excludedAlcoholRisk&quot;: &quot;A String&quot;, # Brand Safety - **Alcohol**.
&quot;excludedGamblingRisk&quot;: &quot;A String&quot;, # Brand Safety - **Gambling**.
&quot;excludeUnrateable&quot;: True or False, # Brand Safety - **Unrateable**.
&quot;excludedIllegalDownloadsRisk&quot;: &quot;A String&quot;, # Brand Safety - **Illegal downloads**.
&quot;excludedViolenceRisk&quot;: &quot;A String&quot;, # Brand Safety - **Violence**.
},
&quot;doubleVerify&quot;: { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
&quot;videoViewability&quot;: { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
&quot;playerImpressionRate&quot;: &quot;A String&quot;, # Target inventory to maximize impressions with 400x300 or greater player
# size.
&quot;videoIab&quot;: &quot;A String&quot;, # Target web inventory to maximize IAB viewable rate.
&quot;videoViewableRate&quot;: &quot;A String&quot;, # Target web inventory to maximize fully viewable rate.
},
&quot;avoidedAgeRatings&quot;: [ # Avoid bidding on apps with the age rating.
&quot;A String&quot;,
],
&quot;fraudInvalidTraffic&quot;: { # DoubleVerify Fraud &amp; Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud &amp; IVT Rates.
&quot;avoidInsufficientOption&quot;: True or False, # Insufficient Historical Fraud &amp; IVT Stats.
&quot;avoidedFraudOption&quot;: &quot;A String&quot;, # Avoid Sites and Apps with historical Fraud &amp; IVT.
},
&quot;brandSafetyCategories&quot;: { # Settings for brand safety controls. # DV Brand Safety Controls.
&quot;avoidedMediumSeverityCategories&quot;: [ # Brand safety medium severity avoidance categories.
&quot;A String&quot;,
],
&quot;avoidedHighSeverityCategories&quot;: [ # Brand safety high severity avoidance categories.
&quot;A String&quot;,
],
&quot;avoidUnknownBrandSafetyCategory&quot;: True or False, # Unknown or unrateable.
},
&quot;appStarRating&quot;: { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
&quot;avoidedStarRating&quot;: &quot;A String&quot;, # Avoid bidding on apps with the star ratings.
&quot;avoidInsufficientStarRating&quot;: True or False, # Avoid bidding on apps with insufficient star ratings.
},
&quot;displayViewability&quot;: { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
&quot;viewableDuring&quot;: &quot;A String&quot;, # Target web and app inventory to maximize 100% viewable duration.
&quot;iab&quot;: &quot;A String&quot;, # Target web and app inventory to maximize IAB viewable rate.
},
},
&quot;adloox&quot;: { # Details of Adloox settings. # Third party brand verifier -- Adloox.
&quot;excludedAdlooxCategories&quot;: [ # Adloox&#x27;s brand safety settings.
&quot;A String&quot;,
],
},
},
&quot;proximityLocationListDetails&quot;: { # Targeting details for proximity location list. This will be # Proximity location list details. This field will be populated when the
# TargetingType is
# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
&quot;proximityRadiusRange&quot;: &quot;A String&quot;, # Required. Radius range for proximity location list.
# This represents the size of the area around a chosen location that will be
# targeted.
#
# `All` proximity location targeting under a single line item must have the
# same radius range value. Set this value to match any existing targeting.
# If updated, this field will change the radius range for all proximity
# targeting under the line item.
&quot;proximityLocationListId&quot;: &quot;A String&quot;, # Required. ID of the proximity location list. Should refer to the
# location_list_id field of a
# LocationList resource whose type is
# `TARGETING_LOCATION_TYPE_PROXIMITY`.
},
&quot;ageRangeDetails&quot;: { # Represents a targetable age range. This will be populated in the details # Age range details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_AGE_RANGE`.
# field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_AGE_RANGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_AGE_RANGE`.
&quot;ageRange&quot;: &quot;A String&quot;, # Output only. The age range of an audience. We only support targeting a continuous age
# range of an audience. Thus, the age range represented in this field can be
# 1) targeted solely, or, 2) part of a larger continuous age range. The reach
# of a continuous age range targeting can be expanded by also targeting an
# audience of an unknown age.
},
&quot;subExchangeDetails&quot;: { # Details for assigned sub-exchange targeting option. This will be populated in # Sub-exchange details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_SUB_EXCHANGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
},
&quot;keywordDetails&quot;: { # Details for assigned keyword targeting option. This will be populated in the # 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.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_KEYWORD`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;keyword&quot;: &quot;A String&quot;, # Required. The keyword, for example `car insurance`.
#
# Positive keyword cannot be offensive word.
# Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number
# of characters is 80. Maximum number of words is 10.
},
&quot;deviceMakeModelDetails&quot;: { # Assigned device make and model targeting option details. This will be # Device make and model details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
# populated in the
# device_make_model_details
# field when
# targeting_type is
# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the device make and model.
},
&quot;digitalContentLabelExclusionDetails&quot;: { # Targeting details for digital content label. This will be # Digital content label details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
#
# Digital content labels are targeting exclusions. Advertiser level digital
# content label exclusions, if set, are always applied in serving (even
# though they aren&#x27;t visible in line item settings). Line item settings can
# exclude content labels in addition to advertiser exclusions, but can&#x27;t
# override them. A line item won&#x27;t serve if all the digital content labels
# are excluded.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
&quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the digital content label to be EXCLUDED.
&quot;contentRatingTier&quot;: &quot;A String&quot;, # Output only. The display name of the digital content label rating tier.
},
&quot;browserDetails&quot;: { # Details for assigned browser targeting option. This will be populated in # Browser details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_BROWSER`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_BROWSER`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_BROWSER`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the browser.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned browser
# targeting options on the same line item must have the same value for this
# field.
},
&quot;appCategoryDetails&quot;: { # Details for assigned app category targeting option. This will be # App category details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_APP_CATEGORY`.
# populated in the
# app_category_details field of
# an AssignedTargetingOption when
# targeting_type
# is `TARGETING_TYPE_APP_CATEGORY`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_APP_CATEGORY`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the app category.
},
&quot;contentOutstreamPositionDetails&quot;: { # Assigned content outstream position targeting option details. This will be # Content outstream position details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
# populated in the
# content_outstream_position_details
# field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
&quot;contentOutstreamPosition&quot;: &quot;A String&quot;, # Output only. The content outstream position.
},
&quot;negativeKeywordListDetails&quot;: { # Targeting details for negative keyword list. This will be populated in the # 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.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.
&quot;negativeKeywordListId&quot;: &quot;A String&quot;, # Required. ID of the negative keyword list. Should refer to the
# negative_keyword_list_id
# field of a NegativeKeywordList resource.
},
&quot;genderDetails&quot;: { # Details for assigned gender targeting option. This will be populated in # Gender details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_GENDER`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARTGETING_TYPE_GENDER`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_GENDER`.
&quot;gender&quot;: &quot;A String&quot;, # Output only. The gender of the audience.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this assigned targeting option.
&quot;inventorySourceDetails&quot;: { # Targeting details for inventory source. This will be # Inventory source details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_INVENTORY_SOURCE`.
&quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. ID of the inventory source. Should refer to the
# inventory_source_id field of an
# InventorySource resource.
},
&quot;sensitiveCategoryExclusionDetails&quot;: { # Targeting details for sensitive category. This will be populated in the # Sensitive category details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
#
# Sensitive categories are targeting exclusions. Advertiser level sensitive
# category exclusions, if set, are always applied in serving (even though
# they aren&#x27;t visible in line item settings). Line item settings can
# exclude sensitive categories in addition to advertiser exclusions, but
# can&#x27;t override them.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
&quot;excludedTargetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the sensitive category to be EXCLUDED.
&quot;sensitiveCategory&quot;: &quot;A String&quot;, # Output only. An enum for the DV360 Sensitive category content classifier.
},
&quot;audienceGroupDetails&quot;: { # Assigned audience group targeting option details. This will be populated in # 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.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_AUDIENCE_GROUP`.
# The relation between each group is UNION, except for
# excluded_first_and_third_party_audience_group and
# excluded_google_audience_group, of which COMPLEMENT is UNION&#x27;ed with other
# groups.
&quot;includedFirstAndThirdPartyAudienceGroups&quot;: [ # The first and third party audience ids and recencies of included first
# and third party audience groups. Each first and third party audience group
# contains first and third party audience ids only.
# The relation between each first and third party audience group is
# INTERSECTION, and the result is UNION&#x27;ed with other audience groups.
# Repeated groups with same settings will be ignored.
{ # Details of first and third party audience group.
# All first and third party audience targeting settings are logically ‘OR’ of
# each other.
&quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and
# third party audience group.
# Repeated settings with same id are not allowed.
{ # Details of first and third party audience targeting setting.
&quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting.
# Only applicable to first party audiences, otherwise
# will be ignored. For more info, refer to
# https://support.google.com/displayvideo/answer/2949947#recency
# When unspecified, no recency limit will be used.
&quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience
# targeting setting. This id is
# first_and_third_party_audience_id.
},
],
},
],
&quot;includedCombinedAudienceGroup&quot;: { # Details of combined audience group. # The combined audience ids of the included combined audience group.
# Contains combined audience ids only.
# All combined audience targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All combined audience targeting settings in combined audience group.
# Repeated settings with same id will be ignored.
# The number of combined audience settings should be no more than five, error
# will be thrown otherwise.
{ # Details of combined audience targeting setting.
&quot;combinedAudienceId&quot;: &quot;A String&quot;, # Required. Combined audience id of combined audience targeting setting.
# This id is combined_audience_id.
},
],
},
&quot;includedCustomListGroup&quot;: { # Details of custom list group. # The custom list ids of the included custom list group.
# Contains custom list ids only.
# All custom list targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All custom list targeting settings in custom list group.
# Repeated settings with same id will be ignored.
{ # Details of custom list targeting setting.
&quot;customListId&quot;: &quot;A String&quot;, # Required. Custom id of custom list targeting setting.
# This id is custom_list_id.
},
],
},
&quot;excludedFirstAndThirdPartyAudienceGroup&quot;: { # Details of first and third party audience group. # 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.
# All first and third party audience targeting settings are logically ‘OR’ of
# each other.
&quot;settings&quot;: [ # Required. All first and third party audience targeting settings in first and
# third party audience group.
# Repeated settings with same id are not allowed.
{ # Details of first and third party audience targeting setting.
&quot;recency&quot;: &quot;A String&quot;, # The recency of the first and third party audience targeting setting.
# Only applicable to first party audiences, otherwise
# will be ignored. For more info, refer to
# https://support.google.com/displayvideo/answer/2949947#recency
# When unspecified, no recency limit will be used.
&quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. First and third party audience id of the first and third party audience
# targeting setting. This id is
# first_and_third_party_audience_id.
},
],
},
&quot;includedGoogleAudienceGroup&quot;: { # Details of Google audience group. # The Google audience ids of the included Google audience group.
# Contains Google audience ids only.
# All Google audience targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group.
# Repeated settings with same id will be ignored.
{ # Details of Google audience targeting setting.
&quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting.
# This id is google_audience_id.
},
],
},
&quot;excludedGoogleAudienceGroup&quot;: { # Details of Google audience group. # The Google audience ids of the excluded Google audience group.
# Used for negative targeting. It&#x27;s COMPLEMENT is used to UNION other
# audience groups.
# Only contains Affinity, In-market and Installed-apps type Google audiences.
# All items are logically ‘OR’ of each other.
# All Google audience targeting settings are logically ‘OR’ of each other.
&quot;settings&quot;: [ # Required. All Google audience targeting settings in Google audience group.
# Repeated settings with same id will be ignored.
{ # Details of Google audience targeting setting.
&quot;googleAudienceId&quot;: &quot;A String&quot;, # Required. Google audience id of the Google audience targeting setting.
# This id is google_audience_id.
},
],
},
},
&quot;userRewardedContentDetails&quot;: { # User rewarded content targeting option details. This will be populated in # User rewarded content details. This field will be populated when the
# TargetingType is
# `TARGETING_TYPE_USER_REWARDED_CONTENT`.
# the
# user_rewarded_content_details
# field when
# targeting_type is
# `TARGETING_TYPE_USER_REWARDED_CONTENT`.
&quot;userRewardedContent&quot;: &quot;A String&quot;, # Output only. User rewarded content status for video ads.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_USER_REWARDED_CONTENT`.
},
&quot;languageDetails&quot;: { # Details for assigned language targeting option. This will be populated in the # Language details. This field will be populated when the TargetingType is
# `TARGETING_TYPE_LANGUAGE`.
# details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_LANGUAGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the language (e.g., &quot;French&quot;).
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned
# language targeting options on the same line item must have the same value
# for this field.
},
&quot;authorizedSellerStatusDetails&quot;: { # Represents an assigned authorized seller status. This will be populated in # Authorized seller status details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
#
# You can only target one authorized seller status option per line item.
#
# If a line item doesn&#x27;t have an authorized seller status option, all
# authorized sellers indicated as DIRECT or RESELLER in the ads.txt file
# are targeted by default.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
&quot;authorizedSellerStatus&quot;: &quot;A String&quot;, # Output only. The authorized seller status to target.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
},
&quot;dayAndTimeDetails&quot;: { # Representation of a segment of time defined on a specific day of the week and # Day and time details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_DAY_AND_TIME`.
# with a start and end time.
# The time represented by `start_hour` must be before the time represented by
# `end_hour`.
&quot;dayOfWeek&quot;: &quot;A String&quot;, # Required. The day of the week for this day and time targeting setting.
&quot;startHour&quot;: 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day)
# and 23 (1 hour before end of day).
&quot;endHour&quot;: 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after
# start of day) and 24 (end of day).
&quot;timeZoneResolution&quot;: &quot;A String&quot;, # Required. The mechanism used to determine which timezone to use for this day and time
# targeting setting.
},
&quot;inheritance&quot;: &quot;A String&quot;, # Output only. The inheritance status of the assigned targeting option.
&quot;environmentDetails&quot;: { # Assigned environment targeting option details. This will be populated # Environment details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_ENVIRONMENT`.
# in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_ENVIRONMENT`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., &quot;508010&quot;
# for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).
&quot;environment&quot;: &quot;A String&quot;, # Output only. The serving environment.
},
&quot;geoRegionDetails&quot;: { # Details for assigned geographic region targeting option. This will be # Geographic region details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_GEO_REGION`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_GEO_REGION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the geographic region (e.g., &quot;Ontario, Canada&quot;).
&quot;geoRegionType&quot;: &quot;A String&quot;, # Output only. The type of geographic region targeting.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;deviceTypeDetails&quot;: { # Targeting details for device type. This will be # Device Type details. This field will be populated when the
# TargetingType is
# `TARGETING_TYPE_DEVICE_TYPE`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_DEVICE_TYPE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. ID of the device type.
&quot;deviceType&quot;: &quot;A String&quot;, # Output only. The display name of the device type.
},
&quot;exchangeDetails&quot;: { # Details for assigned exchange targeting option. This will be populated in # Exchange details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_EXCHANGE`.
# the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_EXCHANGE`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_EXCHANGE`.
},
&quot;assignedTargetingOptionId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned targeting option. The ID is only unique
# within a given line item and targeting type. It may be reused in other
# contexts.
&quot;householdIncomeDetails&quot;: { # Details for assigned household income targeting option. This will be # Household income details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_HOUSEHOLD_INCOME`.
&quot;householdIncome&quot;: &quot;A String&quot;, # Output only. The household income of the audience.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.
},
&quot;contentInstreamPositionDetails&quot;: { # Assigned content instream position targeting option details. This will be # Content instream position details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
# populated in the
# content_instream_position_details
# field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
&quot;contentInstreamPosition&quot;: &quot;A String&quot;, # Output only. The content instream position for video or audio ads.
},
&quot;categoryDetails&quot;: { # Assigned category targeting option details. This will be populated in the # 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.
# category_details field when
# targeting_type is
# `TARGETING_TYPE_CATEGORY`.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id field when
# targeting_type is
# `TARGETING_TYPE_CATEGORY`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the category.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;inventorySourceGroupDetails&quot;: { # Targeting details for inventory source group. This will be # Inventory source group details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
&quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Required. ID of the inventory source group. Should refer to the
# inventory_source_group_id
# field of an InventorySourceGroup resource.
},
&quot;regionalLocationListDetails&quot;: { # Targeting details for regional location list. This will be # Regional location list details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
# populated in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
&quot;regionalLocationListId&quot;: &quot;A String&quot;, # Required. ID of the regional location list. Should refer to the
# location_list_id field of a
# LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
},
&quot;carrierAndIspDetails&quot;: { # Details for assigned carrier and ISP targeting option. This will be populated # Carrier and ISP details. This field will be populated when the
# TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`.
# in the details field of an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_CARRIER_AND_ISP`.
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted. All assigned carrier
# and ISP targeting options on the same line item must have the same value
# for this field.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the carrier or ISP.
},
&quot;viewabilityDetails&quot;: { # Assigned viewability targeting option details. This will be populated in the # Viewability details. This field will be populated when the TargetingType
# is `TARGETING_TYPE_VIEWABILITY`.
#
# You can only target one viewability option per line item.
# viewability_details field of
# an AssignedTargetingOption when
# targeting_type is
# `TARGETING_TYPE_VIEWABILITY`.
&quot;viewability&quot;: &quot;A String&quot;, # Output only. The predicted viewability percentage.
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a
# TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., &quot;509010&quot;
# for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="bulkListLineItemAssignedTargetingOptions_next">bulkListLineItemAssignedTargetingOptions_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code>
<pre>Creates a new line item.
Returns the newly created line item if successful.
Args:
advertiserId: string, Output only. The unique ID of the advertiser the line item belongs to. (required)
body: object, The request body.
The object takes the form of:
{ # A single line item.
&quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the line item.
# ad during a given time period.
&quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to
# `true`, the remaining frequency cap fields are not applicable.
&quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad
# during this period. Must be greater than 0.
#
# Applicable when unlimited is `false`.
&quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
&quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will
# last.
#
# Applicable when unlimited is `false`.
# The following restrictions apply based on the value of
# time_unit:
#
# * `TIME_UNIT_LIFETIME` - this field is output only and will
# default to 1
# * `TIME_UNIT_MONTHS` - must be between 1 and 2
# * `TIME_UNIT_WEEKS` - must be between 1 and 4
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
},
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the line item.
#
# Must be UTF-8 encoded with a maximum size of 240 bytes.
&quot;partnerCosts&quot;: [ # 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.
{ # 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.
&quot;feeAmount&quot;: &quot;A String&quot;, # The CPM fee amount in micros of advertiser&#x27;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&#x27;s currency, set
# this field to 1500000.
&quot;costType&quot;: &quot;A String&quot;, # Required. The type of the partner cost.
&quot;feeType&quot;: &quot;A String&quot;, # Required. The fee type for this partner cost.
&quot;feePercentageMillis&quot;: &quot;A String&quot;, # 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%.
&quot;invoiceType&quot;: &quot;A String&quot;, # 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.
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the line item was last updated. Assigned by the system.
&quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the line item belongs to.
&quot;budget&quot;: { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
&quot;budgetAllocationType&quot;: &quot;A String&quot;, # 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.
&quot;budgetUnit&quot;: &quot;A String&quot;, # Output only. The budget unit specifies whether the budget is currency based
# or impression based. This value is inherited from the parent insertion
# order.
&quot;maxAmount&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;flight&quot;: { # Settings that control the active duration of a line item. # Required. The start and end time of the line item&#x27;s flight.
&quot;flightDateType&quot;: &quot;A String&quot;, # Required. The type of the line item&#x27;s flight dates.
&quot;dateRange&quot;: { # A date range. # The flight start and end dates of the line item. They are resolved
# relative to the parent advertiser&#x27;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.
&quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
&quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
},
&quot;inventorySourceIds&quot;: [ # The IDs of the private inventory sources assigned to the line item.
&quot;A String&quot;,
],
&quot;partnerRevenueModel&quot;: { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
&quot;markupType&quot;: &quot;A String&quot;, # Required. The markup type of the partner revenue model.
&quot;markupAmount&quot;: &quot;A String&quot;, # 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&#x27;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).
},
&quot;lineItemType&quot;: &quot;A String&quot;, # Required. Immutable. The type of the line item.
&quot;entityStatus&quot;: &quot;A String&quot;, # 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&#x27;s parent insertion order is not active, the line item
# can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
&quot;pacing&quot;: { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
&quot;pacingPeriod&quot;: &quot;A String&quot;, # 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`.
&quot;pacingType&quot;: &quot;A String&quot;, # Required. The type of pacing that defines how the budget amount will be
# spent across the pacing_period.
&quot;dailyMaxImpressions&quot;: &quot;A String&quot;, # Maximum number of impressions to serve every day.
#
# Applicable when the budget is impression based. Must be greater than 0.
&quot;dailyMaxMicros&quot;: &quot;A String&quot;, # Maximum currency amount to spend every day in micros of
# advertiser&#x27;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&#x27;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.
},
&quot;lineItemId&quot;: &quot;A String&quot;, # Output only. The unique ID of the line item. Assigned by the system.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the line item.
&quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign that the line item belongs to.
&quot;insertionOrderId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
&quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the line item.
&quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
#
# Must be UTF-8 encoded with a length of no more than 1000 characters.
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
# The integration code will show up together with the entry in many
# places in the system, for example, reporting.
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;creativeIds&quot;: [ # The IDs of the creatives associated with the line item.
&quot;A String&quot;,
],
&quot;conversionCounting&quot;: { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.
#
# All post-click conversions will be counted. A percentage value can be set
# for post-view conversions counting.
&quot;floodlightActivityConfigs&quot;: [ # 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.
{ # Settings that control the behavior of a single Floodlight activity config.
&quot;floodlightActivityId&quot;: &quot;A String&quot;, # Required. The ID of the Floodlight activity.
&quot;postClickLookbackWindowDays&quot;: 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.
&quot;postViewLookbackWindowDays&quot;: 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.
},
],
&quot;postViewCountPercentageMillis&quot;: &quot;A String&quot;, # 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.
},
&quot;bidStrategy&quot;: { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.
# Bid strategy determines the bid price.
&quot;fixedBid&quot;: { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
&quot;bidAmountMicros&quot;: &quot;A String&quot;, # The fixed bid amount, in micros of the advertiser&#x27;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.
},
&quot;maximizeSpendAutoBid&quot;: { # A strategy that automatically adjusts the bid to optimize a specified # 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`.
# performance goal while spending the full budget.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
},
&quot;performanceGoalAutoBid&quot;: { # A strategy that automatically adjusts the bid to meet or beat a specified # 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.
# performance goal.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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`.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
&quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # Required. The performance goal the bidding strategy will attempt to
# meet or beat, in micros of the advertiser&#x27;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.
#
# 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.
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single line item.
&quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the line item.
# ad during a given time period.
&quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to
# `true`, the remaining frequency cap fields are not applicable.
&quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad
# during this period. Must be greater than 0.
#
# Applicable when unlimited is `false`.
&quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
&quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will
# last.
#
# Applicable when unlimited is `false`.
# The following restrictions apply based on the value of
# time_unit:
#
# * `TIME_UNIT_LIFETIME` - this field is output only and will
# default to 1
# * `TIME_UNIT_MONTHS` - must be between 1 and 2
# * `TIME_UNIT_WEEKS` - must be between 1 and 4
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
},
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the line item.
#
# Must be UTF-8 encoded with a maximum size of 240 bytes.
&quot;partnerCosts&quot;: [ # 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.
{ # 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.
&quot;feeAmount&quot;: &quot;A String&quot;, # The CPM fee amount in micros of advertiser&#x27;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&#x27;s currency, set
# this field to 1500000.
&quot;costType&quot;: &quot;A String&quot;, # Required. The type of the partner cost.
&quot;feeType&quot;: &quot;A String&quot;, # Required. The fee type for this partner cost.
&quot;feePercentageMillis&quot;: &quot;A String&quot;, # 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%.
&quot;invoiceType&quot;: &quot;A String&quot;, # 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.
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the line item was last updated. Assigned by the system.
&quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the line item belongs to.
&quot;budget&quot;: { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
&quot;budgetAllocationType&quot;: &quot;A String&quot;, # 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.
&quot;budgetUnit&quot;: &quot;A String&quot;, # Output only. The budget unit specifies whether the budget is currency based
# or impression based. This value is inherited from the parent insertion
# order.
&quot;maxAmount&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;flight&quot;: { # Settings that control the active duration of a line item. # Required. The start and end time of the line item&#x27;s flight.
&quot;flightDateType&quot;: &quot;A String&quot;, # Required. The type of the line item&#x27;s flight dates.
&quot;dateRange&quot;: { # A date range. # The flight start and end dates of the line item. They are resolved
# relative to the parent advertiser&#x27;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.
&quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
&quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
},
&quot;inventorySourceIds&quot;: [ # The IDs of the private inventory sources assigned to the line item.
&quot;A String&quot;,
],
&quot;partnerRevenueModel&quot;: { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
&quot;markupType&quot;: &quot;A String&quot;, # Required. The markup type of the partner revenue model.
&quot;markupAmount&quot;: &quot;A String&quot;, # 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&#x27;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).
},
&quot;lineItemType&quot;: &quot;A String&quot;, # Required. Immutable. The type of the line item.
&quot;entityStatus&quot;: &quot;A String&quot;, # 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&#x27;s parent insertion order is not active, the line item
# can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
&quot;pacing&quot;: { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
&quot;pacingPeriod&quot;: &quot;A String&quot;, # 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`.
&quot;pacingType&quot;: &quot;A String&quot;, # Required. The type of pacing that defines how the budget amount will be
# spent across the pacing_period.
&quot;dailyMaxImpressions&quot;: &quot;A String&quot;, # Maximum number of impressions to serve every day.
#
# Applicable when the budget is impression based. Must be greater than 0.
&quot;dailyMaxMicros&quot;: &quot;A String&quot;, # Maximum currency amount to spend every day in micros of
# advertiser&#x27;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&#x27;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.
},
&quot;lineItemId&quot;: &quot;A String&quot;, # Output only. The unique ID of the line item. Assigned by the system.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the line item.
&quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign that the line item belongs to.
&quot;insertionOrderId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
&quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the line item.
&quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
#
# Must be UTF-8 encoded with a length of no more than 1000 characters.
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
# The integration code will show up together with the entry in many
# places in the system, for example, reporting.
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;creativeIds&quot;: [ # The IDs of the creatives associated with the line item.
&quot;A String&quot;,
],
&quot;conversionCounting&quot;: { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.
#
# All post-click conversions will be counted. A percentage value can be set
# for post-view conversions counting.
&quot;floodlightActivityConfigs&quot;: [ # 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.
{ # Settings that control the behavior of a single Floodlight activity config.
&quot;floodlightActivityId&quot;: &quot;A String&quot;, # Required. The ID of the Floodlight activity.
&quot;postClickLookbackWindowDays&quot;: 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.
&quot;postViewLookbackWindowDays&quot;: 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.
},
],
&quot;postViewCountPercentageMillis&quot;: &quot;A String&quot;, # 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.
},
&quot;bidStrategy&quot;: { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.
# Bid strategy determines the bid price.
&quot;fixedBid&quot;: { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
&quot;bidAmountMicros&quot;: &quot;A String&quot;, # The fixed bid amount, in micros of the advertiser&#x27;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.
},
&quot;maximizeSpendAutoBid&quot;: { # A strategy that automatically adjusts the bid to optimize a specified # 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`.
# performance goal while spending the full budget.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
},
&quot;performanceGoalAutoBid&quot;: { # A strategy that automatically adjusts the bid to meet or beat a specified # 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.
# performance goal.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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`.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
&quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # Required. The performance goal the bidding strategy will attempt to
# meet or beat, in micros of the advertiser&#x27;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.
#
# 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.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(advertiserId, lineItemId, x__xgafv=None)</code>
<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.
Args:
advertiserId: string, The ID of the advertiser this line item belongs to. (required)
lineItemId: string, The ID of the line item we need to fetch. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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 `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(advertiserId, lineItemId, x__xgafv=None)</code>
<pre>Gets a line item.
Args:
advertiserId: string, Required. The ID of the advertiser this line item belongs to. (required)
lineItemId: string, Required. The ID of the line item to fetch. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single line item.
&quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the line item.
# ad during a given time period.
&quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to
# `true`, the remaining frequency cap fields are not applicable.
&quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad
# during this period. Must be greater than 0.
#
# Applicable when unlimited is `false`.
&quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
&quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will
# last.
#
# Applicable when unlimited is `false`.
# The following restrictions apply based on the value of
# time_unit:
#
# * `TIME_UNIT_LIFETIME` - this field is output only and will
# default to 1
# * `TIME_UNIT_MONTHS` - must be between 1 and 2
# * `TIME_UNIT_WEEKS` - must be between 1 and 4
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
},
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the line item.
#
# Must be UTF-8 encoded with a maximum size of 240 bytes.
&quot;partnerCosts&quot;: [ # 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.
{ # 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.
&quot;feeAmount&quot;: &quot;A String&quot;, # The CPM fee amount in micros of advertiser&#x27;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&#x27;s currency, set
# this field to 1500000.
&quot;costType&quot;: &quot;A String&quot;, # Required. The type of the partner cost.
&quot;feeType&quot;: &quot;A String&quot;, # Required. The fee type for this partner cost.
&quot;feePercentageMillis&quot;: &quot;A String&quot;, # 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%.
&quot;invoiceType&quot;: &quot;A String&quot;, # 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.
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the line item was last updated. Assigned by the system.
&quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the line item belongs to.
&quot;budget&quot;: { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
&quot;budgetAllocationType&quot;: &quot;A String&quot;, # 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.
&quot;budgetUnit&quot;: &quot;A String&quot;, # Output only. The budget unit specifies whether the budget is currency based
# or impression based. This value is inherited from the parent insertion
# order.
&quot;maxAmount&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;flight&quot;: { # Settings that control the active duration of a line item. # Required. The start and end time of the line item&#x27;s flight.
&quot;flightDateType&quot;: &quot;A String&quot;, # Required. The type of the line item&#x27;s flight dates.
&quot;dateRange&quot;: { # A date range. # The flight start and end dates of the line item. They are resolved
# relative to the parent advertiser&#x27;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.
&quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
&quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
},
&quot;inventorySourceIds&quot;: [ # The IDs of the private inventory sources assigned to the line item.
&quot;A String&quot;,
],
&quot;partnerRevenueModel&quot;: { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
&quot;markupType&quot;: &quot;A String&quot;, # Required. The markup type of the partner revenue model.
&quot;markupAmount&quot;: &quot;A String&quot;, # 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&#x27;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).
},
&quot;lineItemType&quot;: &quot;A String&quot;, # Required. Immutable. The type of the line item.
&quot;entityStatus&quot;: &quot;A String&quot;, # 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&#x27;s parent insertion order is not active, the line item
# can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
&quot;pacing&quot;: { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
&quot;pacingPeriod&quot;: &quot;A String&quot;, # 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`.
&quot;pacingType&quot;: &quot;A String&quot;, # Required. The type of pacing that defines how the budget amount will be
# spent across the pacing_period.
&quot;dailyMaxImpressions&quot;: &quot;A String&quot;, # Maximum number of impressions to serve every day.
#
# Applicable when the budget is impression based. Must be greater than 0.
&quot;dailyMaxMicros&quot;: &quot;A String&quot;, # Maximum currency amount to spend every day in micros of
# advertiser&#x27;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&#x27;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.
},
&quot;lineItemId&quot;: &quot;A String&quot;, # Output only. The unique ID of the line item. Assigned by the system.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the line item.
&quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign that the line item belongs to.
&quot;insertionOrderId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
&quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the line item.
&quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
#
# Must be UTF-8 encoded with a length of no more than 1000 characters.
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
# The integration code will show up together with the entry in many
# places in the system, for example, reporting.
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;creativeIds&quot;: [ # The IDs of the creatives associated with the line item.
&quot;A String&quot;,
],
&quot;conversionCounting&quot;: { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.
#
# All post-click conversions will be counted. A percentage value can be set
# for post-view conversions counting.
&quot;floodlightActivityConfigs&quot;: [ # 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.
{ # Settings that control the behavior of a single Floodlight activity config.
&quot;floodlightActivityId&quot;: &quot;A String&quot;, # Required. The ID of the Floodlight activity.
&quot;postClickLookbackWindowDays&quot;: 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.
&quot;postViewLookbackWindowDays&quot;: 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.
},
],
&quot;postViewCountPercentageMillis&quot;: &quot;A String&quot;, # 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.
},
&quot;bidStrategy&quot;: { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.
# Bid strategy determines the bid price.
&quot;fixedBid&quot;: { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
&quot;bidAmountMicros&quot;: &quot;A String&quot;, # The fixed bid amount, in micros of the advertiser&#x27;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.
},
&quot;maximizeSpendAutoBid&quot;: { # A strategy that automatically adjusts the bid to optimize a specified # 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`.
# performance goal while spending the full budget.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
},
&quot;performanceGoalAutoBid&quot;: { # A strategy that automatically adjusts the bid to meet or beat a specified # 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.
# performance goal.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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`.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
&quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # Required. The performance goal the bidding strategy will attempt to
# meet or beat, in micros of the advertiser&#x27;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.
#
# 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.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(advertiserId, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code>
<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.
Args:
advertiserId: string, Required. The ID of the advertiser to list line items for. (required)
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.
orderBy: string, Field by which to sort the list.
Acceptable values are:
* &quot;displayName&quot; (default)
* &quot;entityStatus&quot;
The default sorting order is ascending. To specify descending order for
a field, a suffix &quot;desc&quot; should be added to the field name. Example:
`displayName desc`.
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.
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 must be `EQUALS (=)`.
* Supported fields:
- `campaignId`
- `insertionOrderId`
- `entityStatus`
- `lineItemType`.
Examples:
* All line items under an insertion order: `insertionOrderId=&quot;1234&quot;`
* All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`
and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser:
`(entityStatus=&quot;ENTITY_STATUS_ACTIVE&quot; OR
entityStatus=&quot;ENTITY_STATUS_PAUSED&quot;) AND
lineItemType=&quot;LINE_ITEM_TYPE_DISPLAY_DEFAULT&quot;`
The length of this field should be no more than 500 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;lineItems&quot;: [ # The list of line items.
#
# This list will be absent if empty.
{ # A single line item.
&quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the line item.
# ad during a given time period.
&quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to
# `true`, the remaining frequency cap fields are not applicable.
&quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad
# during this period. Must be greater than 0.
#
# Applicable when unlimited is `false`.
&quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
&quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will
# last.
#
# Applicable when unlimited is `false`.
# The following restrictions apply based on the value of
# time_unit:
#
# * `TIME_UNIT_LIFETIME` - this field is output only and will
# default to 1
# * `TIME_UNIT_MONTHS` - must be between 1 and 2
# * `TIME_UNIT_WEEKS` - must be between 1 and 4
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
},
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the line item.
#
# Must be UTF-8 encoded with a maximum size of 240 bytes.
&quot;partnerCosts&quot;: [ # 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.
{ # 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.
&quot;feeAmount&quot;: &quot;A String&quot;, # The CPM fee amount in micros of advertiser&#x27;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&#x27;s currency, set
# this field to 1500000.
&quot;costType&quot;: &quot;A String&quot;, # Required. The type of the partner cost.
&quot;feeType&quot;: &quot;A String&quot;, # Required. The fee type for this partner cost.
&quot;feePercentageMillis&quot;: &quot;A String&quot;, # 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%.
&quot;invoiceType&quot;: &quot;A String&quot;, # 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.
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the line item was last updated. Assigned by the system.
&quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the line item belongs to.
&quot;budget&quot;: { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
&quot;budgetAllocationType&quot;: &quot;A String&quot;, # 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.
&quot;budgetUnit&quot;: &quot;A String&quot;, # Output only. The budget unit specifies whether the budget is currency based
# or impression based. This value is inherited from the parent insertion
# order.
&quot;maxAmount&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;flight&quot;: { # Settings that control the active duration of a line item. # Required. The start and end time of the line item&#x27;s flight.
&quot;flightDateType&quot;: &quot;A String&quot;, # Required. The type of the line item&#x27;s flight dates.
&quot;dateRange&quot;: { # A date range. # The flight start and end dates of the line item. They are resolved
# relative to the parent advertiser&#x27;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.
&quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
&quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
},
&quot;inventorySourceIds&quot;: [ # The IDs of the private inventory sources assigned to the line item.
&quot;A String&quot;,
],
&quot;partnerRevenueModel&quot;: { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
&quot;markupType&quot;: &quot;A String&quot;, # Required. The markup type of the partner revenue model.
&quot;markupAmount&quot;: &quot;A String&quot;, # 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&#x27;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).
},
&quot;lineItemType&quot;: &quot;A String&quot;, # Required. Immutable. The type of the line item.
&quot;entityStatus&quot;: &quot;A String&quot;, # 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&#x27;s parent insertion order is not active, the line item
# can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
&quot;pacing&quot;: { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
&quot;pacingPeriod&quot;: &quot;A String&quot;, # 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`.
&quot;pacingType&quot;: &quot;A String&quot;, # Required. The type of pacing that defines how the budget amount will be
# spent across the pacing_period.
&quot;dailyMaxImpressions&quot;: &quot;A String&quot;, # Maximum number of impressions to serve every day.
#
# Applicable when the budget is impression based. Must be greater than 0.
&quot;dailyMaxMicros&quot;: &quot;A String&quot;, # Maximum currency amount to spend every day in micros of
# advertiser&#x27;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&#x27;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.
},
&quot;lineItemId&quot;: &quot;A String&quot;, # Output only. The unique ID of the line item. Assigned by the system.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the line item.
&quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign that the line item belongs to.
&quot;insertionOrderId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
&quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the line item.
&quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
#
# Must be UTF-8 encoded with a length of no more than 1000 characters.
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
# The integration code will show up together with the entry in many
# places in the system, for example, reporting.
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;creativeIds&quot;: [ # The IDs of the creatives associated with the line item.
&quot;A String&quot;,
],
&quot;conversionCounting&quot;: { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.
#
# All post-click conversions will be counted. A percentage value can be set
# for post-view conversions counting.
&quot;floodlightActivityConfigs&quot;: [ # 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.
{ # Settings that control the behavior of a single Floodlight activity config.
&quot;floodlightActivityId&quot;: &quot;A String&quot;, # Required. The ID of the Floodlight activity.
&quot;postClickLookbackWindowDays&quot;: 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.
&quot;postViewLookbackWindowDays&quot;: 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.
},
],
&quot;postViewCountPercentageMillis&quot;: &quot;A String&quot;, # 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.
},
&quot;bidStrategy&quot;: { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.
# Bid strategy determines the bid price.
&quot;fixedBid&quot;: { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
&quot;bidAmountMicros&quot;: &quot;A String&quot;, # The fixed bid amount, in micros of the advertiser&#x27;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.
},
&quot;maximizeSpendAutoBid&quot;: { # A strategy that automatically adjusts the bid to optimize a specified # 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`.
# performance goal while spending the full budget.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
},
&quot;performanceGoalAutoBid&quot;: { # A strategy that automatically adjusts the bid to meet or beat a specified # 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.
# performance goal.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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`.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
&quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # Required. The performance goal the bidding strategy will attempt to
# meet or beat, in micros of the advertiser&#x27;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.
#
# 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.
},
},
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results.
# Pass this value in the
# page_token
# field in the subsequent call to `ListLineItems` method to retrieve the
# next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(advertiserId, lineItemId, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing line item.
Returns the updated line item if successful.
Args:
advertiserId: string, Output only. The unique ID of the advertiser the line item belongs to. (required)
lineItemId: string, Output only. The unique ID of the line item. Assigned by the system. (required)
body: object, The request body.
The object takes the form of:
{ # A single line item.
&quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the line item.
# ad during a given time period.
&quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to
# `true`, the remaining frequency cap fields are not applicable.
&quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad
# during this period. Must be greater than 0.
#
# Applicable when unlimited is `false`.
&quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
&quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will
# last.
#
# Applicable when unlimited is `false`.
# The following restrictions apply based on the value of
# time_unit:
#
# * `TIME_UNIT_LIFETIME` - this field is output only and will
# default to 1
# * `TIME_UNIT_MONTHS` - must be between 1 and 2
# * `TIME_UNIT_WEEKS` - must be between 1 and 4
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
},
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the line item.
#
# Must be UTF-8 encoded with a maximum size of 240 bytes.
&quot;partnerCosts&quot;: [ # 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.
{ # 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.
&quot;feeAmount&quot;: &quot;A String&quot;, # The CPM fee amount in micros of advertiser&#x27;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&#x27;s currency, set
# this field to 1500000.
&quot;costType&quot;: &quot;A String&quot;, # Required. The type of the partner cost.
&quot;feeType&quot;: &quot;A String&quot;, # Required. The fee type for this partner cost.
&quot;feePercentageMillis&quot;: &quot;A String&quot;, # 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%.
&quot;invoiceType&quot;: &quot;A String&quot;, # 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.
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the line item was last updated. Assigned by the system.
&quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the line item belongs to.
&quot;budget&quot;: { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
&quot;budgetAllocationType&quot;: &quot;A String&quot;, # 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.
&quot;budgetUnit&quot;: &quot;A String&quot;, # Output only. The budget unit specifies whether the budget is currency based
# or impression based. This value is inherited from the parent insertion
# order.
&quot;maxAmount&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;flight&quot;: { # Settings that control the active duration of a line item. # Required. The start and end time of the line item&#x27;s flight.
&quot;flightDateType&quot;: &quot;A String&quot;, # Required. The type of the line item&#x27;s flight dates.
&quot;dateRange&quot;: { # A date range. # The flight start and end dates of the line item. They are resolved
# relative to the parent advertiser&#x27;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.
&quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
&quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
},
&quot;inventorySourceIds&quot;: [ # The IDs of the private inventory sources assigned to the line item.
&quot;A String&quot;,
],
&quot;partnerRevenueModel&quot;: { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
&quot;markupType&quot;: &quot;A String&quot;, # Required. The markup type of the partner revenue model.
&quot;markupAmount&quot;: &quot;A String&quot;, # 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&#x27;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).
},
&quot;lineItemType&quot;: &quot;A String&quot;, # Required. Immutable. The type of the line item.
&quot;entityStatus&quot;: &quot;A String&quot;, # 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&#x27;s parent insertion order is not active, the line item
# can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
&quot;pacing&quot;: { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
&quot;pacingPeriod&quot;: &quot;A String&quot;, # 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`.
&quot;pacingType&quot;: &quot;A String&quot;, # Required. The type of pacing that defines how the budget amount will be
# spent across the pacing_period.
&quot;dailyMaxImpressions&quot;: &quot;A String&quot;, # Maximum number of impressions to serve every day.
#
# Applicable when the budget is impression based. Must be greater than 0.
&quot;dailyMaxMicros&quot;: &quot;A String&quot;, # Maximum currency amount to spend every day in micros of
# advertiser&#x27;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&#x27;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.
},
&quot;lineItemId&quot;: &quot;A String&quot;, # Output only. The unique ID of the line item. Assigned by the system.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the line item.
&quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign that the line item belongs to.
&quot;insertionOrderId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
&quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the line item.
&quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
#
# Must be UTF-8 encoded with a length of no more than 1000 characters.
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
# The integration code will show up together with the entry in many
# places in the system, for example, reporting.
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;creativeIds&quot;: [ # The IDs of the creatives associated with the line item.
&quot;A String&quot;,
],
&quot;conversionCounting&quot;: { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.
#
# All post-click conversions will be counted. A percentage value can be set
# for post-view conversions counting.
&quot;floodlightActivityConfigs&quot;: [ # 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.
{ # Settings that control the behavior of a single Floodlight activity config.
&quot;floodlightActivityId&quot;: &quot;A String&quot;, # Required. The ID of the Floodlight activity.
&quot;postClickLookbackWindowDays&quot;: 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.
&quot;postViewLookbackWindowDays&quot;: 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.
},
],
&quot;postViewCountPercentageMillis&quot;: &quot;A String&quot;, # 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.
},
&quot;bidStrategy&quot;: { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.
# Bid strategy determines the bid price.
&quot;fixedBid&quot;: { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
&quot;bidAmountMicros&quot;: &quot;A String&quot;, # The fixed bid amount, in micros of the advertiser&#x27;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.
},
&quot;maximizeSpendAutoBid&quot;: { # A strategy that automatically adjusts the bid to optimize a specified # 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`.
# performance goal while spending the full budget.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
},
&quot;performanceGoalAutoBid&quot;: { # A strategy that automatically adjusts the bid to meet or beat a specified # 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.
# performance goal.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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`.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
&quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # Required. The performance goal the bidding strategy will attempt to
# meet or beat, in micros of the advertiser&#x27;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.
#
# 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.
},
},
}
updateMask: string, Required. The mask to control which fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single line item.
&quot;frequencyCap&quot;: { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the line item.
# ad during a given time period.
&quot;unlimited&quot;: True or False, # Whether unlimited frequency capping is applied. When this field is set to
# `true`, the remaining frequency cap fields are not applicable.
&quot;maxImpressions&quot;: 42, # The maximum number of times a user may be shown with the same ad
# during this period. Must be greater than 0.
#
# Applicable when unlimited is `false`.
&quot;timeUnit&quot;: &quot;A String&quot;, # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
&quot;timeUnitCount&quot;: 42, # The number of time_unit the frequency cap will
# last.
#
# Applicable when unlimited is `false`.
# The following restrictions apply based on the value of
# time_unit:
#
# * `TIME_UNIT_LIFETIME` - this field is output only and will
# default to 1
# * `TIME_UNIT_MONTHS` - must be between 1 and 2
# * `TIME_UNIT_WEEKS` - must be between 1 and 4
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
},
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the line item.
#
# Must be UTF-8 encoded with a maximum size of 240 bytes.
&quot;partnerCosts&quot;: [ # 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.
{ # 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.
&quot;feeAmount&quot;: &quot;A String&quot;, # The CPM fee amount in micros of advertiser&#x27;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&#x27;s currency, set
# this field to 1500000.
&quot;costType&quot;: &quot;A String&quot;, # Required. The type of the partner cost.
&quot;feeType&quot;: &quot;A String&quot;, # Required. The fee type for this partner cost.
&quot;feePercentageMillis&quot;: &quot;A String&quot;, # 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%.
&quot;invoiceType&quot;: &quot;A String&quot;, # 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.
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the line item was last updated. Assigned by the system.
&quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the line item belongs to.
&quot;budget&quot;: { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
&quot;budgetAllocationType&quot;: &quot;A String&quot;, # 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.
&quot;budgetUnit&quot;: &quot;A String&quot;, # Output only. The budget unit specifies whether the budget is currency based
# or impression based. This value is inherited from the parent insertion
# order.
&quot;maxAmount&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;flight&quot;: { # Settings that control the active duration of a line item. # Required. The start and end time of the line item&#x27;s flight.
&quot;flightDateType&quot;: &quot;A String&quot;, # Required. The type of the line item&#x27;s flight dates.
&quot;dateRange&quot;: { # A date range. # The flight start and end dates of the line item. They are resolved
# relative to the parent advertiser&#x27;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.
&quot;endDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
&quot;startDate&quot;: { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value
# for `year`, `month`, and `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`.
&quot;year&quot;: 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
&quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
&quot;month&quot;: 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
},
&quot;inventorySourceIds&quot;: [ # The IDs of the private inventory sources assigned to the line item.
&quot;A String&quot;,
],
&quot;partnerRevenueModel&quot;: { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
&quot;markupType&quot;: &quot;A String&quot;, # Required. The markup type of the partner revenue model.
&quot;markupAmount&quot;: &quot;A String&quot;, # 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&#x27;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).
},
&quot;lineItemType&quot;: &quot;A String&quot;, # Required. Immutable. The type of the line item.
&quot;entityStatus&quot;: &quot;A String&quot;, # 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&#x27;s parent insertion order is not active, the line item
# can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
&quot;pacing&quot;: { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
&quot;pacingPeriod&quot;: &quot;A String&quot;, # 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`.
&quot;pacingType&quot;: &quot;A String&quot;, # Required. The type of pacing that defines how the budget amount will be
# spent across the pacing_period.
&quot;dailyMaxImpressions&quot;: &quot;A String&quot;, # Maximum number of impressions to serve every day.
#
# Applicable when the budget is impression based. Must be greater than 0.
&quot;dailyMaxMicros&quot;: &quot;A String&quot;, # Maximum currency amount to spend every day in micros of
# advertiser&#x27;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&#x27;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.
},
&quot;lineItemId&quot;: &quot;A String&quot;, # Output only. The unique ID of the line item. Assigned by the system.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the line item.
&quot;campaignId&quot;: &quot;A String&quot;, # Output only. The unique ID of the campaign that the line item belongs to.
&quot;insertionOrderId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
&quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the line item.
&quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
#
# Must be UTF-8 encoded with a length of no more than 1000 characters.
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
# The integration code will show up together with the entry in many
# places in the system, for example, reporting.
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;creativeIds&quot;: [ # The IDs of the creatives associated with the line item.
&quot;A String&quot;,
],
&quot;conversionCounting&quot;: { # Settings that control how conversions are counted. # The conversion tracking setting of the line item.
#
# All post-click conversions will be counted. A percentage value can be set
# for post-view conversions counting.
&quot;floodlightActivityConfigs&quot;: [ # 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.
{ # Settings that control the behavior of a single Floodlight activity config.
&quot;floodlightActivityId&quot;: &quot;A String&quot;, # Required. The ID of the Floodlight activity.
&quot;postClickLookbackWindowDays&quot;: 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.
&quot;postViewLookbackWindowDays&quot;: 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.
},
],
&quot;postViewCountPercentageMillis&quot;: &quot;A String&quot;, # 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.
},
&quot;bidStrategy&quot;: { # Settings that control the bid strategy. # Required. The bidding strategy of the line item.
# Bid strategy determines the bid price.
&quot;fixedBid&quot;: { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
&quot;bidAmountMicros&quot;: &quot;A String&quot;, # The fixed bid amount, in micros of the advertiser&#x27;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.
},
&quot;maximizeSpendAutoBid&quot;: { # A strategy that automatically adjusts the bid to optimize a specified # 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`.
# performance goal while spending the full budget.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
},
&quot;performanceGoalAutoBid&quot;: { # A strategy that automatically adjusts the bid to meet or beat a specified # 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.
# performance goal.
&quot;performanceGoalType&quot;: &quot;A String&quot;, # 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`.
&quot;maxAverageCpmBidAmountMicros&quot;: &quot;A String&quot;, # The maximum average CPM that may be bid, in micros of the advertiser&#x27;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.
&quot;performanceGoalAmountMicros&quot;: &quot;A String&quot;, # Required. The performance goal the bidding strategy will attempt to
# meet or beat, in micros of the advertiser&#x27;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.
#
# 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.
},
},
}</pre>
</div>
</body></html>