Interface MarketingplatformAdminServiceGrpc.AsyncService (0.48.0)

public static interface MarketingplatformAdminServiceGrpc.AsyncService

Service Interface for the Google Marketing Platform Admin API.

Methods

createAdminAccessBinding(CreateAdminAccessBindingRequest request, StreamObserver<AdminAccessBinding> responseObserver)

public default void createAdminAccessBinding(CreateAdminAccessBindingRequest request, StreamObserver<AdminAccessBinding> responseObserver)

Creates an admin access binding in the specified GMP organization.

Parameters
Name Description
request CreateAdminAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<AdminAccessBinding>
public default void createAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest request, StreamObserver<AnalyticsAccountLink> responseObserver)

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.

Parameters
Name Description
request CreateAnalyticsAccountLinkRequest
responseObserver io.grpc.stub.StreamObserver<AnalyticsAccountLink>

createUserGroup(CreateUserGroupRequest request, StreamObserver<UserGroup> responseObserver)

public default void createUserGroup(CreateUserGroupRequest request, StreamObserver<UserGroup> responseObserver)

Creates a user group in the specified GMP organization.

Parameters
Name Description
request CreateUserGroupRequest
responseObserver io.grpc.stub.StreamObserver<UserGroup>

createUserGroupMember(CreateUserGroupMemberRequest request, StreamObserver<UserGroupMember> responseObserver)

public default void createUserGroupMember(CreateUserGroupMemberRequest request, StreamObserver<UserGroupMember> responseObserver)

Adds a member to the specified GMP user group.

Parameters
Name Description
request CreateUserGroupMemberRequest
responseObserver io.grpc.stub.StreamObserver<UserGroupMember>
public default void deleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name Description
request DeleteAnalyticsAccountLinkRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteUserGroup(DeleteUserGroupRequest request, StreamObserver<Empty> responseObserver)

public default void deleteUserGroup(DeleteUserGroupRequest request, StreamObserver<Empty> responseObserver)

Deletes a user group in the specified GMP organization.

Parameters
Name Description
request DeleteUserGroupRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteUserGroupMember(DeleteUserGroupMemberRequest request, StreamObserver<Empty> responseObserver)

public default void deleteUserGroupMember(DeleteUserGroupMemberRequest request, StreamObserver<Empty> responseObserver)

Deletes a member in the specified GMP user group.

Parameters
Name Description
request DeleteUserGroupMemberRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

findSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest request, StreamObserver<FindSalesPartnerManagedClientsResponse> responseObserver)

public default void findSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest request, StreamObserver<FindSalesPartnerManagedClientsResponse> responseObserver)

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.

Parameters
Name Description
request FindSalesPartnerManagedClientsRequest
responseObserver io.grpc.stub.StreamObserver<FindSalesPartnerManagedClientsResponse>

getAdminAccessBinding(GetAdminAccessBindingRequest request, StreamObserver<AdminAccessBinding> responseObserver)

public default void getAdminAccessBinding(GetAdminAccessBindingRequest request, StreamObserver<AdminAccessBinding> responseObserver)

Looks up a single admin access binding.

Parameters
Name Description
request GetAdminAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<AdminAccessBinding>

getOrganization(GetOrganizationRequest request, StreamObserver<Organization> responseObserver)

public default void getOrganization(GetOrganizationRequest request, StreamObserver<Organization> responseObserver)

Looks up a single organization.

Parameters
Name Description
request GetOrganizationRequest
responseObserver io.grpc.stub.StreamObserver<Organization>

getUserGroup(GetUserGroupRequest request, StreamObserver<UserGroup> responseObserver)

public default void getUserGroup(GetUserGroupRequest request, StreamObserver<UserGroup> responseObserver)

Looks up a single user group.

Parameters
Name Description
request GetUserGroupRequest
responseObserver io.grpc.stub.StreamObserver<UserGroup>

getUserGroupMember(GetUserGroupMemberRequest request, StreamObserver<UserGroupMember> responseObserver)

public default void getUserGroupMember(GetUserGroupMemberRequest request, StreamObserver<UserGroupMember> responseObserver)

Looks up a single user group member.

Parameters
Name Description
request GetUserGroupMemberRequest
responseObserver io.grpc.stub.StreamObserver<UserGroupMember>

listAdminAccessBindings(ListAdminAccessBindingsRequest request, StreamObserver<ListAdminAccessBindingsResponse> responseObserver)

public default void listAdminAccessBindings(ListAdminAccessBindingsRequest request, StreamObserver<ListAdminAccessBindingsResponse> responseObserver)

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

Parameters
Name Description
request ListAdminAccessBindingsRequest
responseObserver io.grpc.stub.StreamObserver<ListAdminAccessBindingsResponse>
public default void listAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest request, StreamObserver<ListAnalyticsAccountLinksResponse> responseObserver)

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

Parameters
Name Description
request ListAnalyticsAccountLinksRequest
responseObserver io.grpc.stub.StreamObserver<ListAnalyticsAccountLinksResponse>

listOrganizations(ListOrganizationsRequest request, StreamObserver<ListOrganizationsResponse> responseObserver)

public default void listOrganizations(ListOrganizationsRequest request, StreamObserver<ListOrganizationsResponse> responseObserver)

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

Parameters
Name Description
request ListOrganizationsRequest
responseObserver io.grpc.stub.StreamObserver<ListOrganizationsResponse>

listUserGroupMembers(ListUserGroupMembersRequest request, StreamObserver<ListUserGroupMembersResponse> responseObserver)

public default void listUserGroupMembers(ListUserGroupMembersRequest request, StreamObserver<ListUserGroupMembersResponse> responseObserver)

Returns a list of members in the specified user group.

Parameters
Name Description
request ListUserGroupMembersRequest
responseObserver io.grpc.stub.StreamObserver<ListUserGroupMembersResponse>

listUserGroups(ListUserGroupsRequest request, StreamObserver<ListUserGroupsResponse> responseObserver)

public default void listUserGroups(ListUserGroupsRequest request, StreamObserver<ListUserGroupsResponse> responseObserver)

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

Parameters
Name Description
request ListUserGroupsRequest
responseObserver io.grpc.stub.StreamObserver<ListUserGroupsResponse>

reportPropertyUsage(ReportPropertyUsageRequest request, StreamObserver<ReportPropertyUsageResponse> responseObserver)

public default void reportPropertyUsage(ReportPropertyUsageRequest request, StreamObserver<ReportPropertyUsageResponse> responseObserver)

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.

Parameters
Name Description
request ReportPropertyUsageRequest
responseObserver io.grpc.stub.StreamObserver<ReportPropertyUsageResponse>

setPropertyServiceLevel(SetPropertyServiceLevelRequest request, StreamObserver<SetPropertyServiceLevelResponse> responseObserver)

public default void setPropertyServiceLevel(SetPropertyServiceLevelRequest request, StreamObserver<SetPropertyServiceLevelResponse> responseObserver)

Updates the service level for an Analytics property.

Parameters
Name Description
request SetPropertyServiceLevelRequest
responseObserver io.grpc.stub.StreamObserver<SetPropertyServiceLevelResponse>

updateAdminAccessBinding(UpdateAdminAccessBindingRequest request, StreamObserver<AdminAccessBinding> responseObserver)

public default void updateAdminAccessBinding(UpdateAdminAccessBindingRequest request, StreamObserver<AdminAccessBinding> responseObserver)

Updates an admin access binding in the specified GMP organization.

Parameters
Name Description
request UpdateAdminAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<AdminAccessBinding>

updateUserGroup(UpdateUserGroupRequest request, StreamObserver<UserGroup> responseObserver)

public default void updateUserGroup(UpdateUserGroupRequest request, StreamObserver<UserGroup> responseObserver)

Updates a user group in the specified GMP organization.

Parameters
Name Description
request UpdateUserGroupRequest
responseObserver io.grpc.stub.StreamObserver<UserGroup>

updateUserGroupMember(UpdateUserGroupMemberRequest request, StreamObserver<UserGroupMember> responseObserver)

public default void updateUserGroupMember(UpdateUserGroupMemberRequest request, StreamObserver<UserGroupMember> responseObserver)

Updates a member in the specified GMP user group.

Parameters
Name Description
request UpdateUserGroupMemberRequest
responseObserver io.grpc.stub.StreamObserver<UserGroupMember>