AnalyticsAdminServiceClient

AnalyticsAdminServiceClient

Service Interface for the Analytics Admin API (GA4).

Constructor

new AnalyticsAdminServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of AnalyticsAdminServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint string <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.

fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new AnalyticsAdminServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

accountAccessBindingPath(account, access_binding) → {string}

Return a fully-qualified accountAccessBinding resource name string.

Parameters:
Name Type Description
account string
access_binding string
Returns:
Type Description
string

Resource name string.

accountPath(account) → {string}

Return a fully-qualified account resource name string.

Parameters:
Name Type Description
account string
Returns:
Type Description
string

Resource name string.

accountSummaryPath(account_summary) → {string}

Return a fully-qualified accountSummary resource name string.

Parameters:
Name Type Description
account_summary string
Returns:
Type Description
string

Resource name string.

adSenseLinkPath(property, adsense_link) → {string}

Return a fully-qualified adSenseLink resource name string.

Parameters:
Name Type Description
property string
adsense_link string
Returns:
Type Description
string

Resource name string.

attributionSettingsPath(property) → {string}

Return a fully-qualified attributionSettings resource name string.

Parameters:
Name Type Description
property string
Returns:
Type Description
string

Resource name string.

audiencePath(property, audience) → {string}

Return a fully-qualified audience resource name string.

Parameters:
Name Type Description
property string
audience string
Returns:
Type Description
string

Resource name string.

bigQueryLinkPath(property, bigquery_link) → {string}

Return a fully-qualified bigQueryLink resource name string.

Parameters:
Name Type Description
property string
bigquery_link string
Returns:
Type Description
string

Resource name string.

calculatedMetricPath(property, calculated_metric) → {string}

Return a fully-qualified calculatedMetric resource name string.

Parameters:
Name Type Description
property string
calculated_metric string
Returns:
Type Description
string

Resource name string.

channelGroupPath(property, channel_group) → {string}

Return a fully-qualified channelGroup resource name string.

Parameters:
Name Type Description
property string
channel_group string
Returns:
Type Description
string

Resource name string.

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

conversionEventPath(property, conversion_event) → {string}

Return a fully-qualified conversionEvent resource name string.

Parameters:
Name Type Description
property string
conversion_event string
Returns:
Type Description
string

Resource name string.

customDimensionPath(property, custom_dimension) → {string}

Return a fully-qualified customDimension resource name string.

Parameters:
Name Type Description
property string
custom_dimension string
Returns:
Type Description
string

Resource name string.

customMetricPath(property, custom_metric) → {string}

Return a fully-qualified customMetric resource name string.

Parameters:
Name Type Description
property string
custom_metric string
Returns:
Type Description
string

Resource name string.

dataRedactionSettingsPath(property, data_stream) → {string}

Return a fully-qualified dataRedactionSettings resource name string.

Parameters:
Name Type Description
property string
data_stream string
Returns:
Type Description
string

Resource name string.

dataRetentionSettingsPath(property) → {string}

Return a fully-qualified dataRetentionSettings resource name string.

Parameters:
Name Type Description
property string
Returns:
Type Description
string

Resource name string.

dataSharingSettingsPath(account) → {string}

Return a fully-qualified dataSharingSettings resource name string.

Parameters:
Name Type Description
account string
Returns:
Type Description
string

Resource name string.

dataStreamPath(property, data_stream) → {string}

Return a fully-qualified dataStream resource name string.

Parameters:
Name Type Description
property string
data_stream string
Returns:
Type Description
string

Resource name string.

displayVideo360AdvertiserLinkPath(property) → {string}

Return a fully-qualified displayVideo360AdvertiserLink resource name string.

Parameters:
Name Type Description
property string
Returns:
Type Description
string

Resource name string.