Class MarketingplatformAdminService.MarketingplatformAdminServiceBase

Base class for server-side implementations of MarketingplatformAdminService

Inheritance

object

MarketingplatformAdminService.MarketingplatformAdminServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha

Assembly: Google.Ads.MarketingPlatform.Admin.V1Alpha.dll

Syntax

[BindServiceMethod(typeof(MarketingplatformAdminService), "BindService")]
public abstract class MarketingplatformAdminService.MarketingplatformAdminServiceBase

Methods

CreateAdminAccessBinding(CreateAdminAccessBindingRequest, ServerCallContext)

Creates an admin access binding in the specified GMP organization.

Declaration

public virtual Task<AdminAccessBinding> CreateAdminAccessBinding(CreateAdminAccessBindingRequest request, ServerCallContext context)

Parameters

Type	Name	Description
CreateAdminAccessBindingRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<AdminAccessBinding>	The response to send back to the client (wrapped by a task).

CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest, ServerCallContext)

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 virtual Task<AnalyticsAccountLink> CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest request, ServerCallContext context)

Parameters

Type	Name	Description
CreateAnalyticsAccountLinkRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<AnalyticsAccountLink>	The response to send back to the client (wrapped by a task).

CreateUserGroup(CreateUserGroupRequest, ServerCallContext)

Creates a user group in the specified GMP organization.

Declaration

public virtual Task<UserGroup> CreateUserGroup(CreateUserGroupRequest request, ServerCallContext context)

Parameters

Type	Name	Description
CreateUserGroupRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<UserGroup>	The response to send back to the client (wrapped by a task).

CreateUserGroupMember(CreateUserGroupMemberRequest, ServerCallContext)

Adds a member to the specified GMP user group.

Declaration

public virtual Task<UserGroupMember> CreateUserGroupMember(CreateUserGroupMemberRequest request, ServerCallContext context)

Parameters

Type	Name	Description
CreateUserGroupMemberRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<UserGroupMember>	The response to send back to the client (wrapped by a task).

DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest, ServerCallContext)

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 virtual Task<Empty> DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest request, ServerCallContext context)

Parameters

Type	Name	Description
DeleteAnalyticsAccountLinkRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

DeleteUserGroup(DeleteUserGroupRequest, ServerCallContext)

Deletes a user group in the specified GMP organization.

Declaration

public virtual Task<Empty> DeleteUserGroup(DeleteUserGroupRequest request, ServerCallContext context)

Parameters

Type	Name	Description
DeleteUserGroupRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

DeleteUserGroupMember(DeleteUserGroupMemberRequest, ServerCallContext)

Deletes a member in the specified GMP user group.

Declaration

public virtual Task<Empty> DeleteUserGroupMember(DeleteUserGroupMemberRequest request, ServerCallContext context)

Parameters

Type	Name	Description
DeleteUserGroupMemberRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

FindSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest, ServerCallContext)

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 virtual Task<FindSalesPartnerManagedClientsResponse> FindSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
FindSalesPartnerManagedClientsRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<FindSalesPartnerManagedClientsResponse>	The response to send back to the client (wrapped by a task).

GetAdminAccessBinding(GetAdminAccessBindingRequest, ServerCallContext)

Looks up a single admin access binding.

Declaration

public virtual Task<AdminAccessBinding> GetAdminAccessBinding(GetAdminAccessBindingRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetAdminAccessBindingRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<AdminAccessBinding>	The response to send back to the client (wrapped by a task).

GetOrganization(GetOrganizationRequest, ServerCallContext)

Looks up a single organization.

Declaration

public virtual Task<Organization> GetOrganization(GetOrganizationRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetOrganizationRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Organization>	The response to send back to the client (wrapped by a task).

GetUserGroup(GetUserGroupRequest, ServerCallContext)

Looks up a single user group.

Declaration

public virtual Task<UserGroup> GetUserGroup(GetUserGroupRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetUserGroupRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<UserGroup>	The response to send back to the client (wrapped by a task).

GetUserGroupMember(GetUserGroupMemberRequest, ServerCallContext)

Looks up a single user group member.

Declaration

public virtual Task<UserGroupMember> GetUserGroupMember(GetUserGroupMemberRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetUserGroupMemberRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<UserGroupMember>	The response to send back to the client (wrapped by a task).

ListAdminAccessBindings(ListAdminAccessBindingsRequest, ServerCallContext)

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

Declaration

public virtual Task<ListAdminAccessBindingsResponse> ListAdminAccessBindings(ListAdminAccessBindingsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ListAdminAccessBindingsRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListAdminAccessBindingsResponse>	The response to send back to the client (wrapped by a task).

ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest, ServerCallContext)

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

Declaration

public virtual Task<ListAnalyticsAccountLinksResponse> ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ListAnalyticsAccountLinksRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListAnalyticsAccountLinksResponse>	The response to send back to the client (wrapped by a task).

ListOrganizations(ListOrganizationsRequest, ServerCallContext)

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

Declaration

public virtual Task<ListOrganizationsResponse> ListOrganizations(ListOrganizationsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ListOrganizationsRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListOrganizationsResponse>	The response to send back to the client (wrapped by a task).

ListUserGroupMembers(ListUserGroupMembersRequest, ServerCallContext)

Returns a list of members in the specified user group.

Declaration

public virtual Task<ListUserGroupMembersResponse> ListUserGroupMembers(ListUserGroupMembersRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ListUserGroupMembersRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListUserGroupMembersResponse>	The response to send back to the client (wrapped by a task).

ListUserGroups(ListUserGroupsRequest, ServerCallContext)

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

Declaration

public virtual Task<ListUserGroupsResponse> ListUserGroups(ListUserGroupsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ListUserGroupsRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListUserGroupsResponse>	The response to send back to the client (wrapped by a task).

ReportPropertyUsage(ReportPropertyUsageRequest, ServerCallContext)

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 virtual Task<ReportPropertyUsageResponse> ReportPropertyUsage(ReportPropertyUsageRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ReportPropertyUsageRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ReportPropertyUsageResponse>	The response to send back to the client (wrapped by a task).

SetPropertyServiceLevel(SetPropertyServiceLevelRequest, ServerCallContext)

Updates the service level for an Analytics property.

Declaration

public virtual Task<SetPropertyServiceLevelResponse> SetPropertyServiceLevel(SetPropertyServiceLevelRequest request, ServerCallContext context)

Parameters

Type	Name	Description
SetPropertyServiceLevelRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<SetPropertyServiceLevelResponse>	The response to send back to the client (wrapped by a task).

UpdateAdminAccessBinding(UpdateAdminAccessBindingRequest, ServerCallContext)

Updates an admin access binding in the specified GMP organization.

Declaration

public virtual Task<AdminAccessBinding> UpdateAdminAccessBinding(UpdateAdminAccessBindingRequest request, ServerCallContext context)

Parameters

Type	Name	Description
UpdateAdminAccessBindingRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<AdminAccessBinding>	The response to send back to the client (wrapped by a task).

UpdateUserGroup(UpdateUserGroupRequest, ServerCallContext)

Updates a user group in the specified GMP organization.

Declaration

public virtual Task<UserGroup> UpdateUserGroup(UpdateUserGroupRequest request, ServerCallContext context)

Parameters

Type	Name	Description
UpdateUserGroupRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<UserGroup>	The response to send back to the client (wrapped by a task).

UpdateUserGroupMember(UpdateUserGroupMemberRequest, ServerCallContext)

Updates a member in the specified GMP user group.

Declaration

public virtual Task<UserGroupMember> UpdateUserGroupMember(UpdateUserGroupMemberRequest request, ServerCallContext context)

Parameters

Type	Name	Description
UpdateUserGroupMemberRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<UserGroupMember>	The response to send back to the client (wrapped by a task).