Package com.google.ads.marketingplatform.admin.v1alpha (0.48.0)

GitHub Repository

Prerelease Implications

This package is a prerelease version! Use with caution.

Prerelease versions are considered unstable as they may be shut down and/or subject to breaking changes when upgrading. Use them only for testing or if you specifically need their experimental features.

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient Service Description: Service Interface for the Google Marketing Platform Admin API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceSettings Settings class to configure an instance of MarketingplatformAdminServiceClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.ads.marketingplatform.admin.v1alpha.AdminAccessBinding A resource message representing a binding to a set of roles.
com.google.ads.marketingplatform.admin.v1alpha.AdminAccessBinding.Builder A resource message representing a binding to a set of roles.
com.google.ads.marketingplatform.admin.v1alpha.AdminAccessBindingName
com.google.ads.marketingplatform.admin.v1alpha.AdminAccessBindingName.Builder Builder for organizations/{organization}/adminAccessBindings/{admin_access_binding}.
com.google.ads.marketingplatform.admin.v1alpha.AnalyticsAccountLink A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.
com.google.ads.marketingplatform.admin.v1alpha.AnalyticsAccountLink.Builder A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.
com.google.ads.marketingplatform.admin.v1alpha.AnalyticsAccountLinkName
com.google.ads.marketingplatform.admin.v1alpha.AnalyticsAccountLinkName.Builder Builder for organizations/{organization}/analyticsAccountLinks/{analytics_account_link}.
com.google.ads.marketingplatform.admin.v1alpha.CreateAdminAccessBindingRequest Request message for CreateAdminAccessBinding RPC.
com.google.ads.marketingplatform.admin.v1alpha.CreateAdminAccessBindingRequest.Builder Request message for CreateAdminAccessBinding RPC.
com.google.ads.marketingplatform.admin.v1alpha.CreateAnalyticsAccountLinkRequest Request message for CreateAnalyticsAccountLink RPC.
com.google.ads.marketingplatform.admin.v1alpha.CreateAnalyticsAccountLinkRequest.Builder Request message for CreateAnalyticsAccountLink RPC.
com.google.ads.marketingplatform.admin.v1alpha.CreateUserGroupMemberRequest Request message for CreateUserGroupMember RPC.
com.google.ads.marketingplatform.admin.v1alpha.CreateUserGroupMemberRequest.Builder Request message for CreateUserGroupMember RPC.
com.google.ads.marketingplatform.admin.v1alpha.CreateUserGroupRequest Request message for CreateUserGroup RPC.
com.google.ads.marketingplatform.admin.v1alpha.CreateUserGroupRequest.Builder Request message for CreateUserGroup RPC.
com.google.ads.marketingplatform.admin.v1alpha.DeleteAnalyticsAccountLinkRequest Request message for DeleteAnalyticsAccountLink RPC.
com.google.ads.marketingplatform.admin.v1alpha.DeleteAnalyticsAccountLinkRequest.Builder Request message for DeleteAnalyticsAccountLink RPC.
com.google.ads.marketingplatform.admin.v1alpha.DeleteUserGroupMemberRequest Request message for DeleteUserGroupMember RPC.
com.google.ads.marketingplatform.admin.v1alpha.DeleteUserGroupMemberRequest.Builder Request message for DeleteUserGroupMember RPC.
com.google.ads.marketingplatform.admin.v1alpha.DeleteUserGroupRequest Request message for DeleteUserGroup RPC.
com.google.ads.marketingplatform.admin.v1alpha.DeleteUserGroupRequest.Builder Request message for DeleteUserGroup RPC.
com.google.ads.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsRequest Request message for FindSalesPartnerManagedClients RPC.
com.google.ads.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsRequest.Builder Request message for FindSalesPartnerManagedClients RPC.
com.google.ads.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsResponse Response message for FindSalesPartnerManagedClients RPC.
com.google.ads.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsResponse.Builder Response message for FindSalesPartnerManagedClients RPC.
com.google.ads.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsResponse.ClientData Contains the client data.
com.google.ads.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsResponse.ClientData.Builder Contains the client data.
com.google.ads.marketingplatform.admin.v1alpha.GetAdminAccessBindingRequest Response message for GetAdminAccessBinding RPC.
com.google.ads.marketingplatform.admin.v1alpha.GetAdminAccessBindingRequest.Builder Response message for GetAdminAccessBinding RPC.
com.google.ads.marketingplatform.admin.v1alpha.GetOrganizationRequest Request message for GetOrganization RPC.
com.google.ads.marketingplatform.admin.v1alpha.GetOrganizationRequest.Builder Request message for GetOrganization RPC.
com.google.ads.marketingplatform.admin.v1alpha.GetUserGroupMemberRequest Request message for GetUserGroupMember RPC.
com.google.ads.marketingplatform.admin.v1alpha.GetUserGroupMemberRequest.Builder Request message for GetUserGroupMember RPC.
com.google.ads.marketingplatform.admin.v1alpha.GetUserGroupRequest Request message for GetUserGroup RPC.
com.google.ads.marketingplatform.admin.v1alpha.GetUserGroupRequest.Builder Request message for GetUserGroup RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListAdminAccessBindingsRequest Request message for ListAdminAccessBindings RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListAdminAccessBindingsRequest.Builder Request message for ListAdminAccessBindings RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListAdminAccessBindingsResponse Response message for ListAdminAccessBindings RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListAdminAccessBindingsResponse.Builder Response message for ListAdminAccessBindings RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListAnalyticsAccountLinksRequest Request message for ListAnalyticsAccountLinks RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListAnalyticsAccountLinksRequest.Builder Request message for ListAnalyticsAccountLinks RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListAnalyticsAccountLinksResponse Response message for ListAnalyticsAccountLinks RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListAnalyticsAccountLinksResponse.Builder Response message for ListAnalyticsAccountLinks RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListOrganizationsRequest Request message for ListOrganizations RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListOrganizationsRequest.Builder Request message for ListOrganizations RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListOrganizationsResponse Response message for ListOrganizations RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListOrganizationsResponse.Builder Response message for ListOrganizations RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupMembersRequest Request message for ListUserGroupMembers RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupMembersRequest.Builder Request message for ListUserGroupMembers RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupMembersResponse Response message for ListUserGroupMembers RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupMembersResponse.Builder Response message for ListUserGroupMembers RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupsRequest Request message for ListUserGroups RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupsRequest.Builder Request message for ListUserGroups RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupsResponse Response message for ListUserGroups RPC.
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupsResponse.Builder Response message for ListUserGroups RPC.
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminProto
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListAdminAccessBindingsFixedSizeCollection
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListAdminAccessBindingsPage
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListAdminAccessBindingsPagedResponse
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListAnalyticsAccountLinksFixedSizeCollection
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListAnalyticsAccountLinksPage
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListAnalyticsAccountLinksPagedResponse
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListOrganizationsFixedSizeCollection
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListOrganizationsPage
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListOrganizationsPagedResponse
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListUserGroupMembersFixedSizeCollection
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListUserGroupMembersPage
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListUserGroupMembersPagedResponse
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListUserGroupsFixedSizeCollection
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListUserGroupsPage
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient.ListUserGroupsPagedResponse
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceGrpc Service Interface for the Google Marketing Platform Admin API.
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceGrpc.MarketingplatformAdminServiceImplBase Base class for the server implementation of the service MarketingplatformAdminService. Service Interface for the Google Marketing Platform Admin API.
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceSettings.Builder Builder for MarketingplatformAdminServiceSettings.
com.google.ads.marketingplatform.admin.v1alpha.Organization A resource message representing a Google Marketing Platform organization.
com.google.ads.marketingplatform.admin.v1alpha.Organization.Builder A resource message representing a Google Marketing Platform organization.
com.google.ads.marketingplatform.admin.v1alpha.OrganizationName
com.google.ads.marketingplatform.admin.v1alpha.OrganizationName.Builder Builder for organizations/{organization}.
com.google.ads.marketingplatform.admin.v1alpha.PropertyName
com.google.ads.marketingplatform.admin.v1alpha.PropertyName.Builder Builder for properties/{property}.
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageRequest Request message for ReportPropertyUsage RPC.
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageRequest.Builder Request message for ReportPropertyUsage RPC.
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse Response message for ReportPropertyUsage RPC.
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse.BillInfo Contains the bill amount.
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse.BillInfo.Builder Contains the bill amount.
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse.Builder Response message for ReportPropertyUsage RPC.
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse.PropertyUsage Contains the count of events received by the property, along with metadata that influences the volume of billable events.
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse.PropertyUsage.Builder Contains the count of events received by the property, along with metadata that influences the volume of billable events.
com.google.ads.marketingplatform.admin.v1alpha.ResourcesProto
com.google.ads.marketingplatform.admin.v1alpha.SetPropertyServiceLevelRequest Request message for SetPropertyServiceLevel RPC.
com.google.ads.marketingplatform.admin.v1alpha.SetPropertyServiceLevelRequest.Builder Request message for SetPropertyServiceLevel RPC.
com.google.ads.marketingplatform.admin.v1alpha.SetPropertyServiceLevelResponse Response message for SetPropertyServiceLevel RPC.
com.google.ads.marketingplatform.admin.v1alpha.SetPropertyServiceLevelResponse.Builder Response message for SetPropertyServiceLevel RPC.
com.google.ads.marketingplatform.admin.v1alpha.UpdateAdminAccessBindingRequest Request message for UpdateAdminAccessBinding RPC.
com.google.ads.marketingplatform.admin.v1alpha.UpdateAdminAccessBindingRequest.Builder Request message for UpdateAdminAccessBinding RPC.
com.google.ads.marketingplatform.admin.v1alpha.UpdateUserGroupMemberRequest Request message for UpdateUserGroupMember RPC.
com.google.ads.marketingplatform.admin.v1alpha.UpdateUserGroupMemberRequest.Builder Request message for UpdateUserGroupMember RPC.
com.google.ads.marketingplatform.admin.v1alpha.UpdateUserGroupRequest Request message for UpdateUserGroup RPC.
com.google.ads.marketingplatform.admin.v1alpha.UpdateUserGroupRequest.Builder Request message for UpdateUserGroup RPC.
com.google.ads.marketingplatform.admin.v1alpha.UserGroup A resource message representing a user group in a GMP organization.
com.google.ads.marketingplatform.admin.v1alpha.UserGroup.Builder A resource message representing a user group in a GMP organization.
com.google.ads.marketingplatform.admin.v1alpha.UserGroupMember A resource message representing a member of a user group.
com.google.ads.marketingplatform.admin.v1alpha.UserGroupMember.Builder A resource message representing a member of a user group.
com.google.ads.marketingplatform.admin.v1alpha.UserGroupMemberName
com.google.ads.marketingplatform.admin.v1alpha.UserGroupMemberName.Builder Builder for organizations/{organization}/userGroups/{user_group}/members/{member}.
com.google.ads.marketingplatform.admin.v1alpha.UserGroupName
com.google.ads.marketingplatform.admin.v1alpha.UserGroupName.Builder Builder for organizations/{organization}/userGroups/{user_group}.

Interfaces

Interface Description
com.google.ads.marketingplatform.admin.v1alpha.AdminAccessBindingOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.AnalyticsAccountLinkOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.CreateAdminAccessBindingRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.CreateAnalyticsAccountLinkRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.CreateUserGroupMemberRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.CreateUserGroupRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.DeleteAnalyticsAccountLinkRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.DeleteUserGroupMemberRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.DeleteUserGroupRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsResponse.ClientDataOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsResponseOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.GetAdminAccessBindingRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.GetOrganizationRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.GetUserGroupMemberRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.GetUserGroupRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListAdminAccessBindingsRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListAdminAccessBindingsResponseOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListAnalyticsAccountLinksRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListAnalyticsAccountLinksResponseOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListOrganizationsRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListOrganizationsResponseOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupMembersRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupMembersResponseOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupsRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ListUserGroupsResponseOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceGrpc.AsyncService Service Interface for the Google Marketing Platform Admin API.
com.google.ads.marketingplatform.admin.v1alpha.OrganizationOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse.BillInfoOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse.PropertyUsageOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.ReportPropertyUsageResponseOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.SetPropertyServiceLevelRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.SetPropertyServiceLevelResponseOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.UpdateAdminAccessBindingRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.UpdateUserGroupMemberRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.UpdateUserGroupRequestOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.UserGroupMemberOrBuilder
com.google.ads.marketingplatform.admin.v1alpha.UserGroupOrBuilder

Enums

Enum Description
com.google.ads.marketingplatform.admin.v1alpha.AdminAccessBinding.AccessTargetCase
com.google.ads.marketingplatform.admin.v1alpha.AnalyticsPropertyType Types of the Google Analytics Property.
com.google.ads.marketingplatform.admin.v1alpha.AnalyticsServiceLevel Various levels of service for Google Analytics.
com.google.ads.marketingplatform.admin.v1alpha.LinkVerificationState The verification state of the link between a product account and a GMP organization.
com.google.ads.marketingplatform.admin.v1alpha.OrganizationRole Roles that can be assigned to a user or user group in a GMP organization.
com.google.ads.marketingplatform.admin.v1alpha.UserGroupMember.MemberCase
com.google.ads.marketingplatform.admin.v1alpha.UserGroupMember.MembershipRole The role of the member in the user group.