Class protos.google.analytics.admin.v1beta.AnalyticsAdminService (7.3.0)

Represents an AnalyticsAdminService

Inheritance

$protobuf.rpc.Service > protos.google.analytics.admin.v1beta.AnalyticsAdminService

Package

@google-analytics/admin

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new AnalyticsAdminService service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

acknowledgeUserDataCollection(request, callback)

public acknowledgeUserDataCollection(request: google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.AcknowledgeUserDataCollectionCallback): void;

Calls AcknowledgeUserDataCollection.

Parameters
NameDescription
request IAcknowledgeUserDataCollectionRequest

AcknowledgeUserDataCollectionRequest message or plain object

callback AcknowledgeUserDataCollectionCallback

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

Returns
TypeDescription
void

acknowledgeUserDataCollection(request)

public acknowledgeUserDataCollection(request: google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest): Promise<google.analytics.admin.v1beta.AcknowledgeUserDataCollectionResponse>;

Calls AcknowledgeUserDataCollection.

Parameter
NameDescription
request IAcknowledgeUserDataCollectionRequest

AcknowledgeUserDataCollectionRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.AcknowledgeUserDataCollectionResponse>

Promise

archiveCustomDimension(request, callback)

public archiveCustomDimension(request: google.analytics.admin.v1beta.IArchiveCustomDimensionRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ArchiveCustomDimensionCallback): void;

Calls ArchiveCustomDimension.

Parameters
NameDescription
request IArchiveCustomDimensionRequest

ArchiveCustomDimensionRequest message or plain object

callback ArchiveCustomDimensionCallback

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

Returns
TypeDescription
void

archiveCustomDimension(request)

public archiveCustomDimension(request: google.analytics.admin.v1beta.IArchiveCustomDimensionRequest): Promise<google.protobuf.Empty>;

Calls ArchiveCustomDimension.

Parameter
NameDescription
request IArchiveCustomDimensionRequest

ArchiveCustomDimensionRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

archiveCustomMetric(request, callback)

public archiveCustomMetric(request: google.analytics.admin.v1beta.IArchiveCustomMetricRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ArchiveCustomMetricCallback): void;

Calls ArchiveCustomMetric.

Parameters
NameDescription
request IArchiveCustomMetricRequest

ArchiveCustomMetricRequest message or plain object

callback ArchiveCustomMetricCallback

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

Returns
TypeDescription
void

archiveCustomMetric(request)

public archiveCustomMetric(request: google.analytics.admin.v1beta.IArchiveCustomMetricRequest): Promise<google.protobuf.Empty>;

Calls ArchiveCustomMetric.

Parameter
NameDescription
request IArchiveCustomMetricRequest

ArchiveCustomMetricRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new AnalyticsAdminService service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
AnalyticsAdminService

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

createConversionEvent(request, callback)

public createConversionEvent(request: google.analytics.admin.v1beta.ICreateConversionEventRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.CreateConversionEventCallback): void;

Calls CreateConversionEvent.

Parameters
NameDescription
request ICreateConversionEventRequest

CreateConversionEventRequest message or plain object

callback CreateConversionEventCallback

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

Returns
TypeDescription
void

createConversionEvent(request)

public createConversionEvent(request: google.analytics.admin.v1beta.ICreateConversionEventRequest): Promise<google.analytics.admin.v1beta.ConversionEvent>;

Calls CreateConversionEvent.

Parameter
NameDescription
request ICreateConversionEventRequest

CreateConversionEventRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ConversionEvent>

Promise

createCustomDimension(request, callback)

public createCustomDimension(request: google.analytics.admin.v1beta.ICreateCustomDimensionRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.CreateCustomDimensionCallback): void;

Calls CreateCustomDimension.

Parameters
NameDescription
request ICreateCustomDimensionRequest

CreateCustomDimensionRequest message or plain object

callback CreateCustomDimensionCallback

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

Returns
TypeDescription
void

createCustomDimension(request)

public createCustomDimension(request: google.analytics.admin.v1beta.ICreateCustomDimensionRequest): Promise<google.analytics.admin.v1beta.CustomDimension>;

Calls CreateCustomDimension.

Parameter
NameDescription
request ICreateCustomDimensionRequest

CreateCustomDimensionRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.CustomDimension>

Promise

createCustomMetric(request, callback)

public createCustomMetric(request: google.analytics.admin.v1beta.ICreateCustomMetricRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.CreateCustomMetricCallback): void;

Calls CreateCustomMetric.

Parameters
NameDescription
request ICreateCustomMetricRequest

CreateCustomMetricRequest message or plain object

callback CreateCustomMetricCallback

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

Returns
TypeDescription
void

createCustomMetric(request)

public createCustomMetric(request: google.analytics.admin.v1beta.ICreateCustomMetricRequest): Promise<google.analytics.admin.v1beta.CustomMetric>;

Calls CreateCustomMetric.

Parameter
NameDescription
request ICreateCustomMetricRequest

CreateCustomMetricRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.CustomMetric>

Promise

createDataStream(request, callback)

public createDataStream(request: google.analytics.admin.v1beta.ICreateDataStreamRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.CreateDataStreamCallback): void;

Calls CreateDataStream.

Parameters
NameDescription
request ICreateDataStreamRequest

CreateDataStreamRequest message or plain object

callback CreateDataStreamCallback

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

Returns
TypeDescription
void

createDataStream(request)

public createDataStream(request: google.analytics.admin.v1beta.ICreateDataStreamRequest): Promise<google.analytics.admin.v1beta.DataStream>;

Calls CreateDataStream.

Parameter
NameDescription
request ICreateDataStreamRequest

CreateDataStreamRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.DataStream>

Promise

public createFirebaseLink(request: google.analytics.admin.v1beta.ICreateFirebaseLinkRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.CreateFirebaseLinkCallback): void;

Calls CreateFirebaseLink.

Parameters
NameDescription
request ICreateFirebaseLinkRequest

CreateFirebaseLinkRequest message or plain object

callback CreateFirebaseLinkCallback

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

Returns
TypeDescription
void
public createFirebaseLink(request: google.analytics.admin.v1beta.ICreateFirebaseLinkRequest): Promise<google.analytics.admin.v1beta.FirebaseLink>;

Calls CreateFirebaseLink.

Parameter
NameDescription
request ICreateFirebaseLinkRequest

CreateFirebaseLinkRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.FirebaseLink>

Promise

public createGoogleAdsLink(request: google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.CreateGoogleAdsLinkCallback): void;

Calls CreateGoogleAdsLink.

Parameters
NameDescription
request ICreateGoogleAdsLinkRequest

CreateGoogleAdsLinkRequest message or plain object

callback CreateGoogleAdsLinkCallback

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

Returns
TypeDescription
void
public createGoogleAdsLink(request: google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest): Promise<google.analytics.admin.v1beta.GoogleAdsLink>;

Calls CreateGoogleAdsLink.

Parameter
NameDescription
request ICreateGoogleAdsLinkRequest

CreateGoogleAdsLinkRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.GoogleAdsLink>

Promise

createMeasurementProtocolSecret(request, callback)

public createMeasurementProtocolSecret(request: google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.CreateMeasurementProtocolSecretCallback): void;

Calls CreateMeasurementProtocolSecret.

Parameters
NameDescription
request ICreateMeasurementProtocolSecretRequest

CreateMeasurementProtocolSecretRequest message or plain object

callback CreateMeasurementProtocolSecretCallback

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

Returns
TypeDescription
void

createMeasurementProtocolSecret(request)

public createMeasurementProtocolSecret(request: google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest): Promise<google.analytics.admin.v1beta.MeasurementProtocolSecret>;

Calls CreateMeasurementProtocolSecret.

Parameter
NameDescription
request ICreateMeasurementProtocolSecretRequest

CreateMeasurementProtocolSecretRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.MeasurementProtocolSecret>

Promise

createProperty(request, callback)

public createProperty(request: google.analytics.admin.v1beta.ICreatePropertyRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.CreatePropertyCallback): void;

Calls CreateProperty.

Parameters
NameDescription
request ICreatePropertyRequest

CreatePropertyRequest message or plain object

callback CreatePropertyCallback

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

Returns
TypeDescription
void

createProperty(request)

public createProperty(request: google.analytics.admin.v1beta.ICreatePropertyRequest): Promise<google.analytics.admin.v1beta.Property>;

Calls CreateProperty.

Parameter
NameDescription
request ICreatePropertyRequest

CreatePropertyRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.Property>

Promise

deleteAccount(request, callback)

public deleteAccount(request: google.analytics.admin.v1beta.IDeleteAccountRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.DeleteAccountCallback): void;

Calls DeleteAccount.

Parameters
NameDescription
request IDeleteAccountRequest

DeleteAccountRequest message or plain object

callback DeleteAccountCallback

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

Returns
TypeDescription
void

deleteAccount(request)

public deleteAccount(request: google.analytics.admin.v1beta.IDeleteAccountRequest): Promise<google.protobuf.Empty>;

Calls DeleteAccount.

Parameter
NameDescription
request IDeleteAccountRequest

DeleteAccountRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

deleteConversionEvent(request, callback)

public deleteConversionEvent(request: google.analytics.admin.v1beta.IDeleteConversionEventRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.DeleteConversionEventCallback): void;

Calls DeleteConversionEvent.

Parameters
NameDescription
request IDeleteConversionEventRequest

DeleteConversionEventRequest message or plain object

callback DeleteConversionEventCallback

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

Returns
TypeDescription
void

deleteConversionEvent(request)

public deleteConversionEvent(request: google.analytics.admin.v1beta.IDeleteConversionEventRequest): Promise<google.protobuf.Empty>;

Calls DeleteConversionEvent.

Parameter
NameDescription
request IDeleteConversionEventRequest

DeleteConversionEventRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

deleteDataStream(request, callback)

public deleteDataStream(request: google.analytics.admin.v1beta.IDeleteDataStreamRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.DeleteDataStreamCallback): void;

Calls DeleteDataStream.

Parameters
NameDescription
request IDeleteDataStreamRequest

DeleteDataStreamRequest message or plain object

callback DeleteDataStreamCallback

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

Returns
TypeDescription
void

deleteDataStream(request)

public deleteDataStream(request: google.analytics.admin.v1beta.IDeleteDataStreamRequest): Promise<google.protobuf.Empty>;

Calls DeleteDataStream.

Parameter
NameDescription
request IDeleteDataStreamRequest

DeleteDataStreamRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

public deleteFirebaseLink(request: google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.DeleteFirebaseLinkCallback): void;

Calls DeleteFirebaseLink.

Parameters
NameDescription
request IDeleteFirebaseLinkRequest

DeleteFirebaseLinkRequest message or plain object

callback DeleteFirebaseLinkCallback

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

Returns
TypeDescription
void
public deleteFirebaseLink(request: google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest): Promise<google.protobuf.Empty>;

Calls DeleteFirebaseLink.

Parameter
NameDescription
request IDeleteFirebaseLinkRequest

DeleteFirebaseLinkRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

public deleteGoogleAdsLink(request: google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.DeleteGoogleAdsLinkCallback): void;

Calls DeleteGoogleAdsLink.

Parameters
NameDescription
request IDeleteGoogleAdsLinkRequest

DeleteGoogleAdsLinkRequest message or plain object

callback DeleteGoogleAdsLinkCallback

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

Returns
TypeDescription
void
public deleteGoogleAdsLink(request: google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest): Promise<google.protobuf.Empty>;

Calls DeleteGoogleAdsLink.

Parameter
NameDescription
request IDeleteGoogleAdsLinkRequest

DeleteGoogleAdsLinkRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

deleteMeasurementProtocolSecret(request, callback)

public deleteMeasurementProtocolSecret(request: google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.DeleteMeasurementProtocolSecretCallback): void;

Calls DeleteMeasurementProtocolSecret.

Parameters
NameDescription
request IDeleteMeasurementProtocolSecretRequest

DeleteMeasurementProtocolSecretRequest message or plain object

callback DeleteMeasurementProtocolSecretCallback

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

Returns
TypeDescription
void

deleteMeasurementProtocolSecret(request)

public deleteMeasurementProtocolSecret(request: google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest): Promise<google.protobuf.Empty>;

Calls DeleteMeasurementProtocolSecret.

Parameter
NameDescription
request IDeleteMeasurementProtocolSecretRequest

DeleteMeasurementProtocolSecretRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

deleteProperty(request, callback)

public deleteProperty(request: google.analytics.admin.v1beta.IDeletePropertyRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.DeletePropertyCallback): void;

Calls DeleteProperty.

Parameters
NameDescription
request IDeletePropertyRequest

DeletePropertyRequest message or plain object

callback DeletePropertyCallback

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

Returns
TypeDescription
void

deleteProperty(request)

public deleteProperty(request: google.analytics.admin.v1beta.IDeletePropertyRequest): Promise<google.analytics.admin.v1beta.Property>;

Calls DeleteProperty.

Parameter
NameDescription
request IDeletePropertyRequest

DeletePropertyRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.Property>

Promise

getAccount(request, callback)

public getAccount(request: google.analytics.admin.v1beta.IGetAccountRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.GetAccountCallback): void;

Calls GetAccount.

Parameters
NameDescription
request IGetAccountRequest

GetAccountRequest message or plain object

callback GetAccountCallback

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

Returns
TypeDescription
void

getAccount(request)

public getAccount(request: google.analytics.admin.v1beta.IGetAccountRequest): Promise<google.analytics.admin.v1beta.Account>;

Calls GetAccount.

Parameter
NameDescription
request IGetAccountRequest

GetAccountRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.Account>

Promise

getConversionEvent(request, callback)

public getConversionEvent(request: google.analytics.admin.v1beta.IGetConversionEventRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.GetConversionEventCallback): void;

Calls GetConversionEvent.

Parameters
NameDescription
request IGetConversionEventRequest

GetConversionEventRequest message or plain object

callback GetConversionEventCallback

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

Returns
TypeDescription
void

getConversionEvent(request)

public getConversionEvent(request: google.analytics.admin.v1beta.IGetConversionEventRequest): Promise<google.analytics.admin.v1beta.ConversionEvent>;

Calls GetConversionEvent.

Parameter
NameDescription
request IGetConversionEventRequest

GetConversionEventRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ConversionEvent>

Promise

getCustomDimension(request, callback)

public getCustomDimension(request: google.analytics.admin.v1beta.IGetCustomDimensionRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.GetCustomDimensionCallback): void;

Calls GetCustomDimension.

Parameters
NameDescription
request IGetCustomDimensionRequest

GetCustomDimensionRequest message or plain object

callback GetCustomDimensionCallback

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

Returns
TypeDescription
void

getCustomDimension(request)

public getCustomDimension(request: google.analytics.admin.v1beta.IGetCustomDimensionRequest): Promise<google.analytics.admin.v1beta.CustomDimension>;

Calls GetCustomDimension.

Parameter
NameDescription
request IGetCustomDimensionRequest

GetCustomDimensionRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.CustomDimension>

Promise

getCustomMetric(request, callback)

public getCustomMetric(request: google.analytics.admin.v1beta.IGetCustomMetricRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.GetCustomMetricCallback): void;

Calls GetCustomMetric.

Parameters
NameDescription
request IGetCustomMetricRequest

GetCustomMetricRequest message or plain object

callback GetCustomMetricCallback

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

Returns
TypeDescription
void

getCustomMetric(request)

public getCustomMetric(request: google.analytics.admin.v1beta.IGetCustomMetricRequest): Promise<google.analytics.admin.v1beta.CustomMetric>;

Calls GetCustomMetric.

Parameter
NameDescription
request IGetCustomMetricRequest

GetCustomMetricRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.CustomMetric>

Promise

getDataRetentionSettings(request, callback)

public getDataRetentionSettings(request: google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.GetDataRetentionSettingsCallback): void;

Calls GetDataRetentionSettings.

Parameters
NameDescription
request IGetDataRetentionSettingsRequest

GetDataRetentionSettingsRequest message or plain object

callback GetDataRetentionSettingsCallback

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

Returns
TypeDescription
void

getDataRetentionSettings(request)

public getDataRetentionSettings(request: google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest): Promise<google.analytics.admin.v1beta.DataRetentionSettings>;

Calls GetDataRetentionSettings.

Parameter
NameDescription
request IGetDataRetentionSettingsRequest

GetDataRetentionSettingsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.DataRetentionSettings>

Promise

getDataSharingSettings(request, callback)

public getDataSharingSettings(request: google.analytics.admin.v1beta.IGetDataSharingSettingsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.GetDataSharingSettingsCallback): void;

Calls GetDataSharingSettings.

Parameters
NameDescription
request IGetDataSharingSettingsRequest

GetDataSharingSettingsRequest message or plain object

callback GetDataSharingSettingsCallback

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

Returns
TypeDescription
void

getDataSharingSettings(request)

public getDataSharingSettings(request: google.analytics.admin.v1beta.IGetDataSharingSettingsRequest): Promise<google.analytics.admin.v1beta.DataSharingSettings>;

Calls GetDataSharingSettings.

Parameter
NameDescription
request IGetDataSharingSettingsRequest

GetDataSharingSettingsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.DataSharingSettings>

Promise

getDataStream(request, callback)

public getDataStream(request: google.analytics.admin.v1beta.IGetDataStreamRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.GetDataStreamCallback): void;

Calls GetDataStream.

Parameters
NameDescription
request IGetDataStreamRequest

GetDataStreamRequest message or plain object

callback GetDataStreamCallback

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

Returns
TypeDescription
void

getDataStream(request)

public getDataStream(request: google.analytics.admin.v1beta.IGetDataStreamRequest): Promise<google.analytics.admin.v1beta.DataStream>;

Calls GetDataStream.

Parameter
NameDescription
request IGetDataStreamRequest

GetDataStreamRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.DataStream>

Promise

getMeasurementProtocolSecret(request, callback)

public getMeasurementProtocolSecret(request: google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.GetMeasurementProtocolSecretCallback): void;

Calls GetMeasurementProtocolSecret.

Parameters
NameDescription
request IGetMeasurementProtocolSecretRequest

GetMeasurementProtocolSecretRequest message or plain object

callback GetMeasurementProtocolSecretCallback

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

Returns
TypeDescription
void

getMeasurementProtocolSecret(request)

public getMeasurementProtocolSecret(request: google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest): Promise<google.analytics.admin.v1beta.MeasurementProtocolSecret>;

Calls GetMeasurementProtocolSecret.

Parameter
NameDescription
request IGetMeasurementProtocolSecretRequest

GetMeasurementProtocolSecretRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.MeasurementProtocolSecret>

Promise

getProperty(request, callback)

public getProperty(request: google.analytics.admin.v1beta.IGetPropertyRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.GetPropertyCallback): void;

Calls GetProperty.

Parameters
NameDescription
request IGetPropertyRequest

GetPropertyRequest message or plain object

callback GetPropertyCallback

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

Returns
TypeDescription
void

getProperty(request)

public getProperty(request: google.analytics.admin.v1beta.IGetPropertyRequest): Promise<google.analytics.admin.v1beta.Property>;

Calls GetProperty.

Parameter
NameDescription
request IGetPropertyRequest

GetPropertyRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.Property>

Promise

listAccounts(request, callback)

public listAccounts(request: google.analytics.admin.v1beta.IListAccountsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListAccountsCallback): void;

Calls ListAccounts.

Parameters
NameDescription
request IListAccountsRequest

ListAccountsRequest message or plain object

callback ListAccountsCallback

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

Returns
TypeDescription
void

listAccounts(request)

public listAccounts(request: google.analytics.admin.v1beta.IListAccountsRequest): Promise<google.analytics.admin.v1beta.ListAccountsResponse>;

Calls ListAccounts.

Parameter
NameDescription
request IListAccountsRequest

ListAccountsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListAccountsResponse>

Promise

listAccountSummaries(request, callback)

public listAccountSummaries(request: google.analytics.admin.v1beta.IListAccountSummariesRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListAccountSummariesCallback): void;

Calls ListAccountSummaries.

Parameters
NameDescription
request IListAccountSummariesRequest

ListAccountSummariesRequest message or plain object

callback ListAccountSummariesCallback

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

Returns
TypeDescription
void

listAccountSummaries(request)

public listAccountSummaries(request: google.analytics.admin.v1beta.IListAccountSummariesRequest): Promise<google.analytics.admin.v1beta.ListAccountSummariesResponse>;

Calls ListAccountSummaries.

Parameter
NameDescription
request IListAccountSummariesRequest

ListAccountSummariesRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListAccountSummariesResponse>

Promise

listConversionEvents(request, callback)

public listConversionEvents(request: google.analytics.admin.v1beta.IListConversionEventsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListConversionEventsCallback): void;

Calls ListConversionEvents.

Parameters
NameDescription
request IListConversionEventsRequest

ListConversionEventsRequest message or plain object

callback ListConversionEventsCallback

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

Returns
TypeDescription
void

listConversionEvents(request)

public listConversionEvents(request: google.analytics.admin.v1beta.IListConversionEventsRequest): Promise<google.analytics.admin.v1beta.ListConversionEventsResponse>;

Calls ListConversionEvents.

Parameter
NameDescription
request IListConversionEventsRequest

ListConversionEventsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListConversionEventsResponse>

Promise

listCustomDimensions(request, callback)

public listCustomDimensions(request: google.analytics.admin.v1beta.IListCustomDimensionsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListCustomDimensionsCallback): void;

Calls ListCustomDimensions.

Parameters
NameDescription
request IListCustomDimensionsRequest

ListCustomDimensionsRequest message or plain object

callback ListCustomDimensionsCallback

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

Returns
TypeDescription
void

listCustomDimensions(request)

public listCustomDimensions(request: google.analytics.admin.v1beta.IListCustomDimensionsRequest): Promise<google.analytics.admin.v1beta.ListCustomDimensionsResponse>;

Calls ListCustomDimensions.

Parameter
NameDescription
request IListCustomDimensionsRequest

ListCustomDimensionsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListCustomDimensionsResponse>

Promise

listCustomMetrics(request, callback)

public listCustomMetrics(request: google.analytics.admin.v1beta.IListCustomMetricsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListCustomMetricsCallback): void;

Calls ListCustomMetrics.

Parameters
NameDescription
request IListCustomMetricsRequest

ListCustomMetricsRequest message or plain object

callback ListCustomMetricsCallback

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

Returns
TypeDescription
void

listCustomMetrics(request)

public listCustomMetrics(request: google.analytics.admin.v1beta.IListCustomMetricsRequest): Promise<google.analytics.admin.v1beta.ListCustomMetricsResponse>;

Calls ListCustomMetrics.

Parameter
NameDescription
request IListCustomMetricsRequest

ListCustomMetricsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListCustomMetricsResponse>

Promise

listDataStreams(request, callback)

public listDataStreams(request: google.analytics.admin.v1beta.IListDataStreamsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListDataStreamsCallback): void;

Calls ListDataStreams.

Parameters
NameDescription
request IListDataStreamsRequest

ListDataStreamsRequest message or plain object

callback ListDataStreamsCallback

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

Returns
TypeDescription
void

listDataStreams(request)

public listDataStreams(request: google.analytics.admin.v1beta.IListDataStreamsRequest): Promise<google.analytics.admin.v1beta.ListDataStreamsResponse>;

Calls ListDataStreams.

Parameter
NameDescription
request IListDataStreamsRequest

ListDataStreamsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListDataStreamsResponse>

Promise

public listFirebaseLinks(request: google.analytics.admin.v1beta.IListFirebaseLinksRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListFirebaseLinksCallback): void;

Calls ListFirebaseLinks.

Parameters
NameDescription
request IListFirebaseLinksRequest

ListFirebaseLinksRequest message or plain object

callback ListFirebaseLinksCallback

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

Returns
TypeDescription
void
public listFirebaseLinks(request: google.analytics.admin.v1beta.IListFirebaseLinksRequest): Promise<google.analytics.admin.v1beta.ListFirebaseLinksResponse>;

Calls ListFirebaseLinks.

Parameter
NameDescription
request IListFirebaseLinksRequest

ListFirebaseLinksRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListFirebaseLinksResponse>

Promise

public listGoogleAdsLinks(request: google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListGoogleAdsLinksCallback): void;

Calls ListGoogleAdsLinks.

Parameters
NameDescription
request IListGoogleAdsLinksRequest

ListGoogleAdsLinksRequest message or plain object

callback ListGoogleAdsLinksCallback

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

Returns
TypeDescription
void
public listGoogleAdsLinks(request: google.analytics.admin.v1beta.IListGoogleAdsLinksRequest): Promise<google.analytics.admin.v1beta.ListGoogleAdsLinksResponse>;

Calls ListGoogleAdsLinks.

Parameter
NameDescription
request IListGoogleAdsLinksRequest

ListGoogleAdsLinksRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListGoogleAdsLinksResponse>

Promise

listMeasurementProtocolSecrets(request, callback)

public listMeasurementProtocolSecrets(request: google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListMeasurementProtocolSecretsCallback): void;

Calls ListMeasurementProtocolSecrets.

Parameters
NameDescription
request IListMeasurementProtocolSecretsRequest

ListMeasurementProtocolSecretsRequest message or plain object

callback ListMeasurementProtocolSecretsCallback

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

Returns
TypeDescription
void

listMeasurementProtocolSecrets(request)

public listMeasurementProtocolSecrets(request: google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest): Promise<google.analytics.admin.v1beta.ListMeasurementProtocolSecretsResponse>;

Calls ListMeasurementProtocolSecrets.

Parameter
NameDescription
request IListMeasurementProtocolSecretsRequest

ListMeasurementProtocolSecretsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListMeasurementProtocolSecretsResponse>

Promise

listProperties(request, callback)

public listProperties(request: google.analytics.admin.v1beta.IListPropertiesRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ListPropertiesCallback): void;

Calls ListProperties.

Parameters
NameDescription
request IListPropertiesRequest

ListPropertiesRequest message or plain object

callback ListPropertiesCallback

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

Returns
TypeDescription
void

listProperties(request)

public listProperties(request: google.analytics.admin.v1beta.IListPropertiesRequest): Promise<google.analytics.admin.v1beta.ListPropertiesResponse>;

Calls ListProperties.

Parameter
NameDescription
request IListPropertiesRequest

ListPropertiesRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ListPropertiesResponse>

Promise

provisionAccountTicket(request, callback)

public provisionAccountTicket(request: google.analytics.admin.v1beta.IProvisionAccountTicketRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.ProvisionAccountTicketCallback): void;

Calls ProvisionAccountTicket.

Parameters
NameDescription
request IProvisionAccountTicketRequest

ProvisionAccountTicketRequest message or plain object

callback ProvisionAccountTicketCallback

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

Returns
TypeDescription
void

provisionAccountTicket(request)

public provisionAccountTicket(request: google.analytics.admin.v1beta.IProvisionAccountTicketRequest): Promise<google.analytics.admin.v1beta.ProvisionAccountTicketResponse>;

Calls ProvisionAccountTicket.

Parameter
NameDescription
request IProvisionAccountTicketRequest

ProvisionAccountTicketRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ProvisionAccountTicketResponse>

Promise

runAccessReport(request, callback)

public runAccessReport(request: google.analytics.admin.v1beta.IRunAccessReportRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.RunAccessReportCallback): void;

Calls RunAccessReport.

Parameters
NameDescription
request IRunAccessReportRequest

RunAccessReportRequest message or plain object

callback RunAccessReportCallback

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

Returns
TypeDescription
void

runAccessReport(request)

public runAccessReport(request: google.analytics.admin.v1beta.IRunAccessReportRequest): Promise<google.analytics.admin.v1beta.RunAccessReportResponse>;

Calls RunAccessReport.

Parameter
NameDescription
request IRunAccessReportRequest

RunAccessReportRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.RunAccessReportResponse>

Promise

searchChangeHistoryEvents(request, callback)

public searchChangeHistoryEvents(request: google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.SearchChangeHistoryEventsCallback): void;

Calls SearchChangeHistoryEvents.

Parameters
NameDescription
request ISearchChangeHistoryEventsRequest

SearchChangeHistoryEventsRequest message or plain object

callback SearchChangeHistoryEventsCallback

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

Returns
TypeDescription
void

searchChangeHistoryEvents(request)

public searchChangeHistoryEvents(request: google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest): Promise<google.analytics.admin.v1beta.SearchChangeHistoryEventsResponse>;

Calls SearchChangeHistoryEvents.

Parameter
NameDescription
request ISearchChangeHistoryEventsRequest

SearchChangeHistoryEventsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.SearchChangeHistoryEventsResponse>

Promise

updateAccount(request, callback)

public updateAccount(request: google.analytics.admin.v1beta.IUpdateAccountRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.UpdateAccountCallback): void;

Calls UpdateAccount.

Parameters
NameDescription
request IUpdateAccountRequest

UpdateAccountRequest message or plain object

callback UpdateAccountCallback

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

Returns
TypeDescription
void

updateAccount(request)

public updateAccount(request: google.analytics.admin.v1beta.IUpdateAccountRequest): Promise<google.analytics.admin.v1beta.Account>;

Calls UpdateAccount.

Parameter
NameDescription
request IUpdateAccountRequest

UpdateAccountRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.Account>

Promise

updateConversionEvent(request, callback)

public updateConversionEvent(request: google.analytics.admin.v1beta.IUpdateConversionEventRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.UpdateConversionEventCallback): void;

Calls UpdateConversionEvent.

Parameters
NameDescription
request IUpdateConversionEventRequest

UpdateConversionEventRequest message or plain object

callback UpdateConversionEventCallback

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

Returns
TypeDescription
void

updateConversionEvent(request)

public updateConversionEvent(request: google.analytics.admin.v1beta.IUpdateConversionEventRequest): Promise<google.analytics.admin.v1beta.ConversionEvent>;

Calls UpdateConversionEvent.

Parameter
NameDescription
request IUpdateConversionEventRequest

UpdateConversionEventRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.ConversionEvent>

Promise

updateCustomDimension(request, callback)

public updateCustomDimension(request: google.analytics.admin.v1beta.IUpdateCustomDimensionRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.UpdateCustomDimensionCallback): void;

Calls UpdateCustomDimension.

Parameters
NameDescription
request IUpdateCustomDimensionRequest

UpdateCustomDimensionRequest message or plain object

callback UpdateCustomDimensionCallback

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

Returns
TypeDescription
void

updateCustomDimension(request)

public updateCustomDimension(request: google.analytics.admin.v1beta.IUpdateCustomDimensionRequest): Promise<google.analytics.admin.v1beta.CustomDimension>;

Calls UpdateCustomDimension.

Parameter
NameDescription
request IUpdateCustomDimensionRequest

UpdateCustomDimensionRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.CustomDimension>

Promise

updateCustomMetric(request, callback)

public updateCustomMetric(request: google.analytics.admin.v1beta.IUpdateCustomMetricRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.UpdateCustomMetricCallback): void;

Calls UpdateCustomMetric.

Parameters
NameDescription
request IUpdateCustomMetricRequest

UpdateCustomMetricRequest message or plain object

callback UpdateCustomMetricCallback

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

Returns
TypeDescription
void

updateCustomMetric(request)

public updateCustomMetric(request: google.analytics.admin.v1beta.IUpdateCustomMetricRequest): Promise<google.analytics.admin.v1beta.CustomMetric>;

Calls UpdateCustomMetric.

Parameter
NameDescription
request IUpdateCustomMetricRequest

UpdateCustomMetricRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.CustomMetric>

Promise

updateDataRetentionSettings(request, callback)

public updateDataRetentionSettings(request: google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.UpdateDataRetentionSettingsCallback): void;

Calls UpdateDataRetentionSettings.

Parameters
NameDescription
request IUpdateDataRetentionSettingsRequest

UpdateDataRetentionSettingsRequest message or plain object

callback UpdateDataRetentionSettingsCallback

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

Returns
TypeDescription
void

updateDataRetentionSettings(request)

public updateDataRetentionSettings(request: google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest): Promise<google.analytics.admin.v1beta.DataRetentionSettings>;

Calls UpdateDataRetentionSettings.

Parameter
NameDescription
request IUpdateDataRetentionSettingsRequest

UpdateDataRetentionSettingsRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.DataRetentionSettings>

Promise

updateDataStream(request, callback)

public updateDataStream(request: google.analytics.admin.v1beta.IUpdateDataStreamRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.UpdateDataStreamCallback): void;

Calls UpdateDataStream.

Parameters
NameDescription
request IUpdateDataStreamRequest

UpdateDataStreamRequest message or plain object

callback UpdateDataStreamCallback

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

Returns
TypeDescription
void

updateDataStream(request)

public updateDataStream(request: google.analytics.admin.v1beta.IUpdateDataStreamRequest): Promise<google.analytics.admin.v1beta.DataStream>;

Calls UpdateDataStream.

Parameter
NameDescription
request IUpdateDataStreamRequest

UpdateDataStreamRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.DataStream>

Promise

public updateGoogleAdsLink(request: google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.UpdateGoogleAdsLinkCallback): void;

Calls UpdateGoogleAdsLink.

Parameters
NameDescription
request IUpdateGoogleAdsLinkRequest

UpdateGoogleAdsLinkRequest message or plain object

callback UpdateGoogleAdsLinkCallback

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

Returns
TypeDescription
void
public updateGoogleAdsLink(request: google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest): Promise<google.analytics.admin.v1beta.GoogleAdsLink>;

Calls UpdateGoogleAdsLink.

Parameter
NameDescription
request IUpdateGoogleAdsLinkRequest

UpdateGoogleAdsLinkRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.GoogleAdsLink>

Promise

updateMeasurementProtocolSecret(request, callback)

public updateMeasurementProtocolSecret(request: google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.UpdateMeasurementProtocolSecretCallback): void;

Calls UpdateMeasurementProtocolSecret.

Parameters
NameDescription
request IUpdateMeasurementProtocolSecretRequest

UpdateMeasurementProtocolSecretRequest message or plain object

callback UpdateMeasurementProtocolSecretCallback

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

Returns
TypeDescription
void

updateMeasurementProtocolSecret(request)

public updateMeasurementProtocolSecret(request: google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest): Promise<google.analytics.admin.v1beta.MeasurementProtocolSecret>;

Calls UpdateMeasurementProtocolSecret.

Parameter
NameDescription
request IUpdateMeasurementProtocolSecretRequest

UpdateMeasurementProtocolSecretRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.MeasurementProtocolSecret>

Promise

updateProperty(request, callback)

public updateProperty(request: google.analytics.admin.v1beta.IUpdatePropertyRequest, callback: google.analytics.admin.v1beta.AnalyticsAdminService.UpdatePropertyCallback): void;

Calls UpdateProperty.

Parameters
NameDescription
request IUpdatePropertyRequest

UpdatePropertyRequest message or plain object

callback UpdatePropertyCallback

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

Returns
TypeDescription
void

updateProperty(request)

public updateProperty(request: google.analytics.admin.v1beta.IUpdatePropertyRequest): Promise<google.analytics.admin.v1beta.Property>;

Calls UpdateProperty.

Parameter
NameDescription
request IUpdatePropertyRequest

UpdatePropertyRequest message or plain object

Returns
TypeDescription
Promise<google.analytics.admin.v1beta.Property>

Promise