google-ads-marketing_platform-admin-v1alpha 0.1.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 +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/LICENSE.md +201 -0
- data/README.md +154 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/client.rb +877 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/credentials.rb +50 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/paths.rb +94 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/rest/client.rb +816 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/rest/service_stub.rb +390 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/rest.rb +54 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service.rb +57 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha/rest.rb +39 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha/version.rb +30 -0
- data/lib/google/ads/marketing_platform/admin/v1alpha.rb +47 -0
- data/lib/google/marketingplatform/admin/v1alpha/marketingplatform_admin_pb.rb +59 -0
- data/lib/google/marketingplatform/admin/v1alpha/marketingplatform_admin_services_pb.rb +65 -0
- data/lib/google/marketingplatform/admin/v1alpha/resources_pb.rb +49 -0
- data/lib/google-ads-marketing_platform-admin-v1alpha.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +473 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/marketingplatform/admin/v1alpha/marketingplatform_admin.rb +138 -0
- data/proto_docs/google/marketingplatform/admin/v1alpha/resources.rb +84 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- metadata +103 -0
@@ -0,0 +1,227 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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 Api
|
22
|
+
# A simple descriptor of a resource type.
|
23
|
+
#
|
24
|
+
# ResourceDescriptor annotates a resource message (either by means of a
|
25
|
+
# protobuf annotation or use in the service config), and associates the
|
26
|
+
# resource's schema, the resource type, and the pattern of the resource name.
|
27
|
+
#
|
28
|
+
# Example:
|
29
|
+
#
|
30
|
+
# message Topic {
|
31
|
+
# // Indicates this message defines a resource schema.
|
32
|
+
# // Declares the resource type in the format of {service}/{kind}.
|
33
|
+
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
|
+
# option (google.api.resource) = {
|
35
|
+
# type: "pubsub.googleapis.com/Topic"
|
36
|
+
# pattern: "projects/{project}/topics/{topic}"
|
37
|
+
# };
|
38
|
+
# }
|
39
|
+
#
|
40
|
+
# The ResourceDescriptor Yaml config will look like:
|
41
|
+
#
|
42
|
+
# resources:
|
43
|
+
# - type: "pubsub.googleapis.com/Topic"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
45
|
+
#
|
46
|
+
# Sometimes, resources have multiple patterns, typically because they can
|
47
|
+
# live under multiple parents.
|
48
|
+
#
|
49
|
+
# Example:
|
50
|
+
#
|
51
|
+
# message LogEntry {
|
52
|
+
# option (google.api.resource) = {
|
53
|
+
# type: "logging.googleapis.com/LogEntry"
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
58
|
+
# };
|
59
|
+
# }
|
60
|
+
#
|
61
|
+
# The ResourceDescriptor Yaml config will look like:
|
62
|
+
#
|
63
|
+
# resources:
|
64
|
+
# - type: 'logging.googleapis.com/LogEntry'
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
69
|
+
# @!attribute [rw] type
|
70
|
+
# @return [::String]
|
71
|
+
# The resource type. It must be in the format of
|
72
|
+
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
73
|
+
# singular and must not include version numbers.
|
74
|
+
#
|
75
|
+
# Example: `storage.googleapis.com/Bucket`
|
76
|
+
#
|
77
|
+
# The value of the resource_type_kind must follow the regular expression
|
78
|
+
# /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
|
79
|
+
# should use PascalCase (UpperCamelCase). The maximum number of
|
80
|
+
# characters allowed for the `resource_type_kind` is 100.
|
81
|
+
# @!attribute [rw] pattern
|
82
|
+
# @return [::Array<::String>]
|
83
|
+
# Optional. The relative resource name pattern associated with this resource
|
84
|
+
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
85
|
+
#
|
86
|
+
# The path pattern must follow the syntax, which aligns with HTTP binding
|
87
|
+
# syntax:
|
88
|
+
#
|
89
|
+
# Template = Segment { "/" Segment } ;
|
90
|
+
# Segment = LITERAL | Variable ;
|
91
|
+
# Variable = "{" LITERAL "}" ;
|
92
|
+
#
|
93
|
+
# Examples:
|
94
|
+
#
|
95
|
+
# - "projects/\\{project}/topics/\\{topic}"
|
96
|
+
# - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
|
97
|
+
#
|
98
|
+
# The components in braces correspond to the IDs for each resource in the
|
99
|
+
# hierarchy. It is expected that, if multiple patterns are provided,
|
100
|
+
# the same component name (e.g. "project") refers to IDs of the same
|
101
|
+
# type of resource.
|
102
|
+
# @!attribute [rw] name_field
|
103
|
+
# @return [::String]
|
104
|
+
# Optional. The field on the resource that designates the resource name
|
105
|
+
# field. If omitted, this is assumed to be "name".
|
106
|
+
# @!attribute [rw] history
|
107
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
108
|
+
# Optional. The historical or future-looking state of the resource pattern.
|
109
|
+
#
|
110
|
+
# Example:
|
111
|
+
#
|
112
|
+
# // The InspectTemplate message originally only supported resource
|
113
|
+
# // names with organization, and project was added later.
|
114
|
+
# message InspectTemplate {
|
115
|
+
# option (google.api.resource) = {
|
116
|
+
# type: "dlp.googleapis.com/InspectTemplate"
|
117
|
+
# pattern:
|
118
|
+
# "organizations/{organization}/inspectTemplates/{inspect_template}"
|
119
|
+
# pattern: "projects/{project}/inspectTemplates/{inspect_template}"
|
120
|
+
# history: ORIGINALLY_SINGLE_PATTERN
|
121
|
+
# };
|
122
|
+
# }
|
123
|
+
# @!attribute [rw] plural
|
124
|
+
# @return [::String]
|
125
|
+
# The plural name used in the resource name and permission names, such as
|
126
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
127
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
|
128
|
+
# to this is for Nested Collections that have stuttering names, as defined
|
129
|
+
# in [AIP-122](https://google.aip.dev/122#nested-collections), where the
|
130
|
+
# collection ID in the resource name pattern does not necessarily directly
|
131
|
+
# match the `plural` value.
|
132
|
+
#
|
133
|
+
# It is the same concept of the `plural` field in k8s CRD spec
|
134
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
135
|
+
#
|
136
|
+
# Note: The plural form is required even for singleton resources. See
|
137
|
+
# https://aip.dev/156
|
138
|
+
# @!attribute [rw] singular
|
139
|
+
# @return [::String]
|
140
|
+
# The same concept of the `singular` field in k8s CRD spec
|
141
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
142
|
+
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
143
|
+
# @!attribute [rw] style
|
144
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
145
|
+
# Style flag(s) for this resource.
|
146
|
+
# These indicate that a resource is expected to conform to a given
|
147
|
+
# style. See the specific style flags for additional information.
|
148
|
+
class ResourceDescriptor
|
149
|
+
include ::Google::Protobuf::MessageExts
|
150
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
151
|
+
|
152
|
+
# A description of the historical or future-looking state of the
|
153
|
+
# resource pattern.
|
154
|
+
module History
|
155
|
+
# The "unset" value.
|
156
|
+
HISTORY_UNSPECIFIED = 0
|
157
|
+
|
158
|
+
# The resource originally had one pattern and launched as such, and
|
159
|
+
# additional patterns were added later.
|
160
|
+
ORIGINALLY_SINGLE_PATTERN = 1
|
161
|
+
|
162
|
+
# The resource has one pattern, but the API owner expects to add more
|
163
|
+
# later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
|
164
|
+
# that from being necessary once there are multiple patterns.)
|
165
|
+
FUTURE_MULTI_PATTERN = 2
|
166
|
+
end
|
167
|
+
|
168
|
+
# A flag representing a specific style that a resource claims to conform to.
|
169
|
+
module Style
|
170
|
+
# The unspecified value. Do not use.
|
171
|
+
STYLE_UNSPECIFIED = 0
|
172
|
+
|
173
|
+
# This resource is intended to be "declarative-friendly".
|
174
|
+
#
|
175
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
176
|
+
# setting this to true communicates to tools that this resource should
|
177
|
+
# adhere to declarative-friendly expectations.
|
178
|
+
#
|
179
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
180
|
+
# additional checks.
|
181
|
+
DECLARATIVE_FRIENDLY = 1
|
182
|
+
end
|
183
|
+
end
|
184
|
+
|
185
|
+
# Defines a proto annotation that describes a string field that refers to
|
186
|
+
# an API resource.
|
187
|
+
# @!attribute [rw] type
|
188
|
+
# @return [::String]
|
189
|
+
# The resource type that the annotated field references.
|
190
|
+
#
|
191
|
+
# Example:
|
192
|
+
#
|
193
|
+
# message Subscription {
|
194
|
+
# string topic = 2 [(google.api.resource_reference) = {
|
195
|
+
# type: "pubsub.googleapis.com/Topic"
|
196
|
+
# }];
|
197
|
+
# }
|
198
|
+
#
|
199
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
200
|
+
# APIs use the special value * in their resource reference.
|
201
|
+
#
|
202
|
+
# Example:
|
203
|
+
#
|
204
|
+
# message GetIamPolicyRequest {
|
205
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
206
|
+
# type: "*"
|
207
|
+
# }];
|
208
|
+
# }
|
209
|
+
# @!attribute [rw] child_type
|
210
|
+
# @return [::String]
|
211
|
+
# The resource type of a child collection that the annotated field
|
212
|
+
# references. This is useful for annotating the `parent` field that
|
213
|
+
# doesn't have a fixed resource type.
|
214
|
+
#
|
215
|
+
# Example:
|
216
|
+
#
|
217
|
+
# message ListLogEntriesRequest {
|
218
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
219
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
220
|
+
# };
|
221
|
+
# }
|
222
|
+
class ResourceReference
|
223
|
+
include ::Google::Protobuf::MessageExts
|
224
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
225
|
+
end
|
226
|
+
end
|
227
|
+
end
|
@@ -0,0 +1,138 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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 MarketingPlatform
|
23
|
+
module Admin
|
24
|
+
module V1alpha
|
25
|
+
# Request message for GetOrganization RPC.
|
26
|
+
# @!attribute [rw] name
|
27
|
+
# @return [::String]
|
28
|
+
# Required. The name of the Organization to retrieve.
|
29
|
+
# Format: organizations/\\{org_id}
|
30
|
+
class GetOrganizationRequest
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# Request message for ListAnalyticsAccountLinks RPC.
|
36
|
+
# @!attribute [rw] parent
|
37
|
+
# @return [::String]
|
38
|
+
# Required. The parent organization, which owns this collection of Analytics
|
39
|
+
# account links. Format: organizations/\\{org_id}
|
40
|
+
# @!attribute [rw] page_size
|
41
|
+
# @return [::Integer]
|
42
|
+
# Optional. The maximum number of Analytics account links to return in one
|
43
|
+
# call. The service may return fewer than this value.
|
44
|
+
#
|
45
|
+
# If unspecified, at most 50 Analytics account links will be returned. The
|
46
|
+
# maximum value is 1000; values above 1000 will be coerced to 1000.
|
47
|
+
# @!attribute [rw] page_token
|
48
|
+
# @return [::String]
|
49
|
+
# Optional. A page token, received from a previous ListAnalyticsAccountLinks
|
50
|
+
# call. Provide this to retrieve the subsequent page.
|
51
|
+
#
|
52
|
+
# When paginating, all other parameters provided to
|
53
|
+
# `ListAnalyticsAccountLinks` must match the call that provided the page
|
54
|
+
# token.
|
55
|
+
class ListAnalyticsAccountLinksRequest
|
56
|
+
include ::Google::Protobuf::MessageExts
|
57
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
58
|
+
end
|
59
|
+
|
60
|
+
# Response message for ListAnalyticsAccountLinks RPC.
|
61
|
+
# @!attribute [rw] analytics_account_links
|
62
|
+
# @return [::Array<::Google::Ads::MarketingPlatform::Admin::V1alpha::AnalyticsAccountLink>]
|
63
|
+
# Analytics account links in this organization.
|
64
|
+
# @!attribute [rw] next_page_token
|
65
|
+
# @return [::String]
|
66
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
67
|
+
# If this field is omitted, there are no subsequent pages.
|
68
|
+
class ListAnalyticsAccountLinksResponse
|
69
|
+
include ::Google::Protobuf::MessageExts
|
70
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
71
|
+
end
|
72
|
+
|
73
|
+
# Request message for CreateAnalyticsAccountLink RPC.
|
74
|
+
# @!attribute [rw] parent
|
75
|
+
# @return [::String]
|
76
|
+
# Required. The parent resource where this Analytics account link will be
|
77
|
+
# created. Format: organizations/\\{org_id}
|
78
|
+
# @!attribute [rw] analytics_account_link
|
79
|
+
# @return [::Google::Ads::MarketingPlatform::Admin::V1alpha::AnalyticsAccountLink]
|
80
|
+
# Required. The Analytics account link to create.
|
81
|
+
class CreateAnalyticsAccountLinkRequest
|
82
|
+
include ::Google::Protobuf::MessageExts
|
83
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
84
|
+
end
|
85
|
+
|
86
|
+
# Request message for DeleteAnalyticsAccountLink RPC.
|
87
|
+
# @!attribute [rw] name
|
88
|
+
# @return [::String]
|
89
|
+
# Required. The name of the Analytics account link to delete.
|
90
|
+
# Format:
|
91
|
+
# organizations/\\{org_id}/analyticsAccountLinks/\\{analytics_account_link_id}
|
92
|
+
class DeleteAnalyticsAccountLinkRequest
|
93
|
+
include ::Google::Protobuf::MessageExts
|
94
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
95
|
+
end
|
96
|
+
|
97
|
+
# Request message for SetPropertyServiceLevel RPC.
|
98
|
+
# @!attribute [rw] analytics_account_link
|
99
|
+
# @return [::String]
|
100
|
+
# Required. The parent AnalyticsAccountLink scope where this property is in.
|
101
|
+
# Format:
|
102
|
+
# organizations/\\{org_id}/analyticsAccountLinks/\\{analytics_account_link_id}
|
103
|
+
# @!attribute [rw] analytics_property
|
104
|
+
# @return [::String]
|
105
|
+
# Required. The Analytics property to change the ServiceLevel setting. This
|
106
|
+
# field is the name of the Google Analytics Admin API property resource.
|
107
|
+
#
|
108
|
+
# Format: analyticsadmin.googleapis.com/properties/\\{property_id}
|
109
|
+
# @!attribute [rw] service_level
|
110
|
+
# @return [::Google::Ads::MarketingPlatform::Admin::V1alpha::AnalyticsServiceLevel]
|
111
|
+
# Required. The service level to set for this property.
|
112
|
+
class SetPropertyServiceLevelRequest
|
113
|
+
include ::Google::Protobuf::MessageExts
|
114
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
115
|
+
end
|
116
|
+
|
117
|
+
# Response message for SetPropertyServiceLevel RPC.
|
118
|
+
class SetPropertyServiceLevelResponse
|
119
|
+
include ::Google::Protobuf::MessageExts
|
120
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
121
|
+
end
|
122
|
+
|
123
|
+
# Various levels of service for Google Analytics.
|
124
|
+
module AnalyticsServiceLevel
|
125
|
+
# Service level unspecified.
|
126
|
+
ANALYTICS_SERVICE_LEVEL_UNSPECIFIED = 0
|
127
|
+
|
128
|
+
# The standard version of Google Analytics.
|
129
|
+
ANALYTICS_SERVICE_LEVEL_STANDARD = 1
|
130
|
+
|
131
|
+
# The premium version of Google Analytics.
|
132
|
+
ANALYTICS_SERVICE_LEVEL_360 = 2
|
133
|
+
end
|
134
|
+
end
|
135
|
+
end
|
136
|
+
end
|
137
|
+
end
|
138
|
+
end
|
@@ -0,0 +1,84 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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 MarketingPlatform
|
23
|
+
module Admin
|
24
|
+
module V1alpha
|
25
|
+
# A resource message representing a Google Marketing Platform organization.
|
26
|
+
# @!attribute [rw] name
|
27
|
+
# @return [::String]
|
28
|
+
# Identifier. The resource name of the GMP organization.
|
29
|
+
# Format: organizations/\\{org_id}
|
30
|
+
# @!attribute [rw] display_name
|
31
|
+
# @return [::String]
|
32
|
+
# The human-readable name for the organization.
|
33
|
+
class Organization
|
34
|
+
include ::Google::Protobuf::MessageExts
|
35
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
36
|
+
end
|
37
|
+
|
38
|
+
# A resource message representing the link between a Google Analytics account
|
39
|
+
# and a Google Marketing Platform organization.
|
40
|
+
# @!attribute [rw] name
|
41
|
+
# @return [::String]
|
42
|
+
# Identifier. Resource name of this AnalyticsAccountLink. Note the resource
|
43
|
+
# ID is the same as the ID of the Analtyics account.
|
44
|
+
#
|
45
|
+
# Format:
|
46
|
+
# organizations/\\{org_id}/analyticsAccountLinks/\\{analytics_account_link_id}
|
47
|
+
# Example: "organizations/xyz/analyticsAccountLinks/1234"
|
48
|
+
# @!attribute [rw] analytics_account
|
49
|
+
# @return [::String]
|
50
|
+
# Required. Immutable. The resource name of the AnalyticsAdmin API account.
|
51
|
+
# The account ID will be used as the ID of this AnalyticsAccountLink
|
52
|
+
# resource, which will become the final component of the resource name.
|
53
|
+
#
|
54
|
+
# Format: analyticsadmin.googleapis.com/accounts/\\{account_id}
|
55
|
+
# @!attribute [r] display_name
|
56
|
+
# @return [::String]
|
57
|
+
# Output only. The human-readable name for the Analytics account.
|
58
|
+
# @!attribute [r] link_verification_state
|
59
|
+
# @return [::Google::Ads::MarketingPlatform::Admin::V1alpha::LinkVerificationState]
|
60
|
+
# Output only. The verification state of the link between the Analytics
|
61
|
+
# account and the parent organization.
|
62
|
+
class AnalyticsAccountLink
|
63
|
+
include ::Google::Protobuf::MessageExts
|
64
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
|
+
end
|
66
|
+
|
67
|
+
# The verification state of the link between a product account and a GMP
|
68
|
+
# organization.
|
69
|
+
module LinkVerificationState
|
70
|
+
# The link state is unknown.
|
71
|
+
LINK_VERIFICATION_STATE_UNSPECIFIED = 0
|
72
|
+
|
73
|
+
# The link is established.
|
74
|
+
LINK_VERIFICATION_STATE_VERIFIED = 1
|
75
|
+
|
76
|
+
# The link is requested, but hasn't been approved by the product account
|
77
|
+
# admin.
|
78
|
+
LINK_VERIFICATION_STATE_NOT_VERIFIED = 2
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
@@ -0,0 +1,98 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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 Protobuf
|
22
|
+
# A Duration represents a signed, fixed-length span of time represented
|
23
|
+
# as a count of seconds and fractions of seconds at nanosecond
|
24
|
+
# resolution. It is independent of any calendar and concepts like "day"
|
25
|
+
# or "month". It is related to Timestamp in that the difference between
|
26
|
+
# two Timestamp values is a Duration and it can be added or subtracted
|
27
|
+
# from a Timestamp. Range is approximately +-10,000 years.
|
28
|
+
#
|
29
|
+
# # Examples
|
30
|
+
#
|
31
|
+
# Example 1: Compute Duration from two Timestamps in pseudo code.
|
32
|
+
#
|
33
|
+
# Timestamp start = ...;
|
34
|
+
# Timestamp end = ...;
|
35
|
+
# Duration duration = ...;
|
36
|
+
#
|
37
|
+
# duration.seconds = end.seconds - start.seconds;
|
38
|
+
# duration.nanos = end.nanos - start.nanos;
|
39
|
+
#
|
40
|
+
# if (duration.seconds < 0 && duration.nanos > 0) {
|
41
|
+
# duration.seconds += 1;
|
42
|
+
# duration.nanos -= 1000000000;
|
43
|
+
# } else if (duration.seconds > 0 && duration.nanos < 0) {
|
44
|
+
# duration.seconds -= 1;
|
45
|
+
# duration.nanos += 1000000000;
|
46
|
+
# }
|
47
|
+
#
|
48
|
+
# Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
49
|
+
#
|
50
|
+
# Timestamp start = ...;
|
51
|
+
# Duration duration = ...;
|
52
|
+
# Timestamp end = ...;
|
53
|
+
#
|
54
|
+
# end.seconds = start.seconds + duration.seconds;
|
55
|
+
# end.nanos = start.nanos + duration.nanos;
|
56
|
+
#
|
57
|
+
# if (end.nanos < 0) {
|
58
|
+
# end.seconds -= 1;
|
59
|
+
# end.nanos += 1000000000;
|
60
|
+
# } else if (end.nanos >= 1000000000) {
|
61
|
+
# end.seconds += 1;
|
62
|
+
# end.nanos -= 1000000000;
|
63
|
+
# }
|
64
|
+
#
|
65
|
+
# Example 3: Compute Duration from datetime.timedelta in Python.
|
66
|
+
#
|
67
|
+
# td = datetime.timedelta(days=3, minutes=10)
|
68
|
+
# duration = Duration()
|
69
|
+
# duration.FromTimedelta(td)
|
70
|
+
#
|
71
|
+
# # JSON Mapping
|
72
|
+
#
|
73
|
+
# In JSON format, the Duration type is encoded as a string rather than an
|
74
|
+
# object, where the string ends in the suffix "s" (indicating seconds) and
|
75
|
+
# is preceded by the number of seconds, with nanoseconds expressed as
|
76
|
+
# fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
77
|
+
# encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
78
|
+
# be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
79
|
+
# microsecond should be expressed in JSON format as "3.000001s".
|
80
|
+
# @!attribute [rw] seconds
|
81
|
+
# @return [::Integer]
|
82
|
+
# Signed seconds of the span of time. Must be from -315,576,000,000
|
83
|
+
# to +315,576,000,000 inclusive. Note: these bounds are computed from:
|
84
|
+
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
|
85
|
+
# @!attribute [rw] nanos
|
86
|
+
# @return [::Integer]
|
87
|
+
# Signed fractions of a second at nanosecond resolution of the span
|
88
|
+
# of time. Durations less than one second are represented with a 0
|
89
|
+
# `seconds` field and a positive or negative `nanos` field. For durations
|
90
|
+
# of one second or more, a non-zero value for the `nanos` field must be
|
91
|
+
# of the same sign as the `seconds` field. Must be from -999,999,999
|
92
|
+
# to +999,999,999 inclusive.
|
93
|
+
class Duration
|
94
|
+
include ::Google::Protobuf::MessageExts
|
95
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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 Protobuf
|
22
|
+
# A generic empty message that you can re-use to avoid defining duplicated
|
23
|
+
# empty messages in your APIs. A typical example is to use it as the request
|
24
|
+
# or the response type of an API method. For instance:
|
25
|
+
#
|
26
|
+
# service Foo {
|
27
|
+
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
28
|
+
# }
|
29
|
+
class Empty
|
30
|
+
include ::Google::Protobuf::MessageExts
|
31
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
metadata
ADDED
@@ -0,0 +1,103 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: google-ads-marketing_platform-admin-v1alpha
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Google LLC
|
8
|
+
bindir: bin
|
9
|
+
cert_chain: []
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
11
|
+
dependencies:
|
12
|
+
- !ruby/object:Gem::Dependency
|
13
|
+
name: gapic-common
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
15
|
+
requirements:
|
16
|
+
- - "~>"
|
17
|
+
- !ruby/object:Gem::Version
|
18
|
+
version: '1.0'
|
19
|
+
type: :runtime
|
20
|
+
prerelease: false
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
22
|
+
requirements:
|
23
|
+
- - "~>"
|
24
|
+
- !ruby/object:Gem::Version
|
25
|
+
version: '1.0'
|
26
|
+
- !ruby/object:Gem::Dependency
|
27
|
+
name: google-cloud-errors
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
29
|
+
requirements:
|
30
|
+
- - "~>"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: '1.0'
|
33
|
+
type: :runtime
|
34
|
+
prerelease: false
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - "~>"
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '1.0'
|
40
|
+
description: The Google Marketing Platform Admin API allows for programmatic access
|
41
|
+
to the Google Marketing Platform configuration data. You can use the Google Marketing
|
42
|
+
Platform Admin API to manage links between your Google Marketing Platform organization
|
43
|
+
and Google Analytics accounts, and to set the service level of your GA4 properties.
|
44
|
+
Note that google-ads-marketing_platform-admin-v1alpha is a version-specific client
|
45
|
+
library. For most uses, we recommend installing the main client library google-ads-marketing_platform-admin
|
46
|
+
instead. See the readme for more details.
|
47
|
+
email: googleapis-packages@google.com
|
48
|
+
executables: []
|
49
|
+
extensions: []
|
50
|
+
extra_rdoc_files: []
|
51
|
+
files:
|
52
|
+
- ".yardopts"
|
53
|
+
- AUTHENTICATION.md
|
54
|
+
- LICENSE.md
|
55
|
+
- README.md
|
56
|
+
- lib/google-ads-marketing_platform-admin-v1alpha.rb
|
57
|
+
- lib/google/ads/marketing_platform/admin/v1alpha.rb
|
58
|
+
- lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service.rb
|
59
|
+
- lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/client.rb
|
60
|
+
- lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/credentials.rb
|
61
|
+
- lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/paths.rb
|
62
|
+
- lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/rest.rb
|
63
|
+
- lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/rest/client.rb
|
64
|
+
- lib/google/ads/marketing_platform/admin/v1alpha/marketingplatform_admin_service/rest/service_stub.rb
|
65
|
+
- lib/google/ads/marketing_platform/admin/v1alpha/rest.rb
|
66
|
+
- lib/google/ads/marketing_platform/admin/v1alpha/version.rb
|
67
|
+
- lib/google/marketingplatform/admin/v1alpha/marketingplatform_admin_pb.rb
|
68
|
+
- lib/google/marketingplatform/admin/v1alpha/marketingplatform_admin_services_pb.rb
|
69
|
+
- lib/google/marketingplatform/admin/v1alpha/resources_pb.rb
|
70
|
+
- proto_docs/README.md
|
71
|
+
- proto_docs/google/api/client.rb
|
72
|
+
- proto_docs/google/api/field_behavior.rb
|
73
|
+
- proto_docs/google/api/launch_stage.rb
|
74
|
+
- proto_docs/google/api/resource.rb
|
75
|
+
- proto_docs/google/marketingplatform/admin/v1alpha/marketingplatform_admin.rb
|
76
|
+
- proto_docs/google/marketingplatform/admin/v1alpha/resources.rb
|
77
|
+
- proto_docs/google/protobuf/duration.rb
|
78
|
+
- proto_docs/google/protobuf/empty.rb
|
79
|
+
homepage: https://github.com/googleapis/google-cloud-ruby
|
80
|
+
licenses:
|
81
|
+
- Apache-2.0
|
82
|
+
metadata: {}
|
83
|
+
rdoc_options: []
|
84
|
+
require_paths:
|
85
|
+
- lib
|
86
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
87
|
+
requirements:
|
88
|
+
- - ">="
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '3.1'
|
91
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - ">="
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '0'
|
96
|
+
requirements: []
|
97
|
+
rubygems_version: 3.6.9
|
98
|
+
specification_version: 4
|
99
|
+
summary: The Google Marketing Platform Admin API allows for programmatic access to
|
100
|
+
the Google Marketing Platform configuration data. You can use the Google Marketing
|
101
|
+
Platform Admin API to manage links between your Google Marketing Platform organization
|
102
|
+
and Google Analytics accounts, and to set the service level of your GA4 properties.
|
103
|
+
test_files: []
|