google-ads-data_manager-v1 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/client.rb +494 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/credentials.rb +47 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/rest/client.rb +444 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/rest/service_stub.rb +143 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/rest.rb +53 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service.rb +56 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/client.rb +739 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/credentials.rb +47 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/paths.rb +69 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/rest/client.rb +675 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/rest/service_stub.rb +265 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/rest.rb +52 -0
- data/lib/google/ads/data_manager/v1/partner_link_service.rb +55 -0
- data/lib/google/ads/data_manager/v1/rest.rb +5 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/client.rb +813 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/credentials.rb +47 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/paths.rb +69 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest/client.rb +742 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest/service_stub.rb +327 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest.rb +56 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service.rb +59 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/client.rb +955 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/credentials.rb +47 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/paths.rb +69 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest/client.rb +877 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest/service_stub.rb +388 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest.rb +56 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service.rb +59 -0
- data/lib/google/ads/data_manager/v1/user_list_service/client.rb +972 -0
- data/lib/google/ads/data_manager/v1/user_list_service/credentials.rb +47 -0
- data/lib/google/ads/data_manager/v1/user_list_service/paths.rb +69 -0
- data/lib/google/ads/data_manager/v1/user_list_service/rest/client.rb +894 -0
- data/lib/google/ads/data_manager/v1/user_list_service/rest/service_stub.rb +388 -0
- data/lib/google/ads/data_manager/v1/user_list_service/rest.rb +52 -0
- data/lib/google/ads/data_manager/v1/user_list_service.rb +55 -0
- data/lib/google/ads/data_manager/v1/version.rb +1 -1
- data/lib/google/ads/data_manager/v1.rb +5 -0
- data/lib/google/ads/datamanager/v1/age_range_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/audience_pb.rb +5 -26
- data/lib/google/ads/datamanager/v1/cart_data_pb.rb +3 -25
- data/lib/google/ads/datamanager/v1/consent_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/destination_pb.rb +4 -24
- data/lib/google/ads/datamanager/v1/device_info_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/encryption_info_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/error_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/event_pb.rb +3 -31
- data/lib/google/ads/datamanager/v1/experimental_field_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/gender_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/ingestion_service_pb.rb +3 -31
- data/lib/google/ads/datamanager/v1/insights_service_pb.rb +33 -0
- data/lib/google/ads/datamanager/v1/insights_service_services_pb.rb +62 -0
- data/lib/google/ads/datamanager/v1/item_parameter_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/match_rate_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/partner_link_service_pb.rb +32 -0
- data/lib/google/ads/datamanager/v1/partner_link_service_services_pb.rb +79 -0
- data/lib/google/ads/datamanager/v1/processing_errors_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/request_status_per_destination_pb.rb +7 -26
- data/lib/google/ads/datamanager/v1/terms_of_service_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/user_data_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/user_list_direct_license_pb.rb +28 -0
- data/lib/google/ads/datamanager/v1/user_list_direct_license_service_pb.rb +32 -0
- data/lib/google/ads/datamanager/v1/user_list_direct_license_service_services_pb.rb +63 -0
- data/lib/google/ads/datamanager/v1/user_list_global_license_pb.rb +30 -0
- data/lib/google/ads/datamanager/v1/user_list_global_license_service_pb.rb +34 -0
- data/lib/google/ads/datamanager/v1/user_list_global_license_service_services_pb.rb +67 -0
- data/lib/google/ads/datamanager/v1/user_list_global_license_type_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/user_list_license_client_account_type_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/user_list_license_metrics_pb.rb +23 -0
- data/lib/google/ads/datamanager/v1/user_list_license_pricing_pb.rb +26 -0
- data/lib/google/ads/datamanager/v1/user_list_license_status_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/user_list_pb.rb +43 -0
- data/lib/google/ads/datamanager/v1/user_list_service_pb.rb +34 -0
- data/lib/google/ads/datamanager/v1/user_list_service_services_pb.rb +118 -0
- data/lib/google/ads/datamanager/v1/user_properties_pb.rb +3 -24
- data/proto_docs/google/ads/datamanager/v1/age_range.rb +53 -0
- data/proto_docs/google/ads/datamanager/v1/audience.rb +42 -3
- data/proto_docs/google/ads/datamanager/v1/destination.rb +3 -0
- data/proto_docs/google/ads/datamanager/v1/encryption_info.rb +6 -3
- data/proto_docs/google/ads/datamanager/v1/error.rb +159 -1
- data/proto_docs/google/ads/datamanager/v1/gender.rb +41 -0
- data/proto_docs/google/ads/datamanager/v1/insights_service.rb +133 -0
- data/proto_docs/google/ads/datamanager/v1/partner_link_service.rb +141 -0
- data/proto_docs/google/ads/datamanager/v1/request_status_per_destination.rb +92 -6
- data/proto_docs/google/ads/datamanager/v1/user_list.rb +397 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_direct_license.rb +75 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_direct_license_service.rb +134 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_global_license.rb +114 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_global_license_service.rb +204 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_global_license_type.rb +41 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_license_client_account_type.rb +44 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_license_metrics.rb +55 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_license_pricing.rb +108 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_license_status.rb +38 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_service.rb +151 -0
- data/proto_docs/google/api/client.rb +149 -29
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- metadata +73 -2
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# A user list global license.
|
|
25
|
+
#
|
|
26
|
+
# This feature is only available to data partners.
|
|
27
|
+
# @!attribute [rw] name
|
|
28
|
+
# @return [::String]
|
|
29
|
+
# Identifier. The resource name of the user list global license.
|
|
30
|
+
# @!attribute [rw] user_list_id
|
|
31
|
+
# @return [::Integer]
|
|
32
|
+
# Immutable. ID of the user list being licensed.
|
|
33
|
+
# @!attribute [r] user_list_display_name
|
|
34
|
+
# @return [::String]
|
|
35
|
+
# Output only. Name of the user list being licensed.
|
|
36
|
+
#
|
|
37
|
+
# This field is read-only.
|
|
38
|
+
# @!attribute [rw] license_type
|
|
39
|
+
# @return [::Google::Ads::DataManager::V1::UserListGlobalLicenseType]
|
|
40
|
+
# Immutable. Product type of client customer which the user list is being
|
|
41
|
+
# licensed to.
|
|
42
|
+
# @!attribute [rw] status
|
|
43
|
+
# @return [::Google::Ads::DataManager::V1::UserListLicenseStatus]
|
|
44
|
+
# Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.
|
|
45
|
+
# @!attribute [rw] pricing
|
|
46
|
+
# @return [::Google::Ads::DataManager::V1::UserListLicensePricing]
|
|
47
|
+
# Optional. UserListGlobalLicense pricing.
|
|
48
|
+
# @!attribute [r] historical_pricings
|
|
49
|
+
# @return [::Array<::Google::Ads::DataManager::V1::UserListLicensePricing>]
|
|
50
|
+
# Output only. Pricing history of this user list license.
|
|
51
|
+
#
|
|
52
|
+
# This field is read-only.
|
|
53
|
+
# @!attribute [r] metrics
|
|
54
|
+
# @return [::Google::Ads::DataManager::V1::UserListLicenseMetrics]
|
|
55
|
+
# Output only. Metrics related to this license
|
|
56
|
+
#
|
|
57
|
+
# This field is read-only and only populated if the start and end dates are
|
|
58
|
+
# set in the ListUserListGlobalLicenses call
|
|
59
|
+
class UserListGlobalLicense
|
|
60
|
+
include ::Google::Protobuf::MessageExts
|
|
61
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# Information about a customer of a user list global license. This will
|
|
65
|
+
# automatically be created by the system when a customer purchases a global
|
|
66
|
+
# license.
|
|
67
|
+
# @!attribute [rw] name
|
|
68
|
+
# @return [::String]
|
|
69
|
+
# Identifier. The resource name of the user list global license customer.
|
|
70
|
+
# @!attribute [r] user_list_id
|
|
71
|
+
# @return [::Integer]
|
|
72
|
+
# Output only. ID of the user list being licensed.
|
|
73
|
+
# @!attribute [r] user_list_display_name
|
|
74
|
+
# @return [::String]
|
|
75
|
+
# Output only. Name of the user list being licensed.
|
|
76
|
+
# @!attribute [r] license_type
|
|
77
|
+
# @return [::Google::Ads::DataManager::V1::UserListGlobalLicenseType]
|
|
78
|
+
# Output only. Product type of client customer which the user list is being
|
|
79
|
+
# licensed to.
|
|
80
|
+
# @!attribute [r] status
|
|
81
|
+
# @return [::Google::Ads::DataManager::V1::UserListLicenseStatus]
|
|
82
|
+
# Output only. Status of UserListDirectLicense - ENABLED or DISABLED.
|
|
83
|
+
# @!attribute [r] pricing
|
|
84
|
+
# @return [::Google::Ads::DataManager::V1::UserListLicensePricing]
|
|
85
|
+
# Output only. UserListDirectLicense pricing.
|
|
86
|
+
# @!attribute [r] client_account_type
|
|
87
|
+
# @return [::Google::Ads::DataManager::V1::UserListLicenseClientAccountType]
|
|
88
|
+
# Output only. Product type of client customer which the user list is being
|
|
89
|
+
# licensed to.
|
|
90
|
+
# @!attribute [r] client_account_id
|
|
91
|
+
# @return [::Integer]
|
|
92
|
+
# Output only. ID of client customer which the user list is being licensed
|
|
93
|
+
# to.
|
|
94
|
+
# @!attribute [r] client_account_display_name
|
|
95
|
+
# @return [::String]
|
|
96
|
+
# Output only. Name of client customer which the user list is being licensed
|
|
97
|
+
# to.
|
|
98
|
+
# @!attribute [r] historical_pricings
|
|
99
|
+
# @return [::Array<::Google::Ads::DataManager::V1::UserListLicensePricing>]
|
|
100
|
+
# Output only. Pricing history of this user list license.
|
|
101
|
+
# @!attribute [r] metrics
|
|
102
|
+
# @return [::Google::Ads::DataManager::V1::UserListLicenseMetrics]
|
|
103
|
+
# Output only. Metrics related to this license
|
|
104
|
+
#
|
|
105
|
+
# This field is only populated if the start and end dates are set in the
|
|
106
|
+
# ListUserListGlobalLicenseCustomerInfos call.
|
|
107
|
+
class UserListGlobalLicenseCustomerInfo
|
|
108
|
+
include ::Google::Protobuf::MessageExts
|
|
109
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
110
|
+
end
|
|
111
|
+
end
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
end
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# Request to create a
|
|
25
|
+
# {::Google::Ads::DataManager::V1::UserListGlobalLicense UserListGlobalLicense}
|
|
26
|
+
# resource.
|
|
27
|
+
# @!attribute [rw] parent
|
|
28
|
+
# @return [::String]
|
|
29
|
+
# Required. The account that owns the user list being licensed. Should be in
|
|
30
|
+
# the format accountTypes/\\{ACCOUNT_TYPE}/accounts/\\{ACCOUNT_ID}
|
|
31
|
+
# @!attribute [rw] user_list_global_license
|
|
32
|
+
# @return [::Google::Ads::DataManager::V1::UserListGlobalLicense]
|
|
33
|
+
# Required. The user list global license to create.
|
|
34
|
+
class CreateUserListGlobalLicenseRequest
|
|
35
|
+
include ::Google::Protobuf::MessageExts
|
|
36
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# Request to update a
|
|
40
|
+
# {::Google::Ads::DataManager::V1::UserListGlobalLicense UserListGlobalLicense}
|
|
41
|
+
# resource.
|
|
42
|
+
# @!attribute [rw] user_list_global_license
|
|
43
|
+
# @return [::Google::Ads::DataManager::V1::UserListGlobalLicense]
|
|
44
|
+
# Required. The licenses' `name` field is used to identify the license to
|
|
45
|
+
# update.
|
|
46
|
+
# @!attribute [rw] update_mask
|
|
47
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
48
|
+
# Optional. The list of fields to update. The special character `*` is not
|
|
49
|
+
# supported and an `INVALID_UPDATE_MASK` error will be thrown if used.
|
|
50
|
+
class UpdateUserListGlobalLicenseRequest
|
|
51
|
+
include ::Google::Protobuf::MessageExts
|
|
52
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Request to get a
|
|
56
|
+
# {::Google::Ads::DataManager::V1::UserListGlobalLicense UserListGlobalLicense}
|
|
57
|
+
# resource.
|
|
58
|
+
# @!attribute [rw] name
|
|
59
|
+
# @return [::String]
|
|
60
|
+
# Required. The resource name of the user list global license.
|
|
61
|
+
class GetUserListGlobalLicenseRequest
|
|
62
|
+
include ::Google::Protobuf::MessageExts
|
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# Request to list all
|
|
67
|
+
# {::Google::Ads::DataManager::V1::UserListGlobalLicense UserListGlobalLicense}
|
|
68
|
+
# resources for a given account.
|
|
69
|
+
# @!attribute [rw] parent
|
|
70
|
+
# @return [::String]
|
|
71
|
+
# Required. The account whose licenses are being queried. Should be in the
|
|
72
|
+
# format accountTypes/\\{ACCOUNT_TYPE}/accounts/\\{ACCOUNT_ID}
|
|
73
|
+
# @!attribute [rw] filter
|
|
74
|
+
# @return [::String]
|
|
75
|
+
# Optional. A [filter string](https://google.aip.dev/160) to apply to the
|
|
76
|
+
# list request. All fields need to be on the left hand side of each condition
|
|
77
|
+
# (for example: `user_list_id = 123`). Fields must be specified using either
|
|
78
|
+
# all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake
|
|
79
|
+
# case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
|
|
80
|
+
# camel case and snake case.
|
|
81
|
+
#
|
|
82
|
+
# **Supported Operations:**
|
|
83
|
+
#
|
|
84
|
+
# - `AND`
|
|
85
|
+
# - `=`
|
|
86
|
+
# - `!=`
|
|
87
|
+
# - `>`
|
|
88
|
+
# - `>=`
|
|
89
|
+
# - `<`
|
|
90
|
+
# - `<=`
|
|
91
|
+
#
|
|
92
|
+
# **Unsupported Fields:**
|
|
93
|
+
#
|
|
94
|
+
# - `name` (use get method instead)
|
|
95
|
+
# - `historical_pricings` and all its subfields
|
|
96
|
+
# - `pricing.start_time`
|
|
97
|
+
# - `pricing.end_time`
|
|
98
|
+
# @!attribute [rw] page_size
|
|
99
|
+
# @return [::Integer]
|
|
100
|
+
# Optional. The maximum number of licenses to return. The service may return
|
|
101
|
+
# fewer than this value. If unspecified, at most 50 licenses will be
|
|
102
|
+
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
|
103
|
+
# 1000.
|
|
104
|
+
# @!attribute [rw] page_token
|
|
105
|
+
# @return [::String]
|
|
106
|
+
# Optional. A page token, received from a previous
|
|
107
|
+
# `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent
|
|
108
|
+
# page.
|
|
109
|
+
#
|
|
110
|
+
# When paginating, all other parameters provided to
|
|
111
|
+
# `ListUserListDirectLicense` must match the call that provided the page
|
|
112
|
+
# token.
|
|
113
|
+
class ListUserListGlobalLicensesRequest
|
|
114
|
+
include ::Google::Protobuf::MessageExts
|
|
115
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
# Response from the
|
|
119
|
+
# {::Google::Ads::DataManager::V1::ListUserListGlobalLicensesRequest ListUserListGlobalLicensesRequest}.
|
|
120
|
+
# @!attribute [rw] user_list_global_licenses
|
|
121
|
+
# @return [::Array<::Google::Ads::DataManager::V1::UserListGlobalLicense>]
|
|
122
|
+
# The licenses for the given user list in the request.
|
|
123
|
+
# @!attribute [rw] next_page_token
|
|
124
|
+
# @return [::String]
|
|
125
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
126
|
+
# If this field is omitted, there are no subsequent pages.
|
|
127
|
+
class ListUserListGlobalLicensesResponse
|
|
128
|
+
include ::Google::Protobuf::MessageExts
|
|
129
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# Request to list all
|
|
133
|
+
# {::Google::Ads::DataManager::V1::UserListGlobalLicenseCustomerInfo UserListGlobalLicenseCustomerInfo}
|
|
134
|
+
# resources for a given user list global license.
|
|
135
|
+
# @!attribute [rw] parent
|
|
136
|
+
# @return [::String]
|
|
137
|
+
# Required. The global license whose customer info are being queried. Should
|
|
138
|
+
# be in the format
|
|
139
|
+
# `accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}`.
|
|
140
|
+
# To list all global license customer info under an account, replace the user
|
|
141
|
+
# list global license id with a '-' (for example,
|
|
142
|
+
# `accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-`)
|
|
143
|
+
# @!attribute [rw] filter
|
|
144
|
+
# @return [::String]
|
|
145
|
+
# Optional. A [filter string](https://google.aip.dev/160) to apply to the
|
|
146
|
+
# list request. All fields need to be on the left hand side of each condition
|
|
147
|
+
# (for example: `user_list_id = 123`). Fields must be specified using either
|
|
148
|
+
# all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake
|
|
149
|
+
# case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
|
|
150
|
+
# camel case and snake case.
|
|
151
|
+
#
|
|
152
|
+
# **Supported Operations:**
|
|
153
|
+
#
|
|
154
|
+
# - `AND`
|
|
155
|
+
# - `=`
|
|
156
|
+
# - `!=`
|
|
157
|
+
# - `>`
|
|
158
|
+
# - `>=`
|
|
159
|
+
# - `<`
|
|
160
|
+
# - `<=`
|
|
161
|
+
#
|
|
162
|
+
# **Unsupported Fields:**
|
|
163
|
+
#
|
|
164
|
+
# - `name` (use get method instead)
|
|
165
|
+
# - `historical_pricings` and all its subfields
|
|
166
|
+
# - `pricing.start_time`
|
|
167
|
+
# - `pricing.end_time`
|
|
168
|
+
# @!attribute [rw] page_size
|
|
169
|
+
# @return [::Integer]
|
|
170
|
+
# Optional. The maximum number of licenses to return. The service may return
|
|
171
|
+
# fewer than this value. If unspecified, at most 50 licenses will be
|
|
172
|
+
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
|
173
|
+
# 1000.
|
|
174
|
+
# @!attribute [rw] page_token
|
|
175
|
+
# @return [::String]
|
|
176
|
+
# Optional. A page token, received from a previous
|
|
177
|
+
# `ListUserListDirectLicense` call. Provide this to retrieve the subsequent
|
|
178
|
+
# page.
|
|
179
|
+
#
|
|
180
|
+
# When paginating, all other parameters provided to
|
|
181
|
+
# `ListUserListDirectLicense` must match the call that provided the page
|
|
182
|
+
# token.
|
|
183
|
+
class ListUserListGlobalLicenseCustomerInfosRequest
|
|
184
|
+
include ::Google::Protobuf::MessageExts
|
|
185
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# Response from the
|
|
189
|
+
# [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].
|
|
190
|
+
# @!attribute [rw] user_list_global_license_customer_infos
|
|
191
|
+
# @return [::Array<::Google::Ads::DataManager::V1::UserListGlobalLicenseCustomerInfo>]
|
|
192
|
+
# The customer information for the given license in the request.
|
|
193
|
+
# @!attribute [rw] next_page_token
|
|
194
|
+
# @return [::String]
|
|
195
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
196
|
+
# If this field is omitted, there are no subsequent pages.
|
|
197
|
+
class ListUserListGlobalLicenseCustomerInfosResponse
|
|
198
|
+
include ::Google::Protobuf::MessageExts
|
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
200
|
+
end
|
|
201
|
+
end
|
|
202
|
+
end
|
|
203
|
+
end
|
|
204
|
+
end
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# User list global license types.
|
|
25
|
+
module UserListGlobalLicenseType
|
|
26
|
+
# UNSPECIFIED.
|
|
27
|
+
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED = 0
|
|
28
|
+
|
|
29
|
+
# Reseller license.
|
|
30
|
+
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER = 1
|
|
31
|
+
|
|
32
|
+
# DataMart Sell Side license.
|
|
33
|
+
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE = 2
|
|
34
|
+
|
|
35
|
+
# DataMart Buy Side license.
|
|
36
|
+
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE = 3
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# Possible product of a client account for a user list license.
|
|
25
|
+
module UserListLicenseClientAccountType
|
|
26
|
+
# Unknown.
|
|
27
|
+
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN = 0
|
|
28
|
+
|
|
29
|
+
# Google Ads customer.
|
|
30
|
+
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS = 1
|
|
31
|
+
|
|
32
|
+
# Display & Video 360 partner.
|
|
33
|
+
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER = 2
|
|
34
|
+
|
|
35
|
+
# Display & Video 360 advertiser.
|
|
36
|
+
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER = 3
|
|
37
|
+
|
|
38
|
+
# Google Ad Manager audience link.
|
|
39
|
+
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK = 4
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# Metrics related to a user list license.
|
|
25
|
+
# @!attribute [r] click_count
|
|
26
|
+
# @return [::Integer]
|
|
27
|
+
# Output only. The number of clicks for the user list license.
|
|
28
|
+
# @!attribute [r] impression_count
|
|
29
|
+
# @return [::Integer]
|
|
30
|
+
# Output only. The number of impressions for the user list license.
|
|
31
|
+
# @!attribute [r] revenue_usd_micros
|
|
32
|
+
# @return [::Integer]
|
|
33
|
+
# Output only. The revenue for the user list license in USD micros.
|
|
34
|
+
# @!attribute [r] start_date
|
|
35
|
+
# @return [::Integer]
|
|
36
|
+
# Output only. The start date (inclusive) of the metrics in the format
|
|
37
|
+
# YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date`
|
|
38
|
+
# is used in the filter, `start_date` is also required. If neither
|
|
39
|
+
# `start_date` nor `end_date` are included in the filter, the
|
|
40
|
+
# UserListLicenseMetrics fields will not be populated in the response.
|
|
41
|
+
# @!attribute [r] end_date
|
|
42
|
+
# @return [::Integer]
|
|
43
|
+
# Output only. The end date (inclusive) of the metrics in the format
|
|
44
|
+
# YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date`
|
|
45
|
+
# is used in the filter, `end_date` is also required. If neither `start_date`
|
|
46
|
+
# nor `end_date` are included in the filter, the UserListLicenseMetrics
|
|
47
|
+
# fields will not be populated in the response.
|
|
48
|
+
class UserListLicenseMetrics
|
|
49
|
+
include ::Google::Protobuf::MessageExts
|
|
50
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# A user list license pricing.
|
|
25
|
+
# @!attribute [r] pricing_id
|
|
26
|
+
# @return [::Integer]
|
|
27
|
+
# Output only. The ID of this pricing.
|
|
28
|
+
# @!attribute [rw] cost_micros
|
|
29
|
+
# @return [::Integer]
|
|
30
|
+
# Optional. The cost associated with the model, in micro units (10^-6), in
|
|
31
|
+
# the currency specified by the currency_code field. For example, 2000000
|
|
32
|
+
# means $2 if `currency_code` is `USD`.
|
|
33
|
+
# @!attribute [rw] currency_code
|
|
34
|
+
# @return [::String]
|
|
35
|
+
# Optional. The currency in which cost and max_cost is specified. Must be a
|
|
36
|
+
# three-letter currency code defined in ISO 4217.
|
|
37
|
+
# @!attribute [r] start_time
|
|
38
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
39
|
+
# Output only. Start time of the pricing.
|
|
40
|
+
# @!attribute [rw] end_time
|
|
41
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
42
|
+
# Optional. End time of the pricing.
|
|
43
|
+
# @!attribute [r] pricing_active
|
|
44
|
+
# @return [::Boolean]
|
|
45
|
+
# Output only. Whether this pricing is active.
|
|
46
|
+
# @!attribute [r] buyer_approval_state
|
|
47
|
+
# @return [::Google::Ads::DataManager::V1::UserListLicensePricing::UserListPricingBuyerApprovalState]
|
|
48
|
+
# Output only. The buyer approval state of this pricing.
|
|
49
|
+
#
|
|
50
|
+
# This field is read-only.
|
|
51
|
+
# @!attribute [rw] cost_type
|
|
52
|
+
# @return [::Google::Ads::DataManager::V1::UserListLicensePricing::UserListPricingCostType]
|
|
53
|
+
# Immutable. The cost type of this pricing.
|
|
54
|
+
#
|
|
55
|
+
# Can be set only in the `create` operation. Can't be updated for
|
|
56
|
+
# an existing license.
|
|
57
|
+
# @!attribute [rw] max_cost_micros
|
|
58
|
+
# @return [::Integer]
|
|
59
|
+
# Optional. The maximum CPM a commerce audience can be charged when the
|
|
60
|
+
# MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in
|
|
61
|
+
# the currency specified by the currency_code field. For example, 2000000
|
|
62
|
+
# means $2 if `currency_code` is `USD`.
|
|
63
|
+
#
|
|
64
|
+
# This is only relevant when cost_type is MEDIA_SHARE.
|
|
65
|
+
# When cost_type is not MEDIA_SHARE, and this field is set, a
|
|
66
|
+
# MAX_COST_NOT_ALLOWED error will be returned.
|
|
67
|
+
# If not set or set to`0`, there is no cap.
|
|
68
|
+
class UserListLicensePricing
|
|
69
|
+
include ::Google::Protobuf::MessageExts
|
|
70
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
71
|
+
|
|
72
|
+
# User list pricing buyer approval state.
|
|
73
|
+
module UserListPricingBuyerApprovalState
|
|
74
|
+
# UNSPECIFIED.
|
|
75
|
+
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED = 0
|
|
76
|
+
|
|
77
|
+
# User list client has not yet accepted the pricing terms set by the user
|
|
78
|
+
# list owner.
|
|
79
|
+
PENDING = 1
|
|
80
|
+
|
|
81
|
+
# User list client has accepted the pricing terms set by the user list
|
|
82
|
+
# owner.
|
|
83
|
+
APPROVED = 2
|
|
84
|
+
|
|
85
|
+
# User list client has rejected the pricing terms set by the user list
|
|
86
|
+
# owner.
|
|
87
|
+
REJECTED = 3
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# User list pricing cost type.
|
|
91
|
+
module UserListPricingCostType
|
|
92
|
+
# Unspecified.
|
|
93
|
+
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED = 0
|
|
94
|
+
|
|
95
|
+
# Cost per click.
|
|
96
|
+
CPC = 1
|
|
97
|
+
|
|
98
|
+
# Cost per mille (thousand impressions).
|
|
99
|
+
CPM = 2
|
|
100
|
+
|
|
101
|
+
# Media share.
|
|
102
|
+
MEDIA_SHARE = 3
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
end
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# User list license status.
|
|
25
|
+
module UserListLicenseStatus
|
|
26
|
+
# Unknown.
|
|
27
|
+
USER_LIST_LICENSE_STATUS_UNSPECIFIED = 0
|
|
28
|
+
|
|
29
|
+
# Active status - user list is still being licensed.
|
|
30
|
+
USER_LIST_LICENSE_STATUS_ENABLED = 1
|
|
31
|
+
|
|
32
|
+
# Inactive status - user list is no longer being licensed.
|
|
33
|
+
USER_LIST_LICENSE_STATUS_DISABLED = 2
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|