Class protos.google.marketingplatform.admin.v1alpha.MarketingplatformAdminService (0.4.0)

Represents a MarketingplatformAdminService

Inheritance

$protobuf.rpc.Service > protos.google.marketingplatform.admin.v1alpha.MarketingplatformAdminService

Package

@google-ads/marketing-platform-admin

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new MarketingplatformAdminService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): MarketingplatformAdminService;

Creates new MarketingplatformAdminService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
Type Description
MarketingplatformAdminService

RPC service. Useful where requests and/or responses are streamed.

public createAnalyticsAccountLink(request: google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest, callback: google.marketingplatform.admin.v1alpha.MarketingplatformAdminService.CreateAnalyticsAccountLinkCallback): void;

Calls CreateAnalyticsAccountLink.

Parameters
Name Description
request ICreateAnalyticsAccountLinkRequest

CreateAnalyticsAccountLinkRequest message or plain object

callback CreateAnalyticsAccountLinkCallback

Node-style callback called with the error, if any, and AnalyticsAccountLink

Returns
Type Description
void
public createAnalyticsAccountLink(request: google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest): Promise<google.marketingplatform.admin.v1alpha.AnalyticsAccountLink>;

Calls CreateAnalyticsAccountLink.

Parameter
Name Description
request ICreateAnalyticsAccountLinkRequest

CreateAnalyticsAccountLinkRequest message or plain object

Returns
Type Description
Promise<google.marketingplatform.admin.v1alpha.AnalyticsAccountLink>

Promise

public deleteAnalyticsAccountLink(request: google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest, callback: google.marketingplatform.admin.v1alpha.MarketingplatformAdminService.DeleteAnalyticsAccountLinkCallback): void;

Calls DeleteAnalyticsAccountLink.

Parameters
Name Description
request IDeleteAnalyticsAccountLinkRequest

DeleteAnalyticsAccountLinkRequest message or plain object

callback DeleteAnalyticsAccountLinkCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void
public deleteAnalyticsAccountLink(request: google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest): Promise<google.protobuf.Empty>;

Calls DeleteAnalyticsAccountLink.

Parameter
Name Description
request IDeleteAnalyticsAccountLinkRequest

DeleteAnalyticsAccountLinkRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

findSalesPartnerManagedClients(request, callback)

public findSalesPartnerManagedClients(request: google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest, callback: google.marketingplatform.admin.v1alpha.MarketingplatformAdminService.FindSalesPartnerManagedClientsCallback): void;

Calls FindSalesPartnerManagedClients.

Parameters
Name Description
request IFindSalesPartnerManagedClientsRequest

FindSalesPartnerManagedClientsRequest message or plain object

callback FindSalesPartnerManagedClientsCallback

Node-style callback called with the error, if any, and FindSalesPartnerManagedClientsResponse

Returns
Type Description
void

findSalesPartnerManagedClients(request)

public findSalesPartnerManagedClients(request: google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest): Promise<google.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsResponse>;

Calls FindSalesPartnerManagedClients.

Parameter
Name Description
request IFindSalesPartnerManagedClientsRequest

FindSalesPartnerManagedClientsRequest message or plain object

Returns
Type Description
Promise<google.marketingplatform.admin.v1alpha.FindSalesPartnerManagedClientsResponse>

Promise

getOrganization(request, callback)

public getOrganization(request: google.marketingplatform.admin.v1alpha.IGetOrganizationRequest, callback: google.marketingplatform.admin.v1alpha.MarketingplatformAdminService.GetOrganizationCallback): void;

Calls GetOrganization.

Parameters
Name Description
request IGetOrganizationRequest

GetOrganizationRequest message or plain object

callback GetOrganizationCallback

Node-style callback called with the error, if any, and Organization

Returns
Type Description
void

getOrganization(request)

public getOrganization(request: google.marketingplatform.admin.v1alpha.IGetOrganizationRequest): Promise<google.marketingplatform.admin.v1alpha.Organization>;

Calls GetOrganization.

Parameter
Name Description
request IGetOrganizationRequest

GetOrganizationRequest message or plain object

Returns
Type Description
Promise<google.marketingplatform.admin.v1alpha.Organization>

Promise

public listAnalyticsAccountLinks(request: google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, callback: google.marketingplatform.admin.v1alpha.MarketingplatformAdminService.ListAnalyticsAccountLinksCallback): void;

Calls ListAnalyticsAccountLinks.

Parameters
Name Description
request IListAnalyticsAccountLinksRequest

ListAnalyticsAccountLinksRequest message or plain object

callback ListAnalyticsAccountLinksCallback

Node-style callback called with the error, if any, and ListAnalyticsAccountLinksResponse

Returns
Type Description
void
public listAnalyticsAccountLinks(request: google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest): Promise<google.marketingplatform.admin.v1alpha.ListAnalyticsAccountLinksResponse>;

Calls ListAnalyticsAccountLinks.

Parameter
Name Description
request IListAnalyticsAccountLinksRequest

ListAnalyticsAccountLinksRequest message or plain object

Returns
Type Description
Promise<google.marketingplatform.admin.v1alpha.ListAnalyticsAccountLinksResponse>

Promise

listOrganizations(request, callback)

public listOrganizations(request: google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, callback: google.marketingplatform.admin.v1alpha.MarketingplatformAdminService.ListOrganizationsCallback): void;

Calls ListOrganizations.

Parameters
Name Description
request IListOrganizationsRequest

ListOrganizationsRequest message or plain object

callback ListOrganizationsCallback

Node-style callback called with the error, if any, and ListOrganizationsResponse

Returns
Type Description
void

listOrganizations(request)

public listOrganizations(request: google.marketingplatform.admin.v1alpha.IListOrganizationsRequest): Promise<google.marketingplatform.admin.v1alpha.ListOrganizationsResponse>;

Calls ListOrganizations.

Parameter
Name Description
request IListOrganizationsRequest

ListOrganizationsRequest message or plain object

Returns
Type Description
Promise<google.marketingplatform.admin.v1alpha.ListOrganizationsResponse>

Promise

reportPropertyUsage(request, callback)

public reportPropertyUsage(request: google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest, callback: google.marketingplatform.admin.v1alpha.MarketingplatformAdminService.ReportPropertyUsageCallback): void;

Calls ReportPropertyUsage.

Parameters
Name Description
request IReportPropertyUsageRequest

ReportPropertyUsageRequest message or plain object

callback ReportPropertyUsageCallback

Node-style callback called with the error, if any, and ReportPropertyUsageResponse

Returns
Type Description
void

reportPropertyUsage(request)

public reportPropertyUsage(request: google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest): Promise<google.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse>;

Calls ReportPropertyUsage.

Parameter
Name Description
request IReportPropertyUsageRequest

ReportPropertyUsageRequest message or plain object

Returns
Type Description
Promise<google.marketingplatform.admin.v1alpha.ReportPropertyUsageResponse>

Promise

setPropertyServiceLevel(request, callback)

public setPropertyServiceLevel(request: google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest, callback: google.marketingplatform.admin.v1alpha.MarketingplatformAdminService.SetPropertyServiceLevelCallback): void;

Calls SetPropertyServiceLevel.

Parameters
Name Description
request ISetPropertyServiceLevelRequest

SetPropertyServiceLevelRequest message or plain object

callback SetPropertyServiceLevelCallback

Node-style callback called with the error, if any, and SetPropertyServiceLevelResponse

Returns
Type Description
void

setPropertyServiceLevel(request)

public setPropertyServiceLevel(request: google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest): Promise<google.marketingplatform.admin.v1alpha.SetPropertyServiceLevelResponse>;

Calls SetPropertyServiceLevel.

Parameter
Name Description
request ISetPropertyServiceLevelRequest

SetPropertyServiceLevelRequest message or plain object

Returns
Type Description
Promise<google.marketingplatform.admin.v1alpha.SetPropertyServiceLevelResponse>

Promise