Class MarketingplatformAdminServiceClientImpl

MarketingplatformAdminService client wrapper implementation, for convenient use.

Inheritance
object
MarketingplatformAdminServiceClient
MarketingplatformAdminServiceClientImpl
Inherited Members
Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha
Assembly: Google.Ads.MarketingPlatform.Admin.V1Alpha.dll
public sealed class MarketingplatformAdminServiceClientImpl : MarketingplatformAdminServiceClient

Service Interface for the Google Marketing Platform Admin API.

Constructors

Constructs a client wrapper for the MarketingplatformAdminService service, with the specified gRPC client and settings.

Declaration
public MarketingplatformAdminServiceClientImpl(MarketingplatformAdminService.MarketingplatformAdminServiceClient grpcClient, MarketingplatformAdminServiceSettings settings, ILogger logger)
Parameters
Type Name Description
MarketingplatformAdminService.MarketingplatformAdminServiceClient grpcClient

The underlying gRPC client.
MarketingplatformAdminServiceSettings settings

The base MarketingplatformAdminServiceSettings used within this client.
ILogger logger

Optional ILogger to use within this client.

Properties

The underlying gRPC MarketingplatformAdminService client

Declaration
public override MarketingplatformAdminService.MarketingplatformAdminServiceClient GrpcClient { get; }
Property Value
Type Description
MarketingplatformAdminService.MarketingplatformAdminServiceClient
Overrides

Methods

Creates an admin access binding in the specified GMP organization.

Declaration
public override AdminAccessBinding CreateAdminAccessBinding(CreateAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateAdminAccessBindingRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AdminAccessBinding

The RPC response.
Overrides

Creates an admin access binding in the specified GMP organization.

Declaration
public override Task<AdminAccessBinding> CreateAdminAccessBindingAsync(CreateAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateAdminAccessBindingRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<AdminAccessBinding>

A Task containing the RPC response.
Overrides

Creates the link between the Analytics account and the Google Marketing Platform organization.

User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again.

Declaration
public override AnalyticsAccountLink CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateAnalyticsAccountLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AnalyticsAccountLink

The RPC response.
Overrides

Creates the link between the Analytics account and the Google Marketing Platform organization.

User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again.

Declaration
public override Task<AnalyticsAccountLink> CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateAnalyticsAccountLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<AnalyticsAccountLink>

A Task containing the RPC response.
Overrides

Creates a user group in the specified GMP organization.

Declaration
public override UserGroup CreateUserGroup(CreateUserGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateUserGroupRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
UserGroup

The RPC response.
Overrides

Creates a user group in the specified GMP organization.

Declaration
public override Task<UserGroup> CreateUserGroupAsync(CreateUserGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateUserGroupRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<UserGroup>

A Task containing the RPC response.
Overrides

Adds a member to the specified GMP user group.

Declaration
public override UserGroupMember CreateUserGroupMember(CreateUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateUserGroupMemberRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
UserGroupMember

The RPC response.
Overrides

Adds a member to the specified GMP user group.

Declaration
public override Task<UserGroupMember> CreateUserGroupMemberAsync(CreateUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateUserGroupMemberRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<UserGroupMember>

A Task containing the RPC response.
Overrides

Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization.

User needs to be an org user, and admin on the Analytics account in order to delete the link.

Declaration
public override void DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteAnalyticsAccountLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization.

User needs to be an org user, and admin on the Analytics account in order to delete the link.

Declaration
public override Task DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteAnalyticsAccountLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

Deletes a user group in the specified GMP organization.

Declaration
public override void DeleteUserGroup(DeleteUserGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteUserGroupRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

Deletes a user group in the specified GMP organization.

Declaration
public override Task DeleteUserGroupAsync(DeleteUserGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteUserGroupRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

Deletes a member in the specified GMP user group.

Declaration
public override void DeleteUserGroupMember(DeleteUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteUserGroupMemberRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

Deletes a member in the specified GMP user group.

Declaration
public override Task DeleteUserGroupMemberAsync(DeleteUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteUserGroupMemberRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

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.

Declaration
public override FindSalesPartnerManagedClientsResponse FindSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
FindSalesPartnerManagedClientsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FindSalesPartnerManagedClientsResponse

The RPC response.
Overrides

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.

Declaration
public override Task<FindSalesPartnerManagedClientsResponse> FindSalesPartnerManagedClientsAsync(FindSalesPartnerManagedClientsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
FindSalesPartnerManagedClientsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<FindSalesPartnerManagedClientsResponse>

A Task containing the RPC response.
Overrides

Looks up a single admin access binding.

Declaration
public override AdminAccessBinding GetAdminAccessBinding(GetAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAdminAccessBindingRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AdminAccessBinding

The RPC response.
Overrides

Looks up a single admin access binding.

Declaration
public override Task<AdminAccessBinding> GetAdminAccessBindingAsync(GetAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAdminAccessBindingRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<AdminAccessBinding>

A Task containing the RPC response.
Overrides

Looks up a single organization.

Declaration
public override Organization GetOrganization(GetOrganizationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetOrganizationRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Organization

The RPC response.
Overrides

Looks up a single organization.

Declaration
public override Task<Organization> GetOrganizationAsync(GetOrganizationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetOrganizationRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Organization>

A Task containing the RPC response.
Overrides

Looks up a single user group.

Declaration
public override UserGroup GetUserGroup(GetUserGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetUserGroupRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
UserGroup

The RPC response.
Overrides

Looks up a single user group.

Declaration
public override Task<UserGroup> GetUserGroupAsync(GetUserGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetUserGroupRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<UserGroup>

A Task containing the RPC response.
Overrides

Looks up a single user group member.

Declaration
public override UserGroupMember GetUserGroupMember(GetUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetUserGroupMemberRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
UserGroupMember

The RPC response.
Overrides

Looks up a single user group member.

Declaration
public override Task<UserGroupMember> GetUserGroupMemberAsync(GetUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetUserGroupMemberRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<UserGroupMember>

A Task containing the RPC response.
Overrides

Returns a list of admin access bindings in the specified GMP organization.

Declaration
public override PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> ListAdminAccessBindings(ListAdminAccessBindingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAdminAccessBindingsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding>

A pageable sequence of AdminAccessBinding resources.
Overrides

Returns a list of admin access bindings in the specified GMP organization.

Declaration
public override PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> ListAdminAccessBindingsAsync(ListAdminAccessBindingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAdminAccessBindingsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding>

A pageable asynchronous sequence of AdminAccessBinding resources.
Overrides

Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.

Declaration
public override PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAnalyticsAccountLinksRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink>

A pageable sequence of AnalyticsAccountLink resources.
Overrides

Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.

Declaration
public override PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> ListAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAnalyticsAccountLinksRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink>

A pageable asynchronous sequence of AnalyticsAccountLink resources.
Overrides

Returns a list of organizations that the user has access to.

Declaration
public override PagedEnumerable<ListOrganizationsResponse, Organization> ListOrganizations(ListOrganizationsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListOrganizationsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListOrganizationsResponse, Organization>

A pageable sequence of Organization resources.
Overrides

Returns a list of organizations that the user has access to.

Declaration
public override PagedAsyncEnumerable<ListOrganizationsResponse, Organization> ListOrganizationsAsync(ListOrganizationsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListOrganizationsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListOrganizationsResponse, Organization>

A pageable asynchronous sequence of Organization resources.
Overrides

Returns a list of members in the specified user group.

Declaration
public override PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> ListUserGroupMembers(ListUserGroupMembersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserGroupMembersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember>

A pageable sequence of UserGroupMember resources.
Overrides

Returns a list of members in the specified user group.

Declaration
public override PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> ListUserGroupMembersAsync(ListUserGroupMembersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserGroupMembersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember>

A pageable asynchronous sequence of UserGroupMember resources.
Overrides

Returns a list of user groups in the specified GMP organization.

Declaration
public override PagedEnumerable<ListUserGroupsResponse, UserGroup> ListUserGroups(ListUserGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserGroupsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListUserGroupsResponse, UserGroup>

A pageable sequence of UserGroup resources.
Overrides

Returns a list of user groups in the specified GMP organization.

Declaration
public override PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> ListUserGroupsAsync(ListUserGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserGroupsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup>

A pageable asynchronous sequence of UserGroup resources.
Overrides

Gets 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.

Declaration
public override ReportPropertyUsageResponse ReportPropertyUsage(ReportPropertyUsageRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ReportPropertyUsageRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ReportPropertyUsageResponse

The RPC response.
Overrides

Gets 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.

Declaration
public override Task<ReportPropertyUsageResponse> ReportPropertyUsageAsync(ReportPropertyUsageRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ReportPropertyUsageRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<ReportPropertyUsageResponse>

A Task containing the RPC response.
Overrides

Updates the service level for an Analytics property.

Declaration
public override SetPropertyServiceLevelResponse SetPropertyServiceLevel(SetPropertyServiceLevelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
SetPropertyServiceLevelRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SetPropertyServiceLevelResponse

The RPC response.
Overrides

Updates the service level for an Analytics property.

Declaration
public override Task<SetPropertyServiceLevelResponse> SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
SetPropertyServiceLevelRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<SetPropertyServiceLevelResponse>

A Task containing the RPC response.
Overrides

Updates an admin access binding in the specified GMP organization.

Declaration
public override AdminAccessBinding UpdateAdminAccessBinding(UpdateAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateAdminAccessBindingRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AdminAccessBinding

The RPC response.
Overrides

Updates an admin access binding in the specified GMP organization.

Declaration
public override Task<AdminAccessBinding> UpdateAdminAccessBindingAsync(UpdateAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateAdminAccessBindingRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<AdminAccessBinding>

A Task containing the RPC response.
Overrides

Updates a user group in the specified GMP organization.

Declaration
public override UserGroup UpdateUserGroup(UpdateUserGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateUserGroupRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
UserGroup

The RPC response.
Overrides

Updates a user group in the specified GMP organization.

Declaration
public override Task<UserGroup> UpdateUserGroupAsync(UpdateUserGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateUserGroupRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<UserGroup>

A Task containing the RPC response.
Overrides

Updates a member in the specified GMP user group.

Declaration
public override UserGroupMember UpdateUserGroupMember(UpdateUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateUserGroupMemberRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
UserGroupMember

The RPC response.
Overrides

Updates a member in the specified GMP user group.

Declaration
public override Task<UserGroupMember> UpdateUserGroupMemberAsync(UpdateUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateUserGroupMemberRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<UserGroupMember>

A Task containing the RPC response.
Overrides