Class v1alpha.AnalyticsAdminServiceClient (4.6.0)

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The property for which to acknowledge user data collection.
   */
  // const property = 'abc123'
  /**
   *  Required. An acknowledgement that the caller of this method understands the
   *  terms of user data collection.
   *  This field must contain the exact value:
   *  "I acknowledge that I have the necessary privacy disclosures and rights
   *  from my end users for the collection and processing of their data,
   *  including the association of such data with the visitation information
   *  Google Analytics collects from my site and/or app property."
   */
  // const acknowledgement = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callAcknowledgeUserDataCollection() {
    // Construct request
    const request = {
      property,
      acknowledgement,
    };

    // Run request
    const response = await adminClient.acknowledgeUserDataCollection(request);
    console.log(response);
  }

  callAcknowledgeUserDataCollection();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve.
   *  Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callApproveDisplayVideo360AdvertiserLinkProposal() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.approveDisplayVideo360AdvertiserLinkProposal(request);
    console.log(response);
  }

  callApproveDisplayVideo360AdvertiserLinkProposal();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: properties/1234/audiences/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callArchiveAudience() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.archiveAudience(request);
    console.log(response);
  }

  callArchiveAudience();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the CustomDimension to archive.
   *  Example format: properties/1234/customDimensions/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callArchiveCustomDimension() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.archiveCustomDimension(request);
    console.log(response);
  }

  callArchiveCustomDimension();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the CustomMetric to archive.
   *  Example format: properties/1234/customMetrics/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callArchiveCustomMetric() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.archiveCustomMetric(request);
    console.log(response);
  }

  callArchiveCustomMetric();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: accounts/1234
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of user links to return.
   *  The service may return fewer than this value.
   *  If unspecified, at most 1000 user links will be returned.
   *  The maximum value is 5000; values above 5000 will be coerced to 5000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `AuditUserLinks` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `AuditUserLinks` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callAuditUserLinks() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await adminClient.auditUserLinksAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callAuditUserLinks();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The account or property that owns the access bindings. The parent
   *  field in the CreateAccessBindingRequest messages must either be empty or
   *  match this field. Formats:
   *  - accounts/{account}
   *  - properties/{property}
   */
  // const parent = 'abc123'
  /**
   *  Required. The requests specifying the access bindings to create.
   *  A maximum of 1000 access bindings can be created in a batch.
   */
  // const requests = 1234

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callBatchCreateAccessBindings() {
    // Construct request
    const request = {
      parent,
      requests,
    };

    // Run request
    const response = await adminClient.batchCreateAccessBindings(request);
    console.log(response);
  }

  callBatchCreateAccessBindings();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The account or property that all user links in the request are
   *  for. This field is required. The parent field in the CreateUserLinkRequest
   *  messages must either be empty or match this field.
   *  Example format: accounts/1234
   */
  // const parent = 'abc123'
  /**
   *  Optional. If set, then email the new users notifying them that they've been
   *  granted permissions to the resource. Regardless of whether this is set or
   *  not, notify_new_user field inside each individual request is ignored.
   */
  // const notifyNewUsers = true
  /**
   *  Required. The requests specifying the user links to create.
   *  A maximum of 1000 user links can be created in a batch.
   */
  // const requests = 1234

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callBatchCreateUserLinks() {
    // Construct request
    const request = {
      parent,
      requests,
    };

    // Run request
    const response = await adminClient.batchCreateUserLinks(request);
    console.log(response);
  }

  callBatchCreateUserLinks();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The account or property that owns the access bindings. The parent
   *  field in the DeleteAccessBindingRequest messages must either be empty or
   *  match this field. Formats:
   *  - accounts/{account}
   *  - properties/{property}
   */
  // const parent = 'abc123'
  /**
   *  Required. The requests specifying the access bindings to delete.
   *  A maximum of 1000 access bindings can be deleted in a batch.
   */
  // const requests = 1234

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callBatchDeleteAccessBindings() {
    // Construct request
    const request = {
      parent,
      requests,
    };

    // Run request
    const response = await adminClient.batchDeleteAccessBindings(request);
    console.log(response);
  }

  callBatchDeleteAccessBindings();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The account or property that all user links in the request are
   *  for. The parent of all values for user link names to delete must match this
   *  field.
   *  Example format: accounts/1234
   */
  // const parent = 'abc123'
  /**
   *  Required. The requests specifying the user links to update.
   *  A maximum of 1000 user links can be updated in a batch.
   */
  // const requests = 1234

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callBatchDeleteUserLinks() {
    // Construct request
    const request = {
      parent,
      requests,
    };

    // Run request
    const response = await adminClient.batchDeleteUserLinks(request);
    console.log(response);
  }

  callBatchDeleteUserLinks();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The account or property that owns the access bindings. The parent
   *  of all provided values for the 'names' field must match this field.
   *  Formats:
   *  - accounts/{account}
   *  - properties/{property}
   */
  // const parent = 'abc123'
  /**
   *  Required. The names of the access bindings to retrieve.
   *  A maximum of 1000 access bindings can be retrieved in a batch.
   *  Formats:
   *  - accounts/{account}/accessBindings/{accessBinding}
   *  - properties/{property}/accessBindings/{accessBinding}
   */
  // const names = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callBatchGetAccessBindings() {
    // Construct request
    const request = {
      parent,
      names,
    };

    // Run request
    const response = await adminClient.batchGetAccessBindings(request);
    console.log(response);
  }

  callBatchGetAccessBindings();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The account or property that all user links in the request are
   *  for. The parent of all provided values for the 'names' field must match
   *  this field.
   *  Example format: accounts/1234
   */
  // const parent = 'abc123'
  /**
   *  Required. The names of the user links to retrieve.
   *  A maximum of 1000 user links can be retrieved in a batch.
   *  Format: accounts/{accountId}/userLinks/{userLinkId}
   */
  // const names = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callBatchGetUserLinks() {
    // Construct request
    const request = {
      parent,
      names,
    };

    // Run request
    const response = await adminClient.batchGetUserLinks(request);
    console.log(response);
  }

  callBatchGetUserLinks();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The account or property that owns the access bindings. The parent
   *  field in the UpdateAccessBindingRequest messages must either be empty or
   *  match this field. Formats:
   *  - accounts/{account}
   *  - properties/{property}
   */
  // const parent = 'abc123'
  /**
   *  Required. The requests specifying the access bindings to update.
   *  A maximum of 1000 access bindings can be updated in a batch.
   */
  // const requests = 1234

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callBatchUpdateAccessBindings() {
    // Construct request
    const request = {
      parent,
      requests,
    };

    // Run request
    const response = await adminClient.batchUpdateAccessBindings(request);
    console.log(response);
  }

  callBatchUpdateAccessBindings();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The account or property that all user links in the request are
   *  for. The parent field in the UpdateUserLinkRequest messages must either be
   *  empty or match this field.
   *  Example format: accounts/1234
   */
  // const parent = 'abc123'
  /**
   *  Required. The requests specifying the user links to update.
   *  A maximum of 1000 user links can be updated in a batch.
   */
  // const requests = 1234

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callBatchUpdateUserLinks() {
    // Construct request
    const request = {
      parent,
      requests,
    };

    // Run request
    const response = await adminClient.batchUpdateUserLinks(request);
    console.log(response);
  }

  callBatchUpdateUserLinks();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel.
   *  Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callCancelDisplayVideo360AdvertiserLinkProposal() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.cancelDisplayVideo360AdvertiserLinkProposal(request);
    console.log(response);
  }

  callCancelDisplayVideo360AdvertiserLinkProposal();