google-apis-realtimebidding_v1 0.1.0 → 0.30.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.
@@ -52,7 +52,79 @@ module Google
52
52
  @batch_path = 'batch'
53
53
  end
54
54
 
55
- # Lists creatives.
55
+ # Gets a bidder account by its name.
56
+ # @param [String] name
57
+ # Required. Name of the bidder to get. Format: `bidders/`bidderAccountId``
58
+ # @param [String] fields
59
+ # Selector specifying which fields to include in a partial response.
60
+ # @param [String] quota_user
61
+ # Available to use for quota purposes for server-side applications. Can be any
62
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
63
+ # @param [Google::Apis::RequestOptions] options
64
+ # Request-specific options
65
+ #
66
+ # @yield [result, err] Result & error if block supplied
67
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::Bidder] parsed result object
68
+ # @yieldparam err [StandardError] error object if request failed
69
+ #
70
+ # @return [Google::Apis::RealtimebiddingV1::Bidder]
71
+ #
72
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
73
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
74
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
75
+ def get_bidder(name, fields: nil, quota_user: nil, options: nil, &block)
76
+ command = make_simple_command(:get, 'v1/{+name}', options)
77
+ command.response_representation = Google::Apis::RealtimebiddingV1::Bidder::Representation
78
+ command.response_class = Google::Apis::RealtimebiddingV1::Bidder
79
+ command.params['name'] = name unless name.nil?
80
+ command.query['fields'] = fields unless fields.nil?
81
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
82
+ execute_or_queue_command(command, &block)
83
+ end
84
+
85
+ # Lists all the bidder accounts that belong to the caller.
86
+ # @param [Fixnum] page_size
87
+ # The maximum number of bidders to return. If unspecified, at most 100 bidders
88
+ # will be returned. The maximum value is 500; values above 500 will be coerced
89
+ # to 500.
90
+ # @param [String] page_token
91
+ # A token identifying a page of results the server should return. This value is
92
+ # received from a previous `ListBidders` call in ListBiddersResponse.
93
+ # nextPageToken.
94
+ # @param [String] fields
95
+ # Selector specifying which fields to include in a partial response.
96
+ # @param [String] quota_user
97
+ # Available to use for quota purposes for server-side applications. Can be any
98
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
99
+ # @param [Google::Apis::RequestOptions] options
100
+ # Request-specific options
101
+ #
102
+ # @yield [result, err] Result & error if block supplied
103
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::ListBiddersResponse] parsed result object
104
+ # @yieldparam err [StandardError] error object if request failed
105
+ #
106
+ # @return [Google::Apis::RealtimebiddingV1::ListBiddersResponse]
107
+ #
108
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
109
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
110
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
111
+ def list_bidders(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
112
+ command = make_simple_command(:get, 'v1/bidders', options)
113
+ command.response_representation = Google::Apis::RealtimebiddingV1::ListBiddersResponse::Representation
114
+ command.response_class = Google::Apis::RealtimebiddingV1::ListBiddersResponse
115
+ command.query['pageSize'] = page_size unless page_size.nil?
116
+ command.query['pageToken'] = page_token unless page_token.nil?
117
+ command.query['fields'] = fields unless fields.nil?
118
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
119
+ execute_or_queue_command(command, &block)
120
+ end
121
+
122
+ # Lists creatives as they are at the time of the initial request. This call may
123
+ # take multiple hours to complete. For large, paginated requests, this method
124
+ # returns a snapshot of creatives at the time of request for the first page. `
125
+ # lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives
126
+ # on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/
127
+ # pubsub/docs/overview) to view the latest status.
56
128
  # @param [String] parent
57
129
  # Required. Name of the parent buyer that owns the creatives. The pattern for
58
130
  # this resource is either `buyers/`buyerAccountId`` or `bidders/`bidderAccountId`
@@ -63,8 +135,8 @@ module Google
63
135
  # 123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself.
64
136
  # So for listing creatives pertaining to bidder (`123`), you would use `buyers/
65
137
  # 123`. If you want to access all creatives pertaining to both the bidder and
66
- # all of its child seat accounts, you would use `bidders/`bidderAccountId``, e.g.
67
- # , for all creatives pertaining to bidder (`123`), use `bidders/123`.
138
+ # all of its child seat accounts, you would use `bidders/`bidderAccountId``, for
139
+ # example, for all creatives pertaining to bidder (`123`), use `bidders/123`.
68
140
  # @param [String] filter
69
141
  # Query string to filter creatives. If no filter is specified, all active
70
142
  # creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:
@@ -72,13 +144,15 @@ module Google
72
144
  # IS_COOKIE_TARGETED'
73
145
  # @param [Fixnum] page_size
74
146
  # Requested page size. The server may return fewer creatives than requested (due
75
- # to timeout constraint) even if more are available via another call. If
147
+ # to timeout constraint) even if more are available through another call. If
76
148
  # unspecified, server will pick an appropriate default. Acceptable values are 1
77
149
  # to 1000, inclusive.
78
150
  # @param [String] page_token
79
151
  # A token identifying a page of results the server should return. Typically,
80
152
  # this is the value of ListCreativesResponse.nextPageToken returned from the
81
- # previous call to the 'ListCreatives' method.
153
+ # previous call to the 'ListCreatives' method. Page tokens for continued pages
154
+ # are valid for up to five hours, counting from the call to 'ListCreatives' for
155
+ # the first page.
82
156
  # @param [String] view
83
157
  # Controls the amount of information included in the response. By default only
84
158
  # creativeServingDecision is included. To retrieve the entire creative resource (
@@ -154,6 +228,117 @@ module Google
154
228
  execute_or_queue_command(command, &block)
155
229
  end
156
230
 
231
+ # Gets a bidder endpoint by its name.
232
+ # @param [String] name
233
+ # Required. Name of the bidder endpoint to get. Format: `bidders/`
234
+ # bidderAccountId`/endpoints/`endpointId``
235
+ # @param [String] fields
236
+ # Selector specifying which fields to include in a partial response.
237
+ # @param [String] quota_user
238
+ # Available to use for quota purposes for server-side applications. Can be any
239
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
240
+ # @param [Google::Apis::RequestOptions] options
241
+ # Request-specific options
242
+ #
243
+ # @yield [result, err] Result & error if block supplied
244
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::Endpoint] parsed result object
245
+ # @yieldparam err [StandardError] error object if request failed
246
+ #
247
+ # @return [Google::Apis::RealtimebiddingV1::Endpoint]
248
+ #
249
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
250
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
251
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
252
+ def get_bidder_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
253
+ command = make_simple_command(:get, 'v1/{+name}', options)
254
+ command.response_representation = Google::Apis::RealtimebiddingV1::Endpoint::Representation
255
+ command.response_class = Google::Apis::RealtimebiddingV1::Endpoint
256
+ command.params['name'] = name unless name.nil?
257
+ command.query['fields'] = fields unless fields.nil?
258
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
259
+ execute_or_queue_command(command, &block)
260
+ end
261
+
262
+ # Lists all the bidder's endpoints.
263
+ # @param [String] parent
264
+ # Required. Name of the bidder whose endpoints will be listed. Format: `bidders/`
265
+ # bidderAccountId``
266
+ # @param [Fixnum] page_size
267
+ # The maximum number of endpoints to return. If unspecified, at most 100
268
+ # endpoints will be returned. The maximum value is 500; values above 500 will be
269
+ # coerced to 500.
270
+ # @param [String] page_token
271
+ # A token identifying a page of results the server should return. This value is
272
+ # received from a previous `ListEndpoints` call in ListEndpointsResponse.
273
+ # nextPageToken.
274
+ # @param [String] fields
275
+ # Selector specifying which fields to include in a partial response.
276
+ # @param [String] quota_user
277
+ # Available to use for quota purposes for server-side applications. Can be any
278
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
279
+ # @param [Google::Apis::RequestOptions] options
280
+ # Request-specific options
281
+ #
282
+ # @yield [result, err] Result & error if block supplied
283
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::ListEndpointsResponse] parsed result object
284
+ # @yieldparam err [StandardError] error object if request failed
285
+ #
286
+ # @return [Google::Apis::RealtimebiddingV1::ListEndpointsResponse]
287
+ #
288
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
289
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
290
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
291
+ def list_bidder_endpoints(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
292
+ command = make_simple_command(:get, 'v1/{+parent}/endpoints', options)
293
+ command.response_representation = Google::Apis::RealtimebiddingV1::ListEndpointsResponse::Representation
294
+ command.response_class = Google::Apis::RealtimebiddingV1::ListEndpointsResponse
295
+ command.params['parent'] = parent unless parent.nil?
296
+ command.query['pageSize'] = page_size unless page_size.nil?
297
+ command.query['pageToken'] = page_token unless page_token.nil?
298
+ command.query['fields'] = fields unless fields.nil?
299
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
300
+ execute_or_queue_command(command, &block)
301
+ end
302
+
303
+ # Updates a bidder's endpoint.
304
+ # @param [String] name
305
+ # Output only. Name of the endpoint resource that must follow the pattern `
306
+ # bidders/`bidderAccountId`/endpoints/`endpointId``, where `bidderAccountId` is
307
+ # the account ID of the bidder who operates this endpoint, and `endpointId` is a
308
+ # unique ID assigned by the server.
309
+ # @param [Google::Apis::RealtimebiddingV1::Endpoint] endpoint_object
310
+ # @param [String] update_mask
311
+ # Field mask to use for partial in-place updates.
312
+ # @param [String] fields
313
+ # Selector specifying which fields to include in a partial response.
314
+ # @param [String] quota_user
315
+ # Available to use for quota purposes for server-side applications. Can be any
316
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
317
+ # @param [Google::Apis::RequestOptions] options
318
+ # Request-specific options
319
+ #
320
+ # @yield [result, err] Result & error if block supplied
321
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::Endpoint] parsed result object
322
+ # @yieldparam err [StandardError] error object if request failed
323
+ #
324
+ # @return [Google::Apis::RealtimebiddingV1::Endpoint]
325
+ #
326
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
327
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
328
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
329
+ def patch_bidder_endpoint(name, endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
330
+ command = make_simple_command(:patch, 'v1/{+name}', options)
331
+ command.request_representation = Google::Apis::RealtimebiddingV1::Endpoint::Representation
332
+ command.request_object = endpoint_object
333
+ command.response_representation = Google::Apis::RealtimebiddingV1::Endpoint::Representation
334
+ command.response_class = Google::Apis::RealtimebiddingV1::Endpoint
335
+ command.params['name'] = name unless name.nil?
336
+ command.query['updateMask'] = update_mask unless update_mask.nil?
337
+ command.query['fields'] = fields unless fields.nil?
338
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
339
+ execute_or_queue_command(command, &block)
340
+ end
341
+
157
342
  # Activates a pretargeting configuration.
158
343
  # @param [String] name
159
344
  # Required. The name of the pretargeting configuration. Format: bidders/`
@@ -604,16 +789,207 @@ module Google
604
789
  execute_or_queue_command(command, &block)
605
790
  end
606
791
 
607
- # Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript
608
- # code that can be placed on a web page. When a user visits a page containing a
609
- # remarketing tag, Google adds the user to a user list.
792
+ # Batch approves multiple publisher connections.
793
+ # @param [String] parent
794
+ # Required. The bidder for whom publisher connections will be approved. Format: `
795
+ # bidders/`bidder`` where ``bidder`` is the account ID of the bidder.
796
+ # @param [Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsRequest] batch_approve_publisher_connections_request_object
797
+ # @param [String] fields
798
+ # Selector specifying which fields to include in a partial response.
799
+ # @param [String] quota_user
800
+ # Available to use for quota purposes for server-side applications. Can be any
801
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
802
+ # @param [Google::Apis::RequestOptions] options
803
+ # Request-specific options
804
+ #
805
+ # @yield [result, err] Result & error if block supplied
806
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsResponse] parsed result object
807
+ # @yieldparam err [StandardError] error object if request failed
808
+ #
809
+ # @return [Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsResponse]
810
+ #
811
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
812
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
813
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
814
+ def batch_approve_publisher_connections(parent, batch_approve_publisher_connections_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
815
+ command = make_simple_command(:post, 'v1/{+parent}/publisherConnections:batchApprove', options)
816
+ command.request_representation = Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsRequest::Representation
817
+ command.request_object = batch_approve_publisher_connections_request_object
818
+ command.response_representation = Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsResponse::Representation
819
+ command.response_class = Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsResponse
820
+ command.params['parent'] = parent unless parent.nil?
821
+ command.query['fields'] = fields unless fields.nil?
822
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
823
+ execute_or_queue_command(command, &block)
824
+ end
825
+
826
+ # Batch rejects multiple publisher connections.
827
+ # @param [String] parent
828
+ # Required. The bidder for whom publisher connections will be rejected. Format: `
829
+ # bidders/`bidder`` where ``bidder`` is the account ID of the bidder.
830
+ # @param [Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsRequest] batch_reject_publisher_connections_request_object
831
+ # @param [String] fields
832
+ # Selector specifying which fields to include in a partial response.
833
+ # @param [String] quota_user
834
+ # Available to use for quota purposes for server-side applications. Can be any
835
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
836
+ # @param [Google::Apis::RequestOptions] options
837
+ # Request-specific options
838
+ #
839
+ # @yield [result, err] Result & error if block supplied
840
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsResponse] parsed result object
841
+ # @yieldparam err [StandardError] error object if request failed
842
+ #
843
+ # @return [Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsResponse]
844
+ #
845
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
846
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
847
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
848
+ def batch_reject_publisher_connections(parent, batch_reject_publisher_connections_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
849
+ command = make_simple_command(:post, 'v1/{+parent}/publisherConnections:batchReject', options)
850
+ command.request_representation = Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsRequest::Representation
851
+ command.request_object = batch_reject_publisher_connections_request_object
852
+ command.response_representation = Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsResponse::Representation
853
+ command.response_class = Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsResponse
854
+ command.params['parent'] = parent unless parent.nil?
855
+ command.query['fields'] = fields unless fields.nil?
856
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
857
+ execute_or_queue_command(command, &block)
858
+ end
859
+
860
+ # Gets a publisher connection.
861
+ # @param [String] name
862
+ # Required. Name of the publisher whose connection information is to be
863
+ # retrieved. In the pattern `bidders/`bidder`/publisherConnections/`publisher``
864
+ # where ``bidder`` is the account ID of the bidder, and ``publisher`` is the ads.
865
+ # txt/app-ads.txt publisher ID. See publisherConnection.name.
866
+ # @param [String] fields
867
+ # Selector specifying which fields to include in a partial response.
868
+ # @param [String] quota_user
869
+ # Available to use for quota purposes for server-side applications. Can be any
870
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
871
+ # @param [Google::Apis::RequestOptions] options
872
+ # Request-specific options
873
+ #
874
+ # @yield [result, err] Result & error if block supplied
875
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PublisherConnection] parsed result object
876
+ # @yieldparam err [StandardError] error object if request failed
877
+ #
878
+ # @return [Google::Apis::RealtimebiddingV1::PublisherConnection]
879
+ #
880
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
881
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
882
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
883
+ def get_bidder_publisher_connection(name, fields: nil, quota_user: nil, options: nil, &block)
884
+ command = make_simple_command(:get, 'v1/{+name}', options)
885
+ command.response_representation = Google::Apis::RealtimebiddingV1::PublisherConnection::Representation
886
+ command.response_class = Google::Apis::RealtimebiddingV1::PublisherConnection
887
+ command.params['name'] = name unless name.nil?
888
+ command.query['fields'] = fields unless fields.nil?
889
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
890
+ execute_or_queue_command(command, &block)
891
+ end
892
+
893
+ # Lists publisher connections for a given bidder.
894
+ # @param [String] parent
895
+ # Required. Name of the bidder for which publishers have initiated connections.
896
+ # The pattern for this resource is `bidders/`bidder`` where ``bidder``
897
+ # represents the account ID of the bidder.
898
+ # @param [String] filter
899
+ # Query string to filter publisher connections. Connections can be filtered by `
900
+ # displayName`, `publisherPlatform`, and `biddingState`. If no filter is
901
+ # specified, all publisher connections will be returned. Example: 'displayName="
902
+ # Great Publisher*" AND publisherPlatform=ADMOB AND biddingState != PENDING' See
903
+ # https://google.aip.dev/160 for more information about filtering syntax.
904
+ # @param [String] order_by
905
+ # Order specification by which results should be sorted. If no sort order is
906
+ # specified, the results will be returned in alphabetic order based on the
907
+ # publisher's publisher code. Results can be sorted by `createTime`. Example: '
908
+ # createTime DESC'.
909
+ # @param [Fixnum] page_size
910
+ # Requested page size. The server may return fewer results than requested (due
911
+ # to timeout constraint) even if more are available through another call. If
912
+ # unspecified, the server will pick an appropriate default. Acceptable values
913
+ # are 1 to 5000, inclusive.
914
+ # @param [String] page_token
915
+ # A token identifying a page of results the server should return. Typically,
916
+ # this is the value of ListPublisherConnectionsResponse.nextPageToken returned
917
+ # from the previous call to the 'ListPublisherConnections' method.
918
+ # @param [String] fields
919
+ # Selector specifying which fields to include in a partial response.
920
+ # @param [String] quota_user
921
+ # Available to use for quota purposes for server-side applications. Can be any
922
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
923
+ # @param [Google::Apis::RequestOptions] options
924
+ # Request-specific options
925
+ #
926
+ # @yield [result, err] Result & error if block supplied
927
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::ListPublisherConnectionsResponse] parsed result object
928
+ # @yieldparam err [StandardError] error object if request failed
929
+ #
930
+ # @return [Google::Apis::RealtimebiddingV1::ListPublisherConnectionsResponse]
931
+ #
932
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
933
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
934
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
935
+ def list_bidder_publisher_connections(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
936
+ command = make_simple_command(:get, 'v1/{+parent}/publisherConnections', options)
937
+ command.response_representation = Google::Apis::RealtimebiddingV1::ListPublisherConnectionsResponse::Representation
938
+ command.response_class = Google::Apis::RealtimebiddingV1::ListPublisherConnectionsResponse
939
+ command.params['parent'] = parent unless parent.nil?
940
+ command.query['filter'] = filter unless filter.nil?
941
+ command.query['orderBy'] = order_by unless order_by.nil?
942
+ command.query['pageSize'] = page_size unless page_size.nil?
943
+ command.query['pageToken'] = page_token unless page_token.nil?
944
+ command.query['fields'] = fields unless fields.nil?
945
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
946
+ execute_or_queue_command(command, &block)
947
+ end
948
+
949
+ # Gets a buyer account by its name.
610
950
  # @param [String] name
611
- # Required. To fetch remarketing tag for an account, name must follow the
612
- # pattern `buyers/`accountId`` where ``accountId`` represents ID of a buyer that
613
- # owns the remarketing tag. For a bidder accessing remarketing tag on behalf of
614
- # a child seat buyer, ``accountId`` should represent the ID of the child seat
615
- # buyer. To fetch remarketing tag for a specific user list, name must follow the
616
- # pattern `buyers/`accountId`/userLists/`userListId``. See UserList.name.
951
+ # Required. Name of the buyer to get. Format: `buyers/`buyerId``
952
+ # @param [String] fields
953
+ # Selector specifying which fields to include in a partial response.
954
+ # @param [String] quota_user
955
+ # Available to use for quota purposes for server-side applications. Can be any
956
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
957
+ # @param [Google::Apis::RequestOptions] options
958
+ # Request-specific options
959
+ #
960
+ # @yield [result, err] Result & error if block supplied
961
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::Buyer] parsed result object
962
+ # @yieldparam err [StandardError] error object if request failed
963
+ #
964
+ # @return [Google::Apis::RealtimebiddingV1::Buyer]
965
+ #
966
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
967
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
968
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
969
+ def get_buyer(name, fields: nil, quota_user: nil, options: nil, &block)
970
+ command = make_simple_command(:get, 'v1/{+name}', options)
971
+ command.response_representation = Google::Apis::RealtimebiddingV1::Buyer::Representation
972
+ command.response_class = Google::Apis::RealtimebiddingV1::Buyer
973
+ command.params['name'] = name unless name.nil?
974
+ command.query['fields'] = fields unless fields.nil?
975
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
976
+ execute_or_queue_command(command, &block)
977
+ end
978
+
979
+ # This has been sunset as of October 2023, and will return an error response if
980
+ # called. For more information, see the release notes: https://developers.google.
981
+ # com/authorized-buyers/apis/relnotes#real-time-bidding-api Gets remarketing tag
982
+ # for a buyer. A remarketing tag is a piece of JavaScript code that can be
983
+ # placed on a web page. When a user visits a page containing a remarketing tag,
984
+ # Google adds the user to a user list.
985
+ # @param [String] name
986
+ # Required. To fetch the remarketing tag for an account, the name must follow
987
+ # the pattern `buyers/`accountId``, where ``accountId`` represents the ID of the
988
+ # buyer that owns the remarketing tag. For a bidder accessing the remarketing
989
+ # tag on behalf of a child seat buyer, ``accountId`` should represent the ID of
990
+ # the child seat buyer. To fetch the remarketing tag for a specific user list,
991
+ # the name must follow the pattern `buyers/`accountId`/userLists/`userListId``.
992
+ # See UserList.name.
617
993
  # @param [String] fields
618
994
  # Selector specifying which fields to include in a partial response.
619
995
  # @param [String] quota_user
@@ -641,6 +1017,43 @@ module Google
641
1017
  execute_or_queue_command(command, &block)
642
1018
  end
643
1019
 
1020
+ # Lists all buyer account information the calling buyer user or service account
1021
+ # is permissioned to manage.
1022
+ # @param [Fixnum] page_size
1023
+ # The maximum number of buyers to return. If unspecified, at most 100 buyers
1024
+ # will be returned. The maximum value is 500; values above 500 will be coerced
1025
+ # to 500.
1026
+ # @param [String] page_token
1027
+ # A token identifying a page of results the server should return. This value is
1028
+ # received from a previous `ListBuyers` call in ListBuyersResponse.nextPageToken.
1029
+ # @param [String] fields
1030
+ # Selector specifying which fields to include in a partial response.
1031
+ # @param [String] quota_user
1032
+ # Available to use for quota purposes for server-side applications. Can be any
1033
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1034
+ # @param [Google::Apis::RequestOptions] options
1035
+ # Request-specific options
1036
+ #
1037
+ # @yield [result, err] Result & error if block supplied
1038
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::ListBuyersResponse] parsed result object
1039
+ # @yieldparam err [StandardError] error object if request failed
1040
+ #
1041
+ # @return [Google::Apis::RealtimebiddingV1::ListBuyersResponse]
1042
+ #
1043
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1044
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1045
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1046
+ def list_buyers(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1047
+ command = make_simple_command(:get, 'v1/buyers', options)
1048
+ command.response_representation = Google::Apis::RealtimebiddingV1::ListBuyersResponse::Representation
1049
+ command.response_class = Google::Apis::RealtimebiddingV1::ListBuyersResponse
1050
+ command.query['pageSize'] = page_size unless page_size.nil?
1051
+ command.query['pageToken'] = page_token unless page_token.nil?
1052
+ command.query['fields'] = fields unless fields.nil?
1053
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1054
+ execute_or_queue_command(command, &block)
1055
+ end
1056
+
644
1057
  # Creates a creative.
645
1058
  # @param [String] parent
646
1059
  # Required. The name of the parent buyer that the new creative belongs to that
@@ -714,7 +1127,12 @@ module Google
714
1127
  execute_or_queue_command(command, &block)
715
1128
  end
716
1129
 
717
- # Lists creatives.
1130
+ # Lists creatives as they are at the time of the initial request. This call may
1131
+ # take multiple hours to complete. For large, paginated requests, this method
1132
+ # returns a snapshot of creatives at the time of request for the first page. `
1133
+ # lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives
1134
+ # on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/
1135
+ # pubsub/docs/overview) to view the latest status.
718
1136
  # @param [String] parent
719
1137
  # Required. Name of the parent buyer that owns the creatives. The pattern for
720
1138
  # this resource is either `buyers/`buyerAccountId`` or `bidders/`bidderAccountId`
@@ -725,8 +1143,8 @@ module Google
725
1143
  # 123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself.
726
1144
  # So for listing creatives pertaining to bidder (`123`), you would use `buyers/
727
1145
  # 123`. If you want to access all creatives pertaining to both the bidder and
728
- # all of its child seat accounts, you would use `bidders/`bidderAccountId``, e.g.
729
- # , for all creatives pertaining to bidder (`123`), use `bidders/123`.
1146
+ # all of its child seat accounts, you would use `bidders/`bidderAccountId``, for
1147
+ # example, for all creatives pertaining to bidder (`123`), use `bidders/123`.
730
1148
  # @param [String] filter
731
1149
  # Query string to filter creatives. If no filter is specified, all active
732
1150
  # creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:
@@ -734,13 +1152,15 @@ module Google
734
1152
  # IS_COOKIE_TARGETED'
735
1153
  # @param [Fixnum] page_size
736
1154
  # Requested page size. The server may return fewer creatives than requested (due
737
- # to timeout constraint) even if more are available via another call. If
1155
+ # to timeout constraint) even if more are available through another call. If
738
1156
  # unspecified, server will pick an appropriate default. Acceptable values are 1
739
1157
  # to 1000, inclusive.
740
1158
  # @param [String] page_token
741
1159
  # A token identifying a page of results the server should return. Typically,
742
1160
  # this is the value of ListCreativesResponse.nextPageToken returned from the
743
- # previous call to the 'ListCreatives' method.
1161
+ # previous call to the 'ListCreatives' method. Page tokens for continued pages
1162
+ # are valid for up to five hours, counting from the call to 'ListCreatives' for
1163
+ # the first page.
744
1164
  # @param [String] view
745
1165
  # Controls the amount of information included in the response. By default only
746
1166
  # creativeServingDecision is included. To retrieve the entire creative resource (
@@ -816,8 +1236,8 @@ module Google
816
1236
  execute_or_queue_command(command, &block)
817
1237
  end
818
1238
 
819
- # Change the status of a user list to CLOSED. This prevents new users from being
820
- # added to the user list.
1239
+ # Changes the status of a user list to CLOSED. This prevents new users from
1240
+ # being added to the user list.
821
1241
  # @param [String] name
822
1242
  # Required. The name of the user list to close. See UserList.name
823
1243
  # @param [Google::Apis::RealtimebiddingV1::CloseUserListRequest] close_user_list_request_object
@@ -850,12 +1270,12 @@ module Google
850
1270
  execute_or_queue_command(command, &block)
851
1271
  end
852
1272
 
853
- # Create a new user list.
1273
+ # Creates a new user list.
854
1274
  # @param [String] parent
855
- # Required. The name of the parent buyer of the user list to be retrieved that
1275
+ # Required. The name of the parent buyer of the user list to be retrieved, which
856
1276
  # must follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
857
- # represents the account ID of the buyer who owns user lists. For a bidder
858
- # accessing user lists on behalf of a child seat buyer , ``buyerAccountId``
1277
+ # represents the account ID of the buyer who owns the user list. For a bidder
1278
+ # accessing user lists on behalf of a child seat buyer, ``buyerAccountId``
859
1279
  # should represent the account ID of the child seat buyer.
860
1280
  # @param [Google::Apis::RealtimebiddingV1::UserList] user_list_object
861
1281
  # @param [String] fields
@@ -917,16 +1337,20 @@ module Google
917
1337
  execute_or_queue_command(command, &block)
918
1338
  end
919
1339
 
920
- # Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript
921
- # code that can be placed on a web page. When a user visits a page containing a
922
- # remarketing tag, Google adds the user to a user list.
1340
+ # This has been sunset as of October 2023, and will return an error response if
1341
+ # called. For more information, see the release notes: https://developers.google.
1342
+ # com/authorized-buyers/apis/relnotes#real-time-bidding-api Gets remarketing tag
1343
+ # for a buyer. A remarketing tag is a piece of JavaScript code that can be
1344
+ # placed on a web page. When a user visits a page containing a remarketing tag,
1345
+ # Google adds the user to a user list.
923
1346
  # @param [String] name
924
- # Required. To fetch remarketing tag for an account, name must follow the
925
- # pattern `buyers/`accountId`` where ``accountId`` represents ID of a buyer that
926
- # owns the remarketing tag. For a bidder accessing remarketing tag on behalf of
927
- # a child seat buyer, ``accountId`` should represent the ID of the child seat
928
- # buyer. To fetch remarketing tag for a specific user list, name must follow the
929
- # pattern `buyers/`accountId`/userLists/`userListId``. See UserList.name.
1347
+ # Required. To fetch the remarketing tag for an account, the name must follow
1348
+ # the pattern `buyers/`accountId``, where ``accountId`` represents the ID of the
1349
+ # buyer that owns the remarketing tag. For a bidder accessing the remarketing
1350
+ # tag on behalf of a child seat buyer, ``accountId`` should represent the ID of
1351
+ # the child seat buyer. To fetch the remarketing tag for a specific user list,
1352
+ # the name must follow the pattern `buyers/`accountId`/userLists/`userListId``.
1353
+ # See UserList.name.
930
1354
  # @param [String] fields
931
1355
  # Selector specifying which fields to include in a partial response.
932
1356
  # @param [String] quota_user
@@ -964,7 +1388,7 @@ module Google
964
1388
  # @param [Fixnum] page_size
965
1389
  # The number of results to return per page.
966
1390
  # @param [String] page_token
967
- # Continuation page token (as received from a previous response).
1391
+ # Continuation page token as received from a previous response.
968
1392
  # @param [String] fields
969
1393
  # Selector specifying which fields to include in a partial response.
970
1394
  # @param [String] quota_user
@@ -994,8 +1418,8 @@ module Google
994
1418
  execute_or_queue_command(command, &block)
995
1419
  end
996
1420
 
997
- # Change the status of a user list to OPEN. This allows new users to be added to
998
- # the user list.
1421
+ # Changes the status of a user list to OPEN. This allows new users to be added
1422
+ # to the user list.
999
1423
  # @param [String] name
1000
1424
  # Required. The name of the user list to open. See UserList.name
1001
1425
  # @param [Google::Apis::RealtimebiddingV1::OpenUserListRequest] open_user_list_request_object
@@ -1028,7 +1452,7 @@ module Google
1028
1452
  execute_or_queue_command(command, &block)
1029
1453
  end
1030
1454
 
1031
- # Update the given user list. Only user lists with URLRestrictions can be
1455
+ # Updates the given user list. Only user lists with URLRestrictions can be
1032
1456
  # updated.
1033
1457
  # @param [String] name
1034
1458
  # Output only. Name of the user list that must follow the pattern `buyers/`buyer`