Class MarketingplatformAdminService.MarketingplatformAdminServiceClient

Client for MarketingplatformAdminService

Inheritance

object

ClientBase

ClientBase<MarketingplatformAdminService.MarketingplatformAdminServiceClient>

MarketingplatformAdminService.MarketingplatformAdminServiceClient

Inherited Members

ClientBase<MarketingplatformAdminService.MarketingplatformAdminServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha

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

Syntax

public class MarketingplatformAdminService.MarketingplatformAdminServiceClient : ClientBase<MarketingplatformAdminService.MarketingplatformAdminServiceClient>

Constructors

MarketingplatformAdminServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected MarketingplatformAdminServiceClient()

MarketingplatformAdminServiceClient(CallInvoker)

Creates a new client for MarketingplatformAdminService that uses a custom CallInvoker.

Declaration

public MarketingplatformAdminServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

MarketingplatformAdminServiceClient(ChannelBase)

Creates a new client for MarketingplatformAdminService

Declaration

public MarketingplatformAdminServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

MarketingplatformAdminServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected MarketingplatformAdminServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest, CallOptions)

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 AnalyticsAccountLink CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateAnalyticsAccountLinkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AnalyticsAccountLink	The response received from the server.

CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest, Metadata, DateTime?, CancellationToken)

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 AnalyticsAccountLink CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateAnalyticsAccountLinkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AnalyticsAccountLink	The response received from the server.

CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest, CallOptions)

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 AsyncUnaryCall<AnalyticsAccountLink> CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateAnalyticsAccountLinkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<AnalyticsAccountLink>	The call object.

CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest, Metadata, DateTime?, CancellationToken)

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 AsyncUnaryCall<AnalyticsAccountLink> CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateAnalyticsAccountLinkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<AnalyticsAccountLink>	The call object.

DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest, CallOptions)

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 Empty DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteAnalyticsAccountLinkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Empty	The response received from the server.

DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest, Metadata, DateTime?, CancellationToken)

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 Empty DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteAnalyticsAccountLinkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Empty	The response received from the server.

DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest, CallOptions)

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 AsyncUnaryCall<Empty> DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteAnalyticsAccountLinkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest, Metadata, DateTime?, CancellationToken)

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 AsyncUnaryCall<Empty> DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteAnalyticsAccountLinkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

GetOrganization(GetOrganizationRequest, CallOptions)

Lookup for a single organization.

Declaration

public virtual Organization GetOrganization(GetOrganizationRequest request, CallOptions options)

Parameters

Type	Name	Description
GetOrganizationRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Organization	The response received from the server.

GetOrganization(GetOrganizationRequest, Metadata, DateTime?, CancellationToken)

Lookup for a single organization.

Declaration

public virtual Organization GetOrganization(GetOrganizationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetOrganizationRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Organization	The response received from the server.

GetOrganizationAsync(GetOrganizationRequest, CallOptions)

Lookup for a single organization.

Declaration

public virtual AsyncUnaryCall<Organization> GetOrganizationAsync(GetOrganizationRequest request, CallOptions options)

Parameters

Type	Name	Description
GetOrganizationRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Organization>	The call object.

GetOrganizationAsync(GetOrganizationRequest, Metadata, DateTime?, CancellationToken)

Lookup for a single organization.

Declaration

public virtual AsyncUnaryCall<Organization> GetOrganizationAsync(GetOrganizationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetOrganizationRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Organization>	The call object.

ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest, CallOptions)

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

Declaration

public virtual ListAnalyticsAccountLinksResponse ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest request, CallOptions options)

Parameters

Type	Name	Description
ListAnalyticsAccountLinksRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListAnalyticsAccountLinksResponse	The response received from the server.

ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual ListAnalyticsAccountLinksResponse ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAnalyticsAccountLinksRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
ListAnalyticsAccountLinksResponse	The response received from the server.

ListAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest, CallOptions)

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

Declaration

public virtual AsyncUnaryCall<ListAnalyticsAccountLinksResponse> ListAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest request, CallOptions options)

Parameters

Type	Name	Description
ListAnalyticsAccountLinksRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListAnalyticsAccountLinksResponse>	The call object.

ListAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<ListAnalyticsAccountLinksResponse> ListAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAnalyticsAccountLinksRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<ListAnalyticsAccountLinksResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override MarketingplatformAdminService.MarketingplatformAdminServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
MarketingplatformAdminService.MarketingplatformAdminServiceClient

Overrides

Grpc.Core.ClientBase<Google.Ads.MarketingPlatform.Admin.V1Alpha.MarketingplatformAdminService.MarketingplatformAdminServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetPropertyServiceLevel(SetPropertyServiceLevelRequest, CallOptions)

Updates the service level for an Analytics property.

Declaration

public virtual SetPropertyServiceLevelResponse SetPropertyServiceLevel(SetPropertyServiceLevelRequest request, CallOptions options)

Parameters

Type	Name	Description
SetPropertyServiceLevelRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
SetPropertyServiceLevelResponse	The response received from the server.

SetPropertyServiceLevel(SetPropertyServiceLevelRequest, Metadata, DateTime?, CancellationToken)

Updates the service level for an Analytics property.

Declaration

public virtual SetPropertyServiceLevelResponse SetPropertyServiceLevel(SetPropertyServiceLevelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SetPropertyServiceLevelRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
SetPropertyServiceLevelResponse	The response received from the server.

SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest, CallOptions)

Updates the service level for an Analytics property.

Declaration

public virtual AsyncUnaryCall<SetPropertyServiceLevelResponse> SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest request, CallOptions options)

Parameters

Type	Name	Description
SetPropertyServiceLevelRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<SetPropertyServiceLevelResponse>	The call object.

SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest, Metadata, DateTime?, CancellationToken)

Updates the service level for an Analytics property.

Declaration

public virtual AsyncUnaryCall<SetPropertyServiceLevelResponse> SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SetPropertyServiceLevelRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<SetPropertyServiceLevelResponse>	The call object.