google-ads-marketing_platform-admin-v1alpha 0.2.1 → 0.3.0

data/lib/google/marketingplatform/admin/v1alpha/marketingplatform_admin_services_pb.rb

@@ -36,6 +36,13 @@ module Google
 
               # Lookup for a single organization.
               rpc :GetOrganization, ::Google::Ads::MarketingPlatform::Admin::V1alpha::GetOrganizationRequest, ::Google::Ads::MarketingPlatform::Admin::V1alpha::Organization
+              # Returns a list of organizations that the user has access to.
+              rpc :ListOrganizations, ::Google::Ads::MarketingPlatform::Admin::V1alpha::ListOrganizationsRequest, ::Google::Ads::MarketingPlatform::Admin::V1alpha::ListOrganizationsResponse
+              # Returns a list of clients managed by the sales partner organization.
+              #
+              # User needs to be an OrgAdmin/BillingAdmin on the sales partner organization
+              # in order to view the end clients.
+              rpc :FindSalesPartnerManagedClients, ::Google::Ads::MarketingPlatform::Admin::V1alpha::FindSalesPartnerManagedClientsRequest, ::Google::Ads::MarketingPlatform::Admin::V1alpha::FindSalesPartnerManagedClientsResponse
               # Lists the Google Analytics accounts link to the specified Google Marketing
               # Platform organization.
               rpc :ListAnalyticsAccountLinks, ::Google::Ads::MarketingPlatform::Admin::V1alpha::ListAnalyticsAccountLinksRequest, ::Google::Ads::MarketingPlatform::Admin::V1alpha::ListAnalyticsAccountLinksResponse
@@ -54,6 +61,17 @@ module Google
               rpc :DeleteAnalyticsAccountLink, ::Google::Ads::MarketingPlatform::Admin::V1alpha::DeleteAnalyticsAccountLinkRequest, ::Google::Protobuf::Empty
               # Updates the service level for an Analytics property.
               rpc :SetPropertyServiceLevel, ::Google::Ads::MarketingPlatform::Admin::V1alpha::SetPropertyServiceLevelRequest, ::Google::Ads::MarketingPlatform::Admin::V1alpha::SetPropertyServiceLevelResponse
+              # Get the usage and billing data for properties within the organization for
+              # the specified month.
+              #
+              # Per direct client org, user needs to be OrgAdmin/BillingAdmin on the
+              # organization in order to view the billing and usage data.
+              #
+              # Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on
+              # the sales partner org in order to view the billing and usage data, or
+              # OrgAdmin/BillingAdmin on the sales partner client org in order to view the
+              # usage data only.
+              rpc :ReportPropertyUsage, ::Google::Ads::MarketingPlatform::Admin::V1alpha::ReportPropertyUsageRequest, ::Google::Ads::MarketingPlatform::Admin::V1alpha::ReportPropertyUsageResponse
             end
 
             Stub = Service.rpc_stub_class

data/lib/google/marketingplatform/admin/v1alpha/resources_pb.rb

@@ -8,7 +8,7 @@ require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 
 
-descriptor_data = "\n6google/marketingplatform/admin/v1alpha/resources.proto\x12&google.marketingplatform.admin.v1alpha\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\"\xab\x01\n\x0cOrganization\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x14\n\x0c\x64isplay_name\x18\x02 \x01(\t:r\xea\x41o\n2marketingplatformadmin.googleapis.com/Organization\x12\x1corganizations/{organization}*\rorganizations2\x0corganization\"\xb3\x03\n\x14\x41nalyticsAccountLink\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12K\n\x11\x61nalytics_account\x18\x02 \x01(\tB0\xe0\x41\x02\xe0\x41\x05\xfa\x41\'\n%analyticsadmin.googleapis.com/Account\x12\x19\n\x0c\x64isplay_name\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x63\n\x17link_verification_state\x18\x04 \x01(\x0e\x32=.google.marketingplatform.admin.v1alpha.LinkVerificationStateB\x03\xe0\x41\x03:\xba\x01\xea\x41\xb6\x01\n:marketingplatformadmin.googleapis.com/AnalyticsAccountLink\x12Korganizations/{organization}/analyticsAccountLinks/{analytics_account_link}*\x15\x61nalyticsAccountLinks2\x14\x61nalyticsAccountLink*\x90\x01\n\x15LinkVerificationState\x12\'\n#LINK_VERIFICATION_STATE_UNSPECIFIED\x10\x00\x12$\n LINK_VERIFICATION_STATE_VERIFIED\x10\x01\x12(\n$LINK_VERIFICATION_STATE_NOT_VERIFIED\x10\x02\x42\xd8\x02\n.com.google.ads.marketingplatform.admin.v1alphaB\x0eResourcesProtoP\x01ZKgoogle.golang.org/genproto/googleapis/marketingplatform/admin/v1alpha;admin\xaa\x02*Google.Ads.MarketingPlatform.Admin.V1Alpha\xca\x02*Google\\Ads\\MarketingPlatform\\Admin\\V1alpha\xea\x02.Google::Ads::MarketingPlatform::Admin::V1alpha\xea\x41;\n%analyticsadmin.googleapis.com/Account\x12\x12\x61\x63\x63ounts/{account}b\x06proto3"
+descriptor_data = "\n6google/marketingplatform/admin/v1alpha/resources.proto\x12&google.marketingplatform.admin.v1alpha\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\"\xab\x01\n\x0cOrganization\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x14\n\x0c\x64isplay_name\x18\x02 \x01(\t:r\xea\x41o\n2marketingplatformadmin.googleapis.com/Organization\x12\x1corganizations/{organization}*\rorganizations2\x0corganization\"\xb3\x03\n\x14\x41nalyticsAccountLink\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12K\n\x11\x61nalytics_account\x18\x02 \x01(\tB0\xe0\x41\x02\xe0\x41\x05\xfa\x41\'\n%analyticsadmin.googleapis.com/Account\x12\x19\n\x0c\x64isplay_name\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x63\n\x17link_verification_state\x18\x04 \x01(\x0e\x32=.google.marketingplatform.admin.v1alpha.LinkVerificationStateB\x03\xe0\x41\x03:\xba\x01\xea\x41\xb6\x01\n:marketingplatformadmin.googleapis.com/AnalyticsAccountLink\x12Korganizations/{organization}/analyticsAccountLinks/{analytics_account_link}*\x15\x61nalyticsAccountLinks2\x14\x61nalyticsAccountLink*\x90\x01\n\x15LinkVerificationState\x12\'\n#LINK_VERIFICATION_STATE_UNSPECIFIED\x10\x00\x12$\n LINK_VERIFICATION_STATE_VERIFIED\x10\x01\x12(\n$LINK_VERIFICATION_STATE_NOT_VERIFIED\x10\x02*\x87\x01\n\x15\x41nalyticsServiceLevel\x12\'\n#ANALYTICS_SERVICE_LEVEL_UNSPECIFIED\x10\x00\x12$\n ANALYTICS_SERVICE_LEVEL_STANDARD\x10\x01\x12\x1f\n\x1b\x41NALYTICS_SERVICE_LEVEL_360\x10\x02*\xb3\x01\n\x15\x41nalyticsPropertyType\x12\'\n#ANALYTICS_PROPERTY_TYPE_UNSPECIFIED\x10\x00\x12$\n ANALYTICS_PROPERTY_TYPE_ORDINARY\x10\x01\x12\'\n#ANALYTICS_PROPERTY_TYPE_SUBPROPERTY\x10\x02\x12\"\n\x1e\x41NALYTICS_PROPERTY_TYPE_ROLLUP\x10\x03\x42\xd8\x02\n.com.google.ads.marketingplatform.admin.v1alphaB\x0eResourcesProtoP\x01ZKgoogle.golang.org/genproto/googleapis/marketingplatform/admin/v1alpha;admin\xaa\x02*Google.Ads.MarketingPlatform.Admin.V1Alpha\xca\x02*Google\\Ads\\MarketingPlatform\\Admin\\V1alpha\xea\x02.Google::Ads::MarketingPlatform::Admin::V1alpha\xea\x41;\n%analyticsadmin.googleapis.com/Account\x12\x12\x61\x63\x63ounts/{account}b\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 
@@ -42,6 +42,8 @@ module Google
           Organization = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.marketingplatform.admin.v1alpha.Organization").msgclass
           AnalyticsAccountLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.marketingplatform.admin.v1alpha.AnalyticsAccountLink").msgclass
           LinkVerificationState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.marketingplatform.admin.v1alpha.LinkVerificationState").enummodule
+          AnalyticsServiceLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.marketingplatform.admin.v1alpha.AnalyticsServiceLevel").enummodule
+          AnalyticsPropertyType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.marketingplatform.admin.v1alpha.AnalyticsPropertyType").enummodule
         end
       end
     end

data/proto_docs/google/marketingplatform/admin/v1alpha/marketingplatform_admin.rb

@@ -32,6 +32,78 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Request message for ListOrganizations RPC.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     Optional. The maximum number of organizations to return in one call. The
+          #     service may return fewer than this value.
+          #
+          #     If unspecified, at most 50 organizations will be returned. The
+          #     maximum value is 1000; values above 1000 will be coerced to 1000.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     Optional. A page token, received from a previous ListOrganizations call.
+          #     Provide this to retrieve the subsequent page.
+          #
+          #     When paginating, all other parameters provided to
+          #     `ListOrganizations` must match the call that provided the page
+          #     token.
+          class ListOrganizationsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for ListOrganizations RPC.
+          # @!attribute [rw] organizations
+          #   @return [::Array<::Google::Ads::MarketingPlatform::Admin::V1alpha::Organization>]
+          #     The Organization resource that the user has access to, which includes the
+          #     org id and display name.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A token, which can be sent as `page_token` to retrieve the next page.
+          #     If this field is omitted, there are no subsequent pages.
+          class ListOrganizationsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for FindSalesPartnerManagedClients RPC.
+          # @!attribute [rw] organization
+          #   @return [::String]
+          #     Required. The name of the sales partner organization.
+          #     Format: organizations/\\{org_id}
+          # @!attribute [rw] is_active
+          #   @return [::Boolean]
+          #     Optional. If set, only active and just ended clients will be returned.
+          class FindSalesPartnerManagedClientsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for FindSalesPartnerManagedClients RPC.
+          # @!attribute [rw] client_data
+          #   @return [::Array<::Google::Ads::MarketingPlatform::Admin::V1alpha::FindSalesPartnerManagedClientsResponse::ClientData>]
+          #     The clients managed by the sales org.
+          class FindSalesPartnerManagedClientsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Contains the client data.
+            # @!attribute [rw] organization
+            #   @return [::Google::Ads::MarketingPlatform::Admin::V1alpha::Organization]
+            #     The end client that has/had contract with the requested sales org.
+            # @!attribute [rw] start_date
+            #   @return [::Google::Type::Date]
+            #     The start date of the contract between the sales org and the end client.
+            # @!attribute [rw] end_date
+            #   @return [::Google::Type::Date]
+            #     The end date of the contract between the sales org and the end client.
+            class ClientData
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
           # Request message for ListAnalyticsAccountLinks RPC.
           # @!attribute [rw] parent
           #   @return [::String]
@@ -120,16 +192,85 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Various levels of service for Google Analytics.
-          module AnalyticsServiceLevel
-            # Service level unspecified.
-            ANALYTICS_SERVICE_LEVEL_UNSPECIFIED = 0
+          # Request message for ReportPropertyUsage RPC.
+          # @!attribute [rw] organization
+          #   @return [::String]
+          #     Required. Specifies the organization whose property usage will be listed.
+          #
+          #     Format: organizations/\\{org_id}
+          # @!attribute [rw] month
+          #   @return [::String]
+          #     Required. The target month to list property usages.
+          #
+          #     Format: YYYY-MM. For example, "2025-05"
+          class ReportPropertyUsageRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for ReportPropertyUsage RPC.
+          # @!attribute [rw] property_usages
+          #   @return [::Array<::Google::Ads::MarketingPlatform::Admin::V1alpha::ReportPropertyUsageResponse::PropertyUsage>]
+          #     Usage data for all properties in the specified organization and month.
+          # @!attribute [rw] bill_info
+          #   @return [::Google::Ads::MarketingPlatform::Admin::V1alpha::ReportPropertyUsageResponse::BillInfo]
+          #     Bill amount in the specified organization and month.
+          #
+          #     Will be empty if user only has access to usage data.
+          class ReportPropertyUsageResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
 
-            # The standard version of Google Analytics.
-            ANALYTICS_SERVICE_LEVEL_STANDARD = 1
+            # Contains the count of events received by the property, along with metadata
+            # that influences the volume of `billable` events.
+            # @!attribute [rw] property
+            #   @return [::String]
+            #     The name of the Google Analytics Admin API property resource.
+            #
+            #     Format: analyticsadmin.googleapis.com/properties/\\{property_id}
+            # @!attribute [rw] display_name
+            #   @return [::String]
+            #     The display name of the property.
+            # @!attribute [rw] account_id
+            #   @return [::Integer]
+            #     The ID of the property's parent account.
+            # @!attribute [rw] service_level
+            #   @return [::Google::Ads::MarketingPlatform::Admin::V1alpha::AnalyticsServiceLevel]
+            #     The service level of the property.
+            # @!attribute [rw] property_type
+            #   @return [::Google::Ads::MarketingPlatform::Admin::V1alpha::AnalyticsPropertyType]
+            #     The subtype of the analytics property. This affects the billable event
+            #     count.
+            # @!attribute [rw] total_event_count
+            #   @return [::Integer]
+            #     Total event count that the property received during the requested month.
+            # @!attribute [rw] billable_event_count
+            #   @return [::Integer]
+            #     The number of events for which the property is billed in the requested
+            #     month.
+            class PropertyUsage
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
 
-            # The premium version of Google Analytics.
-            ANALYTICS_SERVICE_LEVEL_360 = 2
+            # Contains the bill amount.
+            # @!attribute [rw] base_fee
+            #   @return [::Google::Type::Money]
+            #     The amount of the monthly base fee.
+            # @!attribute [rw] event_fee
+            #   @return [::Google::Type::Money]
+            #     The amount of the event fee.
+            # @!attribute [rw] price_protection_credit
+            #   @return [::Google::Type::Money]
+            #     The amount of the price protection credit, this is only available for
+            #     eligible customers.
+            # @!attribute [rw] total
+            #   @return [::Google::Type::Money]
+            #     The total amount of the bill.
+            class BillInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
         end
       end

data/proto_docs/google/marketingplatform/admin/v1alpha/resources.rb

@@ -77,6 +77,33 @@ module Google
             # admin.
             LINK_VERIFICATION_STATE_NOT_VERIFIED = 2
           end
+
+          # Various levels of service for Google Analytics.
+          module AnalyticsServiceLevel
+            # Service level unspecified.
+            ANALYTICS_SERVICE_LEVEL_UNSPECIFIED = 0
+
+            # The standard version of Google Analytics.
+            ANALYTICS_SERVICE_LEVEL_STANDARD = 1
+
+            # The premium version of Google Analytics.
+            ANALYTICS_SERVICE_LEVEL_360 = 2
+          end
+
+          # Types of the Google Analytics Property.
+          module AnalyticsPropertyType
+            # Unknown or unspecified property type
+            ANALYTICS_PROPERTY_TYPE_UNSPECIFIED = 0
+
+            # Ordinary Google Analytics property
+            ANALYTICS_PROPERTY_TYPE_ORDINARY = 1
+
+            # Google Analytics subproperty
+            ANALYTICS_PROPERTY_TYPE_SUBPROPERTY = 2
+
+            # Google Analytics rollup property
+            ANALYTICS_PROPERTY_TYPE_ROLLUP = 3
+          end
         end
       end
     end

data/proto_docs/google/type/date.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents a whole or partial calendar date, such as a birthday. The time of
+    # day and time zone are either specified elsewhere or are insignificant. The
+    # date is relative to the Gregorian Calendar. This can represent one of the
+    # following:
+    #
+    # * A full date, with non-zero year, month, and day values
+    # * A month and day value, with a zero year, such as an anniversary
+    # * A year on its own, with zero month and day values
+    # * A year and month value, with a zero day, such as a credit card expiration
+    # date
+    #
+    # Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
+    # `google.protobuf.Timestamp`.
+    # @!attribute [rw] year
+    #   @return [::Integer]
+    #     Year of the date. Must be from 1 to 9999, or 0 to specify a date without
+    #     a year.
+    # @!attribute [rw] month
+    #   @return [::Integer]
+    #     Month of a year. Must be from 1 to 12, or 0 to specify a year without a
+    #     month and day.
+    # @!attribute [rw] day
+    #   @return [::Integer]
+    #     Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
+    #     to specify a year by itself or a year and month where the day isn't
+    #     significant.
+    class Date
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/type/money.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents an amount of money with its currency type.
+    # @!attribute [rw] currency_code
+    #   @return [::String]
+    #     The three-letter currency code defined in ISO 4217.
+    # @!attribute [rw] units
+    #   @return [::Integer]
+    #     The whole units of the amount.
+    #     For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Number of nano (10^-9) units of the amount.
+    #     The value must be between -999,999,999 and +999,999,999 inclusive.
+    #     If `units` is positive, `nanos` must be positive or zero.
+    #     If `units` is zero, `nanos` can be positive, zero, or negative.
+    #     If `units` is negative, `nanos` must be negative or zero.
+    #     For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+    class Money
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-ads-marketing_platform-admin-v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
@@ -76,6 +76,8 @@ files:
 - proto_docs/google/marketingplatform/admin/v1alpha/resources.rb
 - proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
+- proto_docs/google/type/date.rb
+- proto_docs/google/type/money.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0