google-apis-realtimebidding_v1 0.1.0 → 0.30.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +123 -0
- data/OVERVIEW.md +3 -3
- data/lib/google/apis/realtimebidding_v1/classes.rb +553 -39
- data/lib/google/apis/realtimebidding_v1/gem_version.rb +3 -3
- data/lib/google/apis/realtimebidding_v1/representations.rb +203 -0
- data/lib/google/apis/realtimebidding_v1/service.rb +462 -38
- metadata +17 -11
@@ -36,6 +36,58 @@ module Google
|
|
36
36
|
end
|
37
37
|
end
|
38
38
|
|
39
|
+
# The list of detected Ad Technology Providers for this creative. Bids placed
|
40
|
+
# for inventory that will serve to EEA or UK users are expected to comply with
|
41
|
+
# GDPR requirements. You must ensure that the creatives used in such bids should
|
42
|
+
# contain only user consented ad technology providers as indicated in the bid
|
43
|
+
# request. Google reserves the right to filter non-compliant bids. User
|
44
|
+
# consented ad technology providers can be found in the [Google Protocol](https:/
|
45
|
+
# /developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto)
|
46
|
+
# with the `BidRequest.adslot.consented_providers_settings` field, and can be
|
47
|
+
# found as an [OpenRTB extension](https://developers.google.com/authorized-
|
48
|
+
# buyers/rtb/downloads/openrtb-adx-proto) with the `BidRequest.user.ext.
|
49
|
+
# consented_providers_settings` and `BidRequest.user.ext.consent` fields. See
|
50
|
+
# https://support.google.com/authorizedbuyers/answer/9789378 for additional
|
51
|
+
# information about the Google TCF v2 integration.
|
52
|
+
class AdTechnologyProviders
|
53
|
+
include Google::Apis::Core::Hashable
|
54
|
+
|
55
|
+
# The detected IAB Global Vendor List (GVL) IDs for this creative. See the IAB
|
56
|
+
# Global Vendor List at https://vendor-list.consensu.org/v2/vendor-list.json for
|
57
|
+
# details about the vendors.
|
58
|
+
# Corresponds to the JSON property `detectedGvlIds`
|
59
|
+
# @return [Array<Fixnum>]
|
60
|
+
attr_accessor :detected_gvl_ids
|
61
|
+
|
62
|
+
# The detected [Google Ad Tech Providers (ATP)](https://support.google.com/
|
63
|
+
# admanager/answer/9012903) for this creative. See https://storage.googleapis.
|
64
|
+
# com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided
|
65
|
+
# name, a privacy policy URL, and a list of domains which can be attributed to
|
66
|
+
# the provider.
|
67
|
+
# Corresponds to the JSON property `detectedProviderIds`
|
68
|
+
# @return [Array<Fixnum>]
|
69
|
+
attr_accessor :detected_provider_ids
|
70
|
+
|
71
|
+
# Domains of detected unidentified ad technology providers (if any). You must
|
72
|
+
# ensure that the creatives used in bids placed for inventory that will serve to
|
73
|
+
# EEA or UK users does not contain unidentified ad technology providers. Google
|
74
|
+
# reserves the right to filter non-compliant bids.
|
75
|
+
# Corresponds to the JSON property `unidentifiedProviderDomains`
|
76
|
+
# @return [Array<String>]
|
77
|
+
attr_accessor :unidentified_provider_domains
|
78
|
+
|
79
|
+
def initialize(**args)
|
80
|
+
update!(**args)
|
81
|
+
end
|
82
|
+
|
83
|
+
# Update properties of this object
|
84
|
+
def update!(**args)
|
85
|
+
@detected_gvl_ids = args[:detected_gvl_ids] if args.key?(:detected_gvl_ids)
|
86
|
+
@detected_provider_ids = args[:detected_provider_ids] if args.key?(:detected_provider_ids)
|
87
|
+
@unidentified_provider_domains = args[:unidentified_provider_domains] if args.key?(:unidentified_provider_domains)
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
39
91
|
# A request to start targeting the provided app IDs in a specific pretargeting
|
40
92
|
# configuration. The pretargeting configuration itself specifies how these apps
|
41
93
|
# are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.
|
@@ -205,6 +257,213 @@ module Google
|
|
205
257
|
end
|
206
258
|
end
|
207
259
|
|
260
|
+
# A request to approve a batch of publisher connections.
|
261
|
+
class BatchApprovePublisherConnectionsRequest
|
262
|
+
include Google::Apis::Core::Hashable
|
263
|
+
|
264
|
+
# Required. The names of the publishers with which connections will be approved.
|
265
|
+
# In the pattern `bidders/`bidder`/publisherConnections/`publisher`` where ``
|
266
|
+
# bidder`` is the account ID of the bidder, and ``publisher`` is the ads.txt/app-
|
267
|
+
# ads.txt publisher ID.
|
268
|
+
# Corresponds to the JSON property `names`
|
269
|
+
# @return [Array<String>]
|
270
|
+
attr_accessor :names
|
271
|
+
|
272
|
+
def initialize(**args)
|
273
|
+
update!(**args)
|
274
|
+
end
|
275
|
+
|
276
|
+
# Update properties of this object
|
277
|
+
def update!(**args)
|
278
|
+
@names = args[:names] if args.key?(:names)
|
279
|
+
end
|
280
|
+
end
|
281
|
+
|
282
|
+
# A response for the request to approve a batch of publisher connections.
|
283
|
+
class BatchApprovePublisherConnectionsResponse
|
284
|
+
include Google::Apis::Core::Hashable
|
285
|
+
|
286
|
+
# The publisher connections that have been approved.
|
287
|
+
# Corresponds to the JSON property `publisherConnections`
|
288
|
+
# @return [Array<Google::Apis::RealtimebiddingV1::PublisherConnection>]
|
289
|
+
attr_accessor :publisher_connections
|
290
|
+
|
291
|
+
def initialize(**args)
|
292
|
+
update!(**args)
|
293
|
+
end
|
294
|
+
|
295
|
+
# Update properties of this object
|
296
|
+
def update!(**args)
|
297
|
+
@publisher_connections = args[:publisher_connections] if args.key?(:publisher_connections)
|
298
|
+
end
|
299
|
+
end
|
300
|
+
|
301
|
+
# A request to reject a batch of publisher connections.
|
302
|
+
class BatchRejectPublisherConnectionsRequest
|
303
|
+
include Google::Apis::Core::Hashable
|
304
|
+
|
305
|
+
# Required. The names of the publishers with whom connection will be rejected.
|
306
|
+
# In the pattern `bidders/`bidder`/publisherConnections/`publisher`` where ``
|
307
|
+
# bidder`` is the account ID of the bidder, and ``publisher`` is the ads.txt/app-
|
308
|
+
# ads.txt publisher ID.
|
309
|
+
# Corresponds to the JSON property `names`
|
310
|
+
# @return [Array<String>]
|
311
|
+
attr_accessor :names
|
312
|
+
|
313
|
+
def initialize(**args)
|
314
|
+
update!(**args)
|
315
|
+
end
|
316
|
+
|
317
|
+
# Update properties of this object
|
318
|
+
def update!(**args)
|
319
|
+
@names = args[:names] if args.key?(:names)
|
320
|
+
end
|
321
|
+
end
|
322
|
+
|
323
|
+
# A response for the request to reject a batch of publisher connections.
|
324
|
+
class BatchRejectPublisherConnectionsResponse
|
325
|
+
include Google::Apis::Core::Hashable
|
326
|
+
|
327
|
+
# The publisher connections that have been rejected.
|
328
|
+
# Corresponds to the JSON property `publisherConnections`
|
329
|
+
# @return [Array<Google::Apis::RealtimebiddingV1::PublisherConnection>]
|
330
|
+
attr_accessor :publisher_connections
|
331
|
+
|
332
|
+
def initialize(**args)
|
333
|
+
update!(**args)
|
334
|
+
end
|
335
|
+
|
336
|
+
# Update properties of this object
|
337
|
+
def update!(**args)
|
338
|
+
@publisher_connections = args[:publisher_connections] if args.key?(:publisher_connections)
|
339
|
+
end
|
340
|
+
end
|
341
|
+
|
342
|
+
# Bidder settings.
|
343
|
+
class Bidder
|
344
|
+
include Google::Apis::Core::Hashable
|
345
|
+
|
346
|
+
# Output only. An option to bypass pretargeting for private auctions and
|
347
|
+
# preferred deals. When true, bid requests from these nonguaranteed deals will
|
348
|
+
# always be sent. When false, bid requests will be subject to regular
|
349
|
+
# pretargeting configurations. Programmatic Guaranteed deals will always be sent
|
350
|
+
# to the bidder, regardless of the value for this flag. Auction packages are not
|
351
|
+
# impacted by this value and are subject to the regular pretargeting
|
352
|
+
# configurations.
|
353
|
+
# Corresponds to the JSON property `bypassNonguaranteedDealsPretargeting`
|
354
|
+
# @return [Boolean]
|
355
|
+
attr_accessor :bypass_nonguaranteed_deals_pretargeting
|
356
|
+
alias_method :bypass_nonguaranteed_deals_pretargeting?, :bypass_nonguaranteed_deals_pretargeting
|
357
|
+
|
358
|
+
# Output only. The buyer's network ID used for cookie matching. This ID
|
359
|
+
# corresponds to the `google_nid` parameter in the URL used in cookie match
|
360
|
+
# requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-
|
361
|
+
# guide for further information.
|
362
|
+
# Corresponds to the JSON property `cookieMatchingNetworkId`
|
363
|
+
# @return [String]
|
364
|
+
attr_accessor :cookie_matching_network_id
|
365
|
+
|
366
|
+
# Output only. The base URL used in cookie match requests. Refer to https://
|
367
|
+
# developers.google.com/authorized-buyers/rtb/cookie-guide for further
|
368
|
+
# information.
|
369
|
+
# Corresponds to the JSON property `cookieMatchingUrl`
|
370
|
+
# @return [String]
|
371
|
+
attr_accessor :cookie_matching_url
|
372
|
+
|
373
|
+
# Output only. The billing ID for the deals pretargeting config. This billing ID
|
374
|
+
# is sent on the bid request for guaranteed and nonguaranteed deals matched in
|
375
|
+
# pretargeting.
|
376
|
+
# Corresponds to the JSON property `dealsBillingId`
|
377
|
+
# @return [String]
|
378
|
+
attr_accessor :deals_billing_id
|
379
|
+
|
380
|
+
# Output only. Name of the bidder resource that must follow the pattern `bidders/
|
381
|
+
# `bidderAccountId``, where ``bidderAccountId`` is the account ID of the bidder
|
382
|
+
# whose information is to be received. One can get their account ID on the
|
383
|
+
# Authorized Buyers or Open Bidding UI, or by contacting their Google account
|
384
|
+
# manager.
|
385
|
+
# Corresponds to the JSON property `name`
|
386
|
+
# @return [String]
|
387
|
+
attr_accessor :name
|
388
|
+
|
389
|
+
def initialize(**args)
|
390
|
+
update!(**args)
|
391
|
+
end
|
392
|
+
|
393
|
+
# Update properties of this object
|
394
|
+
def update!(**args)
|
395
|
+
@bypass_nonguaranteed_deals_pretargeting = args[:bypass_nonguaranteed_deals_pretargeting] if args.key?(:bypass_nonguaranteed_deals_pretargeting)
|
396
|
+
@cookie_matching_network_id = args[:cookie_matching_network_id] if args.key?(:cookie_matching_network_id)
|
397
|
+
@cookie_matching_url = args[:cookie_matching_url] if args.key?(:cookie_matching_url)
|
398
|
+
@deals_billing_id = args[:deals_billing_id] if args.key?(:deals_billing_id)
|
399
|
+
@name = args[:name] if args.key?(:name)
|
400
|
+
end
|
401
|
+
end
|
402
|
+
|
403
|
+
# RTB Buyer account information.
|
404
|
+
class Buyer
|
405
|
+
include Google::Apis::Core::Hashable
|
406
|
+
|
407
|
+
# Output only. The number of creatives that this buyer submitted through the API
|
408
|
+
# or bid with in the last 30 days. This is counted against the maximum number of
|
409
|
+
# active creatives.
|
410
|
+
# Corresponds to the JSON property `activeCreativeCount`
|
411
|
+
# @return [Fixnum]
|
412
|
+
attr_accessor :active_creative_count
|
413
|
+
|
414
|
+
# Output only. The name of the bidder resource that is responsible for receiving
|
415
|
+
# bidding traffic for this account. The bidder name must follow the pattern `
|
416
|
+
# bidders/`bidderAccountId``, where ``bidderAccountId`` is the account ID of the
|
417
|
+
# bidder receiving traffic for this buyer.
|
418
|
+
# Corresponds to the JSON property `bidder`
|
419
|
+
# @return [String]
|
420
|
+
attr_accessor :bidder
|
421
|
+
|
422
|
+
# Output only. A list of billing IDs associated with this account. These IDs
|
423
|
+
# appear on: 1. A bid request, to signal which buyers are eligible to bid on a
|
424
|
+
# given opportunity, and which pretargeting configurations were matched for each
|
425
|
+
# eligible buyer. 2. The bid response, to attribute a winning impression to a
|
426
|
+
# specific account for billing, reporting, policy and publisher block
|
427
|
+
# enforcement.
|
428
|
+
# Corresponds to the JSON property `billingIds`
|
429
|
+
# @return [Array<String>]
|
430
|
+
attr_accessor :billing_ids
|
431
|
+
|
432
|
+
# Output only. The diplay name associated with this buyer account, as visible to
|
433
|
+
# sellers.
|
434
|
+
# Corresponds to the JSON property `displayName`
|
435
|
+
# @return [String]
|
436
|
+
attr_accessor :display_name
|
437
|
+
|
438
|
+
# Output only. The maximum number of active creatives that this buyer can have.
|
439
|
+
# Corresponds to the JSON property `maximumActiveCreativeCount`
|
440
|
+
# @return [Fixnum]
|
441
|
+
attr_accessor :maximum_active_creative_count
|
442
|
+
|
443
|
+
# Output only. Name of the buyer resource that must follow the pattern `buyers/`
|
444
|
+
# buyerAccountId``, where ``buyerAccountId`` is the account ID of the buyer
|
445
|
+
# account whose information is to be received. One can get their account ID on
|
446
|
+
# the Authorized Buyers or Open Bidding UI, or by contacting their Google
|
447
|
+
# account manager.
|
448
|
+
# Corresponds to the JSON property `name`
|
449
|
+
# @return [String]
|
450
|
+
attr_accessor :name
|
451
|
+
|
452
|
+
def initialize(**args)
|
453
|
+
update!(**args)
|
454
|
+
end
|
455
|
+
|
456
|
+
# Update properties of this object
|
457
|
+
def update!(**args)
|
458
|
+
@active_creative_count = args[:active_creative_count] if args.key?(:active_creative_count)
|
459
|
+
@bidder = args[:bidder] if args.key?(:bidder)
|
460
|
+
@billing_ids = args[:billing_ids] if args.key?(:billing_ids)
|
461
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
462
|
+
@maximum_active_creative_count = args[:maximum_active_creative_count] if args.key?(:maximum_active_creative_count)
|
463
|
+
@name = args[:name] if args.key?(:name)
|
464
|
+
end
|
465
|
+
end
|
466
|
+
|
208
467
|
# A request to close a specified user list.
|
209
468
|
class CloseUserListRequest
|
210
469
|
include Google::Apis::Core::Hashable
|
@@ -245,7 +504,7 @@ module Google
|
|
245
504
|
# @return [Fixnum]
|
246
505
|
attr_accessor :agency_id
|
247
506
|
|
248
|
-
# Output only. The last update timestamp of the creative
|
507
|
+
# Output only. The last update timestamp of the creative through the API.
|
249
508
|
# Corresponds to the JSON property `apiUpdateTime`
|
250
509
|
# @return [String]
|
251
510
|
attr_accessor :api_update_time
|
@@ -328,12 +587,23 @@ module Google
|
|
328
587
|
# @return [Google::Apis::RealtimebiddingV1::NativeContent]
|
329
588
|
attr_accessor :native
|
330
589
|
|
590
|
+
# Experimental field that can be used during the [FLEDGE Origin Trial](/
|
591
|
+
# authorized-buyers/rtb/fledge-origin-trial). The URL to fetch an interest group
|
592
|
+
# ad used in [TURTLEDOVE on-device auction](https://github.com/WICG/turtledove/
|
593
|
+
# blob/main/FLEDGE.md#1-browsers-record-interest-groups"). This should be unique
|
594
|
+
# among all creatives for a given `accountId`. This URL should be the same as
|
595
|
+
# the URL returned by [generateBid()](https://github.com/WICG/turtledove/blob/
|
596
|
+
# main/FLEDGE.md#32-on-device-bidding).
|
597
|
+
# Corresponds to the JSON property `renderUrl`
|
598
|
+
# @return [String]
|
599
|
+
attr_accessor :render_url
|
600
|
+
|
331
601
|
# All restricted categories for the ads that may be shown from this creative.
|
332
602
|
# Corresponds to the JSON property `restrictedCategories`
|
333
603
|
# @return [Array<String>]
|
334
604
|
attr_accessor :restricted_categories
|
335
605
|
|
336
|
-
# Output only. The version of
|
606
|
+
# Output only. The version of the creative. Version for a new creative is 1 and
|
337
607
|
# it increments during subsequent creative updates.
|
338
608
|
# Corresponds to the JSON property `version`
|
339
609
|
# @return [Fixnum]
|
@@ -367,6 +637,7 @@ module Google
|
|
367
637
|
@impression_tracking_urls = args[:impression_tracking_urls] if args.key?(:impression_tracking_urls)
|
368
638
|
@name = args[:name] if args.key?(:name)
|
369
639
|
@native = args[:native] if args.key?(:native)
|
640
|
+
@render_url = args[:render_url] if args.key?(:render_url)
|
370
641
|
@restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories)
|
371
642
|
@version = args[:version] if args.key?(:version)
|
372
643
|
@video = args[:video] if args.key?(:video)
|
@@ -402,6 +673,23 @@ module Google
|
|
402
673
|
class CreativeServingDecision
|
403
674
|
include Google::Apis::Core::Hashable
|
404
675
|
|
676
|
+
# The list of detected Ad Technology Providers for this creative. Bids placed
|
677
|
+
# for inventory that will serve to EEA or UK users are expected to comply with
|
678
|
+
# GDPR requirements. You must ensure that the creatives used in such bids should
|
679
|
+
# contain only user consented ad technology providers as indicated in the bid
|
680
|
+
# request. Google reserves the right to filter non-compliant bids. User
|
681
|
+
# consented ad technology providers can be found in the [Google Protocol](https:/
|
682
|
+
# /developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto)
|
683
|
+
# with the `BidRequest.adslot.consented_providers_settings` field, and can be
|
684
|
+
# found as an [OpenRTB extension](https://developers.google.com/authorized-
|
685
|
+
# buyers/rtb/downloads/openrtb-adx-proto) with the `BidRequest.user.ext.
|
686
|
+
# consented_providers_settings` and `BidRequest.user.ext.consent` fields. See
|
687
|
+
# https://support.google.com/authorizedbuyers/answer/9789378 for additional
|
688
|
+
# information about the Google TCF v2 integration.
|
689
|
+
# Corresponds to the JSON property `adTechnologyProviders`
|
690
|
+
# @return [Google::Apis::RealtimebiddingV1::AdTechnologyProviders]
|
691
|
+
attr_accessor :ad_technology_providers
|
692
|
+
|
405
693
|
# Policy compliance of the creative for a transaction type or a region.
|
406
694
|
# Corresponds to the JSON property `chinaPolicyCompliance`
|
407
695
|
# @return [Google::Apis::RealtimebiddingV1::PolicyCompliance]
|
@@ -500,6 +788,7 @@ module Google
|
|
500
788
|
|
501
789
|
# Update properties of this object
|
502
790
|
def update!(**args)
|
791
|
+
@ad_technology_providers = args[:ad_technology_providers] if args.key?(:ad_technology_providers)
|
503
792
|
@china_policy_compliance = args[:china_policy_compliance] if args.key?(:china_policy_compliance)
|
504
793
|
@deals_policy_compliance = args[:deals_policy_compliance] if args.key?(:deals_policy_compliance)
|
505
794
|
@detected_advertisers = args[:detected_advertisers] if args.key?(:detected_advertisers)
|
@@ -520,11 +809,11 @@ module Google
|
|
520
809
|
# Represents a whole or partial calendar date, such as a birthday. The time of
|
521
810
|
# day and time zone are either specified elsewhere or are insignificant. The
|
522
811
|
# date is relative to the Gregorian Calendar. This can represent one of the
|
523
|
-
# following: * A full date, with non-zero year, month, and day values * A month
|
524
|
-
# and day
|
525
|
-
# with zero month and day
|
526
|
-
#
|
527
|
-
# google.protobuf.Timestamp
|
812
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
813
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
814
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
815
|
+
# example, a credit card expiration date). Related types: * google.type.
|
816
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
528
817
|
class Date
|
529
818
|
include Google::Apis::Core::Hashable
|
530
819
|
|
@@ -604,7 +893,7 @@ module Google
|
|
604
893
|
# @return [String]
|
605
894
|
attr_accessor :expanded_url
|
606
895
|
|
607
|
-
# HTTP error code (
|
896
|
+
# HTTP error code (for example, 404 or 5xx)
|
608
897
|
# Corresponds to the JSON property `httpError`
|
609
898
|
# @return [Fixnum]
|
610
899
|
attr_accessor :http_error
|
@@ -675,7 +964,7 @@ module Google
|
|
675
964
|
class DomainCallEvidence
|
676
965
|
include Google::Apis::Core::Hashable
|
677
966
|
|
678
|
-
# Breakdown of the most frequent domains called
|
967
|
+
# Breakdown of the most frequent domains called through HTTP by the creative.
|
679
968
|
# Corresponds to the JSON property `topHttpCallDomains`
|
680
969
|
# @return [Array<Google::Apis::RealtimebiddingV1::DomainCalls>]
|
681
970
|
attr_accessor :top_http_call_domains
|
@@ -751,8 +1040,7 @@ module Google
|
|
751
1040
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
752
1041
|
# messages in your APIs. A typical example is to use it as the request or the
|
753
1042
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
754
|
-
# protobuf.Empty) returns (google.protobuf.Empty); `
|
755
|
-
# `Empty` is empty JSON object ````.
|
1043
|
+
# protobuf.Empty) returns (google.protobuf.Empty); `
|
756
1044
|
class Empty
|
757
1045
|
include Google::Apis::Core::Hashable
|
758
1046
|
|
@@ -765,14 +1053,65 @@ module Google
|
|
765
1053
|
end
|
766
1054
|
end
|
767
1055
|
|
768
|
-
#
|
1056
|
+
# Bidder endpoint that receives bid requests.
|
1057
|
+
class Endpoint
|
1058
|
+
include Google::Apis::Core::Hashable
|
1059
|
+
|
1060
|
+
# The protocol that the bidder endpoint is using.
|
1061
|
+
# Corresponds to the JSON property `bidProtocol`
|
1062
|
+
# @return [String]
|
1063
|
+
attr_accessor :bid_protocol
|
1064
|
+
|
1065
|
+
# The maximum number of queries per second allowed to be sent to this server.
|
1066
|
+
# Corresponds to the JSON property `maximumQps`
|
1067
|
+
# @return [Fixnum]
|
1068
|
+
attr_accessor :maximum_qps
|
1069
|
+
|
1070
|
+
# Output only. Name of the endpoint resource that must follow the pattern `
|
1071
|
+
# bidders/`bidderAccountId`/endpoints/`endpointId``, where `bidderAccountId` is
|
1072
|
+
# the account ID of the bidder who operates this endpoint, and `endpointId` is a
|
1073
|
+
# unique ID assigned by the server.
|
1074
|
+
# Corresponds to the JSON property `name`
|
1075
|
+
# @return [String]
|
1076
|
+
attr_accessor :name
|
1077
|
+
|
1078
|
+
# The trading location that bid requests should be sent from. See https://
|
1079
|
+
# developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for
|
1080
|
+
# further information.
|
1081
|
+
# Corresponds to the JSON property `tradingLocation`
|
1082
|
+
# @return [String]
|
1083
|
+
attr_accessor :trading_location
|
1084
|
+
|
1085
|
+
# Output only. The URL that bid requests should be sent to.
|
1086
|
+
# Corresponds to the JSON property `url`
|
1087
|
+
# @return [String]
|
1088
|
+
attr_accessor :url
|
1089
|
+
|
1090
|
+
def initialize(**args)
|
1091
|
+
update!(**args)
|
1092
|
+
end
|
1093
|
+
|
1094
|
+
# Update properties of this object
|
1095
|
+
def update!(**args)
|
1096
|
+
@bid_protocol = args[:bid_protocol] if args.key?(:bid_protocol)
|
1097
|
+
@maximum_qps = args[:maximum_qps] if args.key?(:maximum_qps)
|
1098
|
+
@name = args[:name] if args.key?(:name)
|
1099
|
+
@trading_location = args[:trading_location] if args.key?(:trading_location)
|
1100
|
+
@url = args[:url] if args.key?(:url)
|
1101
|
+
end
|
1102
|
+
end
|
1103
|
+
|
1104
|
+
# This has been sunset as of October 2023, and will return an error response if
|
1105
|
+
# called. For more information, see the release notes: https://developers.google.
|
1106
|
+
# com/authorized-buyers/apis/relnotes#real-time-bidding-api Response for a
|
1107
|
+
# request to get remarketing tag.
|
769
1108
|
class GetRemarketingTagResponse
|
770
1109
|
include Google::Apis::Core::Hashable
|
771
1110
|
|
772
|
-
#
|
773
|
-
# list. For more information and code samples on using
|
774
|
-
# refer to [Tag your site for remarketing](
|
775
|
-
#
|
1111
|
+
# An HTML tag that can be placed on the advertiser's page to add users to a user
|
1112
|
+
# list. For more information and code samples on using snippets on your website,
|
1113
|
+
# refer to [Tag your site for remarketing](https://support.google.com/google-ads/
|
1114
|
+
# answer/2476688).
|
776
1115
|
# Corresponds to the JSON property `snippet`
|
777
1116
|
# @return [String]
|
778
1117
|
attr_accessor :snippet
|
@@ -902,6 +1241,58 @@ module Google
|
|
902
1241
|
end
|
903
1242
|
end
|
904
1243
|
|
1244
|
+
# A response containing bidders.
|
1245
|
+
class ListBiddersResponse
|
1246
|
+
include Google::Apis::Core::Hashable
|
1247
|
+
|
1248
|
+
# List of bidders.
|
1249
|
+
# Corresponds to the JSON property `bidders`
|
1250
|
+
# @return [Array<Google::Apis::RealtimebiddingV1::Bidder>]
|
1251
|
+
attr_accessor :bidders
|
1252
|
+
|
1253
|
+
# A token which can be passed to a subsequent call to the `ListBidders` method
|
1254
|
+
# to retrieve the next page of results in ListBiddersRequest.pageToken.
|
1255
|
+
# Corresponds to the JSON property `nextPageToken`
|
1256
|
+
# @return [String]
|
1257
|
+
attr_accessor :next_page_token
|
1258
|
+
|
1259
|
+
def initialize(**args)
|
1260
|
+
update!(**args)
|
1261
|
+
end
|
1262
|
+
|
1263
|
+
# Update properties of this object
|
1264
|
+
def update!(**args)
|
1265
|
+
@bidders = args[:bidders] if args.key?(:bidders)
|
1266
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
1267
|
+
end
|
1268
|
+
end
|
1269
|
+
|
1270
|
+
# A response containing buyer account information.
|
1271
|
+
class ListBuyersResponse
|
1272
|
+
include Google::Apis::Core::Hashable
|
1273
|
+
|
1274
|
+
# List of buyers.
|
1275
|
+
# Corresponds to the JSON property `buyers`
|
1276
|
+
# @return [Array<Google::Apis::RealtimebiddingV1::Buyer>]
|
1277
|
+
attr_accessor :buyers
|
1278
|
+
|
1279
|
+
# A token which can be passed to a subsequent call to the `ListBuyers` method to
|
1280
|
+
# retrieve the next page of results in ListBuyersRequest.pageToken.
|
1281
|
+
# Corresponds to the JSON property `nextPageToken`
|
1282
|
+
# @return [String]
|
1283
|
+
attr_accessor :next_page_token
|
1284
|
+
|
1285
|
+
def initialize(**args)
|
1286
|
+
update!(**args)
|
1287
|
+
end
|
1288
|
+
|
1289
|
+
# Update properties of this object
|
1290
|
+
def update!(**args)
|
1291
|
+
@buyers = args[:buyers] if args.key?(:buyers)
|
1292
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
1293
|
+
end
|
1294
|
+
end
|
1295
|
+
|
905
1296
|
# A response for listing creatives.
|
906
1297
|
class ListCreativesResponse
|
907
1298
|
include Google::Apis::Core::Hashable
|
@@ -929,6 +1320,32 @@ module Google
|
|
929
1320
|
end
|
930
1321
|
end
|
931
1322
|
|
1323
|
+
# A response containing bidder endpoints.
|
1324
|
+
class ListEndpointsResponse
|
1325
|
+
include Google::Apis::Core::Hashable
|
1326
|
+
|
1327
|
+
# List of bidder endpoints.
|
1328
|
+
# Corresponds to the JSON property `endpoints`
|
1329
|
+
# @return [Array<Google::Apis::RealtimebiddingV1::Endpoint>]
|
1330
|
+
attr_accessor :endpoints
|
1331
|
+
|
1332
|
+
# A token which can be passed to a subsequent call to the `ListEndpoints` method
|
1333
|
+
# to retrieve the next page of results in ListEndpointsRequest.pageToken.
|
1334
|
+
# Corresponds to the JSON property `nextPageToken`
|
1335
|
+
# @return [String]
|
1336
|
+
attr_accessor :next_page_token
|
1337
|
+
|
1338
|
+
def initialize(**args)
|
1339
|
+
update!(**args)
|
1340
|
+
end
|
1341
|
+
|
1342
|
+
# Update properties of this object
|
1343
|
+
def update!(**args)
|
1344
|
+
@endpoints = args[:endpoints] if args.key?(:endpoints)
|
1345
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
1346
|
+
end
|
1347
|
+
end
|
1348
|
+
|
932
1349
|
# A response containing pretargeting configurations.
|
933
1350
|
class ListPretargetingConfigsResponse
|
934
1351
|
include Google::Apis::Core::Hashable
|
@@ -956,14 +1373,41 @@ module Google
|
|
956
1373
|
end
|
957
1374
|
end
|
958
1375
|
|
1376
|
+
# A response to a request for listing publisher connections.
|
1377
|
+
class ListPublisherConnectionsResponse
|
1378
|
+
include Google::Apis::Core::Hashable
|
1379
|
+
|
1380
|
+
# A token to retrieve the next page of results. Pass this value in the
|
1381
|
+
# ListPublisherConnectionsRequest.pageToken field in the subsequent call to the `
|
1382
|
+
# ListPublisherConnections` method to retrieve the next page of results.
|
1383
|
+
# Corresponds to the JSON property `nextPageToken`
|
1384
|
+
# @return [String]
|
1385
|
+
attr_accessor :next_page_token
|
1386
|
+
|
1387
|
+
# The list of publisher connections.
|
1388
|
+
# Corresponds to the JSON property `publisherConnections`
|
1389
|
+
# @return [Array<Google::Apis::RealtimebiddingV1::PublisherConnection>]
|
1390
|
+
attr_accessor :publisher_connections
|
1391
|
+
|
1392
|
+
def initialize(**args)
|
1393
|
+
update!(**args)
|
1394
|
+
end
|
1395
|
+
|
1396
|
+
# Update properties of this object
|
1397
|
+
def update!(**args)
|
1398
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
1399
|
+
@publisher_connections = args[:publisher_connections] if args.key?(:publisher_connections)
|
1400
|
+
end
|
1401
|
+
end
|
1402
|
+
|
959
1403
|
# The list user list response.
|
960
1404
|
class ListUserListsResponse
|
961
1405
|
include Google::Apis::Core::Hashable
|
962
1406
|
|
963
1407
|
# The continuation page token to send back to the server in a subsequent request.
|
964
1408
|
# Due to a currently known issue, it is recommended that the caller keep
|
965
|
-
# invoking the list method
|
966
|
-
# if the result set is empty
|
1409
|
+
# invoking the list method until the time a next page token is not returned,
|
1410
|
+
# even if the result set is empty.
|
967
1411
|
# Corresponds to the JSON property `nextPageToken`
|
968
1412
|
# @return [String]
|
969
1413
|
attr_accessor :next_page_token
|
@@ -1078,6 +1522,11 @@ module Google
|
|
1078
1522
|
# @return [String]
|
1079
1523
|
attr_accessor :video_url
|
1080
1524
|
|
1525
|
+
# The contents of a VAST document for a native video ad.
|
1526
|
+
# Corresponds to the JSON property `videoVastXml`
|
1527
|
+
# @return [String]
|
1528
|
+
attr_accessor :video_vast_xml
|
1529
|
+
|
1081
1530
|
def initialize(**args)
|
1082
1531
|
update!(**args)
|
1083
1532
|
end
|
@@ -1096,6 +1545,7 @@ module Google
|
|
1096
1545
|
@price_display_text = args[:price_display_text] if args.key?(:price_display_text)
|
1097
1546
|
@star_rating = args[:star_rating] if args.key?(:star_rating)
|
1098
1547
|
@video_url = args[:video_url] if args.key?(:video_url)
|
1548
|
+
@video_vast_xml = args[:video_vast_xml] if args.key?(:video_vast_xml)
|
1099
1549
|
end
|
1100
1550
|
end
|
1101
1551
|
|
@@ -1143,16 +1593,16 @@ module Google
|
|
1143
1593
|
class PolicyCompliance
|
1144
1594
|
include Google::Apis::Core::Hashable
|
1145
1595
|
|
1146
|
-
# Serving status for the given transaction type (
|
1147
|
-
# region (
|
1148
|
-
# creatives.list method.
|
1596
|
+
# Serving status for the given transaction type (for example, open auction,
|
1597
|
+
# deals) or region (for example, China, Russia). Can be used to filter the
|
1598
|
+
# response of the creatives.list method.
|
1149
1599
|
# Corresponds to the JSON property `status`
|
1150
1600
|
# @return [String]
|
1151
1601
|
attr_accessor :status
|
1152
1602
|
|
1153
|
-
# Topics related to the policy compliance for this transaction type (
|
1154
|
-
# auction, deals) or region (
|
1155
|
-
# status is DISAPPROVED.
|
1603
|
+
# Topics related to the policy compliance for this transaction type (for example,
|
1604
|
+
# open auction, deals) or region (for example, China, Russia). Topics may be
|
1605
|
+
# present only if status is DISAPPROVED.
|
1156
1606
|
# Corresponds to the JSON property `topics`
|
1157
1607
|
# @return [Array<Google::Apis::RealtimebiddingV1::PolicyTopicEntry>]
|
1158
1608
|
attr_accessor :topics
|
@@ -1184,6 +1634,15 @@ module Google
|
|
1184
1634
|
# @return [String]
|
1185
1635
|
attr_accessor :help_center_url
|
1186
1636
|
|
1637
|
+
# Whether or not the policy topic is missing a certificate. Some policy topics
|
1638
|
+
# require a certificate to unblock serving in some regions. For more information
|
1639
|
+
# about creative certification, refer to: https://support.google.com/
|
1640
|
+
# authorizedbuyers/answer/7450776
|
1641
|
+
# Corresponds to the JSON property `missingCertificate`
|
1642
|
+
# @return [Boolean]
|
1643
|
+
attr_accessor :missing_certificate
|
1644
|
+
alias_method :missing_certificate?, :missing_certificate
|
1645
|
+
|
1187
1646
|
# Policy topic this entry refers to. For example, "ALCOHOL", "
|
1188
1647
|
# TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible
|
1189
1648
|
# policy topics is not fixed for a particular API version and may change at any
|
@@ -1200,6 +1659,7 @@ module Google
|
|
1200
1659
|
def update!(**args)
|
1201
1660
|
@evidences = args[:evidences] if args.key?(:evidences)
|
1202
1661
|
@help_center_url = args[:help_center_url] if args.key?(:help_center_url)
|
1662
|
+
@missing_certificate = args[:missing_certificate] if args.key?(:missing_certificate)
|
1203
1663
|
@policy_topic = args[:policy_topic] if args.key?(:policy_topic)
|
1204
1664
|
end
|
1205
1665
|
end
|
@@ -1458,6 +1918,56 @@ module Google
|
|
1458
1918
|
end
|
1459
1919
|
end
|
1460
1920
|
|
1921
|
+
# An Open Bidding exchange's connection to a publisher. This is initiated by the
|
1922
|
+
# publisher for the bidder to review. If approved by the bidder, this means that
|
1923
|
+
# the bidder agrees to receive bid requests from the publisher.
|
1924
|
+
class PublisherConnection
|
1925
|
+
include Google::Apis::Core::Hashable
|
1926
|
+
|
1927
|
+
# Whether the publisher has been approved by the bidder.
|
1928
|
+
# Corresponds to the JSON property `biddingState`
|
1929
|
+
# @return [String]
|
1930
|
+
attr_accessor :bidding_state
|
1931
|
+
|
1932
|
+
# Output only. The time at which the publisher initiated a connection with the
|
1933
|
+
# bidder (irrespective of if or when the bidder approves it). This is
|
1934
|
+
# subsequently updated if the publisher revokes and re-initiates the connection.
|
1935
|
+
# Corresponds to the JSON property `createTime`
|
1936
|
+
# @return [String]
|
1937
|
+
attr_accessor :create_time
|
1938
|
+
|
1939
|
+
# Output only. Publisher display name.
|
1940
|
+
# Corresponds to the JSON property `displayName`
|
1941
|
+
# @return [String]
|
1942
|
+
attr_accessor :display_name
|
1943
|
+
|
1944
|
+
# Output only. Name of the publisher connection. This follows the pattern `
|
1945
|
+
# bidders/`bidder`/publisherConnections/`publisher``, where ``bidder``
|
1946
|
+
# represents the account ID of the bidder, and ``publisher`` is the ads.txt/app-
|
1947
|
+
# ads.txt publisher ID.
|
1948
|
+
# Corresponds to the JSON property `name`
|
1949
|
+
# @return [String]
|
1950
|
+
attr_accessor :name
|
1951
|
+
|
1952
|
+
# Output only. Whether the publisher is an Ad Manager or AdMob publisher.
|
1953
|
+
# Corresponds to the JSON property `publisherPlatform`
|
1954
|
+
# @return [String]
|
1955
|
+
attr_accessor :publisher_platform
|
1956
|
+
|
1957
|
+
def initialize(**args)
|
1958
|
+
update!(**args)
|
1959
|
+
end
|
1960
|
+
|
1961
|
+
# Update properties of this object
|
1962
|
+
def update!(**args)
|
1963
|
+
@bidding_state = args[:bidding_state] if args.key?(:bidding_state)
|
1964
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1965
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
1966
|
+
@name = args[:name] if args.key?(:name)
|
1967
|
+
@publisher_platform = args[:publisher_platform] if args.key?(:publisher_platform)
|
1968
|
+
end
|
1969
|
+
end
|
1970
|
+
|
1461
1971
|
# A request to stop targeting the provided apps in a specific pretargeting
|
1462
1972
|
# configuration. The pretargeting configuration itself specifies how these apps
|
1463
1973
|
# are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.
|
@@ -1594,19 +2104,21 @@ module Google
|
|
1594
2104
|
end
|
1595
2105
|
end
|
1596
2106
|
|
1597
|
-
#
|
1598
|
-
#
|
2107
|
+
# Deprecated. This will be removed in October 2023. For more information, see
|
2108
|
+
# the release notes: https://developers.google.com/authorized-buyers/apis/
|
2109
|
+
# relnotes#real-time-bidding-api Represents the URL restriction (for the URL
|
2110
|
+
# captured by the pixel callback) for a user list.
|
1599
2111
|
class UrlRestriction
|
1600
2112
|
include Google::Apis::Core::Hashable
|
1601
2113
|
|
1602
2114
|
# Represents a whole or partial calendar date, such as a birthday. The time of
|
1603
2115
|
# day and time zone are either specified elsewhere or are insignificant. The
|
1604
2116
|
# date is relative to the Gregorian Calendar. This can represent one of the
|
1605
|
-
# following: * A full date, with non-zero year, month, and day values * A month
|
1606
|
-
# and day
|
1607
|
-
# with zero month and day
|
1608
|
-
#
|
1609
|
-
# google.protobuf.Timestamp
|
2117
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
2118
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
2119
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
2120
|
+
# example, a credit card expiration date). Related types: * google.type.
|
2121
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
1610
2122
|
# Corresponds to the JSON property `endDate`
|
1611
2123
|
# @return [Google::Apis::RealtimebiddingV1::Date]
|
1612
2124
|
attr_accessor :end_date
|
@@ -1619,11 +2131,11 @@ module Google
|
|
1619
2131
|
# Represents a whole or partial calendar date, such as a birthday. The time of
|
1620
2132
|
# day and time zone are either specified elsewhere or are insignificant. The
|
1621
2133
|
# date is relative to the Gregorian Calendar. This can represent one of the
|
1622
|
-
# following: * A full date, with non-zero year, month, and day values * A month
|
1623
|
-
# and day
|
1624
|
-
# with zero month and day
|
1625
|
-
#
|
1626
|
-
# google.protobuf.Timestamp
|
2134
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
2135
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
2136
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
2137
|
+
# example, a credit card expiration date). Related types: * google.type.
|
2138
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
1627
2139
|
# Corresponds to the JSON property `startDate`
|
1628
2140
|
# @return [Google::Apis::RealtimebiddingV1::Date]
|
1629
2141
|
attr_accessor :start_date
|
@@ -1685,8 +2197,10 @@ module Google
|
|
1685
2197
|
# @return [String]
|
1686
2198
|
attr_accessor :status
|
1687
2199
|
|
1688
|
-
#
|
1689
|
-
#
|
2200
|
+
# Deprecated. This will be removed in October 2023. For more information, see
|
2201
|
+
# the release notes: https://developers.google.com/authorized-buyers/apis/
|
2202
|
+
# relnotes#real-time-bidding-api Represents the URL restriction (for the URL
|
2203
|
+
# captured by the pixel callback) for a user list.
|
1690
2204
|
# Corresponds to the JSON property `urlRestriction`
|
1691
2205
|
# @return [Google::Apis::RealtimebiddingV1::UrlRestriction]
|
1692
2206
|
attr_accessor :url_restriction
|
@@ -1822,7 +2336,7 @@ module Google
|
|
1822
2336
|
# subscriptions/`subscription_id``. Subscription is created with pull delivery.
|
1823
2337
|
# All service accounts belonging to the bidder will have read access to this
|
1824
2338
|
# subscription. Subscriptions that are inactive for more than 90 days will be
|
1825
|
-
# disabled.
|
2339
|
+
# disabled. Use watchCreatives to re-enable the subscription.
|
1826
2340
|
# Corresponds to the JSON property `subscription`
|
1827
2341
|
# @return [String]
|
1828
2342
|
attr_accessor :subscription
|