google-apis-displayvideo_v1 0.4.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8de1d9be1605a455bf547590d02fa833444ebd7fa461bb19203758517ce5f158
4
- data.tar.gz: f54023c145c1389f9152505f6422e39e7ae67c65b48fb15aea35e76e23e5cec2
3
+ metadata.gz: a4dc11ce04907f4c314bc9a398b1b798b839ead286f2380947b17d43a3a28114
4
+ data.tar.gz: '08848f5e54a1336004be9d975229ed0192b30926b87585dde4740238845b38c2'
5
5
  SHA512:
6
- metadata.gz: b8e14fc5a085a95751ab51a7f65a976bc871a5d992d16dfef14b68f50ddb19320f4eca3e50c542f8532efa2e62b98af54ddb022d1446595d8e7cfdeada6543c7
7
- data.tar.gz: de38e35e5a6ec34b489471ef8bfafbf8ab1a4169a7c24b1ff3bcb6a960b86118821f64ae74eb6d10f4614bc7c8da518f459151c0406d2af10e9d44d5acce51bd
6
+ metadata.gz: 0ec87434e69ae86c141083df96a1561743c91bb9a99ef9fbc5ce89947161a7510bb4ac76093df3d1cef4e64cafbf7d1780cb7c3484698a6e4e1bd2e3635cbac5
7
+ data.tar.gz: f23da662553e53a0555e4e2aeea8c5cadef88324559695484a884ef3a69b9c40a6b43404fd60cbb45a6d6ab377cea4ea447c8ff0c7a1b193452a99eb90943332
data/CHANGELOG.md CHANGED
@@ -1,5 +1,28 @@
1
1
  # Release history for google-apis-displayvideo_v1
2
2
 
3
+ ### v0.9.0 (2021-05-21)
4
+
5
+ * Regenerated from discovery document revision 20210520
6
+ * Unspecified changes
7
+
8
+ ### v0.8.0 (2021-04-23)
9
+
10
+ * Regenerated from discovery document revision 20210422
11
+
12
+ ### v0.7.0 (2021-03-23)
13
+
14
+ * Regenerated from discovery document revision 20210318
15
+
16
+ ### v0.6.0 (2021-03-16)
17
+
18
+ * Regenerated from discovery document revision 20210312
19
+ * Regenerated using generator version 0.2.0
20
+
21
+ ### v0.5.0 (2021-03-05)
22
+
23
+ * Regenerated from discovery document revision 20210304
24
+ * Unspecified changes
25
+
3
26
  ### v0.4.0 (2021-02-26)
4
27
 
5
28
  * Regenerated from discovery document revision 20210225
@@ -137,8 +137,9 @@ module Google
137
137
 
138
138
  # Required. Controls whether or not insertion orders and line items of the
139
139
  # advertiser can spend their budgets and bid on inventory. * Accepted values are
140
- # `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to
141
- # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days
140
+ # `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `
141
+ # ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `
142
+ # ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days
142
143
  # from when it was first scheduled for deletion.
143
144
  # Corresponds to the JSON property `entityStatus`
144
145
  # @return [String]
@@ -165,6 +166,16 @@ module Google
165
166
  # @return [Fixnum]
166
167
  attr_accessor :partner_id
167
168
 
169
+ # Whether integration with Mediaocean (Prisma) is enabled. By enabling this: On
170
+ # behalf of my company, I authorize Mediaocean (Prisma) to send budget segment
171
+ # plans to Google, and I authorize Google to send corresponding reporting and
172
+ # invoices from DV360 to Mediaocean for the purposes of budget planning, billing,
173
+ # and reconciliation for this advertiser.
174
+ # Corresponds to the JSON property `prismaEnabled`
175
+ # @return [Boolean]
176
+ attr_accessor :prisma_enabled
177
+ alias_method :prisma_enabled?, :prisma_enabled
178
+
168
179
  # Targeting settings related to ad serving of an advertiser.
169
180
  # Corresponds to the JSON property `servingConfig`
170
181
  # @return [Google::Apis::DisplayvideoV1::AdvertiserTargetingConfig]
@@ -192,6 +203,7 @@ module Google
192
203
  @integration_details = args[:integration_details] if args.key?(:integration_details)
193
204
  @name = args[:name] if args.key?(:name)
194
205
  @partner_id = args[:partner_id] if args.key?(:partner_id)
206
+ @prisma_enabled = args[:prisma_enabled] if args.key?(:prisma_enabled)
195
207
  @serving_config = args[:serving_config] if args.key?(:serving_config)
196
208
  @update_time = args[:update_time] if args.key?(:update_time)
197
209
  end
@@ -456,6 +468,13 @@ module Google
456
468
  # @return [String]
457
469
  attr_accessor :app_id
458
470
 
471
+ # Indicates the platform of the targeted app. If this field is not specified,
472
+ # the app platform will be assumed to be mobile (i.e., Android or iOS), and we
473
+ # will derive the appropriate mobile platform from the app ID.
474
+ # Corresponds to the JSON property `appPlatform`
475
+ # @return [String]
476
+ attr_accessor :app_platform
477
+
459
478
  # Output only. The display name of the app.
460
479
  # Corresponds to the JSON property `displayName`
461
480
  # @return [String]
@@ -474,6 +493,7 @@ module Google
474
493
  # Update properties of this object
475
494
  def update!(**args)
476
495
  @app_id = args[:app_id] if args.key?(:app_id)
496
+ @app_platform = args[:app_platform] if args.key?(:app_platform)
477
497
  @display_name = args[:display_name] if args.key?(:display_name)
478
498
  @negative = args[:negative] if args.key?(:negative)
479
499
  end
@@ -850,6 +870,15 @@ module Google
850
870
  # @return [String]
851
871
  attr_accessor :name
852
872
 
873
+ # Details for native content position assigned targeting option. This will be
874
+ # populated in the native_content_position_details field when targeting_type is `
875
+ # TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is
876
+ # not supported. Remove all native content position targeting options to achieve
877
+ # this effect.
878
+ # Corresponds to the JSON property `nativeContentPositionDetails`
879
+ # @return [Google::Apis::DisplayvideoV1::NativeContentPositionAssignedTargetingOptionDetails]
880
+ attr_accessor :native_content_position_details
881
+
853
882
  # Targeting details for negative keyword list. This will be populated in the
854
883
  # details field of an AssignedTargetingOption when targeting_type is `
855
884
  # TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.
@@ -981,6 +1010,7 @@ module Google
981
1010
  @keyword_details = args[:keyword_details] if args.key?(:keyword_details)
982
1011
  @language_details = args[:language_details] if args.key?(:language_details)
983
1012
  @name = args[:name] if args.key?(:name)
1013
+ @native_content_position_details = args[:native_content_position_details] if args.key?(:native_content_position_details)
984
1014
  @negative_keyword_list_details = args[:negative_keyword_list_details] if args.key?(:negative_keyword_list_details)
985
1015
  @on_screen_position_details = args[:on_screen_position_details] if args.key?(:on_screen_position_details)
986
1016
  @operating_system_details = args[:operating_system_details] if args.key?(:operating_system_details)
@@ -1345,6 +1375,56 @@ module Google
1345
1375
  end
1346
1376
  end
1347
1377
 
1378
+ # Represents a summarized budget information associated with this invoice.
1379
+ class BudgetSummary
1380
+ include Google::Apis::Core::Hashable
1381
+
1382
+ # Output only. External budget id.
1383
+ # Corresponds to the JSON property `externalBudgetId`
1384
+ # @return [String]
1385
+ attr_accessor :external_budget_id
1386
+
1387
+ # Output only. The pre-tax amount for this budget, in micros of the invoice's
1388
+ # currency. For example if currency_code is `USD`, then 1000000 micros is one US
1389
+ # dollar.
1390
+ # Corresponds to the JSON property `preTaxAmountMicros`
1391
+ # @return [Fixnum]
1392
+ attr_accessor :pre_tax_amount_micros
1393
+
1394
+ # Google Payments Center supports searching and filtering on the component
1395
+ # fields of this code.
1396
+ # Corresponds to the JSON property `prismaCpeCode`
1397
+ # @return [Google::Apis::DisplayvideoV1::PrismaCpeCode]
1398
+ attr_accessor :prisma_cpe_code
1399
+
1400
+ # Output only. The tax amount for this budget, in micros of the invoice's
1401
+ # currency. For example if currency_code is `USD`, then 1000000 micros is one US
1402
+ # dollar.
1403
+ # Corresponds to the JSON property `taxAmountMicros`
1404
+ # @return [Fixnum]
1405
+ attr_accessor :tax_amount_micros
1406
+
1407
+ # Output only. The total amount of charges for this budget, in micros of the
1408
+ # invoice's currency. For example if currency_code is `USD`, then 1000000 micros
1409
+ # is one US dollar.
1410
+ # Corresponds to the JSON property `totalAmountMicros`
1411
+ # @return [Fixnum]
1412
+ attr_accessor :total_amount_micros
1413
+
1414
+ def initialize(**args)
1415
+ update!(**args)
1416
+ end
1417
+
1418
+ # Update properties of this object
1419
+ def update!(**args)
1420
+ @external_budget_id = args[:external_budget_id] if args.key?(:external_budget_id)
1421
+ @pre_tax_amount_micros = args[:pre_tax_amount_micros] if args.key?(:pre_tax_amount_micros)
1422
+ @prisma_cpe_code = args[:prisma_cpe_code] if args.key?(:prisma_cpe_code)
1423
+ @tax_amount_micros = args[:tax_amount_micros] if args.key?(:tax_amount_micros)
1424
+ @total_amount_micros = args[:total_amount_micros] if args.key?(:total_amount_micros)
1425
+ end
1426
+ end
1427
+
1348
1428
  # Request message for BulkEditAdvertiserAssignedTargetingOptions.
1349
1429
  class BulkEditAdvertiserAssignedTargetingOptionsRequest
1350
1430
  include Google::Apis::Core::Hashable
@@ -1781,6 +1861,35 @@ module Google
1781
1861
  end
1782
1862
  end
1783
1863
 
1864
+ # Response message for BulkListCampaignAssignedTargetingOptions.
1865
+ class BulkListCampaignAssignedTargetingOptionsResponse
1866
+ include Google::Apis::Core::Hashable
1867
+
1868
+ # The list of assigned targeting options. This list will be absent if empty.
1869
+ # Corresponds to the JSON property `assignedTargetingOptions`
1870
+ # @return [Array<Google::Apis::DisplayvideoV1::AssignedTargetingOption>]
1871
+ attr_accessor :assigned_targeting_options
1872
+
1873
+ # A token identifying the next page of results. This value should be specified
1874
+ # as the pageToken in a subsequent
1875
+ # BulkListCampaignAssignedTargetingOptionsRequest to fetch the next page of
1876
+ # results. This token will be absent if there are no more
1877
+ # assigned_targeting_options to return.
1878
+ # Corresponds to the JSON property `nextPageToken`
1879
+ # @return [String]
1880
+ attr_accessor :next_page_token
1881
+
1882
+ def initialize(**args)
1883
+ update!(**args)
1884
+ end
1885
+
1886
+ # Update properties of this object
1887
+ def update!(**args)
1888
+ @assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
1889
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1890
+ end
1891
+ end
1892
+
1784
1893
  # Response message for BulkListInsertionOrderAssignedTargetingOptions.
1785
1894
  class BulkListInsertionOrderAssignedTargetingOptionsResponse
1786
1895
  include Google::Apis::Core::Hashable
@@ -1848,6 +1957,12 @@ module Google
1848
1957
  # @return [Fixnum]
1849
1958
  attr_accessor :advertiser_id
1850
1959
 
1960
+ # The list of budgets available to this campaign. Setting no budget gives an
1961
+ # unlimited campaign budget.
1962
+ # Corresponds to the JSON property `campaignBudgets`
1963
+ # @return [Array<Google::Apis::DisplayvideoV1::CampaignBudget>]
1964
+ attr_accessor :campaign_budgets
1965
+
1851
1966
  # Settings that track the planned spend and duration of a campaign.
1852
1967
  # Corresponds to the JSON property `campaignFlight`
1853
1968
  # @return [Google::Apis::DisplayvideoV1::CampaignFlight]
@@ -1901,6 +2016,7 @@ module Google
1901
2016
  # Update properties of this object
1902
2017
  def update!(**args)
1903
2018
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
2019
+ @campaign_budgets = args[:campaign_budgets] if args.key?(:campaign_budgets)
1904
2020
  @campaign_flight = args[:campaign_flight] if args.key?(:campaign_flight)
1905
2021
  @campaign_goal = args[:campaign_goal] if args.key?(:campaign_goal)
1906
2022
  @campaign_id = args[:campaign_id] if args.key?(:campaign_id)
@@ -1912,6 +2028,82 @@ module Google
1912
2028
  end
1913
2029
  end
1914
2030
 
2031
+ # Settings that control how the campaign budget is allocated.
2032
+ class CampaignBudget
2033
+ include Google::Apis::Core::Hashable
2034
+
2035
+ # Required. The budget amount the insertion order will spend for the given
2036
+ # date_range. The amount is in micros. Must be greater than 0. For example,
2037
+ # 500000000 represents 500 standard units of the currency.
2038
+ # Corresponds to the JSON property `budgetAmountMicros`
2039
+ # @return [Fixnum]
2040
+ attr_accessor :budget_amount_micros
2041
+
2042
+ # The unique ID of the campaign budget. If not included, budget is assumed to be
2043
+ # new.
2044
+ # Corresponds to the JSON property `budgetId`
2045
+ # @return [Fixnum]
2046
+ attr_accessor :budget_id
2047
+
2048
+ # Required. Immutable. The budget unit specifies whether the budget is currency
2049
+ # based or impression based.
2050
+ # Corresponds to the JSON property `budgetUnit`
2051
+ # @return [String]
2052
+ attr_accessor :budget_unit
2053
+
2054
+ # A date range.
2055
+ # Corresponds to the JSON property `dateRange`
2056
+ # @return [Google::Apis::DisplayvideoV1::DateRange]
2057
+ attr_accessor :date_range
2058
+
2059
+ # Required. The display name of the budget. Must be UTF-8 encoded with a maximum
2060
+ # size of 240 bytes.
2061
+ # Corresponds to the JSON property `displayName`
2062
+ # @return [String]
2063
+ attr_accessor :display_name
2064
+
2065
+ # Immutable. Must be unique under the campaign. If set, all impressions served
2066
+ # against this budget will include this ID on the invoice if the customer has
2067
+ # opted into budget-segment-level billing.
2068
+ # Corresponds to the JSON property `externalBudgetId`
2069
+ # @return [String]
2070
+ attr_accessor :external_budget_id
2071
+
2072
+ # Required. The external source of the budget segment.
2073
+ # Corresponds to the JSON property `externalBudgetSource`
2074
+ # @return [String]
2075
+ attr_accessor :external_budget_source
2076
+
2077
+ # Immutable. If set, all external_budget_id sharing the same invoice_grouping_id
2078
+ # will include this ID on the invoice if the customer has opted into budget-
2079
+ # segment-level billing.
2080
+ # Corresponds to the JSON property `invoiceGroupingId`
2081
+ # @return [String]
2082
+ attr_accessor :invoice_grouping_id
2083
+
2084
+ # Settings specific to the MediaOcean Prisma tool.
2085
+ # Corresponds to the JSON property `prismaConfig`
2086
+ # @return [Google::Apis::DisplayvideoV1::PrismaConfig]
2087
+ attr_accessor :prisma_config
2088
+
2089
+ def initialize(**args)
2090
+ update!(**args)
2091
+ end
2092
+
2093
+ # Update properties of this object
2094
+ def update!(**args)
2095
+ @budget_amount_micros = args[:budget_amount_micros] if args.key?(:budget_amount_micros)
2096
+ @budget_id = args[:budget_id] if args.key?(:budget_id)
2097
+ @budget_unit = args[:budget_unit] if args.key?(:budget_unit)
2098
+ @date_range = args[:date_range] if args.key?(:date_range)
2099
+ @display_name = args[:display_name] if args.key?(:display_name)
2100
+ @external_budget_id = args[:external_budget_id] if args.key?(:external_budget_id)
2101
+ @external_budget_source = args[:external_budget_source] if args.key?(:external_budget_source)
2102
+ @invoice_grouping_id = args[:invoice_grouping_id] if args.key?(:invoice_grouping_id)
2103
+ @prisma_config = args[:prisma_config] if args.key?(:prisma_config)
2104
+ end
2105
+ end
2106
+
1915
2107
  # Settings that track the planned spend and duration of a campaign.
1916
2108
  class CampaignFlight
1917
2109
  include Google::Apis::Core::Hashable
@@ -2109,11 +2301,23 @@ module Google
2109
2301
  # @return [String]
2110
2302
  attr_accessor :name
2111
2303
 
2304
+ # Output only. Number of line items that are directly targeting this channel
2305
+ # negatively.
2306
+ # Corresponds to the JSON property `negativelyTargetedLineItemCount`
2307
+ # @return [Fixnum]
2308
+ attr_accessor :negatively_targeted_line_item_count
2309
+
2112
2310
  # The ID of the partner that owns the channel.
2113
2311
  # Corresponds to the JSON property `partnerId`
2114
2312
  # @return [Fixnum]
2115
2313
  attr_accessor :partner_id
2116
2314
 
2315
+ # Output only. Number of line items that are directly targeting this channel
2316
+ # positively.
2317
+ # Corresponds to the JSON property `positivelyTargetedLineItemCount`
2318
+ # @return [Fixnum]
2319
+ attr_accessor :positively_targeted_line_item_count
2320
+
2117
2321
  def initialize(**args)
2118
2322
  update!(**args)
2119
2323
  end
@@ -2124,7 +2328,9 @@ module Google
2124
2328
  @channel_id = args[:channel_id] if args.key?(:channel_id)
2125
2329
  @display_name = args[:display_name] if args.key?(:display_name)
2126
2330
  @name = args[:name] if args.key?(:name)
2331
+ @negatively_targeted_line_item_count = args[:negatively_targeted_line_item_count] if args.key?(:negatively_targeted_line_item_count)
2127
2332
  @partner_id = args[:partner_id] if args.key?(:partner_id)
2333
+ @positively_targeted_line_item_count = args[:positively_targeted_line_item_count] if args.key?(:positively_targeted_line_item_count)
2128
2334
  end
2129
2335
  end
2130
2336
 
@@ -4254,18 +4460,18 @@ module Google
4254
4460
  include Google::Apis::Core::Hashable
4255
4461
 
4256
4462
  # The maximum number of times a user may be shown with the same ad during this
4257
- # period. Must be greater than 0. Applicable when unlimited is `false`.
4463
+ # period. Must be greater than 0. Required when unlimited is `false`.
4258
4464
  # Corresponds to the JSON property `maxImpressions`
4259
4465
  # @return [Fixnum]
4260
4466
  attr_accessor :max_impressions
4261
4467
 
4262
- # The time unit in which the frequency cap will be applied. Applicable when
4468
+ # The time unit in which the frequency cap will be applied. Required when
4263
4469
  # unlimited is `false`.
4264
4470
  # Corresponds to the JSON property `timeUnit`
4265
4471
  # @return [String]
4266
4472
  attr_accessor :time_unit
4267
4473
 
4268
- # The number of time_unit the frequency cap will last. Applicable when unlimited
4474
+ # The number of time_unit the frequency cap will last. Required when unlimited
4269
4475
  # is `false`. The following restrictions apply based on the value of time_unit: *
4270
4476
  # `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `
4271
4477
  # TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be
@@ -4344,6 +4550,44 @@ module Google
4344
4550
  end
4345
4551
  end
4346
4552
 
4553
+ # Request message for LineItemService.GenerateDefaultLineItem.
4554
+ class GenerateDefaultLineItemRequest
4555
+ include Google::Apis::Core::Hashable
4556
+
4557
+ # Required. The display name of the line item. Must be UTF-8 encoded with a
4558
+ # maximum size of 240 bytes.
4559
+ # Corresponds to the JSON property `displayName`
4560
+ # @return [String]
4561
+ attr_accessor :display_name
4562
+
4563
+ # Required. The unique ID of the insertion order that the line item belongs to.
4564
+ # Corresponds to the JSON property `insertionOrderId`
4565
+ # @return [Fixnum]
4566
+ attr_accessor :insertion_order_id
4567
+
4568
+ # Required. The type of the line item.
4569
+ # Corresponds to the JSON property `lineItemType`
4570
+ # @return [String]
4571
+ attr_accessor :line_item_type
4572
+
4573
+ # A mobile app promoted by a mobile app install line item.
4574
+ # Corresponds to the JSON property `mobileApp`
4575
+ # @return [Google::Apis::DisplayvideoV1::MobileApp]
4576
+ attr_accessor :mobile_app
4577
+
4578
+ def initialize(**args)
4579
+ update!(**args)
4580
+ end
4581
+
4582
+ # Update properties of this object
4583
+ def update!(**args)
4584
+ @display_name = args[:display_name] if args.key?(:display_name)
4585
+ @insertion_order_id = args[:insertion_order_id] if args.key?(:insertion_order_id)
4586
+ @line_item_type = args[:line_item_type] if args.key?(:line_item_type)
4587
+ @mobile_app = args[:mobile_app] if args.key?(:mobile_app)
4588
+ end
4589
+ end
4590
+
4347
4591
  # Details for assigned geographic region targeting option. This will be
4348
4592
  # populated in the details field of an AssignedTargetingOption when
4349
4593
  # targeting_type is `TARGETING_TYPE_GEO_REGION`.
@@ -5252,6 +5496,175 @@ module Google
5252
5496
  end
5253
5497
  end
5254
5498
 
5499
+ # A single Invoice.
5500
+ class Invoice
5501
+ include Google::Apis::Core::Hashable
5502
+
5503
+ # Output only. Budget invoice grouping ID associated with the budget segment in
5504
+ # the insertion order.
5505
+ # Corresponds to the JSON property `budgetInvoiceGroupingId`
5506
+ # @return [String]
5507
+ attr_accessor :budget_invoice_grouping_id
5508
+
5509
+ # Output only. The list of summarized budget information associated with this
5510
+ # invoice.
5511
+ # Corresponds to the JSON property `budgetSummaries`
5512
+ # @return [Array<Google::Apis::DisplayvideoV1::BudgetSummary>]
5513
+ attr_accessor :budget_summaries
5514
+
5515
+ # Output only. The originally issued invoice that is being adjusted by this
5516
+ # invoice, if applicable. If there is a corrected invoice, the
5517
+ # replaced_invoice_ids field will be empty. May appear on invoice PDF as `
5518
+ # Reference invoice number`.
5519
+ # Corresponds to the JSON property `correctedInvoiceId`
5520
+ # @return [String]
5521
+ attr_accessor :corrected_invoice_id
5522
+
5523
+ # Output only. Invoice currency code in ISO 4217 format.
5524
+ # Corresponds to the JSON property `currencyCode`
5525
+ # @return [String]
5526
+ attr_accessor :currency_code
5527
+
5528
+ # Output only. Display name of the invoice.
5529
+ # Corresponds to the JSON property `displayName`
5530
+ # @return [String]
5531
+ attr_accessor :display_name
5532
+
5533
+ # Represents a whole or partial calendar date, such as a birthday. The time of
5534
+ # day and time zone are either specified elsewhere or are insignificant. The
5535
+ # date is relative to the Gregorian Calendar. This can represent one of the
5536
+ # following: * A full date, with non-zero year, month, and day values * A month
5537
+ # and day value, with a zero year, such as an anniversary * A year on its own,
5538
+ # with zero month and day values * A year and month value, with a zero day, such
5539
+ # as a credit card expiration date Related types are google.type.TimeOfDay and `
5540
+ # google.protobuf.Timestamp`.
5541
+ # Corresponds to the JSON property `dueDate`
5542
+ # @return [Google::Apis::DisplayvideoV1::Date]
5543
+ attr_accessor :due_date
5544
+
5545
+ # Output only. The unique ID of the invoice.
5546
+ # Corresponds to the JSON property `invoiceId`
5547
+ # @return [String]
5548
+ attr_accessor :invoice_id
5549
+
5550
+ # Output only. The type of invoice document.
5551
+ # Corresponds to the JSON property `invoiceType`
5552
+ # @return [String]
5553
+ attr_accessor :invoice_type
5554
+
5555
+ # Represents a whole or partial calendar date, such as a birthday. The time of
5556
+ # day and time zone are either specified elsewhere or are insignificant. The
5557
+ # date is relative to the Gregorian Calendar. This can represent one of the
5558
+ # following: * A full date, with non-zero year, month, and day values * A month
5559
+ # and day value, with a zero year, such as an anniversary * A year on its own,
5560
+ # with zero month and day values * A year and month value, with a zero day, such
5561
+ # as a credit card expiration date Related types are google.type.TimeOfDay and `
5562
+ # google.protobuf.Timestamp`.
5563
+ # Corresponds to the JSON property `issueDate`
5564
+ # @return [Google::Apis::DisplayvideoV1::Date]
5565
+ attr_accessor :issue_date
5566
+
5567
+ # Output only. The resource name of the invoice.
5568
+ # Corresponds to the JSON property `name`
5569
+ # @return [String]
5570
+ attr_accessor :name
5571
+
5572
+ # Output only. The total amount of costs or adjustments not tied to a particular
5573
+ # budget, in micros of the invoice's currency. For example if currency_code is `
5574
+ # USD`, then 1000000 micros is one US dollar.
5575
+ # Corresponds to the JSON property `nonBudgetMicros`
5576
+ # @return [Fixnum]
5577
+ attr_accessor :non_budget_micros
5578
+
5579
+ # Output only. The ID of the payments account the invoice belongs to. Appears on
5580
+ # the invoice PDF as `Billing Account Number`.
5581
+ # Corresponds to the JSON property `paymentsAccountId`
5582
+ # @return [String]
5583
+ attr_accessor :payments_account_id
5584
+
5585
+ # Output only. The ID of the payments profile the invoice belongs to. Appears on
5586
+ # the invoice PDF as `Billing ID`.
5587
+ # Corresponds to the JSON property `paymentsProfileId`
5588
+ # @return [String]
5589
+ attr_accessor :payments_profile_id
5590
+
5591
+ # Output only. The URL to download a PDF copy of the invoice. Note that this URL
5592
+ # is user specific and requires a valid OAuth 2.0 access token to access. The
5593
+ # access token must be provided in an `Authorization: Bearer` HTTP header and be
5594
+ # authorized for one of the following scopes: * `https://www.googleapis.com/auth/
5595
+ # display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video`
5596
+ # The URL will only be usable for 7 days from when the api is called.
5597
+ # Corresponds to the JSON property `pdfUrl`
5598
+ # @return [String]
5599
+ attr_accessor :pdf_url
5600
+
5601
+ # Output only. Purchase order number associated with the invoice.
5602
+ # Corresponds to the JSON property `purchaseOrderNumber`
5603
+ # @return [String]
5604
+ attr_accessor :purchase_order_number
5605
+
5606
+ # Output only. The originally issued invoice(s) that is being cancelled by this
5607
+ # invoice, if applicable. If there are any replaced invoices, the
5608
+ # corrected_invoice_id field will be empty. May appear on invoice PDF as `
5609
+ # Replaced invoice numbers`. Note: There may be multiple replaced invoices due
5610
+ # to consolidation of multiple invoices into a single invoice.
5611
+ # Corresponds to the JSON property `replacedInvoiceIds`
5612
+ # @return [Array<String>]
5613
+ attr_accessor :replaced_invoice_ids
5614
+
5615
+ # A date range.
5616
+ # Corresponds to the JSON property `serviceDateRange`
5617
+ # @return [Google::Apis::DisplayvideoV1::DateRange]
5618
+ attr_accessor :service_date_range
5619
+
5620
+ # Output only. The pre-tax subtotal amount, in micros of the invoice's currency.
5621
+ # For example if currency_code is `USD`, then 1000000 micros is one US dollar.
5622
+ # Corresponds to the JSON property `subtotalAmountMicros`
5623
+ # @return [Fixnum]
5624
+ attr_accessor :subtotal_amount_micros
5625
+
5626
+ # Output only. The invoice total amount, in micros of the invoice's currency.
5627
+ # For example if currency_code is `USD`, then 1000000 micros is one US dollar.
5628
+ # Corresponds to the JSON property `totalAmountMicros`
5629
+ # @return [Fixnum]
5630
+ attr_accessor :total_amount_micros
5631
+
5632
+ # Output only. The sum of all taxes in invoice, in micros of the invoice's
5633
+ # currency. For example if currency_code is `USD`, then 1000000 micros is one US
5634
+ # dollar.
5635
+ # Corresponds to the JSON property `totalTaxAmountMicros`
5636
+ # @return [Fixnum]
5637
+ attr_accessor :total_tax_amount_micros
5638
+
5639
+ def initialize(**args)
5640
+ update!(**args)
5641
+ end
5642
+
5643
+ # Update properties of this object
5644
+ def update!(**args)
5645
+ @budget_invoice_grouping_id = args[:budget_invoice_grouping_id] if args.key?(:budget_invoice_grouping_id)
5646
+ @budget_summaries = args[:budget_summaries] if args.key?(:budget_summaries)
5647
+ @corrected_invoice_id = args[:corrected_invoice_id] if args.key?(:corrected_invoice_id)
5648
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
5649
+ @display_name = args[:display_name] if args.key?(:display_name)
5650
+ @due_date = args[:due_date] if args.key?(:due_date)
5651
+ @invoice_id = args[:invoice_id] if args.key?(:invoice_id)
5652
+ @invoice_type = args[:invoice_type] if args.key?(:invoice_type)
5653
+ @issue_date = args[:issue_date] if args.key?(:issue_date)
5654
+ @name = args[:name] if args.key?(:name)
5655
+ @non_budget_micros = args[:non_budget_micros] if args.key?(:non_budget_micros)
5656
+ @payments_account_id = args[:payments_account_id] if args.key?(:payments_account_id)
5657
+ @payments_profile_id = args[:payments_profile_id] if args.key?(:payments_profile_id)
5658
+ @pdf_url = args[:pdf_url] if args.key?(:pdf_url)
5659
+ @purchase_order_number = args[:purchase_order_number] if args.key?(:purchase_order_number)
5660
+ @replaced_invoice_ids = args[:replaced_invoice_ids] if args.key?(:replaced_invoice_ids)
5661
+ @service_date_range = args[:service_date_range] if args.key?(:service_date_range)
5662
+ @subtotal_amount_micros = args[:subtotal_amount_micros] if args.key?(:subtotal_amount_micros)
5663
+ @total_amount_micros = args[:total_amount_micros] if args.key?(:total_amount_micros)
5664
+ @total_tax_amount_micros = args[:total_tax_amount_micros] if args.key?(:total_tax_amount_micros)
5665
+ end
5666
+ end
5667
+
5255
5668
  # Details for assigned keyword targeting option. This will be populated in the
5256
5669
  # details field of an AssignedTargetingOption when targeting_type is `
5257
5670
  # TARGETING_TYPE_KEYWORD`.
@@ -5695,6 +6108,34 @@ module Google
5695
6108
  end
5696
6109
  end
5697
6110
 
6111
+ # Response message for ListCampaignAssignedTargetingOptions.
6112
+ class ListCampaignAssignedTargetingOptionsResponse
6113
+ include Google::Apis::Core::Hashable
6114
+
6115
+ # The list of assigned targeting options. This list will be absent if empty.
6116
+ # Corresponds to the JSON property `assignedTargetingOptions`
6117
+ # @return [Array<Google::Apis::DisplayvideoV1::AssignedTargetingOption>]
6118
+ attr_accessor :assigned_targeting_options
6119
+
6120
+ # A token identifying the next page of results. This value should be specified
6121
+ # as the pageToken in a subsequent ListCampaignAssignedTargetingOptionsRequest
6122
+ # to fetch the next page of results. This token will be absent if there are no
6123
+ # more assigned_targeting_options to return.
6124
+ # Corresponds to the JSON property `nextPageToken`
6125
+ # @return [String]
6126
+ attr_accessor :next_page_token
6127
+
6128
+ def initialize(**args)
6129
+ update!(**args)
6130
+ end
6131
+
6132
+ # Update properties of this object
6133
+ def update!(**args)
6134
+ @assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
6135
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6136
+ end
6137
+ end
6138
+
5698
6139
  #
5699
6140
  class ListCampaignsResponse
5700
6141
  include Google::Apis::Core::Hashable
@@ -6024,6 +6465,33 @@ module Google
6024
6465
  end
6025
6466
  end
6026
6467
 
6468
+ # Response message for InvoiceService.ListInvoices.
6469
+ class ListInvoicesResponse
6470
+ include Google::Apis::Core::Hashable
6471
+
6472
+ # The list of invoices. This list will be absent if empty.
6473
+ # Corresponds to the JSON property `invoices`
6474
+ # @return [Array<Google::Apis::DisplayvideoV1::Invoice>]
6475
+ attr_accessor :invoices
6476
+
6477
+ # A token to retrieve the next page of results. Pass this value in the [
6478
+ # ListInvoicesRequest.page_token] field in the subsequent call to `ListInvoices`
6479
+ # method to retrieve the next page of results.
6480
+ # Corresponds to the JSON property `nextPageToken`
6481
+ # @return [String]
6482
+ attr_accessor :next_page_token
6483
+
6484
+ def initialize(**args)
6485
+ update!(**args)
6486
+ end
6487
+
6488
+ # Update properties of this object
6489
+ def update!(**args)
6490
+ @invoices = args[:invoices] if args.key?(:invoices)
6491
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6492
+ end
6493
+ end
6494
+
6027
6495
  # Response message for ListLineItemAssignedTargetingOptions.
6028
6496
  class ListLineItemAssignedTargetingOptionsResponse
6029
6497
  include Google::Apis::Core::Hashable
@@ -6398,6 +6866,25 @@ module Google
6398
6866
  end
6399
6867
  end
6400
6868
 
6869
+ # Response message for InvoiceService.LookupInvoiceCurrency.
6870
+ class LookupInvoiceCurrencyResponse
6871
+ include Google::Apis::Core::Hashable
6872
+
6873
+ # Output only. Invoice currency code in ISO 4217 format.
6874
+ # Corresponds to the JSON property `currencyCode`
6875
+ # @return [String]
6876
+ attr_accessor :currency_code
6877
+
6878
+ def initialize(**args)
6879
+ update!(**args)
6880
+ end
6881
+
6882
+ # Update properties of this object
6883
+ def update!(**args)
6884
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
6885
+ end
6886
+ end
6887
+
6401
6888
  # A single manual trigger in Display & Video 360.
6402
6889
  class ManualTrigger
6403
6890
  include Google::Apis::Core::Hashable
@@ -6600,6 +7087,57 @@ module Google
6600
7087
  end
6601
7088
  end
6602
7089
 
7090
+ # Details for native content position assigned targeting option. This will be
7091
+ # populated in the native_content_position_details field when targeting_type is `
7092
+ # TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is
7093
+ # not supported. Remove all native content position targeting options to achieve
7094
+ # this effect.
7095
+ class NativeContentPositionAssignedTargetingOptionDetails
7096
+ include Google::Apis::Core::Hashable
7097
+
7098
+ # Output only. The content position.
7099
+ # Corresponds to the JSON property `contentPosition`
7100
+ # @return [String]
7101
+ attr_accessor :content_position
7102
+
7103
+ # Required. The targeting_option_id field when targeting_type is `
7104
+ # TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
7105
+ # Corresponds to the JSON property `targetingOptionId`
7106
+ # @return [String]
7107
+ attr_accessor :targeting_option_id
7108
+
7109
+ def initialize(**args)
7110
+ update!(**args)
7111
+ end
7112
+
7113
+ # Update properties of this object
7114
+ def update!(**args)
7115
+ @content_position = args[:content_position] if args.key?(:content_position)
7116
+ @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id)
7117
+ end
7118
+ end
7119
+
7120
+ # Represents a targetable native content position. This will be populated in the
7121
+ # native_content_position_details field when targeting_type is `
7122
+ # TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
7123
+ class NativeContentPositionTargetingOptionDetails
7124
+ include Google::Apis::Core::Hashable
7125
+
7126
+ # Output only. The content position.
7127
+ # Corresponds to the JSON property `contentPosition`
7128
+ # @return [String]
7129
+ attr_accessor :content_position
7130
+
7131
+ def initialize(**args)
7132
+ update!(**args)
7133
+ end
7134
+
7135
+ # Update properties of this object
7136
+ def update!(**args)
7137
+ @content_position = args[:content_position] if args.key?(:content_position)
7138
+ end
7139
+ end
7140
+
6603
7141
  # A negatively targeted keyword that belongs to a negative keyword list.
6604
7142
  class NegativeKeyword
6605
7143
  include Google::Apis::Core::Hashable
@@ -6657,6 +7195,12 @@ module Google
6657
7195
  # @return [Fixnum]
6658
7196
  attr_accessor :negative_keyword_list_id
6659
7197
 
7198
+ # Output only. Number of line items that are directly targeting this negative
7199
+ # keyword list.
7200
+ # Corresponds to the JSON property `targetedLineItemCount`
7201
+ # @return [Fixnum]
7202
+ attr_accessor :targeted_line_item_count
7203
+
6660
7204
  def initialize(**args)
6661
7205
  update!(**args)
6662
7206
  end
@@ -6667,6 +7211,7 @@ module Google
6667
7211
  @display_name = args[:display_name] if args.key?(:display_name)
6668
7212
  @name = args[:name] if args.key?(:name)
6669
7213
  @negative_keyword_list_id = args[:negative_keyword_list_id] if args.key?(:negative_keyword_list_id)
7214
+ @targeted_line_item_count = args[:targeted_line_item_count] if args.key?(:targeted_line_item_count)
6670
7215
  end
6671
7216
  end
6672
7217
 
@@ -7406,6 +7951,70 @@ module Google
7406
7951
  end
7407
7952
  end
7408
7953
 
7954
+ # Settings specific to the MediaOcean Prisma tool.
7955
+ class PrismaConfig
7956
+ include Google::Apis::Core::Hashable
7957
+
7958
+ # Google Payments Center supports searching and filtering on the component
7959
+ # fields of this code.
7960
+ # Corresponds to the JSON property `prismaCpeCode`
7961
+ # @return [Google::Apis::DisplayvideoV1::PrismaCpeCode]
7962
+ attr_accessor :prisma_cpe_code
7963
+
7964
+ # Required. The Prisma type.
7965
+ # Corresponds to the JSON property `prismaType`
7966
+ # @return [String]
7967
+ attr_accessor :prisma_type
7968
+
7969
+ # Required. The entity allocated this budget (DSP, site, etc.).
7970
+ # Corresponds to the JSON property `supplier`
7971
+ # @return [String]
7972
+ attr_accessor :supplier
7973
+
7974
+ def initialize(**args)
7975
+ update!(**args)
7976
+ end
7977
+
7978
+ # Update properties of this object
7979
+ def update!(**args)
7980
+ @prisma_cpe_code = args[:prisma_cpe_code] if args.key?(:prisma_cpe_code)
7981
+ @prisma_type = args[:prisma_type] if args.key?(:prisma_type)
7982
+ @supplier = args[:supplier] if args.key?(:supplier)
7983
+ end
7984
+ end
7985
+
7986
+ # Google Payments Center supports searching and filtering on the component
7987
+ # fields of this code.
7988
+ class PrismaCpeCode
7989
+ include Google::Apis::Core::Hashable
7990
+
7991
+ # The Prisma client code.
7992
+ # Corresponds to the JSON property `prismaClientCode`
7993
+ # @return [String]
7994
+ attr_accessor :prisma_client_code
7995
+
7996
+ # The Prisma estimate code.
7997
+ # Corresponds to the JSON property `prismaEstimateCode`
7998
+ # @return [String]
7999
+ attr_accessor :prisma_estimate_code
8000
+
8001
+ # The Prisma product code.
8002
+ # Corresponds to the JSON property `prismaProductCode`
8003
+ # @return [String]
8004
+ attr_accessor :prisma_product_code
8005
+
8006
+ def initialize(**args)
8007
+ update!(**args)
8008
+ end
8009
+
8010
+ # Update properties of this object
8011
+ def update!(**args)
8012
+ @prisma_client_code = args[:prisma_client_code] if args.key?(:prisma_client_code)
8013
+ @prisma_estimate_code = args[:prisma_estimate_code] if args.key?(:prisma_estimate_code)
8014
+ @prisma_product_code = args[:prisma_product_code] if args.key?(:prisma_product_code)
8015
+ end
8016
+ end
8017
+
7409
8018
  # Targeting details for proximity location list. This will be populated in the
7410
8019
  # details field of an AssignedTargetingOption when targeting_type is `
7411
8020
  # TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
@@ -7533,6 +8142,96 @@ module Google
7533
8142
  end
7534
8143
  end
7535
8144
 
8145
+ # Request message for NegativeKeywordService.ReplaceNegativeKeywords.
8146
+ class ReplaceNegativeKeywordsRequest
8147
+ include Google::Apis::Core::Hashable
8148
+
8149
+ # The negative keywords that will replace the existing keywords in the negative
8150
+ # keyword list, specified as a list of NegativeKeywords.
8151
+ # Corresponds to the JSON property `newNegativeKeywords`
8152
+ # @return [Array<Google::Apis::DisplayvideoV1::NegativeKeyword>]
8153
+ attr_accessor :new_negative_keywords
8154
+
8155
+ def initialize(**args)
8156
+ update!(**args)
8157
+ end
8158
+
8159
+ # Update properties of this object
8160
+ def update!(**args)
8161
+ @new_negative_keywords = args[:new_negative_keywords] if args.key?(:new_negative_keywords)
8162
+ end
8163
+ end
8164
+
8165
+ # Response message for NegativeKeywordService.ReplaceNegativeKeywords.
8166
+ class ReplaceNegativeKeywordsResponse
8167
+ include Google::Apis::Core::Hashable
8168
+
8169
+ # The full list of negative keywords now present in the negative keyword list.
8170
+ # Corresponds to the JSON property `negativeKeywords`
8171
+ # @return [Array<Google::Apis::DisplayvideoV1::NegativeKeyword>]
8172
+ attr_accessor :negative_keywords
8173
+
8174
+ def initialize(**args)
8175
+ update!(**args)
8176
+ end
8177
+
8178
+ # Update properties of this object
8179
+ def update!(**args)
8180
+ @negative_keywords = args[:negative_keywords] if args.key?(:negative_keywords)
8181
+ end
8182
+ end
8183
+
8184
+ # Request message for SiteService.ReplaceSites.
8185
+ class ReplaceSitesRequest
8186
+ include Google::Apis::Core::Hashable
8187
+
8188
+ # The ID of the advertiser that owns the parent channel.
8189
+ # Corresponds to the JSON property `advertiserId`
8190
+ # @return [Fixnum]
8191
+ attr_accessor :advertiser_id
8192
+
8193
+ # The sites that will replace the existing sites assigned to the channel,
8194
+ # specified as a list of Sites.
8195
+ # Corresponds to the JSON property `newSites`
8196
+ # @return [Array<Google::Apis::DisplayvideoV1::Site>]
8197
+ attr_accessor :new_sites
8198
+
8199
+ # The ID of the partner that owns the parent channel.
8200
+ # Corresponds to the JSON property `partnerId`
8201
+ # @return [Fixnum]
8202
+ attr_accessor :partner_id
8203
+
8204
+ def initialize(**args)
8205
+ update!(**args)
8206
+ end
8207
+
8208
+ # Update properties of this object
8209
+ def update!(**args)
8210
+ @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
8211
+ @new_sites = args[:new_sites] if args.key?(:new_sites)
8212
+ @partner_id = args[:partner_id] if args.key?(:partner_id)
8213
+ end
8214
+ end
8215
+
8216
+ # Response message for SiteService.ReplaceSites.
8217
+ class ReplaceSitesResponse
8218
+ include Google::Apis::Core::Hashable
8219
+
8220
+ # The list of sites in the channel after replacing.
8221
+ # Corresponds to the JSON property `sites`
8222
+ # @return [Array<Google::Apis::DisplayvideoV1::Site>]
8223
+ attr_accessor :sites
8224
+
8225
+ def initialize(**args)
8226
+ update!(**args)
8227
+ end
8228
+
8229
+ # Update properties of this object
8230
+ def update!(**args)
8231
+ @sites = args[:sites] if args.key?(:sites)
8232
+ end
8233
+ end
8234
+
7536
8235
  # Review statuses for the creative.
7537
8236
  class ReviewStatusInfo
7538
8237
  include Google::Apis::Core::Hashable
@@ -8043,6 +8742,13 @@ module Google
8043
8742
  # @return [String]
8044
8743
  attr_accessor :name
8045
8744
 
8745
+ # Represents a targetable native content position. This will be populated in the
8746
+ # native_content_position_details field when targeting_type is `
8747
+ # TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
8748
+ # Corresponds to the JSON property `nativeContentPositionDetails`
8749
+ # @return [Google::Apis::DisplayvideoV1::NativeContentPositionTargetingOptionDetails]
8750
+ attr_accessor :native_content_position_details
8751
+
8046
8752
  # Represents a targetable on screen position, which could be used by display and
8047
8753
  # video ads. This will be populated in the on_screen_position_details field when
8048
8754
  # targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
@@ -8134,6 +8840,7 @@ module Google
8134
8840
  @household_income_details = args[:household_income_details] if args.key?(:household_income_details)
8135
8841
  @language_details = args[:language_details] if args.key?(:language_details)
8136
8842
  @name = args[:name] if args.key?(:name)
8843
+ @native_content_position_details = args[:native_content_position_details] if args.key?(:native_content_position_details)
8137
8844
  @on_screen_position_details = args[:on_screen_position_details] if args.key?(:on_screen_position_details)
8138
8845
  @operating_system_details = args[:operating_system_details] if args.key?(:operating_system_details)
8139
8846
  @parental_status_details = args[:parental_status_details] if args.key?(:parental_status_details)