Class MarketingplatformAdminServiceGrpc.MarketingplatformAdminServiceBlockingV2Stub (0.48.0)

public static final class MarketingplatformAdminServiceGrpc.MarketingplatformAdminServiceBlockingV2Stub extends AbstractBlockingStub<MarketingplatformAdminServiceGrpc.MarketingplatformAdminServiceBlockingV2Stub>

A stub to allow clients to do synchronous rpc calls to service MarketingplatformAdminService.

Service Interface for the Google Marketing Platform Admin API.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > MarketingplatformAdminServiceGrpc.MarketingplatformAdminServiceBlockingV2Stub

Methods

build(Channel channel, CallOptions callOptions)

protected MarketingplatformAdminServiceGrpc.MarketingplatformAdminServiceBlockingV2Stub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
MarketingplatformAdminServiceGrpc.MarketingplatformAdminServiceBlockingV2Stub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAdminAccessBinding(CreateAdminAccessBindingRequest request)

public AdminAccessBinding createAdminAccessBinding(CreateAdminAccessBindingRequest request)

Creates an admin access binding in the specified GMP organization.

Parameter
Name Description
request CreateAdminAccessBindingRequest
Returns
Type Description
AdminAccessBinding
Exceptions
Type Description
io.grpc.StatusException
public AnalyticsAccountLink createAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest request)

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.

Parameter
Name Description
request CreateAnalyticsAccountLinkRequest
Returns
Type Description
AnalyticsAccountLink
Exceptions
Type Description
io.grpc.StatusException

createUserGroup(CreateUserGroupRequest request)

public UserGroup createUserGroup(CreateUserGroupRequest request)

Creates a user group in the specified GMP organization.

Parameter
Name Description
request CreateUserGroupRequest
Returns
Type Description
UserGroup
Exceptions
Type Description
io.grpc.StatusException

createUserGroupMember(CreateUserGroupMemberRequest request)

public UserGroupMember createUserGroupMember(CreateUserGroupMemberRequest request)

Adds a member to the specified GMP user group.

Parameter
Name Description
request CreateUserGroupMemberRequest
Returns
Type Description
UserGroupMember
Exceptions
Type Description
io.grpc.StatusException
public Empty deleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest request)

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.

Parameter
Name Description
request DeleteAnalyticsAccountLinkRequest
Returns
Type Description
Empty
Exceptions
Type Description
io.grpc.StatusException

deleteUserGroup(DeleteUserGroupRequest request)

public Empty deleteUserGroup(DeleteUserGroupRequest request)

Deletes a user group in the specified GMP organization.

Parameter
Name Description
request DeleteUserGroupRequest
Returns
Type Description
Empty
Exceptions
Type Description
io.grpc.StatusException

deleteUserGroupMember(DeleteUserGroupMemberRequest request)

public Empty deleteUserGroupMember(DeleteUserGroupMemberRequest request)

Deletes a member in the specified GMP user group.

Parameter
Name Description
request DeleteUserGroupMemberRequest
Returns
Type Description
Empty
Exceptions
Type Description
io.grpc.StatusException

findSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest request)

public FindSalesPartnerManagedClientsResponse findSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest request)

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.

Parameter
Name Description
request FindSalesPartnerManagedClientsRequest
Returns
Type Description
FindSalesPartnerManagedClientsResponse
Exceptions
Type Description
io.grpc.StatusException

getAdminAccessBinding(GetAdminAccessBindingRequest request)

public AdminAccessBinding getAdminAccessBinding(GetAdminAccessBindingRequest request)

Looks up a single admin access binding.

Parameter
Name Description
request GetAdminAccessBindingRequest
Returns
Type Description
AdminAccessBinding
Exceptions
Type Description
io.grpc.StatusException

getOrganization(GetOrganizationRequest request)

public Organization getOrganization(GetOrganizationRequest request)

Looks up a single organization.

Parameter
Name Description
request GetOrganizationRequest
Returns
Type Description
Organization
Exceptions
Type Description
io.grpc.StatusException

getUserGroup(GetUserGroupRequest request)

public UserGroup getUserGroup(GetUserGroupRequest request)

Looks up a single user group.

Parameter
Name Description
request GetUserGroupRequest
Returns
Type Description
UserGroup
Exceptions
Type Description
io.grpc.StatusException

getUserGroupMember(GetUserGroupMemberRequest request)

public UserGroupMember getUserGroupMember(GetUserGroupMemberRequest request)

Looks up a single user group member.

Parameter
Name Description
request GetUserGroupMemberRequest
Returns
Type Description
UserGroupMember
Exceptions
Type Description
io.grpc.StatusException

listAdminAccessBindings(ListAdminAccessBindingsRequest request)

public ListAdminAccessBindingsResponse listAdminAccessBindings(ListAdminAccessBindingsRequest request)

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

Parameter
Name Description
request ListAdminAccessBindingsRequest
Returns
Type Description
ListAdminAccessBindingsResponse
Exceptions
Type Description
io.grpc.StatusException
public ListAnalyticsAccountLinksResponse listAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest request)

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

Parameter
Name Description
request ListAnalyticsAccountLinksRequest
Returns
Type Description
ListAnalyticsAccountLinksResponse
Exceptions
Type Description
io.grpc.StatusException

listOrganizations(ListOrganizationsRequest request)

public ListOrganizationsResponse listOrganizations(ListOrganizationsRequest request)

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

Parameter
Name Description
request ListOrganizationsRequest
Returns
Type Description
ListOrganizationsResponse
Exceptions
Type Description
io.grpc.StatusException

listUserGroupMembers(ListUserGroupMembersRequest request)

public ListUserGroupMembersResponse listUserGroupMembers(ListUserGroupMembersRequest request)

Returns a list of members in the specified user group.

Parameter
Name Description
request ListUserGroupMembersRequest
Returns
Type Description
ListUserGroupMembersResponse
Exceptions
Type Description
io.grpc.StatusException

listUserGroups(ListUserGroupsRequest request)

public ListUserGroupsResponse listUserGroups(ListUserGroupsRequest request)

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

Parameter
Name Description
request ListUserGroupsRequest
Returns
Type Description
ListUserGroupsResponse
Exceptions
Type Description
io.grpc.StatusException

reportPropertyUsage(ReportPropertyUsageRequest request)

public ReportPropertyUsageResponse reportPropertyUsage(ReportPropertyUsageRequest request)

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.

Parameter
Name Description
request ReportPropertyUsageRequest
Returns
Type Description
ReportPropertyUsageResponse
Exceptions
Type Description
io.grpc.StatusException

setPropertyServiceLevel(SetPropertyServiceLevelRequest request)

public SetPropertyServiceLevelResponse setPropertyServiceLevel(SetPropertyServiceLevelRequest request)

Updates the service level for an Analytics property.

Parameter
Name Description
request SetPropertyServiceLevelRequest
Returns
Type Description
SetPropertyServiceLevelResponse
Exceptions
Type Description
io.grpc.StatusException

updateAdminAccessBinding(UpdateAdminAccessBindingRequest request)

public AdminAccessBinding updateAdminAccessBinding(UpdateAdminAccessBindingRequest request)

Updates an admin access binding in the specified GMP organization.

Parameter
Name Description
request UpdateAdminAccessBindingRequest
Returns
Type Description
AdminAccessBinding
Exceptions
Type Description
io.grpc.StatusException

updateUserGroup(UpdateUserGroupRequest request)

public UserGroup updateUserGroup(UpdateUserGroupRequest request)

Updates a user group in the specified GMP organization.

Parameter
Name Description
request UpdateUserGroupRequest
Returns
Type Description
UserGroup
Exceptions
Type Description
io.grpc.StatusException

updateUserGroupMember(UpdateUserGroupMemberRequest request)

public UserGroupMember updateUserGroupMember(UpdateUserGroupMemberRequest request)

Updates a member in the specified GMP user group.

Parameter
Name Description
request UpdateUserGroupMemberRequest
Returns
Type Description
UserGroupMember
Exceptions
Type Description
io.grpc.StatusException