| <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. |
| "deleteRequests": [ # 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. |
| "targetingType": "A String", # Required. Identifies the type of this assigned targeting option. |
| "assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete. |
| "A String", |
| ], |
| }, |
| ], |
| "createRequests": [ # 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. |
| "targetingType": "A String", # Required. Identifies the type of this assigned targeting option. |
| "assignedTargetingOptions": [ # 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. |
| "appDetails": { # 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`. |
| "displayName": "A String", # Output only. The display name of the app. |
| "appId": "A String", # Required. The ID of the app. |
| # |
| # Android's Play store app uses bundle ID, for example |
| # `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for |
| # example `422689480`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "parentalStatusDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. |
| "parentalStatus": "A String", # Output only. The parental status of the audience. |
| }, |
| "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option. |
| "urlDetails": { # 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`. |
| "url": "A String", # Required. The URL, for example `example.com`. |
| # |
| # DV360 supports two levels of subdirectory targeting, for example |
| # `www.example.com/one-subdirectory-level/second-level`, and five levels of |
| # subdomain targeting, for example `five.four.three.two.one.example.com`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "onScreenPositionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| "onScreenPosition": "A String", # Output only. The on screen position. |
| }, |
| "videoPlayerSizeDetails": { # 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. |
| "videoPlayerSize": "A String", # Output only. The video player size. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| }, |
| "channelDetails": { # 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`. |
| "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID |
| # field on a |
| # [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or |
| # [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) |
| # resource. |
| "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser |
| # level assigned targeting option, this field must be true. |
| }, |
| "operatingSystemDetails": { # 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`. |
| "displayName": "A String", # Output only. The display name of the operating system. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting option ID populated in |
| # targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_OPERATING_SYSTEM`. |
| }, |
| "thirdPartyVerifierDetails": { # 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`. |
| "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. |
| "excludedAdFraudRisk": "A String", # Ad Fraud settings. |
| "displayViewability": "A String", # Display Viewability section (applicable to display line items only). |
| "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**. |
| "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**. |
| "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**. |
| "excludedAdultRisk": "A String", # Brand Safety - **Adult content**. |
| "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only). |
| "videoViewability": "A String", # Video Viewability Section (applicable to video line items only). |
| "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**. |
| "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**. |
| "excludeUnrateable": True or False, # Brand Safety - **Unrateable**. |
| "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**. |
| "excludedViolenceRisk": "A String", # Brand Safety - **Violence**. |
| }, |
| "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify. |
| "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only). |
| "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player |
| # size. |
| "videoIab": "A String", # Target web inventory to maximize IAB viewable rate. |
| "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate. |
| }, |
| "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating. |
| "A String", |
| ], |
| "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates. |
| "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats. |
| "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT. |
| }, |
| "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls. |
| "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories. |
| "A String", |
| ], |
| "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories. |
| "A String", |
| ], |
| "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable. |
| }, |
| "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings. |
| "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings. |
| "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings. |
| }, |
| "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only). |
| "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration. |
| "iab": "A String", # Target web and app inventory to maximize IAB viewable rate. |
| }, |
| }, |
| "adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox. |
| "excludedAdlooxCategories": [ # Adloox's brand safety settings. |
| "A String", |
| ], |
| }, |
| }, |
| "proximityLocationListDetails": { # 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`. |
| "proximityRadiusRange": "A String", # Required. Radius range for proximity location list. |
| # This represents the size of the area around a chosen location that will be |
| # targeted. |
| # |
| # `All` proximity location targeting under a single line item must have the |
| # same radius range value. Set this value to match any existing targeting. |
| # If updated, this field will change the radius range for all proximity |
| # targeting under the line item. |
| "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the |
| # location_list_id field of a |
| # LocationList resource whose type is |
| # `TARGETING_LOCATION_TYPE_PROXIMITY`. |
| }, |
| "ageRangeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. |
| "ageRange": "A String", # Output only. The age range of an audience. We only support targeting a continuous age |
| # range of an audience. Thus, the age range represented in this field can be |
| # 1) targeted solely, or, 2) part of a larger continuous age range. The reach |
| # of a continuous age range targeting can be expanded by also targeting an |
| # audience of an unknown age. |
| }, |
| "subExchangeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| }, |
| "keywordDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "keyword": "A String", # Required. The keyword, for example `car insurance`. |
| # |
| # Positive keyword cannot be offensive word. |
| # Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number |
| # of characters is 80. Maximum number of words is 10. |
| }, |
| "deviceMakeModelDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "displayName": "A String", # Output only. The display name of the device make and model. |
| }, |
| "digitalContentLabelExclusionDetails": { # 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't visible in line item settings). Line item settings can |
| # exclude content labels in addition to advertiser exclusions, but can't |
| # override them. A line item won't serve if all the digital content labels |
| # are excluded. |
| # populated in the details field of an AssignedTargetingOption when |
| # targeting_type is |
| # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. |
| "excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED. |
| "contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier. |
| }, |
| "browserDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_BROWSER`. |
| "displayName": "A String", # Output only. The display name of the browser. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser |
| # targeting options on the same line item must have the same value for this |
| # field. |
| }, |
| "appCategoryDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_APP_CATEGORY`. |
| "displayName": "A String", # Output only. The display name of the app category. |
| }, |
| "contentOutstreamPositionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "contentOutstreamPosition": "A String", # Output only. The content outstream position. |
| }, |
| "negativeKeywordListDetails": { # 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`. |
| "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the |
| # negative_keyword_list_id |
| # field of a NegativeKeywordList resource. |
| }, |
| "genderDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_GENDER`. |
| "gender": "A String", # Output only. The gender of the audience. |
| }, |
| "name": "A String", # Output only. The resource name for this assigned targeting option. |
| "inventorySourceDetails": { # 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`. |
| "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the |
| # inventory_source_id field of an |
| # InventorySource resource. |
| }, |
| "sensitiveCategoryExclusionDetails": { # 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't visible in line item settings). Line item settings can |
| # exclude sensitive categories in addition to advertiser exclusions, but |
| # can't override them. |
| # details field of an AssignedTargetingOption when |
| # targeting_type is |
| # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. |
| "excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED. |
| "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier. |
| }, |
| "audienceGroupDetails": { # 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'ed with other |
| # groups. |
| "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first |
| # and third party audience groups. Each first and third party audience group |
| # contains first and third party audience ids only. |
| # The relation between each first and third party audience group is |
| # INTERSECTION, and the result is UNION'ed with other audience groups. |
| # Repeated groups with same settings will be ignored. |
| { # Details of first and third party audience group. |
| # All first and third party audience targeting settings are logically ‘OR’ of |
| # each other. |
| "settings": [ # Required. All first and third party audience targeting settings in first and |
| # third party audience group. |
| # Repeated settings with same id are not allowed. |
| { # Details of first and third party audience targeting setting. |
| "recency": "A String", # The recency of the first and third party audience targeting setting. |
| # Only applicable to first party audiences, otherwise |
| # will be ignored. For more info, refer to |
| # https://support.google.com/displayvideo/answer/2949947#recency |
| # When unspecified, no recency limit will be used. |
| "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience |
| # targeting setting. This id is |
| # first_and_third_party_audience_id. |
| }, |
| ], |
| }, |
| ], |
| "includedCombinedAudienceGroup": { # 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. |
| "settings": [ # Required. All combined audience targeting settings in combined audience group. |
| # Repeated settings with same id will be ignored. |
| # The number of combined audience settings should be no more than five, error |
| # will be thrown otherwise. |
| { # Details of combined audience targeting setting. |
| "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. |
| # This id is combined_audience_id. |
| }, |
| ], |
| }, |
| "includedCustomListGroup": { # 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. |
| "settings": [ # Required. All custom list targeting settings in custom list group. |
| # Repeated settings with same id will be ignored. |
| { # Details of custom list targeting setting. |
| "customListId": "A String", # Required. Custom id of custom list targeting setting. |
| # This id is custom_list_id. |
| }, |
| ], |
| }, |
| "excludedFirstAndThirdPartyAudienceGroup": { # 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. |
| "settings": [ # Required. All first and third party audience targeting settings in first and |
| # third party audience group. |
| # Repeated settings with same id are not allowed. |
| { # Details of first and third party audience targeting setting. |
| "recency": "A String", # The recency of the first and third party audience targeting setting. |
| # Only applicable to first party audiences, otherwise |
| # will be ignored. For more info, refer to |
| # https://support.google.com/displayvideo/answer/2949947#recency |
| # When unspecified, no recency limit will be used. |
| "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience |
| # targeting setting. This id is |
| # first_and_third_party_audience_id. |
| }, |
| ], |
| }, |
| "includedGoogleAudienceGroup": { # 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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. |
| # Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. |
| # This id is google_audience_id. |
| }, |
| ], |
| }, |
| "excludedGoogleAudienceGroup": { # Details of Google audience group. # The Google audience ids of the excluded Google audience group. |
| # Used for negative targeting. It's COMPLEMENT is used to UNION other |
| # audience groups. |
| # Only contains Affinity, In-market and Installed-apps type Google audiences. |
| # All items are logically ‘OR’ of each other. |
| # All Google audience targeting settings are logically ‘OR’ of each other. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. |
| # Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. |
| # This id is google_audience_id. |
| }, |
| ], |
| }, |
| }, |
| "userRewardedContentDetails": { # 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`. |
| "userRewardedContent": "A String", # Output only. User rewarded content status for video ads. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| }, |
| "languageDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_LANGUAGE`. |
| "displayName": "A String", # Output only. The display name of the language (e.g., "French"). |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned |
| # language targeting options on the same line item must have the same value |
| # for this field. |
| }, |
| "authorizedSellerStatusDetails": { # 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'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`. |
| "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. |
| }, |
| "dayAndTimeDetails": { # 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`. |
| "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. |
| "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) |
| # and 23 (1 hour before end of day). |
| "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after |
| # start of day) and 24 (end of day). |
| "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time |
| # targeting setting. |
| }, |
| "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option. |
| "environmentDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" |
| # for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option). |
| "environment": "A String", # Output only. The serving environment. |
| }, |
| "geoRegionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_GEO_REGION`. |
| "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| "geoRegionType": "A String", # Output only. The type of geographic region targeting. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "deviceTypeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. ID of the device type. |
| "deviceType": "A String", # Output only. The display name of the device type. |
| }, |
| "exchangeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_EXCHANGE`. |
| }, |
| "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique |
| # within a given line item and targeting type. It may be reused in other |
| # contexts. |
| "householdIncomeDetails": { # 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`. |
| "householdIncome": "A String", # Output only. The household income of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| }, |
| "contentInstreamPositionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads. |
| }, |
| "categoryDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_CATEGORY`. |
| "displayName": "A String", # Output only. The display name of the category. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "inventorySourceGroupDetails": { # 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`. |
| "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the |
| # inventory_source_group_id |
| # field of an InventorySourceGroup resource. |
| }, |
| "regionalLocationListDetails": { # 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`. |
| "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the |
| # location_list_id field of a |
| # LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "carrierAndIspDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier |
| # and ISP targeting options on the same line item must have the same value |
| # for this field. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "displayName": "A String", # Output only. The display name of the carrier or ISP. |
| }, |
| "viewabilityDetails": { # 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`. |
| "viewability": "A String", # Output only. The predicted viewability percentage. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" |
| # for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option). |
| }, |
| }, |
| ], |
| }, |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "createdAssignedTargetingOptions": [ # 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. |
| "appDetails": { # 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`. |
| "displayName": "A String", # Output only. The display name of the app. |
| "appId": "A String", # Required. The ID of the app. |
| # |
| # Android's Play store app uses bundle ID, for example |
| # `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for |
| # example `422689480`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "parentalStatusDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. |
| "parentalStatus": "A String", # Output only. The parental status of the audience. |
| }, |
| "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option. |
| "urlDetails": { # 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`. |
| "url": "A String", # Required. The URL, for example `example.com`. |
| # |
| # DV360 supports two levels of subdirectory targeting, for example |
| # `www.example.com/one-subdirectory-level/second-level`, and five levels of |
| # subdomain targeting, for example `five.four.three.two.one.example.com`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "onScreenPositionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| "onScreenPosition": "A String", # Output only. The on screen position. |
| }, |
| "videoPlayerSizeDetails": { # 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. |
| "videoPlayerSize": "A String", # Output only. The video player size. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| }, |
| "channelDetails": { # 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`. |
| "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID |
| # field on a |
| # [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or |
| # [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) |
| # resource. |
| "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser |
| # level assigned targeting option, this field must be true. |
| }, |
| "operatingSystemDetails": { # 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`. |
| "displayName": "A String", # Output only. The display name of the operating system. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting option ID populated in |
| # targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_OPERATING_SYSTEM`. |
| }, |
| "thirdPartyVerifierDetails": { # 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`. |
| "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. |
| "excludedAdFraudRisk": "A String", # Ad Fraud settings. |
| "displayViewability": "A String", # Display Viewability section (applicable to display line items only). |
| "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**. |
| "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**. |
| "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**. |
| "excludedAdultRisk": "A String", # Brand Safety - **Adult content**. |
| "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only). |
| "videoViewability": "A String", # Video Viewability Section (applicable to video line items only). |
| "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**. |
| "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**. |
| "excludeUnrateable": True or False, # Brand Safety - **Unrateable**. |
| "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**. |
| "excludedViolenceRisk": "A String", # Brand Safety - **Violence**. |
| }, |
| "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify. |
| "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only). |
| "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player |
| # size. |
| "videoIab": "A String", # Target web inventory to maximize IAB viewable rate. |
| "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate. |
| }, |
| "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating. |
| "A String", |
| ], |
| "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates. |
| "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats. |
| "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT. |
| }, |
| "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls. |
| "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories. |
| "A String", |
| ], |
| "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories. |
| "A String", |
| ], |
| "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable. |
| }, |
| "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings. |
| "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings. |
| "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings. |
| }, |
| "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only). |
| "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration. |
| "iab": "A String", # Target web and app inventory to maximize IAB viewable rate. |
| }, |
| }, |
| "adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox. |
| "excludedAdlooxCategories": [ # Adloox's brand safety settings. |
| "A String", |
| ], |
| }, |
| }, |
| "proximityLocationListDetails": { # 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`. |
| "proximityRadiusRange": "A String", # Required. Radius range for proximity location list. |
| # This represents the size of the area around a chosen location that will be |
| # targeted. |
| # |
| # `All` proximity location targeting under a single line item must have the |
| # same radius range value. Set this value to match any existing targeting. |
| # If updated, this field will change the radius range for all proximity |
| # targeting under the line item. |
| "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the |
| # location_list_id field of a |
| # LocationList resource whose type is |
| # `TARGETING_LOCATION_TYPE_PROXIMITY`. |
| }, |
| "ageRangeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. |
| "ageRange": "A String", # Output only. The age range of an audience. We only support targeting a continuous age |
| # range of an audience. Thus, the age range represented in this field can be |
| # 1) targeted solely, or, 2) part of a larger continuous age range. The reach |
| # of a continuous age range targeting can be expanded by also targeting an |
| # audience of an unknown age. |
| }, |
| "subExchangeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| }, |
| "keywordDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "keyword": "A String", # Required. The keyword, for example `car insurance`. |
| # |
| # Positive keyword cannot be offensive word. |
| # Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number |
| # of characters is 80. Maximum number of words is 10. |
| }, |
| "deviceMakeModelDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "displayName": "A String", # Output only. The display name of the device make and model. |
| }, |
| "digitalContentLabelExclusionDetails": { # 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't visible in line item settings). Line item settings can |
| # exclude content labels in addition to advertiser exclusions, but can't |
| # override them. A line item won't serve if all the digital content labels |
| # are excluded. |
| # populated in the details field of an AssignedTargetingOption when |
| # targeting_type is |
| # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. |
| "excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED. |
| "contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier. |
| }, |
| "browserDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_BROWSER`. |
| "displayName": "A String", # Output only. The display name of the browser. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser |
| # targeting options on the same line item must have the same value for this |
| # field. |
| }, |
| "appCategoryDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_APP_CATEGORY`. |
| "displayName": "A String", # Output only. The display name of the app category. |
| }, |
| "contentOutstreamPositionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "contentOutstreamPosition": "A String", # Output only. The content outstream position. |
| }, |
| "negativeKeywordListDetails": { # 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`. |
| "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the |
| # negative_keyword_list_id |
| # field of a NegativeKeywordList resource. |
| }, |
| "genderDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_GENDER`. |
| "gender": "A String", # Output only. The gender of the audience. |
| }, |
| "name": "A String", # Output only. The resource name for this assigned targeting option. |
| "inventorySourceDetails": { # 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`. |
| "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the |
| # inventory_source_id field of an |
| # InventorySource resource. |
| }, |
| "sensitiveCategoryExclusionDetails": { # 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't visible in line item settings). Line item settings can |
| # exclude sensitive categories in addition to advertiser exclusions, but |
| # can't override them. |
| # details field of an AssignedTargetingOption when |
| # targeting_type is |
| # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. |
| "excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED. |
| "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier. |
| }, |
| "audienceGroupDetails": { # 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'ed with other |
| # groups. |
| "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first |
| # and third party audience groups. Each first and third party audience group |
| # contains first and third party audience ids only. |
| # The relation between each first and third party audience group is |
| # INTERSECTION, and the result is UNION'ed with other audience groups. |
| # Repeated groups with same settings will be ignored. |
| { # Details of first and third party audience group. |
| # All first and third party audience targeting settings are logically ‘OR’ of |
| # each other. |
| "settings": [ # Required. All first and third party audience targeting settings in first and |
| # third party audience group. |
| # Repeated settings with same id are not allowed. |
| { # Details of first and third party audience targeting setting. |
| "recency": "A String", # The recency of the first and third party audience targeting setting. |
| # Only applicable to first party audiences, otherwise |
| # will be ignored. For more info, refer to |
| # https://support.google.com/displayvideo/answer/2949947#recency |
| # When unspecified, no recency limit will be used. |
| "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience |
| # targeting setting. This id is |
| # first_and_third_party_audience_id. |
| }, |
| ], |
| }, |
| ], |
| "includedCombinedAudienceGroup": { # 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. |
| "settings": [ # Required. All combined audience targeting settings in combined audience group. |
| # Repeated settings with same id will be ignored. |
| # The number of combined audience settings should be no more than five, error |
| # will be thrown otherwise. |
| { # Details of combined audience targeting setting. |
| "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. |
| # This id is combined_audience_id. |
| }, |
| ], |
| }, |
| "includedCustomListGroup": { # 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. |
| "settings": [ # Required. All custom list targeting settings in custom list group. |
| # Repeated settings with same id will be ignored. |
| { # Details of custom list targeting setting. |
| "customListId": "A String", # Required. Custom id of custom list targeting setting. |
| # This id is custom_list_id. |
| }, |
| ], |
| }, |
| "excludedFirstAndThirdPartyAudienceGroup": { # 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. |
| "settings": [ # Required. All first and third party audience targeting settings in first and |
| # third party audience group. |
| # Repeated settings with same id are not allowed. |
| { # Details of first and third party audience targeting setting. |
| "recency": "A String", # The recency of the first and third party audience targeting setting. |
| # Only applicable to first party audiences, otherwise |
| # will be ignored. For more info, refer to |
| # https://support.google.com/displayvideo/answer/2949947#recency |
| # When unspecified, no recency limit will be used. |
| "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience |
| # targeting setting. This id is |
| # first_and_third_party_audience_id. |
| }, |
| ], |
| }, |
| "includedGoogleAudienceGroup": { # 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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. |
| # Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. |
| # This id is google_audience_id. |
| }, |
| ], |
| }, |
| "excludedGoogleAudienceGroup": { # Details of Google audience group. # The Google audience ids of the excluded Google audience group. |
| # Used for negative targeting. It's COMPLEMENT is used to UNION other |
| # audience groups. |
| # Only contains Affinity, In-market and Installed-apps type Google audiences. |
| # All items are logically ‘OR’ of each other. |
| # All Google audience targeting settings are logically ‘OR’ of each other. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. |
| # Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. |
| # This id is google_audience_id. |
| }, |
| ], |
| }, |
| }, |
| "userRewardedContentDetails": { # 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`. |
| "userRewardedContent": "A String", # Output only. User rewarded content status for video ads. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| }, |
| "languageDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_LANGUAGE`. |
| "displayName": "A String", # Output only. The display name of the language (e.g., "French"). |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned |
| # language targeting options on the same line item must have the same value |
| # for this field. |
| }, |
| "authorizedSellerStatusDetails": { # 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'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`. |
| "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. |
| }, |
| "dayAndTimeDetails": { # 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`. |
| "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. |
| "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) |
| # and 23 (1 hour before end of day). |
| "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after |
| # start of day) and 24 (end of day). |
| "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time |
| # targeting setting. |
| }, |
| "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option. |
| "environmentDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" |
| # for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option). |
| "environment": "A String", # Output only. The serving environment. |
| }, |
| "geoRegionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_GEO_REGION`. |
| "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| "geoRegionType": "A String", # Output only. The type of geographic region targeting. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "deviceTypeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. ID of the device type. |
| "deviceType": "A String", # Output only. The display name of the device type. |
| }, |
| "exchangeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_EXCHANGE`. |
| }, |
| "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique |
| # within a given line item and targeting type. It may be reused in other |
| # contexts. |
| "householdIncomeDetails": { # 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`. |
| "householdIncome": "A String", # Output only. The household income of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| }, |
| "contentInstreamPositionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads. |
| }, |
| "categoryDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_CATEGORY`. |
| "displayName": "A String", # Output only. The display name of the category. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "inventorySourceGroupDetails": { # 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`. |
| "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the |
| # inventory_source_group_id |
| # field of an InventorySourceGroup resource. |
| }, |
| "regionalLocationListDetails": { # 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`. |
| "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the |
| # location_list_id field of a |
| # LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "carrierAndIspDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier |
| # and ISP targeting options on the same line item must have the same value |
| # for this field. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "displayName": "A String", # Output only. The display name of the carrier or ISP. |
| }, |
| "viewabilityDetails": { # 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`. |
| "viewability": "A String", # Output only. The predicted viewability percentage. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" |
| # for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option). |
| }, |
| }, |
| ], |
| }</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="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR |
| targetingType="TARGETING_TYPE_CHANNEL"` |
| * AssignedTargetingOptions with inheritance status of NOT_INHERITED or |
| INHERITED_FROM_PARTNER |
| `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` |
| |
| The length of this field should be no more than 500 characters. |
| 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 '5000'. 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 "desc" 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: |
| |
| { |
| "nextPageToken": "A String", # A token identifying the next page of results. This value should be |
| # specified as the |
| # pageToken in |
| # a subsequent BulkListLineItemAssignedTargetingOptionsRequest to fetch |
| # the next page of results. This token will be absent if there are no more |
| # assigned_targeting_options |
| # to return. |
| "assignedTargetingOptions": [ # 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. |
| "appDetails": { # 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`. |
| "displayName": "A String", # Output only. The display name of the app. |
| "appId": "A String", # Required. The ID of the app. |
| # |
| # Android's Play store app uses bundle ID, for example |
| # `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for |
| # example `422689480`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "parentalStatusDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. |
| "parentalStatus": "A String", # Output only. The parental status of the audience. |
| }, |
| "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option. |
| "urlDetails": { # 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`. |
| "url": "A String", # Required. The URL, for example `example.com`. |
| # |
| # DV360 supports two levels of subdirectory targeting, for example |
| # `www.example.com/one-subdirectory-level/second-level`, and five levels of |
| # subdomain targeting, for example `five.four.three.two.one.example.com`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "onScreenPositionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_ON_SCREEN_POSITION`. |
| "onScreenPosition": "A String", # Output only. The on screen position. |
| }, |
| "videoPlayerSizeDetails": { # 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. |
| "videoPlayerSize": "A String", # Output only. The video player size. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. |
| }, |
| "channelDetails": { # 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`. |
| "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID |
| # field on a |
| # [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or |
| # [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) |
| # resource. |
| "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser |
| # level assigned targeting option, this field must be true. |
| }, |
| "operatingSystemDetails": { # 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`. |
| "displayName": "A String", # Output only. The display name of the operating system. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting option ID populated in |
| # targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_OPERATING_SYSTEM`. |
| }, |
| "thirdPartyVerifierDetails": { # 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`. |
| "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. |
| "excludedAdFraudRisk": "A String", # Ad Fraud settings. |
| "displayViewability": "A String", # Display Viewability section (applicable to display line items only). |
| "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**. |
| "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**. |
| "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**. |
| "excludedAdultRisk": "A String", # Brand Safety - **Adult content**. |
| "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only). |
| "videoViewability": "A String", # Video Viewability Section (applicable to video line items only). |
| "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**. |
| "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**. |
| "excludeUnrateable": True or False, # Brand Safety - **Unrateable**. |
| "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**. |
| "excludedViolenceRisk": "A String", # Brand Safety - **Violence**. |
| }, |
| "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify. |
| "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only). |
| "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player |
| # size. |
| "videoIab": "A String", # Target web inventory to maximize IAB viewable rate. |
| "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate. |
| }, |
| "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating. |
| "A String", |
| ], |
| "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates. |
| "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats. |
| "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT. |
| }, |
| "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls. |
| "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories. |
| "A String", |
| ], |
| "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories. |
| "A String", |
| ], |
| "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable. |
| }, |
| "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings. |
| "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings. |
| "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings. |
| }, |
| "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only). |
| "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration. |
| "iab": "A String", # Target web and app inventory to maximize IAB viewable rate. |
| }, |
| }, |
| "adloox": { # Details of Adloox settings. # Third party brand verifier -- Adloox. |
| "excludedAdlooxCategories": [ # Adloox's brand safety settings. |
| "A String", |
| ], |
| }, |
| }, |
| "proximityLocationListDetails": { # 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`. |
| "proximityRadiusRange": "A String", # Required. Radius range for proximity location list. |
| # This represents the size of the area around a chosen location that will be |
| # targeted. |
| # |
| # `All` proximity location targeting under a single line item must have the |
| # same radius range value. Set this value to match any existing targeting. |
| # If updated, this field will change the radius range for all proximity |
| # targeting under the line item. |
| "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the |
| # location_list_id field of a |
| # LocationList resource whose type is |
| # `TARGETING_LOCATION_TYPE_PROXIMITY`. |
| }, |
| "ageRangeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. |
| "ageRange": "A String", # Output only. The age range of an audience. We only support targeting a continuous age |
| # range of an audience. Thus, the age range represented in this field can be |
| # 1) targeted solely, or, 2) part of a larger continuous age range. The reach |
| # of a continuous age range targeting can be expanded by also targeting an |
| # audience of an unknown age. |
| }, |
| "subExchangeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| }, |
| "keywordDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "keyword": "A String", # Required. The keyword, for example `car insurance`. |
| # |
| # Positive keyword cannot be offensive word. |
| # Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number |
| # of characters is 80. Maximum number of words is 10. |
| }, |
| "deviceMakeModelDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. |
| "displayName": "A String", # Output only. The display name of the device make and model. |
| }, |
| "digitalContentLabelExclusionDetails": { # 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't visible in line item settings). Line item settings can |
| # exclude content labels in addition to advertiser exclusions, but can't |
| # override them. A line item won't serve if all the digital content labels |
| # are excluded. |
| # populated in the details field of an AssignedTargetingOption when |
| # targeting_type is |
| # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. |
| "excludedTargetingOptionId": "A String", # Required. ID of the digital content label to be EXCLUDED. |
| "contentRatingTier": "A String", # Output only. The display name of the digital content label rating tier. |
| }, |
| "browserDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_BROWSER`. |
| "displayName": "A String", # Output only. The display name of the browser. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser |
| # targeting options on the same line item must have the same value for this |
| # field. |
| }, |
| "appCategoryDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_APP_CATEGORY`. |
| "displayName": "A String", # Output only. The display name of the app category. |
| }, |
| "contentOutstreamPositionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. |
| "contentOutstreamPosition": "A String", # Output only. The content outstream position. |
| }, |
| "negativeKeywordListDetails": { # 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`. |
| "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the |
| # negative_keyword_list_id |
| # field of a NegativeKeywordList resource. |
| }, |
| "genderDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_GENDER`. |
| "gender": "A String", # Output only. The gender of the audience. |
| }, |
| "name": "A String", # Output only. The resource name for this assigned targeting option. |
| "inventorySourceDetails": { # 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`. |
| "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the |
| # inventory_source_id field of an |
| # InventorySource resource. |
| }, |
| "sensitiveCategoryExclusionDetails": { # 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't visible in line item settings). Line item settings can |
| # exclude sensitive categories in addition to advertiser exclusions, but |
| # can't override them. |
| # details field of an AssignedTargetingOption when |
| # targeting_type is |
| # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. |
| "excludedTargetingOptionId": "A String", # Required. ID of the sensitive category to be EXCLUDED. |
| "sensitiveCategory": "A String", # Output only. An enum for the DV360 Sensitive category content classifier. |
| }, |
| "audienceGroupDetails": { # 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'ed with other |
| # groups. |
| "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first |
| # and third party audience groups. Each first and third party audience group |
| # contains first and third party audience ids only. |
| # The relation between each first and third party audience group is |
| # INTERSECTION, and the result is UNION'ed with other audience groups. |
| # Repeated groups with same settings will be ignored. |
| { # Details of first and third party audience group. |
| # All first and third party audience targeting settings are logically ‘OR’ of |
| # each other. |
| "settings": [ # Required. All first and third party audience targeting settings in first and |
| # third party audience group. |
| # Repeated settings with same id are not allowed. |
| { # Details of first and third party audience targeting setting. |
| "recency": "A String", # The recency of the first and third party audience targeting setting. |
| # Only applicable to first party audiences, otherwise |
| # will be ignored. For more info, refer to |
| # https://support.google.com/displayvideo/answer/2949947#recency |
| # When unspecified, no recency limit will be used. |
| "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience |
| # targeting setting. This id is |
| # first_and_third_party_audience_id. |
| }, |
| ], |
| }, |
| ], |
| "includedCombinedAudienceGroup": { # 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. |
| "settings": [ # Required. All combined audience targeting settings in combined audience group. |
| # Repeated settings with same id will be ignored. |
| # The number of combined audience settings should be no more than five, error |
| # will be thrown otherwise. |
| { # Details of combined audience targeting setting. |
| "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. |
| # This id is combined_audience_id. |
| }, |
| ], |
| }, |
| "includedCustomListGroup": { # 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. |
| "settings": [ # Required. All custom list targeting settings in custom list group. |
| # Repeated settings with same id will be ignored. |
| { # Details of custom list targeting setting. |
| "customListId": "A String", # Required. Custom id of custom list targeting setting. |
| # This id is custom_list_id. |
| }, |
| ], |
| }, |
| "excludedFirstAndThirdPartyAudienceGroup": { # 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. |
| "settings": [ # Required. All first and third party audience targeting settings in first and |
| # third party audience group. |
| # Repeated settings with same id are not allowed. |
| { # Details of first and third party audience targeting setting. |
| "recency": "A String", # The recency of the first and third party audience targeting setting. |
| # Only applicable to first party audiences, otherwise |
| # will be ignored. For more info, refer to |
| # https://support.google.com/displayvideo/answer/2949947#recency |
| # When unspecified, no recency limit will be used. |
| "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience |
| # targeting setting. This id is |
| # first_and_third_party_audience_id. |
| }, |
| ], |
| }, |
| "includedGoogleAudienceGroup": { # 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. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. |
| # Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. |
| # This id is google_audience_id. |
| }, |
| ], |
| }, |
| "excludedGoogleAudienceGroup": { # Details of Google audience group. # The Google audience ids of the excluded Google audience group. |
| # Used for negative targeting. It's COMPLEMENT is used to UNION other |
| # audience groups. |
| # Only contains Affinity, In-market and Installed-apps type Google audiences. |
| # All items are logically ‘OR’ of each other. |
| # All Google audience targeting settings are logically ‘OR’ of each other. |
| "settings": [ # Required. All Google audience targeting settings in Google audience group. |
| # Repeated settings with same id will be ignored. |
| { # Details of Google audience targeting setting. |
| "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. |
| # This id is google_audience_id. |
| }, |
| ], |
| }, |
| }, |
| "userRewardedContentDetails": { # 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`. |
| "userRewardedContent": "A String", # Output only. User rewarded content status for video ads. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| }, |
| "languageDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_LANGUAGE`. |
| "displayName": "A String", # Output only. The display name of the language (e.g., "French"). |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned |
| # language targeting options on the same line item must have the same value |
| # for this field. |
| }, |
| "authorizedSellerStatusDetails": { # 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'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`. |
| "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. |
| }, |
| "dayAndTimeDetails": { # 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`. |
| "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. |
| "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) |
| # and 23 (1 hour before end of day). |
| "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after |
| # start of day) and 24 (end of day). |
| "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time |
| # targeting setting. |
| }, |
| "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option. |
| "environmentDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" |
| # for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option). |
| "environment": "A String", # Output only. The serving environment. |
| }, |
| "geoRegionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_GEO_REGION`. |
| "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| "geoRegionType": "A String", # Output only. The type of geographic region targeting. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "deviceTypeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. ID of the device type. |
| "deviceType": "A String", # Output only. The display name of the device type. |
| }, |
| "exchangeDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_EXCHANGE`. |
| }, |
| "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique |
| # within a given line item and targeting type. It may be reused in other |
| # contexts. |
| "householdIncomeDetails": { # 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`. |
| "householdIncome": "A String", # Output only. The household income of the audience. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. |
| }, |
| "contentInstreamPositionDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. |
| "contentInstreamPosition": "A String", # Output only. The content instream position for video or audio ads. |
| }, |
| "categoryDetails": { # 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`. |
| "targetingOptionId": "A String", # Required. The targeting_option_id field when |
| # targeting_type is |
| # `TARGETING_TYPE_CATEGORY`. |
| "displayName": "A String", # Output only. The display name of the category. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "inventorySourceGroupDetails": { # 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`. |
| "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the |
| # inventory_source_group_id |
| # field of an InventorySourceGroup resource. |
| }, |
| "regionalLocationListDetails": { # 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`. |
| "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the |
| # location_list_id field of a |
| # LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. |
| }, |
| "carrierAndIspDetails": { # 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`. |
| "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier |
| # and ISP targeting options on the same line item must have the same value |
| # for this field. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. |
| "displayName": "A String", # Output only. The display name of the carrier or ISP. |
| }, |
| "viewabilityDetails": { # 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`. |
| "viewability": "A String", # Output only. The predicted viewability percentage. |
| "targetingOptionId": "A String", # Required. The targeting_option_id of a |
| # TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" |
| # for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option). |
| }, |
| }, |
| ], |
| }</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 'execute()' 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. |
| "frequencyCap": { # 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. |
| "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| # `true`, the remaining frequency cap fields are not applicable. |
| "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| # during this period. Must be greater than 0. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| # last. |
| # |
| # Applicable when unlimited is `false`. |
| # The following restrictions apply based on the value of |
| # time_unit: |
| # |
| # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| # default to 1 |
| # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| }, |
| "displayName": "A String", # Required. The display name of the line item. |
| # |
| # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "partnerCosts": [ # The partner costs associated with the line item. |
| # |
| # If absent or empty in CreateLineItem |
| # method, the newly created line item will inherit partner costs from its |
| # parent insertion order. |
| { # 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. |
| "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| # |
| # For example, for 1.5 standard unit of the advertiser's currency, set |
| # this field to 1500000. |
| "costType": "A String", # Required. The type of the partner cost. |
| "feeType": "A String", # Required. The fee type for this partner cost. |
| "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| # |
| # For example: 100 represents 0.1%. |
| "invoiceType": "A String", # The invoice type for this partner cost. |
| # |
| # * Required when cost_type is one of: |
| # - `PARTNER_COST_TYPE_ADLOOX` |
| # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| # * Output only for other types. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. |
| "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. |
| "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. |
| "budgetAllocationType": "A String", # Required. The type of the budget allocation. |
| # |
| # `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when |
| # automatic budget allocation is enabled for the parent insertion order. |
| "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based |
| # or impression based. This value is inherited from the parent insertion |
| # order. |
| "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. |
| # |
| # When budget_allocation_type is: |
| # |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable |
| # and is set by the system. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if |
| # budget_unit is: |
| # - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount |
| # to spend, in micros of the advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number |
| # of impressions to serve. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not |
| # applicable and will be ignored by the system. |
| }, |
| "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight. |
| "flightDateType": "A String", # Required. The type of the line item's flight dates. |
| "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved |
| # relative to the parent advertiser's time zone. |
| # |
| # * Required when |
| # flight_date_type is |
| # `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. |
| # * When creating a new flight, both `start_date` and `end_date` must be in |
| # the future. |
| # * An existing flight with a `start_date` in the past has a mutable |
| # `end_date` but an immutable `start_date`. |
| # * `end_date` must be the `start_date` or later, both before the year 2037. |
| "endDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| "startDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| }, |
| }, |
| "inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item. |
| "A String", |
| ], |
| "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. |
| "markupType": "A String", # Required. The markup type of the partner revenue model. |
| "markupAmount": "A String", # Required. The markup amount of the partner revenue model. |
| # Must be greater than or equal to 0. |
| # |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM |
| # markup in micros of advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field |
| # represents the media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field |
| # represents the total media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| }, |
| "lineItemType": "A String", # Required. Immutable. The type of the line item. |
| "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and |
| # bid on inventory. |
| # |
| # * For CreateLineItem method, only |
| # `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use |
| # UpdateLineItem method and update the |
| # status to `ENTITY_STATUS_ACTIVE` after creation. |
| # * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from |
| # any other status. |
| # * If the line item's parent insertion order is not active, the line item |
| # can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. |
| "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. |
| "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| # |
| # When automatic budget allocation is enabled at the insertion order via |
| # auto_budget_allocation, this |
| # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| # spent across the pacing_period. |
| "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| # |
| # Applicable when the budget is impression based. Must be greater than 0. |
| "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| # advertiser's currency. |
| # |
| # Applicable when the budget is currency based. Must be greater than 0. |
| # For example, for 1.5 standard unit of the currency, set this field to |
| # 1500000. |
| # |
| # The value assigned will be rounded to whole billable units for the |
| # relevant currency by the following rules: any positive value less than a |
| # single billable unit will be rounded up to one billable unit and any |
| # value larger than a single billable unit will be rounded down to the |
| # nearest billable value. For example, if the currency's billable unit is |
| # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| # 0.01. |
| }, |
| "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system. |
| "name": "A String", # Output only. The resource name of the line item. |
| "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. |
| "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. |
| "integrationDetails": { # Integration details of an entry. # Integration details of the line item. |
| "details": "A String", # Additional details of the entry in string format. |
| # |
| # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| "integrationCode": "A String", # An external identifier to be associated with the entry. |
| # The integration code will show up together with the entry in many |
| # places in the system, for example, reporting. |
| # |
| # Must be UTF-8 encoded with a length of no more than 500 characters. |
| }, |
| "creativeIds": [ # The IDs of the creatives associated with the line item. |
| "A String", |
| ], |
| "conversionCounting": { # 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. |
| "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. |
| # |
| # The number of conversions counted is the sum of all of the conversions |
| # counted by all of the Floodlight activity IDs specified in this field. |
| { # Settings that control the behavior of a single Floodlight activity config. |
| "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. |
| "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| }, |
| ], |
| "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a |
| # percent). Must be between 0 and 100000 inclusive. |
| # |
| # For example, to track 50% of the post-click conversions, set a value of |
| # 50000. |
| }, |
| "bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item. |
| # Bid strategy determines the bid price. |
| "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| # For insertion order entity, |
| # bid_amount_micros should be set as 0. |
| # For line item entity, |
| # bid_amount_micros must be greater |
| # than or equal to billable unit of the given currency and smaller than or |
| # equal to the upper limit 1000000000. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "maximizeSpendAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # tries to minimize while spending the full budget. |
| # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| # this strategy. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "performanceGoalAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # will try to meet or beat. |
| # |
| # For line item level usage, the value must be one of: |
| # |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. Not applicable when |
| # performance_goal_type |
| # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| # meet or beat, in micros of the advertiser's currency. |
| # Must be greater than or equal to a billable unit of the given currency and |
| # smaller or equal to upper bounds. Each |
| # performance_goal_type |
| # has its upper bound: |
| # |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| # upper bound is 10000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| # upper bound is 1000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| # 1000.00 USD. |
| # |
| # 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. |
| "frequencyCap": { # 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. |
| "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| # `true`, the remaining frequency cap fields are not applicable. |
| "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| # during this period. Must be greater than 0. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| # last. |
| # |
| # Applicable when unlimited is `false`. |
| # The following restrictions apply based on the value of |
| # time_unit: |
| # |
| # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| # default to 1 |
| # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| }, |
| "displayName": "A String", # Required. The display name of the line item. |
| # |
| # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "partnerCosts": [ # The partner costs associated with the line item. |
| # |
| # If absent or empty in CreateLineItem |
| # method, the newly created line item will inherit partner costs from its |
| # parent insertion order. |
| { # 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. |
| "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| # |
| # For example, for 1.5 standard unit of the advertiser's currency, set |
| # this field to 1500000. |
| "costType": "A String", # Required. The type of the partner cost. |
| "feeType": "A String", # Required. The fee type for this partner cost. |
| "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| # |
| # For example: 100 represents 0.1%. |
| "invoiceType": "A String", # The invoice type for this partner cost. |
| # |
| # * Required when cost_type is one of: |
| # - `PARTNER_COST_TYPE_ADLOOX` |
| # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| # * Output only for other types. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. |
| "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. |
| "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. |
| "budgetAllocationType": "A String", # Required. The type of the budget allocation. |
| # |
| # `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when |
| # automatic budget allocation is enabled for the parent insertion order. |
| "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based |
| # or impression based. This value is inherited from the parent insertion |
| # order. |
| "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. |
| # |
| # When budget_allocation_type is: |
| # |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable |
| # and is set by the system. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if |
| # budget_unit is: |
| # - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount |
| # to spend, in micros of the advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number |
| # of impressions to serve. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not |
| # applicable and will be ignored by the system. |
| }, |
| "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight. |
| "flightDateType": "A String", # Required. The type of the line item's flight dates. |
| "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved |
| # relative to the parent advertiser's time zone. |
| # |
| # * Required when |
| # flight_date_type is |
| # `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. |
| # * When creating a new flight, both `start_date` and `end_date` must be in |
| # the future. |
| # * An existing flight with a `start_date` in the past has a mutable |
| # `end_date` but an immutable `start_date`. |
| # * `end_date` must be the `start_date` or later, both before the year 2037. |
| "endDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| "startDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| }, |
| }, |
| "inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item. |
| "A String", |
| ], |
| "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. |
| "markupType": "A String", # Required. The markup type of the partner revenue model. |
| "markupAmount": "A String", # Required. The markup amount of the partner revenue model. |
| # Must be greater than or equal to 0. |
| # |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM |
| # markup in micros of advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field |
| # represents the media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field |
| # represents the total media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| }, |
| "lineItemType": "A String", # Required. Immutable. The type of the line item. |
| "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and |
| # bid on inventory. |
| # |
| # * For CreateLineItem method, only |
| # `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use |
| # UpdateLineItem method and update the |
| # status to `ENTITY_STATUS_ACTIVE` after creation. |
| # * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from |
| # any other status. |
| # * If the line item's parent insertion order is not active, the line item |
| # can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. |
| "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. |
| "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| # |
| # When automatic budget allocation is enabled at the insertion order via |
| # auto_budget_allocation, this |
| # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| # spent across the pacing_period. |
| "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| # |
| # Applicable when the budget is impression based. Must be greater than 0. |
| "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| # advertiser's currency. |
| # |
| # Applicable when the budget is currency based. Must be greater than 0. |
| # For example, for 1.5 standard unit of the currency, set this field to |
| # 1500000. |
| # |
| # The value assigned will be rounded to whole billable units for the |
| # relevant currency by the following rules: any positive value less than a |
| # single billable unit will be rounded up to one billable unit and any |
| # value larger than a single billable unit will be rounded down to the |
| # nearest billable value. For example, if the currency's billable unit is |
| # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| # 0.01. |
| }, |
| "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system. |
| "name": "A String", # Output only. The resource name of the line item. |
| "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. |
| "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. |
| "integrationDetails": { # Integration details of an entry. # Integration details of the line item. |
| "details": "A String", # Additional details of the entry in string format. |
| # |
| # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| "integrationCode": "A String", # An external identifier to be associated with the entry. |
| # The integration code will show up together with the entry in many |
| # places in the system, for example, reporting. |
| # |
| # Must be UTF-8 encoded with a length of no more than 500 characters. |
| }, |
| "creativeIds": [ # The IDs of the creatives associated with the line item. |
| "A String", |
| ], |
| "conversionCounting": { # 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. |
| "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. |
| # |
| # The number of conversions counted is the sum of all of the conversions |
| # counted by all of the Floodlight activity IDs specified in this field. |
| { # Settings that control the behavior of a single Floodlight activity config. |
| "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. |
| "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| }, |
| ], |
| "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a |
| # percent). Must be between 0 and 100000 inclusive. |
| # |
| # For example, to track 50% of the post-click conversions, set a value of |
| # 50000. |
| }, |
| "bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item. |
| # Bid strategy determines the bid price. |
| "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| # For insertion order entity, |
| # bid_amount_micros should be set as 0. |
| # For line item entity, |
| # bid_amount_micros must be greater |
| # than or equal to billable unit of the given currency and smaller than or |
| # equal to the upper limit 1000000000. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "maximizeSpendAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # tries to minimize while spending the full budget. |
| # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| # this strategy. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "performanceGoalAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # will try to meet or beat. |
| # |
| # For line item level usage, the value must be one of: |
| # |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. Not applicable when |
| # performance_goal_type |
| # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| # meet or beat, in micros of the advertiser's currency. |
| # Must be greater than or equal to a billable unit of the given currency and |
| # smaller or equal to upper bounds. Each |
| # performance_goal_type |
| # has its upper bound: |
| # |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| # upper bound is 10000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| # upper bound is 1000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| # 1000.00 USD. |
| # |
| # 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. |
| "frequencyCap": { # 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. |
| "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| # `true`, the remaining frequency cap fields are not applicable. |
| "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| # during this period. Must be greater than 0. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| # last. |
| # |
| # Applicable when unlimited is `false`. |
| # The following restrictions apply based on the value of |
| # time_unit: |
| # |
| # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| # default to 1 |
| # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| }, |
| "displayName": "A String", # Required. The display name of the line item. |
| # |
| # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "partnerCosts": [ # The partner costs associated with the line item. |
| # |
| # If absent or empty in CreateLineItem |
| # method, the newly created line item will inherit partner costs from its |
| # parent insertion order. |
| { # 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. |
| "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| # |
| # For example, for 1.5 standard unit of the advertiser's currency, set |
| # this field to 1500000. |
| "costType": "A String", # Required. The type of the partner cost. |
| "feeType": "A String", # Required. The fee type for this partner cost. |
| "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| # |
| # For example: 100 represents 0.1%. |
| "invoiceType": "A String", # The invoice type for this partner cost. |
| # |
| # * Required when cost_type is one of: |
| # - `PARTNER_COST_TYPE_ADLOOX` |
| # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| # * Output only for other types. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. |
| "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. |
| "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. |
| "budgetAllocationType": "A String", # Required. The type of the budget allocation. |
| # |
| # `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when |
| # automatic budget allocation is enabled for the parent insertion order. |
| "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based |
| # or impression based. This value is inherited from the parent insertion |
| # order. |
| "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. |
| # |
| # When budget_allocation_type is: |
| # |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable |
| # and is set by the system. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if |
| # budget_unit is: |
| # - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount |
| # to spend, in micros of the advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number |
| # of impressions to serve. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not |
| # applicable and will be ignored by the system. |
| }, |
| "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight. |
| "flightDateType": "A String", # Required. The type of the line item's flight dates. |
| "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved |
| # relative to the parent advertiser's time zone. |
| # |
| # * Required when |
| # flight_date_type is |
| # `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. |
| # * When creating a new flight, both `start_date` and `end_date` must be in |
| # the future. |
| # * An existing flight with a `start_date` in the past has a mutable |
| # `end_date` but an immutable `start_date`. |
| # * `end_date` must be the `start_date` or later, both before the year 2037. |
| "endDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| "startDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| }, |
| }, |
| "inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item. |
| "A String", |
| ], |
| "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. |
| "markupType": "A String", # Required. The markup type of the partner revenue model. |
| "markupAmount": "A String", # Required. The markup amount of the partner revenue model. |
| # Must be greater than or equal to 0. |
| # |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM |
| # markup in micros of advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field |
| # represents the media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field |
| # represents the total media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| }, |
| "lineItemType": "A String", # Required. Immutable. The type of the line item. |
| "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and |
| # bid on inventory. |
| # |
| # * For CreateLineItem method, only |
| # `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use |
| # UpdateLineItem method and update the |
| # status to `ENTITY_STATUS_ACTIVE` after creation. |
| # * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from |
| # any other status. |
| # * If the line item's parent insertion order is not active, the line item |
| # can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. |
| "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. |
| "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| # |
| # When automatic budget allocation is enabled at the insertion order via |
| # auto_budget_allocation, this |
| # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| # spent across the pacing_period. |
| "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| # |
| # Applicable when the budget is impression based. Must be greater than 0. |
| "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| # advertiser's currency. |
| # |
| # Applicable when the budget is currency based. Must be greater than 0. |
| # For example, for 1.5 standard unit of the currency, set this field to |
| # 1500000. |
| # |
| # The value assigned will be rounded to whole billable units for the |
| # relevant currency by the following rules: any positive value less than a |
| # single billable unit will be rounded up to one billable unit and any |
| # value larger than a single billable unit will be rounded down to the |
| # nearest billable value. For example, if the currency's billable unit is |
| # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| # 0.01. |
| }, |
| "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system. |
| "name": "A String", # Output only. The resource name of the line item. |
| "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. |
| "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. |
| "integrationDetails": { # Integration details of an entry. # Integration details of the line item. |
| "details": "A String", # Additional details of the entry in string format. |
| # |
| # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| "integrationCode": "A String", # An external identifier to be associated with the entry. |
| # The integration code will show up together with the entry in many |
| # places in the system, for example, reporting. |
| # |
| # Must be UTF-8 encoded with a length of no more than 500 characters. |
| }, |
| "creativeIds": [ # The IDs of the creatives associated with the line item. |
| "A String", |
| ], |
| "conversionCounting": { # 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. |
| "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. |
| # |
| # The number of conversions counted is the sum of all of the conversions |
| # counted by all of the Floodlight activity IDs specified in this field. |
| { # Settings that control the behavior of a single Floodlight activity config. |
| "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. |
| "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| }, |
| ], |
| "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a |
| # percent). Must be between 0 and 100000 inclusive. |
| # |
| # For example, to track 50% of the post-click conversions, set a value of |
| # 50000. |
| }, |
| "bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item. |
| # Bid strategy determines the bid price. |
| "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| # For insertion order entity, |
| # bid_amount_micros should be set as 0. |
| # For line item entity, |
| # bid_amount_micros must be greater |
| # than or equal to billable unit of the given currency and smaller than or |
| # equal to the upper limit 1000000000. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "maximizeSpendAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # tries to minimize while spending the full budget. |
| # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| # this strategy. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "performanceGoalAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # will try to meet or beat. |
| # |
| # For line item level usage, the value must be one of: |
| # |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. Not applicable when |
| # performance_goal_type |
| # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| # meet or beat, in micros of the advertiser's currency. |
| # Must be greater than or equal to a billable unit of the given currency and |
| # smaller or equal to upper bounds. Each |
| # performance_goal_type |
| # has its upper bound: |
| # |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| # upper bound is 10000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| # upper bound is 1000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| # 1000.00 USD. |
| # |
| # 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: |
| |
| * "displayName" (default) |
| * "entityStatus" |
| |
| The default sorting order is ascending. To specify descending order for |
| a field, a suffix "desc" should be added to the field name. Example: |
| `displayName desc`. |
| 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="1234"` |
| * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` |
| and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: |
| `(entityStatus="ENTITY_STATUS_ACTIVE" OR |
| entityStatus="ENTITY_STATUS_PAUSED") AND |
| lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` |
| |
| 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: |
| |
| { |
| "lineItems": [ # The list of line items. |
| # |
| # This list will be absent if empty. |
| { # A single line item. |
| "frequencyCap": { # 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. |
| "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| # `true`, the remaining frequency cap fields are not applicable. |
| "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| # during this period. Must be greater than 0. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| # last. |
| # |
| # Applicable when unlimited is `false`. |
| # The following restrictions apply based on the value of |
| # time_unit: |
| # |
| # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| # default to 1 |
| # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| }, |
| "displayName": "A String", # Required. The display name of the line item. |
| # |
| # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "partnerCosts": [ # The partner costs associated with the line item. |
| # |
| # If absent or empty in CreateLineItem |
| # method, the newly created line item will inherit partner costs from its |
| # parent insertion order. |
| { # 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. |
| "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| # |
| # For example, for 1.5 standard unit of the advertiser's currency, set |
| # this field to 1500000. |
| "costType": "A String", # Required. The type of the partner cost. |
| "feeType": "A String", # Required. The fee type for this partner cost. |
| "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| # |
| # For example: 100 represents 0.1%. |
| "invoiceType": "A String", # The invoice type for this partner cost. |
| # |
| # * Required when cost_type is one of: |
| # - `PARTNER_COST_TYPE_ADLOOX` |
| # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| # * Output only for other types. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. |
| "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. |
| "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. |
| "budgetAllocationType": "A String", # Required. The type of the budget allocation. |
| # |
| # `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when |
| # automatic budget allocation is enabled for the parent insertion order. |
| "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based |
| # or impression based. This value is inherited from the parent insertion |
| # order. |
| "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. |
| # |
| # When budget_allocation_type is: |
| # |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable |
| # and is set by the system. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if |
| # budget_unit is: |
| # - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount |
| # to spend, in micros of the advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number |
| # of impressions to serve. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not |
| # applicable and will be ignored by the system. |
| }, |
| "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight. |
| "flightDateType": "A String", # Required. The type of the line item's flight dates. |
| "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved |
| # relative to the parent advertiser's time zone. |
| # |
| # * Required when |
| # flight_date_type is |
| # `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. |
| # * When creating a new flight, both `start_date` and `end_date` must be in |
| # the future. |
| # * An existing flight with a `start_date` in the past has a mutable |
| # `end_date` but an immutable `start_date`. |
| # * `end_date` must be the `start_date` or later, both before the year 2037. |
| "endDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| "startDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| }, |
| }, |
| "inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item. |
| "A String", |
| ], |
| "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. |
| "markupType": "A String", # Required. The markup type of the partner revenue model. |
| "markupAmount": "A String", # Required. The markup amount of the partner revenue model. |
| # Must be greater than or equal to 0. |
| # |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM |
| # markup in micros of advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field |
| # represents the media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field |
| # represents the total media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| }, |
| "lineItemType": "A String", # Required. Immutable. The type of the line item. |
| "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and |
| # bid on inventory. |
| # |
| # * For CreateLineItem method, only |
| # `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use |
| # UpdateLineItem method and update the |
| # status to `ENTITY_STATUS_ACTIVE` after creation. |
| # * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from |
| # any other status. |
| # * If the line item's parent insertion order is not active, the line item |
| # can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. |
| "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. |
| "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| # |
| # When automatic budget allocation is enabled at the insertion order via |
| # auto_budget_allocation, this |
| # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| # spent across the pacing_period. |
| "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| # |
| # Applicable when the budget is impression based. Must be greater than 0. |
| "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| # advertiser's currency. |
| # |
| # Applicable when the budget is currency based. Must be greater than 0. |
| # For example, for 1.5 standard unit of the currency, set this field to |
| # 1500000. |
| # |
| # The value assigned will be rounded to whole billable units for the |
| # relevant currency by the following rules: any positive value less than a |
| # single billable unit will be rounded up to one billable unit and any |
| # value larger than a single billable unit will be rounded down to the |
| # nearest billable value. For example, if the currency's billable unit is |
| # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| # 0.01. |
| }, |
| "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system. |
| "name": "A String", # Output only. The resource name of the line item. |
| "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. |
| "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. |
| "integrationDetails": { # Integration details of an entry. # Integration details of the line item. |
| "details": "A String", # Additional details of the entry in string format. |
| # |
| # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| "integrationCode": "A String", # An external identifier to be associated with the entry. |
| # The integration code will show up together with the entry in many |
| # places in the system, for example, reporting. |
| # |
| # Must be UTF-8 encoded with a length of no more than 500 characters. |
| }, |
| "creativeIds": [ # The IDs of the creatives associated with the line item. |
| "A String", |
| ], |
| "conversionCounting": { # 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. |
| "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. |
| # |
| # The number of conversions counted is the sum of all of the conversions |
| # counted by all of the Floodlight activity IDs specified in this field. |
| { # Settings that control the behavior of a single Floodlight activity config. |
| "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. |
| "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| }, |
| ], |
| "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a |
| # percent). Must be between 0 and 100000 inclusive. |
| # |
| # For example, to track 50% of the post-click conversions, set a value of |
| # 50000. |
| }, |
| "bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item. |
| # Bid strategy determines the bid price. |
| "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| # For insertion order entity, |
| # bid_amount_micros should be set as 0. |
| # For line item entity, |
| # bid_amount_micros must be greater |
| # than or equal to billable unit of the given currency and smaller than or |
| # equal to the upper limit 1000000000. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "maximizeSpendAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # tries to minimize while spending the full budget. |
| # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| # this strategy. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "performanceGoalAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # will try to meet or beat. |
| # |
| # For line item level usage, the value must be one of: |
| # |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. Not applicable when |
| # performance_goal_type |
| # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| # meet or beat, in micros of the advertiser's currency. |
| # Must be greater than or equal to a billable unit of the given currency and |
| # smaller or equal to upper bounds. Each |
| # performance_goal_type |
| # has its upper bound: |
| # |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| # upper bound is 10000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| # upper bound is 1000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| # 1000.00 USD. |
| # |
| # 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. |
| }, |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # A token to retrieve the next page of results. |
| # Pass this value in the |
| # page_token |
| # field in the subsequent call to `ListLineItems` method to retrieve the |
| # next page of results. |
| }</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 'execute()' 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. |
| "frequencyCap": { # 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. |
| "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| # `true`, the remaining frequency cap fields are not applicable. |
| "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| # during this period. Must be greater than 0. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| # last. |
| # |
| # Applicable when unlimited is `false`. |
| # The following restrictions apply based on the value of |
| # time_unit: |
| # |
| # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| # default to 1 |
| # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| }, |
| "displayName": "A String", # Required. The display name of the line item. |
| # |
| # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "partnerCosts": [ # The partner costs associated with the line item. |
| # |
| # If absent or empty in CreateLineItem |
| # method, the newly created line item will inherit partner costs from its |
| # parent insertion order. |
| { # 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. |
| "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| # |
| # For example, for 1.5 standard unit of the advertiser's currency, set |
| # this field to 1500000. |
| "costType": "A String", # Required. The type of the partner cost. |
| "feeType": "A String", # Required. The fee type for this partner cost. |
| "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| # |
| # For example: 100 represents 0.1%. |
| "invoiceType": "A String", # The invoice type for this partner cost. |
| # |
| # * Required when cost_type is one of: |
| # - `PARTNER_COST_TYPE_ADLOOX` |
| # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| # * Output only for other types. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. |
| "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. |
| "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. |
| "budgetAllocationType": "A String", # Required. The type of the budget allocation. |
| # |
| # `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when |
| # automatic budget allocation is enabled for the parent insertion order. |
| "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based |
| # or impression based. This value is inherited from the parent insertion |
| # order. |
| "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. |
| # |
| # When budget_allocation_type is: |
| # |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable |
| # and is set by the system. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if |
| # budget_unit is: |
| # - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount |
| # to spend, in micros of the advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number |
| # of impressions to serve. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not |
| # applicable and will be ignored by the system. |
| }, |
| "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight. |
| "flightDateType": "A String", # Required. The type of the line item's flight dates. |
| "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved |
| # relative to the parent advertiser's time zone. |
| # |
| # * Required when |
| # flight_date_type is |
| # `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. |
| # * When creating a new flight, both `start_date` and `end_date` must be in |
| # the future. |
| # * An existing flight with a `start_date` in the past has a mutable |
| # `end_date` but an immutable `start_date`. |
| # * `end_date` must be the `start_date` or later, both before the year 2037. |
| "endDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| "startDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| }, |
| }, |
| "inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item. |
| "A String", |
| ], |
| "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. |
| "markupType": "A String", # Required. The markup type of the partner revenue model. |
| "markupAmount": "A String", # Required. The markup amount of the partner revenue model. |
| # Must be greater than or equal to 0. |
| # |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM |
| # markup in micros of advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field |
| # represents the media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field |
| # represents the total media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| }, |
| "lineItemType": "A String", # Required. Immutable. The type of the line item. |
| "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and |
| # bid on inventory. |
| # |
| # * For CreateLineItem method, only |
| # `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use |
| # UpdateLineItem method and update the |
| # status to `ENTITY_STATUS_ACTIVE` after creation. |
| # * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from |
| # any other status. |
| # * If the line item's parent insertion order is not active, the line item |
| # can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. |
| "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. |
| "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| # |
| # When automatic budget allocation is enabled at the insertion order via |
| # auto_budget_allocation, this |
| # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| # spent across the pacing_period. |
| "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| # |
| # Applicable when the budget is impression based. Must be greater than 0. |
| "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| # advertiser's currency. |
| # |
| # Applicable when the budget is currency based. Must be greater than 0. |
| # For example, for 1.5 standard unit of the currency, set this field to |
| # 1500000. |
| # |
| # The value assigned will be rounded to whole billable units for the |
| # relevant currency by the following rules: any positive value less than a |
| # single billable unit will be rounded up to one billable unit and any |
| # value larger than a single billable unit will be rounded down to the |
| # nearest billable value. For example, if the currency's billable unit is |
| # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| # 0.01. |
| }, |
| "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system. |
| "name": "A String", # Output only. The resource name of the line item. |
| "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. |
| "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. |
| "integrationDetails": { # Integration details of an entry. # Integration details of the line item. |
| "details": "A String", # Additional details of the entry in string format. |
| # |
| # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| "integrationCode": "A String", # An external identifier to be associated with the entry. |
| # The integration code will show up together with the entry in many |
| # places in the system, for example, reporting. |
| # |
| # Must be UTF-8 encoded with a length of no more than 500 characters. |
| }, |
| "creativeIds": [ # The IDs of the creatives associated with the line item. |
| "A String", |
| ], |
| "conversionCounting": { # 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. |
| "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. |
| # |
| # The number of conversions counted is the sum of all of the conversions |
| # counted by all of the Floodlight activity IDs specified in this field. |
| { # Settings that control the behavior of a single Floodlight activity config. |
| "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. |
| "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| }, |
| ], |
| "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a |
| # percent). Must be between 0 and 100000 inclusive. |
| # |
| # For example, to track 50% of the post-click conversions, set a value of |
| # 50000. |
| }, |
| "bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item. |
| # Bid strategy determines the bid price. |
| "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| # For insertion order entity, |
| # bid_amount_micros should be set as 0. |
| # For line item entity, |
| # bid_amount_micros must be greater |
| # than or equal to billable unit of the given currency and smaller than or |
| # equal to the upper limit 1000000000. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "maximizeSpendAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # tries to minimize while spending the full budget. |
| # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| # this strategy. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "performanceGoalAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # will try to meet or beat. |
| # |
| # For line item level usage, the value must be one of: |
| # |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. Not applicable when |
| # performance_goal_type |
| # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| # meet or beat, in micros of the advertiser's currency. |
| # Must be greater than or equal to a billable unit of the given currency and |
| # smaller or equal to upper bounds. Each |
| # performance_goal_type |
| # has its upper bound: |
| # |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| # upper bound is 10000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| # upper bound is 1000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| # 1000.00 USD. |
| # |
| # 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. |
| "frequencyCap": { # 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. |
| "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| # `true`, the remaining frequency cap fields are not applicable. |
| "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| # during this period. Must be greater than 0. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| # |
| # Applicable when unlimited is `false`. |
| "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| # last. |
| # |
| # Applicable when unlimited is `false`. |
| # The following restrictions apply based on the value of |
| # time_unit: |
| # |
| # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| # default to 1 |
| # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| }, |
| "displayName": "A String", # Required. The display name of the line item. |
| # |
| # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "partnerCosts": [ # The partner costs associated with the line item. |
| # |
| # If absent or empty in CreateLineItem |
| # method, the newly created line item will inherit partner costs from its |
| # parent insertion order. |
| { # 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. |
| "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| # |
| # For example, for 1.5 standard unit of the advertiser's currency, set |
| # this field to 1500000. |
| "costType": "A String", # Required. The type of the partner cost. |
| "feeType": "A String", # Required. The fee type for this partner cost. |
| "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| # |
| # Applicable when the fee_type is |
| # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| # |
| # For example: 100 represents 0.1%. |
| "invoiceType": "A String", # The invoice type for this partner cost. |
| # |
| # * Required when cost_type is one of: |
| # - `PARTNER_COST_TYPE_ADLOOX` |
| # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| # * Output only for other types. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. |
| "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. |
| "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. |
| "budgetAllocationType": "A String", # Required. The type of the budget allocation. |
| # |
| # `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when |
| # automatic budget allocation is enabled for the parent insertion order. |
| "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based |
| # or impression based. This value is inherited from the parent insertion |
| # order. |
| "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. |
| # |
| # When budget_allocation_type is: |
| # |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable |
| # and is set by the system. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if |
| # budget_unit is: |
| # - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount |
| # to spend, in micros of the advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number |
| # of impressions to serve. |
| # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not |
| # applicable and will be ignored by the system. |
| }, |
| "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight. |
| "flightDateType": "A String", # Required. The type of the line item's flight dates. |
| "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved |
| # relative to the parent advertiser's time zone. |
| # |
| # * Required when |
| # flight_date_type is |
| # `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. |
| # * When creating a new flight, both `start_date` and `end_date` must be in |
| # the future. |
| # * An existing flight with a `start_date` in the past has a mutable |
| # `end_date` but an immutable `start_date`. |
| # * `end_date` must be the `start_date` or later, both before the year 2037. |
| "endDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| "startDate": { # 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`. |
| "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| # a year. |
| "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| # if specifying a year by itself or a year and month where the day is not |
| # significant. |
| "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| # month and day. |
| }, |
| }, |
| }, |
| "inventorySourceIds": [ # The IDs of the private inventory sources assigned to the line item. |
| "A String", |
| ], |
| "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. |
| "markupType": "A String", # Required. The markup type of the partner revenue model. |
| "markupAmount": "A String", # Required. The markup amount of the partner revenue model. |
| # Must be greater than or equal to 0. |
| # |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM |
| # markup in micros of advertiser's currency. For example, 1500000 |
| # represents 1.5 standard units of the currency. |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field |
| # represents the media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| # * When the markup_type is set to be |
| # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field |
| # represents the total media cost percent markup in millis. For example, |
| # 100 represents 0.1% (decimal 0.001). |
| }, |
| "lineItemType": "A String", # Required. Immutable. The type of the line item. |
| "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and |
| # bid on inventory. |
| # |
| # * For CreateLineItem method, only |
| # `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use |
| # UpdateLineItem method and update the |
| # status to `ENTITY_STATUS_ACTIVE` after creation. |
| # * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from |
| # any other status. |
| # * If the line item's parent insertion order is not active, the line item |
| # can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. |
| "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. |
| "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| # |
| # When automatic budget allocation is enabled at the insertion order via |
| # auto_budget_allocation, this |
| # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| # spent across the pacing_period. |
| "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| # |
| # Applicable when the budget is impression based. Must be greater than 0. |
| "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| # advertiser's currency. |
| # |
| # Applicable when the budget is currency based. Must be greater than 0. |
| # For example, for 1.5 standard unit of the currency, set this field to |
| # 1500000. |
| # |
| # The value assigned will be rounded to whole billable units for the |
| # relevant currency by the following rules: any positive value less than a |
| # single billable unit will be rounded up to one billable unit and any |
| # value larger than a single billable unit will be rounded down to the |
| # nearest billable value. For example, if the currency's billable unit is |
| # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| # 0.01. |
| }, |
| "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system. |
| "name": "A String", # Output only. The resource name of the line item. |
| "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to. |
| "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to. |
| "integrationDetails": { # Integration details of an entry. # Integration details of the line item. |
| "details": "A String", # Additional details of the entry in string format. |
| # |
| # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| "integrationCode": "A String", # An external identifier to be associated with the entry. |
| # The integration code will show up together with the entry in many |
| # places in the system, for example, reporting. |
| # |
| # Must be UTF-8 encoded with a length of no more than 500 characters. |
| }, |
| "creativeIds": [ # The IDs of the creatives associated with the line item. |
| "A String", |
| ], |
| "conversionCounting": { # 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. |
| "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. |
| # |
| # The number of conversions counted is the sum of all of the conversions |
| # counted by all of the Floodlight activity IDs specified in this field. |
| { # Settings that control the behavior of a single Floodlight activity config. |
| "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity. |
| "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a |
| # conversion may be counted. |
| # Must be between 0 and 90 inclusive. |
| }, |
| ], |
| "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a |
| # percent). Must be between 0 and 100000 inclusive. |
| # |
| # For example, to track 50% of the post-click conversions, set a value of |
| # 50000. |
| }, |
| "bidStrategy": { # Settings that control the bid strategy. # Required. The bidding strategy of the line item. |
| # Bid strategy determines the bid price. |
| "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| # For insertion order entity, |
| # bid_amount_micros should be set as 0. |
| # For line item entity, |
| # bid_amount_micros must be greater |
| # than or equal to billable unit of the given currency and smaller than or |
| # equal to the upper limit 1000000000. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "maximizeSpendAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # tries to minimize while spending the full budget. |
| # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| # this strategy. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| }, |
| "performanceGoalAutoBid": { # 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. |
| "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| # will try to meet or beat. |
| # |
| # For line item level usage, the value must be one of: |
| # |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| # currency. Must be greater than or equal to a billable unit of the given |
| # currency. Not applicable when |
| # performance_goal_type |
| # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| # |
| # For example, 1500000 represents 1.5 standard units of the currency. |
| "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| # meet or beat, in micros of the advertiser's currency. |
| # Must be greater than or equal to a billable unit of the given currency and |
| # smaller or equal to upper bounds. Each |
| # performance_goal_type |
| # has its upper bound: |
| # |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| # upper bound is 10000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| # upper bound is 1000.00 USD. |
| # * when |
| # performance_goal_type |
| # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| # 1000.00 USD. |
| # |
| # 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> |