google-apis-displayvideo_v1 0.15.0 → 0.19.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 44e473d674761f8586286b98be6bba2bfafa110d2c877300266ae98ef1a94503
4
- data.tar.gz: d03f3ca6d1d3b711cbabe35195de121f179f508de174fc08b8fd8b41844fa742
3
+ metadata.gz: be7d89e0f02c27d25739268c9cabf08dc56f5a87491d9e0d54bf9e7318cdeadf
4
+ data.tar.gz: c5f59f41ec89978c900e4d5d8b749aa8cb7df28f5be5148ac929a532056b9c1e
5
5
  SHA512:
6
- metadata.gz: edc0aae6ab68931a6b7471ed4cf969268b010e561b62e43e4c9bf1765cb1fa905442f9f84b50ac562fdf51eb536a1fbdad53174d1f6bfe3d6059397916a53717
7
- data.tar.gz: 4f2ba5f57ec6ba2c53f4baf3fca21fb9648093c35cc395985a6b831507234f234cafb8d2c5c05d0ed0859d2c45a6334b746984e38cb63d323f309f8d0b9761f8
6
+ metadata.gz: 11f640d12cdca54c1f0e8b466a90af831a663ee0759b2978099267fbe7eff84679e32fcefade7e39a0c1c108815e9665e6229c5ddff06e113b5c4200d83bd4ea
7
+ data.tar.gz: 49dd4436462571cd0ed5f7097f2fdf9744551b15149b1e1b8205600d8e10007975218340b6e51b58aaa35d3f152ecf802d79d60a04d79bb7b57b2e10d20af0cd
data/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Release history for google-apis-displayvideo_v1
2
2
 
3
+ ### v0.19.0 (2021-10-22)
4
+
5
+ * Regenerated from discovery document revision 20211021
6
+ * Unspecified changes
7
+
8
+ ### v0.18.0 (2021-10-01)
9
+
10
+ * Regenerated from discovery document revision 20210930
11
+
12
+ ### v0.17.0 (2021-09-21)
13
+
14
+ * Regenerated from discovery document revision 20210920
15
+
16
+ ### v0.16.0 (2021-09-10)
17
+
18
+ * Regenerated from discovery document revision 20210909
19
+
3
20
  ### v0.15.0 (2021-09-03)
4
21
 
5
22
  * Regenerated from discovery document revision 20210902
data/OVERVIEW.md CHANGED
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
60
60
 
61
61
  More detailed descriptions of the Google simple REST clients are available in two documents.
62
62
 
63
- * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
- * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Displayvideo service in particular.)
67
67
 
@@ -2000,7 +2000,8 @@ module Google
2000
2000
  attr_accessor :proximity_radius_unit
2001
2001
 
2002
2002
  # Required. The targeting_option_id of a TargetingOption of type `
2003
- # TARGETING_TYPE_BUSINESS_CHAIN`.
2003
+ # TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs
2004
+ # can be retrieved using SearchTargetingOptions.
2004
2005
  # Corresponds to the JSON property `targetingOptionId`
2005
2006
  # @return [String]
2006
2007
  attr_accessor :targeting_option_id
@@ -2025,14 +2026,14 @@ module Google
2025
2026
 
2026
2027
  # The search query for the desired business chain. The query must be the full
2027
2028
  # name of the business, e.g. "KFC", "mercedes-benz".
2028
- # Corresponds to the JSON property `businessChain`
2029
+ # Corresponds to the JSON property `businessChainQuery`
2029
2030
  # @return [String]
2030
- attr_accessor :business_chain
2031
+ attr_accessor :business_chain_query
2031
2032
 
2032
2033
  # The search query for the desired geo region, e.g. "Seattle", "United State".
2033
- # Corresponds to the JSON property `region`
2034
+ # Corresponds to the JSON property `regionQuery`
2034
2035
  # @return [String]
2035
- attr_accessor :region
2036
+ attr_accessor :region_query
2036
2037
 
2037
2038
  def initialize(**args)
2038
2039
  update!(**args)
@@ -2040,8 +2041,8 @@ module Google
2040
2041
 
2041
2042
  # Update properties of this object
2042
2043
  def update!(**args)
2043
- @business_chain = args[:business_chain] if args.key?(:business_chain)
2044
- @region = args[:region] if args.key?(:region)
2044
+ @business_chain_query = args[:business_chain_query] if args.key?(:business_chain_query)
2045
+ @region_query = args[:region_query] if args.key?(:region_query)
2045
2046
  end
2046
2047
  end
2047
2048
 
@@ -3459,9 +3460,13 @@ module Google
3459
3460
  # @return [Fixnum]
3460
3461
  attr_accessor :partner_id
3461
3462
 
3462
- # The IDs of the advertisers who have access to this algorithm. This field will
3463
- # not be set if the algorithm owner is a partner and is being retrieved using an
3464
- # advertiser accessor.
3463
+ # The IDs of the advertisers who have access to this algorithm. If advertiser_id
3464
+ # is set, this field will only consist of that value. This field will not be set
3465
+ # if the algorithm [`owner`](/display-video/api/reference/rest/v1/
3466
+ # customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a
3467
+ # partner and is being retrieved using an advertiser [`accessor`](/display-video/
3468
+ # api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.
3469
+ # oneof_accessor).
3465
3470
  # Corresponds to the JSON property `sharedAdvertiserIds`
3466
3471
  # @return [Array<Fixnum>]
3467
3472
  attr_accessor :shared_advertiser_ids
@@ -3484,6 +3489,92 @@ module Google
3484
3489
  end
3485
3490
  end
3486
3491
 
3492
+ # A single custom bidding script.
3493
+ class CustomBiddingScript
3494
+ include Google::Apis::Core::Hashable
3495
+
3496
+ # Output only. Whether the script is currently being used for scoring by the
3497
+ # parent algorithm.
3498
+ # Corresponds to the JSON property `active`
3499
+ # @return [Boolean]
3500
+ attr_accessor :active
3501
+ alias_method :active?, :active
3502
+
3503
+ # Output only. The time when the script was created.
3504
+ # Corresponds to the JSON property `createTime`
3505
+ # @return [String]
3506
+ attr_accessor :create_time
3507
+
3508
+ # Output only. The unique ID of the custom bidding algorithm the script belongs
3509
+ # to.
3510
+ # Corresponds to the JSON property `customBiddingAlgorithmId`
3511
+ # @return [Fixnum]
3512
+ attr_accessor :custom_bidding_algorithm_id
3513
+
3514
+ # Output only. The unique ID of the custom bidding script.
3515
+ # Corresponds to the JSON property `customBiddingScriptId`
3516
+ # @return [Fixnum]
3517
+ attr_accessor :custom_bidding_script_id
3518
+
3519
+ # Output only. Error details of a rejected custom bidding script. This field
3520
+ # will only be populated when Script.state is REJECTED.
3521
+ # Corresponds to the JSON property `errors`
3522
+ # @return [Array<Google::Apis::DisplayvideoV1::ScriptError>]
3523
+ attr_accessor :errors
3524
+
3525
+ # Output only. The resource name of the custom bidding script.
3526
+ # Corresponds to the JSON property `name`
3527
+ # @return [String]
3528
+ attr_accessor :name
3529
+
3530
+ # The reference to the uploaded custom bidding script file.
3531
+ # Corresponds to the JSON property `script`
3532
+ # @return [Google::Apis::DisplayvideoV1::CustomBiddingScriptRef]
3533
+ attr_accessor :script
3534
+
3535
+ # Output only. The state of the custom bidding script.
3536
+ # Corresponds to the JSON property `state`
3537
+ # @return [String]
3538
+ attr_accessor :state
3539
+
3540
+ def initialize(**args)
3541
+ update!(**args)
3542
+ end
3543
+
3544
+ # Update properties of this object
3545
+ def update!(**args)
3546
+ @active = args[:active] if args.key?(:active)
3547
+ @create_time = args[:create_time] if args.key?(:create_time)
3548
+ @custom_bidding_algorithm_id = args[:custom_bidding_algorithm_id] if args.key?(:custom_bidding_algorithm_id)
3549
+ @custom_bidding_script_id = args[:custom_bidding_script_id] if args.key?(:custom_bidding_script_id)
3550
+ @errors = args[:errors] if args.key?(:errors)
3551
+ @name = args[:name] if args.key?(:name)
3552
+ @script = args[:script] if args.key?(:script)
3553
+ @state = args[:state] if args.key?(:state)
3554
+ end
3555
+ end
3556
+
3557
+ # The reference to the uploaded custom bidding script file.
3558
+ class CustomBiddingScriptRef
3559
+ include Google::Apis::Core::Hashable
3560
+
3561
+ # A resource name to be used in media.download to Download the script files. Or
3562
+ # media.upload to Upload the script files. Resource names have the format `
3563
+ # customBiddingAlgorithms/`custom_bidding_algorithm_id`/scriptRef/`ref_id``.
3564
+ # Corresponds to the JSON property `resourceName`
3565
+ # @return [String]
3566
+ attr_accessor :resource_name
3567
+
3568
+ def initialize(**args)
3569
+ update!(**args)
3570
+ end
3571
+
3572
+ # Update properties of this object
3573
+ def update!(**args)
3574
+ @resource_name = args[:resource_name] if args.key?(:resource_name)
3575
+ end
3576
+ end
3577
+
3487
3578
  # Describes a custom list entity, such as a custom affinity or custom intent
3488
3579
  # audience list.
3489
3580
  class CustomList
@@ -6422,6 +6513,34 @@ module Google
6422
6513
  end
6423
6514
  end
6424
6515
 
6516
+ #
6517
+ class ListCustomBiddingScriptsResponse
6518
+ include Google::Apis::Core::Hashable
6519
+
6520
+ # The list of custom bidding scripts. This list will be absent if empty.
6521
+ # Corresponds to the JSON property `customBiddingScripts`
6522
+ # @return [Array<Google::Apis::DisplayvideoV1::CustomBiddingScript>]
6523
+ attr_accessor :custom_bidding_scripts
6524
+
6525
+ # A token to retrieve the next page of results. Pass this value in the
6526
+ # page_token field in the subsequent call to `ListCustomBiddingScriptsRequest`
6527
+ # method to retrieve the next page of results. If this field is null, it means
6528
+ # this is the last page.
6529
+ # Corresponds to the JSON property `nextPageToken`
6530
+ # @return [String]
6531
+ attr_accessor :next_page_token
6532
+
6533
+ def initialize(**args)
6534
+ update!(**args)
6535
+ end
6536
+
6537
+ # Update properties of this object
6538
+ def update!(**args)
6539
+ @custom_bidding_scripts = args[:custom_bidding_scripts] if args.key?(:custom_bidding_scripts)
6540
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6541
+ end
6542
+ end
6543
+
6425
6544
  #
6426
6545
  class ListCustomListsResponse
6427
6546
  include Google::Apis::Core::Hashable
@@ -8186,7 +8305,13 @@ module Google
8186
8305
  attr_accessor :proximity_radius_unit
8187
8306
 
8188
8307
  # Required. The targeting_option_id of a TargetingOption of type `
8189
- # TARGETING_TYPE_POI` or reuse an existing assigned_targeting_option_id.
8308
+ # TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using
8309
+ # SearchTargetingOptions. If targeting a specific latitude/longitude coordinate
8310
+ # removed from an address or POI name, you can generate the necessary targeting
8311
+ # option ID by rounding the desired coordinate values to the 6th decimal place,
8312
+ # removing the decimals, and concatenating the string values separated by a
8313
+ # semicolon. For example, you can target the latitude/longitude pair of 40.
8314
+ # 7414691, -74.003387 using the targeting option ID "40741469;-74003387".
8190
8315
  # Corresponds to the JSON property `targetingOptionId`
8191
8316
  # @return [String]
8192
8317
  attr_accessor :targeting_option_id
@@ -8586,6 +8711,43 @@ module Google
8586
8711
  end
8587
8712
  end
8588
8713
 
8714
+ # An error message for a custom bidding script.
8715
+ class ScriptError
8716
+ include Google::Apis::Core::Hashable
8717
+
8718
+ # The column number in the script where the error was thrown.
8719
+ # Corresponds to the JSON property `column`
8720
+ # @return [Fixnum]
8721
+ attr_accessor :column
8722
+
8723
+ # The type of error.
8724
+ # Corresponds to the JSON property `errorCode`
8725
+ # @return [String]
8726
+ attr_accessor :error_code
8727
+
8728
+ # The detailed error message.
8729
+ # Corresponds to the JSON property `errorMessage`
8730
+ # @return [String]
8731
+ attr_accessor :error_message
8732
+
8733
+ # The line number in the script where the error was thrown.
8734
+ # Corresponds to the JSON property `line`
8735
+ # @return [Fixnum]
8736
+ attr_accessor :line
8737
+
8738
+ def initialize(**args)
8739
+ update!(**args)
8740
+ end
8741
+
8742
+ # Update properties of this object
8743
+ def update!(**args)
8744
+ @column = args[:column] if args.key?(:column)
8745
+ @error_code = args[:error_code] if args.key?(:error_code)
8746
+ @error_message = args[:error_message] if args.key?(:error_message)
8747
+ @line = args[:line] if args.key?(:line)
8748
+ end
8749
+ end
8750
+
8589
8751
  # Structured Data File (SDF) related settings.
8590
8752
  class SdfConfig
8591
8753
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DisplayvideoV1
18
18
  # Version of the google-apis-displayvideo_v1 gem
19
- GEM_VERSION = "0.15.0"
19
+ GEM_VERSION = "0.19.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210902"
25
+ REVISION = "20211021"
26
26
  end
27
27
  end
28
28
  end
@@ -508,6 +508,18 @@ module Google
508
508
  include Google::Apis::Core::JsonObjectSupport
509
509
  end
510
510
 
511
+ class CustomBiddingScript
512
+ class Representation < Google::Apis::Core::JsonRepresentation; end
513
+
514
+ include Google::Apis::Core::JsonObjectSupport
515
+ end
516
+
517
+ class CustomBiddingScriptRef
518
+ class Representation < Google::Apis::Core::JsonRepresentation; end
519
+
520
+ include Google::Apis::Core::JsonObjectSupport
521
+ end
522
+
511
523
  class CustomList
512
524
  class Representation < Google::Apis::Core::JsonRepresentation; end
513
525
 
@@ -982,6 +994,12 @@ module Google
982
994
  include Google::Apis::Core::JsonObjectSupport
983
995
  end
984
996
 
997
+ class ListCustomBiddingScriptsResponse
998
+ class Representation < Google::Apis::Core::JsonRepresentation; end
999
+
1000
+ include Google::Apis::Core::JsonObjectSupport
1001
+ end
1002
+
985
1003
  class ListCustomListsResponse
986
1004
  class Representation < Google::Apis::Core::JsonRepresentation; end
987
1005
 
@@ -1378,6 +1396,12 @@ module Google
1378
1396
  include Google::Apis::Core::JsonObjectSupport
1379
1397
  end
1380
1398
 
1399
+ class ScriptError
1400
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1401
+
1402
+ include Google::Apis::Core::JsonObjectSupport
1403
+ end
1404
+
1381
1405
  class SdfConfig
1382
1406
  class Representation < Google::Apis::Core::JsonRepresentation; end
1383
1407
 
@@ -2119,8 +2143,8 @@ module Google
2119
2143
  class BusinessChainSearchTerms
2120
2144
  # @private
2121
2145
  class Representation < Google::Apis::Core::JsonRepresentation
2122
- property :business_chain, as: 'businessChain'
2123
- property :region, as: 'region'
2146
+ property :business_chain_query, as: 'businessChainQuery'
2147
+ property :region_query, as: 'regionQuery'
2124
2148
  end
2125
2149
  end
2126
2150
 
@@ -2468,6 +2492,29 @@ module Google
2468
2492
  end
2469
2493
  end
2470
2494
 
2495
+ class CustomBiddingScript
2496
+ # @private
2497
+ class Representation < Google::Apis::Core::JsonRepresentation
2498
+ property :active, as: 'active'
2499
+ property :create_time, as: 'createTime'
2500
+ property :custom_bidding_algorithm_id, :numeric_string => true, as: 'customBiddingAlgorithmId'
2501
+ property :custom_bidding_script_id, :numeric_string => true, as: 'customBiddingScriptId'
2502
+ collection :errors, as: 'errors', class: Google::Apis::DisplayvideoV1::ScriptError, decorator: Google::Apis::DisplayvideoV1::ScriptError::Representation
2503
+
2504
+ property :name, as: 'name'
2505
+ property :script, as: 'script', class: Google::Apis::DisplayvideoV1::CustomBiddingScriptRef, decorator: Google::Apis::DisplayvideoV1::CustomBiddingScriptRef::Representation
2506
+
2507
+ property :state, as: 'state'
2508
+ end
2509
+ end
2510
+
2511
+ class CustomBiddingScriptRef
2512
+ # @private
2513
+ class Representation < Google::Apis::Core::JsonRepresentation
2514
+ property :resource_name, as: 'resourceName'
2515
+ end
2516
+ end
2517
+
2471
2518
  class CustomList
2472
2519
  # @private
2473
2520
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3259,6 +3306,15 @@ module Google
3259
3306
  end
3260
3307
  end
3261
3308
 
3309
+ class ListCustomBiddingScriptsResponse
3310
+ # @private
3311
+ class Representation < Google::Apis::Core::JsonRepresentation
3312
+ collection :custom_bidding_scripts, as: 'customBiddingScripts', class: Google::Apis::DisplayvideoV1::CustomBiddingScript, decorator: Google::Apis::DisplayvideoV1::CustomBiddingScript::Representation
3313
+
3314
+ property :next_page_token, as: 'nextPageToken'
3315
+ end
3316
+ end
3317
+
3262
3318
  class ListCustomListsResponse
3263
3319
  # @private
3264
3320
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3866,6 +3922,16 @@ module Google
3866
3922
  end
3867
3923
  end
3868
3924
 
3925
+ class ScriptError
3926
+ # @private
3927
+ class Representation < Google::Apis::Core::JsonRepresentation
3928
+ property :column, :numeric_string => true, as: 'column'
3929
+ property :error_code, as: 'errorCode'
3930
+ property :error_message, as: 'errorMessage'
3931
+ property :line, :numeric_string => true, as: 'line'
3932
+ end
3933
+ end
3934
+
3869
3935
  class SdfConfig
3870
3936
  # @private
3871
3937
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -22,8 +22,9 @@ module Google
22
22
  module DisplayvideoV1
23
23
  # Display & Video 360 API
24
24
  #
25
- # Display & Video 360 API allows users to manage and create campaigns and
26
- # reports.
25
+ # Display & Video 360 API allows users to automate complex Display & Video 360
26
+ # workflows, such as creating insertion orders and setting targeting options for
27
+ # individual line items.
27
28
  #
28
29
  # @example
29
30
  # require 'google/apis/displayvideo_v1'
@@ -3872,6 +3873,181 @@ module Google
3872
3873
  execute_or_queue_command(command, &block)
3873
3874
  end
3874
3875
 
3876
+ # Creates a custom bidding script reference object for a script file. The
3877
+ # resulting reference object provides a resource path to which the script file
3878
+ # should be uploaded. This reference object should be included in when creating
3879
+ # a new custom bidding script object.
3880
+ # @param [Fixnum] custom_bidding_algorithm_id
3881
+ # Required. The ID of the custom bidding algorithm owns the script.
3882
+ # @param [Fixnum] advertiser_id
3883
+ # The ID of the advertiser that owns the parent custom bidding algorithm.
3884
+ # @param [Fixnum] partner_id
3885
+ # The ID of the partner that owns the parent custom bidding algorithm. Only this
3886
+ # partner will have write access to this custom bidding script.
3887
+ # @param [String] fields
3888
+ # Selector specifying which fields to include in a partial response.
3889
+ # @param [String] quota_user
3890
+ # Available to use for quota purposes for server-side applications. Can be any
3891
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3892
+ # @param [Google::Apis::RequestOptions] options
3893
+ # Request-specific options
3894
+ #
3895
+ # @yield [result, err] Result & error if block supplied
3896
+ # @yieldparam result [Google::Apis::DisplayvideoV1::CustomBiddingScriptRef] parsed result object
3897
+ # @yieldparam err [StandardError] error object if request failed
3898
+ #
3899
+ # @return [Google::Apis::DisplayvideoV1::CustomBiddingScriptRef]
3900
+ #
3901
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3902
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3903
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3904
+ def upload_custom_bidding_algorithm_script(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
3905
+ command = make_simple_command(:get, 'v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript', options)
3906
+ command.response_representation = Google::Apis::DisplayvideoV1::CustomBiddingScriptRef::Representation
3907
+ command.response_class = Google::Apis::DisplayvideoV1::CustomBiddingScriptRef
3908
+ command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
3909
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
3910
+ command.query['partnerId'] = partner_id unless partner_id.nil?
3911
+ command.query['fields'] = fields unless fields.nil?
3912
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3913
+ execute_or_queue_command(command, &block)
3914
+ end
3915
+
3916
+ # Creates a new custom bidding script. Returns the newly created script if
3917
+ # successful.
3918
+ # @param [Fixnum] custom_bidding_algorithm_id
3919
+ # Required. The ID of the custom bidding algorithm that owns the script.
3920
+ # @param [Google::Apis::DisplayvideoV1::CustomBiddingScript] custom_bidding_script_object
3921
+ # @param [Fixnum] advertiser_id
3922
+ # The ID of the advertiser that owns the parent custom bidding algorithm.
3923
+ # @param [Fixnum] partner_id
3924
+ # The ID of the partner that owns the parent custom bidding algorithm. Only this
3925
+ # partner will have write access to this custom bidding script.
3926
+ # @param [String] fields
3927
+ # Selector specifying which fields to include in a partial response.
3928
+ # @param [String] quota_user
3929
+ # Available to use for quota purposes for server-side applications. Can be any
3930
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3931
+ # @param [Google::Apis::RequestOptions] options
3932
+ # Request-specific options
3933
+ #
3934
+ # @yield [result, err] Result & error if block supplied
3935
+ # @yieldparam result [Google::Apis::DisplayvideoV1::CustomBiddingScript] parsed result object
3936
+ # @yieldparam err [StandardError] error object if request failed
3937
+ #
3938
+ # @return [Google::Apis::DisplayvideoV1::CustomBiddingScript]
3939
+ #
3940
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3941
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3942
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3943
+ def create_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
3944
+ command = make_simple_command(:post, 'v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts', options)
3945
+ command.request_representation = Google::Apis::DisplayvideoV1::CustomBiddingScript::Representation
3946
+ command.request_object = custom_bidding_script_object
3947
+ command.response_representation = Google::Apis::DisplayvideoV1::CustomBiddingScript::Representation
3948
+ command.response_class = Google::Apis::DisplayvideoV1::CustomBiddingScript
3949
+ command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
3950
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
3951
+ command.query['partnerId'] = partner_id unless partner_id.nil?
3952
+ command.query['fields'] = fields unless fields.nil?
3953
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3954
+ execute_or_queue_command(command, &block)
3955
+ end
3956
+
3957
+ # Gets a custom bidding script.
3958
+ # @param [Fixnum] custom_bidding_algorithm_id
3959
+ # Required. The ID of the custom bidding algorithm owns the script.
3960
+ # @param [Fixnum] custom_bidding_script_id
3961
+ # Required. The ID of the custom bidding script to fetch.
3962
+ # @param [Fixnum] advertiser_id
3963
+ # The ID of the advertiser that owns the parent custom bidding algorithm.
3964
+ # @param [Fixnum] partner_id
3965
+ # The ID of the partner that owns the parent custom bidding algorithm. Only this
3966
+ # partner will have write access to this custom bidding script.
3967
+ # @param [String] fields
3968
+ # Selector specifying which fields to include in a partial response.
3969
+ # @param [String] quota_user
3970
+ # Available to use for quota purposes for server-side applications. Can be any
3971
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3972
+ # @param [Google::Apis::RequestOptions] options
3973
+ # Request-specific options
3974
+ #
3975
+ # @yield [result, err] Result & error if block supplied
3976
+ # @yieldparam result [Google::Apis::DisplayvideoV1::CustomBiddingScript] parsed result object
3977
+ # @yieldparam err [StandardError] error object if request failed
3978
+ #
3979
+ # @return [Google::Apis::DisplayvideoV1::CustomBiddingScript]
3980
+ #
3981
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3982
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3983
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3984
+ def get_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
3985
+ command = make_simple_command(:get, 'v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}', options)
3986
+ command.response_representation = Google::Apis::DisplayvideoV1::CustomBiddingScript::Representation
3987
+ command.response_class = Google::Apis::DisplayvideoV1::CustomBiddingScript
3988
+ command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
3989
+ command.params['customBiddingScriptId'] = custom_bidding_script_id unless custom_bidding_script_id.nil?
3990
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
3991
+ command.query['partnerId'] = partner_id unless partner_id.nil?
3992
+ command.query['fields'] = fields unless fields.nil?
3993
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3994
+ execute_or_queue_command(command, &block)
3995
+ end
3996
+
3997
+ # Lists custom bidding scripts that belong to the given algorithm. The order is
3998
+ # defined by the order_by parameter.
3999
+ # @param [Fixnum] custom_bidding_algorithm_id
4000
+ # Required. The ID of the custom bidding algorithm owns the script.
4001
+ # @param [Fixnum] advertiser_id
4002
+ # The ID of the advertiser that owns the parent custom bidding algorithm.
4003
+ # @param [String] order_by
4004
+ # Field by which to sort the list. Acceptable values are: * `createTime desc` (
4005
+ # default) The default sorting order is descending. To specify ascending order
4006
+ # for a field, the suffix "desc" should be removed. Example: `createTime`.
4007
+ # @param [Fixnum] page_size
4008
+ # Requested page size. Must be between `1` and `100`. If unspecified will
4009
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
4010
+ # specified.
4011
+ # @param [String] page_token
4012
+ # A token identifying a page of results the server should return. Typically,
4013
+ # this is the value of next_page_token returned from the previous call to `
4014
+ # ListCustomBiddingScripts` method. If not specified, the first page of results
4015
+ # will be returned.
4016
+ # @param [Fixnum] partner_id
4017
+ # The ID of the partner that owns the parent custom bidding algorithm. Only this
4018
+ # partner will have write access to this custom bidding script.
4019
+ # @param [String] fields
4020
+ # Selector specifying which fields to include in a partial response.
4021
+ # @param [String] quota_user
4022
+ # Available to use for quota purposes for server-side applications. Can be any
4023
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4024
+ # @param [Google::Apis::RequestOptions] options
4025
+ # Request-specific options
4026
+ #
4027
+ # @yield [result, err] Result & error if block supplied
4028
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListCustomBiddingScriptsResponse] parsed result object
4029
+ # @yieldparam err [StandardError] error object if request failed
4030
+ #
4031
+ # @return [Google::Apis::DisplayvideoV1::ListCustomBiddingScriptsResponse]
4032
+ #
4033
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4034
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4035
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4036
+ def list_custom_bidding_algorithm_scripts(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4037
+ command = make_simple_command(:get, 'v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts', options)
4038
+ command.response_representation = Google::Apis::DisplayvideoV1::ListCustomBiddingScriptsResponse::Representation
4039
+ command.response_class = Google::Apis::DisplayvideoV1::ListCustomBiddingScriptsResponse
4040
+ command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
4041
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
4042
+ command.query['orderBy'] = order_by unless order_by.nil?
4043
+ command.query['pageSize'] = page_size unless page_size.nil?
4044
+ command.query['pageToken'] = page_token unless page_token.nil?
4045
+ command.query['partnerId'] = partner_id unless partner_id.nil?
4046
+ command.query['fields'] = fields unless fields.nil?
4047
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4048
+ execute_or_queue_command(command, &block)
4049
+ end
4050
+
3875
4051
  # Gets a custom list.
3876
4052
  # @param [Fixnum] custom_list_id
3877
4053
  # Required. The ID of the custom list to fetch.
@@ -4781,6 +4957,51 @@ module Google
4781
4957
  execute_or_queue_command(command, &block)
4782
4958
  end
4783
4959
 
4960
+ # Uploads media. Upload is supported on the URI `/upload/media/`resource_name=**`
4961
+ # ?upload_type=media.` **Note**: Upload requests will not be successful without
4962
+ # including `upload_type=media` query string.
4963
+ # @param [String] resource_name
4964
+ # Name of the media that is being downloaded. See ReadRequest.resource_name.
4965
+ # @param [Google::Apis::DisplayvideoV1::GoogleBytestreamMedia] google_bytestream_media_object
4966
+ # @param [String] fields
4967
+ # Selector specifying which fields to include in a partial response.
4968
+ # @param [String] quota_user
4969
+ # Available to use for quota purposes for server-side applications. Can be any
4970
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4971
+ # @param [IO, String] upload_source
4972
+ # IO stream or filename containing content to upload
4973
+ # @param [String] content_type
4974
+ # Content type of the uploaded content.
4975
+ # @param [Google::Apis::RequestOptions] options
4976
+ # Request-specific options
4977
+ #
4978
+ # @yield [result, err] Result & error if block supplied
4979
+ # @yieldparam result [Google::Apis::DisplayvideoV1::GoogleBytestreamMedia] parsed result object
4980
+ # @yieldparam err [StandardError] error object if request failed
4981
+ #
4982
+ # @return [Google::Apis::DisplayvideoV1::GoogleBytestreamMedia]
4983
+ #
4984
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4985
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4986
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4987
+ def upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
4988
+ if upload_source.nil?
4989
+ command = make_simple_command(:post, 'media/{+resourceName}', options)
4990
+ else
4991
+ command = make_upload_command(:post, 'media/{+resourceName}', options)
4992
+ command.upload_source = upload_source
4993
+ command.upload_content_type = content_type
4994
+ end
4995
+ command.request_representation = Google::Apis::DisplayvideoV1::GoogleBytestreamMedia::Representation
4996
+ command.request_object = google_bytestream_media_object
4997
+ command.response_representation = Google::Apis::DisplayvideoV1::GoogleBytestreamMedia::Representation
4998
+ command.response_class = Google::Apis::DisplayvideoV1::GoogleBytestreamMedia
4999
+ command.params['resourceName'] = resource_name unless resource_name.nil?
5000
+ command.query['fields'] = fields unless fields.nil?
5001
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5002
+ execute_or_queue_command(command, &block)
5003
+ end
5004
+
4784
5005
  # Bulk edits targeting options under a single partner. The operation will delete
4785
5006
  # the assigned targeting options provided in
4786
5007
  # BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create
@@ -5529,7 +5750,22 @@ module Google
5529
5750
 
5530
5751
  # Gets a single targeting option.
5531
5752
  # @param [String] targeting_type
5532
- # Required. The type of targeting option to retrieve.
5753
+ # Required. The type of targeting option to retrieve. Accepted values are: * `
5754
+ # TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `
5755
+ # TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `
5756
+ # TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `
5757
+ # TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
5758
+ # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `
5759
+ # TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
5760
+ # TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `
5761
+ # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
5762
+ # TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `
5763
+ # TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
5764
+ # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `
5765
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `
5766
+ # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `
5767
+ # TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `
5768
+ # TARGETING_TYPE_OMID`
5533
5769
  # @param [String] targeting_option_id
5534
5770
  # Required. The ID of the of targeting option to retrieve.
5535
5771
  # @param [Fixnum] advertiser_id
@@ -5565,7 +5801,22 @@ module Google
5565
5801
 
5566
5802
  # Lists targeting options of a given type.
5567
5803
  # @param [String] targeting_type
5568
- # Required. The type of targeting option to be listed.
5804
+ # Required. The type of targeting option to be listed. Accepted values are: * `
5805
+ # TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `
5806
+ # TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `
5807
+ # TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `
5808
+ # TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
5809
+ # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `
5810
+ # TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
5811
+ # TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `
5812
+ # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
5813
+ # TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `
5814
+ # TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
5815
+ # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `
5816
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `
5817
+ # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `
5818
+ # TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `
5819
+ # TARGETING_TYPE_OMID`
5569
5820
  # @param [Fixnum] advertiser_id
5570
5821
  # Required. The Advertiser this request is being made in the context of.
5571
5822
  # @param [String] filter
@@ -21,8 +21,9 @@ module Google
21
21
  module Apis
22
22
  # Display & Video 360 API
23
23
  #
24
- # Display & Video 360 API allows users to manage and create campaigns and
25
- # reports.
24
+ # Display & Video 360 API allows users to automate complex Display & Video 360
25
+ # workflows, such as creating insertion orders and setting targeting options for
26
+ # individual line items.
26
27
  #
27
28
  # @see https://developers.google.com/display-video/
28
29
  module DisplayvideoV1
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-displayvideo_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.15.0
4
+ version: 0.19.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-09-06 00:00:00.000000000 Z
11
+ date: 2021-10-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-displayvideo_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v1/v0.15.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-displayvideo_v1
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v1/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v1/v0.19.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v1
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths: