Class MarketingplatformAdminServiceClientImpl

MarketingplatformAdminService client wrapper implementation, for convenient use.

Inheritance

object

MarketingplatformAdminServiceClient

MarketingplatformAdminServiceClientImpl

Inherited Members

MarketingplatformAdminServiceClient.DefaultEndpoint

MarketingplatformAdminServiceClient.DefaultScopes

MarketingplatformAdminServiceClient.ServiceMetadata

MarketingplatformAdminServiceClient.CreateAsync(CancellationToken)

MarketingplatformAdminServiceClient.Create()

MarketingplatformAdminServiceClient.ShutdownDefaultChannelsAsync()

MarketingplatformAdminServiceClient.GetOrganizationAsync(GetOrganizationRequest, CancellationToken)

MarketingplatformAdminServiceClient.GetOrganization(string, CallSettings)

MarketingplatformAdminServiceClient.GetOrganizationAsync(string, CallSettings)

MarketingplatformAdminServiceClient.GetOrganizationAsync(string, CancellationToken)

MarketingplatformAdminServiceClient.GetOrganization(OrganizationName, CallSettings)

MarketingplatformAdminServiceClient.GetOrganizationAsync(OrganizationName, CallSettings)

MarketingplatformAdminServiceClient.GetOrganizationAsync(OrganizationName, CancellationToken)

MarketingplatformAdminServiceClient.FindSalesPartnerManagedClientsAsync(FindSalesPartnerManagedClientsRequest, CancellationToken)

MarketingplatformAdminServiceClient.ListAnalyticsAccountLinks(string, string, int?, CallSettings)

MarketingplatformAdminServiceClient.ListAnalyticsAccountLinksAsync(string, string, int?, CallSettings)

MarketingplatformAdminServiceClient.ListAnalyticsAccountLinks(OrganizationName, string, int?, CallSettings)

MarketingplatformAdminServiceClient.ListAnalyticsAccountLinksAsync(OrganizationName, string, int?, CallSettings)

MarketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest, CancellationToken)

MarketingplatformAdminServiceClient.CreateAnalyticsAccountLink(string, AnalyticsAccountLink, CallSettings)

MarketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(string, AnalyticsAccountLink, CallSettings)

MarketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(string, AnalyticsAccountLink, CancellationToken)

MarketingplatformAdminServiceClient.CreateAnalyticsAccountLink(OrganizationName, AnalyticsAccountLink, CallSettings)

MarketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(OrganizationName, AnalyticsAccountLink, CallSettings)

MarketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(OrganizationName, AnalyticsAccountLink, CancellationToken)

MarketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest, CancellationToken)

MarketingplatformAdminServiceClient.DeleteAnalyticsAccountLink(string, CallSettings)

MarketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(string, CallSettings)

MarketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(string, CancellationToken)

MarketingplatformAdminServiceClient.DeleteAnalyticsAccountLink(AnalyticsAccountLinkName, CallSettings)

MarketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(AnalyticsAccountLinkName, CallSettings)

MarketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(AnalyticsAccountLinkName, CancellationToken)

MarketingplatformAdminServiceClient.SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest, CancellationToken)

MarketingplatformAdminServiceClient.SetPropertyServiceLevel(string, CallSettings)

MarketingplatformAdminServiceClient.SetPropertyServiceLevelAsync(string, CallSettings)

MarketingplatformAdminServiceClient.SetPropertyServiceLevelAsync(string, CancellationToken)

MarketingplatformAdminServiceClient.ReportPropertyUsageAsync(ReportPropertyUsageRequest, CancellationToken)

MarketingplatformAdminServiceClient.ReportPropertyUsage(string, CallSettings)

MarketingplatformAdminServiceClient.ReportPropertyUsageAsync(string, CallSettings)

MarketingplatformAdminServiceClient.ReportPropertyUsageAsync(string, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha

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

Syntax

public sealed class MarketingplatformAdminServiceClientImpl : MarketingplatformAdminServiceClient

Remarks

Service Interface for the Google Marketing Platform Admin API.

Constructors

MarketingplatformAdminServiceClientImpl(MarketingplatformAdminServiceClient, MarketingplatformAdminServiceSettings, ILogger)

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

GrpcClient

The underlying gRPC MarketingplatformAdminService client

Declaration

public override MarketingplatformAdminService.MarketingplatformAdminServiceClient GrpcClient { get; }

Property Value

Type	Description
MarketingplatformAdminService.MarketingplatformAdminServiceClient

Overrides

MarketingplatformAdminServiceClient.GrpcClient

Methods

CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest, CallSettings)

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

MarketingplatformAdminServiceClient.CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest, CallSettings)

CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest, CallSettings)

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

MarketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest, CallSettings)

DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest, CallSettings)

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

MarketingplatformAdminServiceClient.DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest, CallSettings)

DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest, CallSettings)

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

MarketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest, CallSettings)

FindSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest, CallSettings)

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

MarketingplatformAdminServiceClient.FindSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest, CallSettings)

FindSalesPartnerManagedClientsAsync(FindSalesPartnerManagedClientsRequest, CallSettings)

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

MarketingplatformAdminServiceClient.FindSalesPartnerManagedClientsAsync(FindSalesPartnerManagedClientsRequest, CallSettings)

GetOrganization(GetOrganizationRequest, CallSettings)

Lookup for 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

MarketingplatformAdminServiceClient.GetOrganization(GetOrganizationRequest, CallSettings)

GetOrganizationAsync(GetOrganizationRequest, CallSettings)

Lookup for 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

MarketingplatformAdminServiceClient.GetOrganizationAsync(GetOrganizationRequest, CallSettings)

ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest, CallSettings)

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

MarketingplatformAdminServiceClient.ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest, CallSettings)

ListAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest, CallSettings)

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

MarketingplatformAdminServiceClient.ListAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest, CallSettings)

ListOrganizations(ListOrganizationsRequest, CallSettings)

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

MarketingplatformAdminServiceClient.ListOrganizations(ListOrganizationsRequest, CallSettings)

ListOrganizationsAsync(ListOrganizationsRequest, CallSettings)

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

MarketingplatformAdminServiceClient.ListOrganizationsAsync(ListOrganizationsRequest, CallSettings)

ReportPropertyUsage(ReportPropertyUsageRequest, CallSettings)

Get 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

MarketingplatformAdminServiceClient.ReportPropertyUsage(ReportPropertyUsageRequest, CallSettings)

ReportPropertyUsageAsync(ReportPropertyUsageRequest, CallSettings)

Get 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

MarketingplatformAdminServiceClient.ReportPropertyUsageAsync(ReportPropertyUsageRequest, CallSettings)

SetPropertyServiceLevel(SetPropertyServiceLevelRequest, CallSettings)

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

MarketingplatformAdminServiceClient.SetPropertyServiceLevel(SetPropertyServiceLevelRequest, CallSettings)

SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest, CallSettings)

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

MarketingplatformAdminServiceClient.SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest, CallSettings)