Class v1alpha.MarketingplatformAdminServiceClient (0.6.1)

0.6.1 (latest) 0.6.0 0.4.0 0.1.0

Service Interface for the Google Marketing Platform Admin API. v1alpha

Package

@google-ads/marketing-platform-admin

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of MarketingplatformAdminServiceClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : 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 MarketingplatformAdminServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

marketingplatformAdminServiceStub

marketingplatformAdminServiceStub?: Promise<{
        [name: string]: Function;
    }>;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

adminAccessBindingPath(organization, adminAccessBinding)

adminAccessBindingPath(organization: string, adminAccessBinding: string): string;

Return a fully-qualified adminAccessBinding resource name string.

Parameters
Name	Description
organization	string
adminAccessBinding	string

Returns
Type	Description
string	{string} Resource name string.

analyticsAccountLinkPath(organization, analyticsAccountLink)

analyticsAccountLinkPath(organization: string, analyticsAccountLink: string): string;

Return a fully-qualified analyticsAccountLink resource name string.

Parameters
Name	Description
organization	string
analyticsAccountLink	string

Returns
Type	Description
string	{string} Resource name string.

close()

close(): Promise<void>;

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<void>	{Promise} A promise that resolves when the client is closed.

createAdminAccessBinding(request, options)

createAdminAccessBinding(request?: protos.google.marketingplatform.admin.v1alpha.ICreateAdminAccessBindingRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding,
        (protos.google.marketingplatform.admin.v1alpha.ICreateAdminAccessBindingRequest | undefined),
        {} | undefined
    ]>;

Creates an admin access binding in the specified GMP organization.

Parameters
Name	Description
request	ICreateAdminAccessBindingRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, (protos.google.marketingplatform.admin.v1alpha.ICreateAdminAccessBindingRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing AdminAccessBinding. Please see the documentation for more details and examples.

Example

  /**
   * 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 parent organization, which owns this Admin Access Binding.
   *  Format: organizations/{org_id}
   */
  // const parent = 'abc123'
  /**
   *  Required. The Admin Access Binding to create.
   *  Only 'user_email' input is allowed.
   */
  // const adminAccessBinding = {}

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callCreateAdminAccessBinding();

createAdminAccessBinding(request, options, callback)

createAdminAccessBinding(request: protos.google.marketingplatform.admin.v1alpha.ICreateAdminAccessBindingRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.ICreateAdminAccessBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateAdminAccessBindingRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.ICreateAdminAccessBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createAdminAccessBinding(request, callback)

createAdminAccessBinding(request: protos.google.marketingplatform.admin.v1alpha.ICreateAdminAccessBindingRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.ICreateAdminAccessBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateAdminAccessBindingRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.ICreateAdminAccessBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createAnalyticsAccountLink(request, options)

createAnalyticsAccountLink(request?: protos.google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink,
        (protos.google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest | undefined),
        {} | undefined
    ]>;

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.

Parameters
Name	Description
request	ICreateAnalyticsAccountLinkRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink, (protos.google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing AnalyticsAccountLink. Please see the documentation for more details and examples.

Example

  /**
   * 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 parent resource where this Analytics account link will be
   *  created. Format: organizations/{org_id}
   */
  // const parent = 'abc123'
  /**
   *  Required. The Analytics account link to create.
   */
  // const analyticsAccountLink = {}

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callCreateAnalyticsAccountLink();

createAnalyticsAccountLink(request, options, callback)

createAnalyticsAccountLink(request: protos.google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink, protos.google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateAnalyticsAccountLinkRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink, protos.google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createAnalyticsAccountLink(request, callback)

createAnalyticsAccountLink(request: protos.google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink, protos.google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateAnalyticsAccountLinkRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink, protos.google.marketingplatform.admin.v1alpha.ICreateAnalyticsAccountLinkRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createUserGroup(request, options)

createUserGroup(request?: protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IUserGroup,
        (protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupRequest | undefined),
        {} | undefined
    ]>;

Creates a user group in the specified GMP organization.

Parameters
Name	Description
request	ICreateUserGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IUserGroup, (protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserGroup. Please see the documentation for more details and examples.

Example

  /**
   * 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 parent resource where this UserGroup will be created.
   *  Format: organizations/{org_id}
   */
  // const parent = 'abc123'
  /**
   *  Required. The user group to create.
   */
  // const userGroup = {}

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callCreateUserGroup();

createUserGroup(request, options, callback)

createUserGroup(request: protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateUserGroupRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createUserGroup(request, callback)

createUserGroup(request: protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateUserGroupRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createUserGroupMember(request, options)

createUserGroupMember(request?: protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupMemberRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IUserGroupMember,
        (protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupMemberRequest | undefined),
        {} | undefined
    ]>;

Adds a member to the specified GMP user group.

Parameters
Name	Description
request	ICreateUserGroupMemberRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, (protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupMemberRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 parent resource where this UserGroupMember will be created.
   *  Format: organizations/{org_id}/userGroups/{user_group_id}
   */
  // const parent = 'abc123'
  /**
   *  Required. The user group member to create.
   */
  // const userGroupMember = {}

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callCreateUserGroupMember();

createUserGroupMember(request, options, callback)

createUserGroupMember(request: protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupMemberRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupMemberRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateUserGroupMemberRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupMemberRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createUserGroupMember(request, callback)

createUserGroupMember(request: protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupMemberRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupMemberRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateUserGroupMemberRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.ICreateUserGroupMemberRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteAnalyticsAccountLink(request, options)

deleteAnalyticsAccountLink(request?: protos.google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest | undefined),
        {} | undefined
    ]>;

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.

Parameters
Name	Description
request	IDeleteAnalyticsAccountLinkRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 Analytics account link to delete.
   *  Format:
   *  organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callDeleteAnalyticsAccountLink();

deleteAnalyticsAccountLink(request, options, callback)

deleteAnalyticsAccountLink(request: protos.google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteAnalyticsAccountLinkRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteAnalyticsAccountLink(request, callback)

deleteAnalyticsAccountLink(request: protos.google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteAnalyticsAccountLinkRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteAnalyticsAccountLinkRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteUserGroup(request, options)

deleteUserGroup(request?: protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupRequest | undefined),
        {} | undefined
    ]>;

Deletes a user group in the specified GMP organization.

Parameters
Name	Description
request	IDeleteUserGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 user group to delete.
   *  Format: organizations/{org_id}/userGroups/{user_group_id}
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callDeleteUserGroup();

deleteUserGroup(request, options, callback)

deleteUserGroup(request: protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteUserGroupRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteUserGroup(request, callback)

deleteUserGroup(request: protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteUserGroupRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteUserGroupMember(request, options)

deleteUserGroupMember(request?: protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupMemberRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupMemberRequest | undefined),
        {} | undefined
    ]>;

Deletes a member in the specified GMP user group.

Parameters
Name	Description
request	IDeleteUserGroupMemberRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupMemberRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 user group member to delete.
   *  Format:
   *  organizations/{org_id}/userGroups/{user_group_id}/members/{member_id}
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callDeleteUserGroupMember();

deleteUserGroupMember(request, options, callback)

deleteUserGroupMember(request: protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupMemberRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupMemberRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteUserGroupMemberRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupMemberRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteUserGroupMember(request, callback)

deleteUserGroupMember(request: protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupMemberRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupMemberRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteUserGroupMemberRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.marketingplatform.admin.v1alpha.IDeleteUserGroupMemberRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

findSalesPartnerManagedClients(request, options)

findSalesPartnerManagedClients(request?: protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsResponse,
        (protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest | undefined),
        {} | undefined
    ]>;

Returns a list of clients managed by the sales partner organization.

User needs to be an OrgAdmin/BillingAdmin on the sales partner organization in order to view the end clients.

Parameters
Name	Description
request	IFindSalesPartnerManagedClientsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsResponse, (protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 sales partner organization.
   *  Format: organizations/{org_id}
   */
  // const organization = 'abc123'
  /**
   *  Optional. If set, only active and just ended clients will be returned.
   */
  // const isActive = true

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

  async function callFindSalesPartnerManagedClients() {
    // Construct request
    const request = {
      organization,
    };

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

  callFindSalesPartnerManagedClients();

findSalesPartnerManagedClients(request, options, callback)

findSalesPartnerManagedClients(request: protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsResponse, protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IFindSalesPartnerManagedClientsRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsResponse, protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

findSalesPartnerManagedClients(request, callback)

findSalesPartnerManagedClients(request: protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsResponse, protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IFindSalesPartnerManagedClientsRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsResponse, protos.google.marketingplatform.admin.v1alpha.IFindSalesPartnerManagedClientsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getAdminAccessBinding(request, options)

getAdminAccessBinding(request?: protos.google.marketingplatform.admin.v1alpha.IGetAdminAccessBindingRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding,
        (protos.google.marketingplatform.admin.v1alpha.IGetAdminAccessBindingRequest | undefined),
        {} | undefined
    ]>;

Looks up a single admin access binding.

Parameters
Name	Description
request	IGetAdminAccessBindingRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, (protos.google.marketingplatform.admin.v1alpha.IGetAdminAccessBindingRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing AdminAccessBinding. Please see the documentation for more details and examples.

Example

  /**
   * 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 AdminAccessBinding to retrieve.
   *  Format:
   *  organizations/{org_id}/adminAccessBindings/{admin_access_binding_id}
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callGetAdminAccessBinding();

getAdminAccessBinding(request, options, callback)

getAdminAccessBinding(request: protos.google.marketingplatform.admin.v1alpha.IGetAdminAccessBindingRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.IGetAdminAccessBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetAdminAccessBindingRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.IGetAdminAccessBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getAdminAccessBinding(request, callback)

getAdminAccessBinding(request: protos.google.marketingplatform.admin.v1alpha.IGetAdminAccessBindingRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.IGetAdminAccessBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetAdminAccessBindingRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.IGetAdminAccessBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getOrganization(request, options)

getOrganization(request?: protos.google.marketingplatform.admin.v1alpha.IGetOrganizationRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IOrganization,
        (protos.google.marketingplatform.admin.v1alpha.IGetOrganizationRequest | undefined),
        {} | undefined
    ]>;

Looks up a single organization.

Parameters
Name	Description
request	IGetOrganizationRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IOrganization, (protos.google.marketingplatform.admin.v1alpha.IGetOrganizationRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Organization. Please see the documentation for more details and examples.

Example

  /**
   * 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 Organization to retrieve.
   *  Format: organizations/{org_id}
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callGetOrganization();

getOrganization(request, options, callback)

getOrganization(request: protos.google.marketingplatform.admin.v1alpha.IGetOrganizationRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IOrganization, protos.google.marketingplatform.admin.v1alpha.IGetOrganizationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetOrganizationRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IOrganization, protos.google.marketingplatform.admin.v1alpha.IGetOrganizationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getOrganization(request, callback)

getOrganization(request: protos.google.marketingplatform.admin.v1alpha.IGetOrganizationRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IOrganization, protos.google.marketingplatform.admin.v1alpha.IGetOrganizationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetOrganizationRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IOrganization, protos.google.marketingplatform.admin.v1alpha.IGetOrganizationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

getUserGroup(request, options)

getUserGroup(request?: protos.google.marketingplatform.admin.v1alpha.IGetUserGroupRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IUserGroup,
        (protos.google.marketingplatform.admin.v1alpha.IGetUserGroupRequest | undefined),
        {} | undefined
    ]>;

Looks up a single user group.

Parameters
Name	Description
request	IGetUserGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IUserGroup, (protos.google.marketingplatform.admin.v1alpha.IGetUserGroupRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserGroup. Please see the documentation for more details and examples.

Example

  /**
   * 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 UserGroup to retrieve.
   *  Format: organizations/{org_id}/userGroups/{user_group_id}
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callGetUserGroup();

getUserGroup(request, options, callback)

getUserGroup(request: protos.google.marketingplatform.admin.v1alpha.IGetUserGroupRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.IGetUserGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetUserGroupRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.IGetUserGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getUserGroup(request, callback)

getUserGroup(request: protos.google.marketingplatform.admin.v1alpha.IGetUserGroupRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.IGetUserGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetUserGroupRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.IGetUserGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getUserGroupMember(request, options)

getUserGroupMember(request?: protos.google.marketingplatform.admin.v1alpha.IGetUserGroupMemberRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IUserGroupMember,
        (protos.google.marketingplatform.admin.v1alpha.IGetUserGroupMemberRequest | undefined),
        {} | undefined
    ]>;

Looks up a single user group member.

Parameters
Name	Description
request	IGetUserGroupMemberRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, (protos.google.marketingplatform.admin.v1alpha.IGetUserGroupMemberRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 user group member to retrieve.
   *  Format:
   *  organizations/{org_id}/userGroups/{user_group_id}/members/{member_id}
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callGetUserGroupMember();

getUserGroupMember(request, options, callback)

getUserGroupMember(request: protos.google.marketingplatform.admin.v1alpha.IGetUserGroupMemberRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.IGetUserGroupMemberRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetUserGroupMemberRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.IGetUserGroupMemberRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getUserGroupMember(request, callback)

getUserGroupMember(request: protos.google.marketingplatform.admin.v1alpha.IGetUserGroupMemberRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.IGetUserGroupMemberRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetUserGroupMemberRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.IGetUserGroupMemberRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listAdminAccessBindings(request, options)

listAdminAccessBindings(request?: protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding[],
        protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest | null,
        protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsResponse
    ]>;

Returns a list of admin access bindings in the specified GMP organization.

Parameters
Name	Description
request	IListAdminAccessBindingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding[], protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest | null, protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of AdminAccessBinding. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAdminAccessBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAdminAccessBindings(request, options, callback)

listAdminAccessBindings(request: protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest, protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding>): void;

Parameters
Name	Description
request	IListAdminAccessBindingsRequest
options	CallOptions
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest, protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding>

Returns
Type	Description
void

listAdminAccessBindings(request, callback)

listAdminAccessBindings(request: protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest, protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding>): void;

Parameters
Name	Description
request	IListAdminAccessBindingsRequest
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest, protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding>

Returns
Type	Description
void

listAdminAccessBindingsAsync(request, options)

listAdminAccessBindingsAsync(request?: protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding>;

Equivalent to listAdminAccessBindings, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListAdminAccessBindingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AdminAccessBinding. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 parent organization, which owns this collection of Admin
   *  Access Bindings. Format: organizations/{org_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of Admin Access Bindings to return in one
   *  call. The service may return fewer than this value.
   *  If unspecified, at most 50 Admin Access Bindings will be returned. The
   *  maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous ListAdminAccessBindings
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListAdminAccessBindings` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callListAdminAccessBindings();

listAdminAccessBindingsStream(request, options)

listAdminAccessBindingsStream(request?: protos.google.marketingplatform.admin.v1alpha.IListAdminAccessBindingsRequest, options?: CallOptions): Transform;

Equivalent to listAdminAccessBindings, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAdminAccessBindingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing AdminAccessBinding on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAdminAccessBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAnalyticsAccountLinks(request, options)

listAnalyticsAccountLinks(request?: protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink[],
        protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest | null,
        protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksResponse
    ]>;

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

Parameters
Name	Description
request	IListAnalyticsAccountLinksRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink[], protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest | null, protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of AnalyticsAccountLink. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAnalyticsAccountLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAnalyticsAccountLinks(request, options, callback)

listAnalyticsAccountLinks(request: protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink>): void;

Parameters
Name	Description
request	IListAnalyticsAccountLinksRequest
options	CallOptions
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink>

Returns
Type	Description
void

listAnalyticsAccountLinks(request, callback)

listAnalyticsAccountLinks(request: protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink>): void;

Parameters
Name	Description
request	IListAnalyticsAccountLinksRequest
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink>

Returns
Type	Description
void

listAnalyticsAccountLinksAsync(request, options)

listAnalyticsAccountLinksAsync(request?: protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, options?: CallOptions): AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink>;

Equivalent to listAnalyticsAccountLinks, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListAnalyticsAccountLinksRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IAnalyticsAccountLink>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AnalyticsAccountLink. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 parent organization, which owns this collection of Analytics
   *  account links. Format: organizations/{org_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of Analytics account links to return in one
   *  call. The service may return fewer than this value.
   *  If unspecified, at most 50 Analytics account links will be returned. The
   *  maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous ListAnalyticsAccountLinks
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListAnalyticsAccountLinks` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callListAnalyticsAccountLinks();

listAnalyticsAccountLinksStream(request, options)

listAnalyticsAccountLinksStream(request?: protos.google.marketingplatform.admin.v1alpha.IListAnalyticsAccountLinksRequest, options?: CallOptions): Transform;

Equivalent to listAnalyticsAccountLinks, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAnalyticsAccountLinksRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing AnalyticsAccountLink on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAnalyticsAccountLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOrganizations(request, options)

listOrganizations(request?: protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IOrganization[],
        protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest | null,
        protos.google.marketingplatform.admin.v1alpha.IListOrganizationsResponse
    ]>;

Returns a list of organizations that the user has access to.

Parameters
Name	Description
request	IListOrganizationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IOrganization[], protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest | null, protos.google.marketingplatform.admin.v1alpha.IListOrganizationsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Organization. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listOrganizationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOrganizations(request, options, callback)

listOrganizations(request: protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, protos.google.marketingplatform.admin.v1alpha.IListOrganizationsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IOrganization>): void;

Parameters
Name	Description
request	IListOrganizationsRequest
options	CallOptions
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, protos.google.marketingplatform.admin.v1alpha.IListOrganizationsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IOrganization>

Returns
Type	Description
void

listOrganizations(request, callback)

listOrganizations(request: protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, protos.google.marketingplatform.admin.v1alpha.IListOrganizationsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IOrganization>): void;

Parameters
Name	Description
request	IListOrganizationsRequest
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, protos.google.marketingplatform.admin.v1alpha.IListOrganizationsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IOrganization>

Returns
Type	Description
void

listOrganizationsAsync(request, options)

listOrganizationsAsync(request?: protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, options?: CallOptions): AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IOrganization>;

Equivalent to listOrganizations, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListOrganizationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IOrganization>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Organization. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  Optional. The maximum number of organizations to return in one call. The
   *  service may return fewer than this value.
   *  If unspecified, at most 50 organizations will be returned. The
   *  maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous ListOrganizations call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListOrganizations` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

  async function callListOrganizations() {
    // Construct request
    const request = {
    };

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

  callListOrganizations();

listOrganizationsStream(request, options)

listOrganizationsStream(request?: protos.google.marketingplatform.admin.v1alpha.IListOrganizationsRequest, options?: CallOptions): Transform;

Equivalent to listOrganizations, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListOrganizationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing Organization on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listOrganizationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listUserGroupMembers(request, options)

listUserGroupMembers(request?: protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IUserGroupMember[],
        protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest | null,
        protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersResponse
    ]>;

Returns a list of members in the specified user group.

Parameters
Name	Description
request	IListUserGroupMembersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IUserGroupMember[], protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest | null, protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listUserGroupMembersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listUserGroupMembers(request, options, callback)

listUserGroupMembers(request: protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest, options: CallOptions, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest, protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IUserGroupMember>): void;

Parameters
Name	Description
request	IListUserGroupMembersRequest
options	CallOptions
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest, protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IUserGroupMember>

Returns
Type	Description
void

listUserGroupMembers(request, callback)

listUserGroupMembers(request: protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest, protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IUserGroupMember>): void;

Parameters
Name	Description
request	IListUserGroupMembersRequest
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest, protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IUserGroupMember>

Returns
Type	Description
void

listUserGroupMembersAsync(request, options)

listUserGroupMembersAsync(request?: protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest, options?: CallOptions): AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember>;

Equivalent to listUserGroupMembers, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListUserGroupMembersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 parent user group where this UserGroupMember will be listed.
   *  Format: organizations/{org_id}/userGroups/{user_group_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of user group members to return in one call.
   *  The service may return fewer than this value.
   *  If unspecified, at most 50 user group members will be returned. The
   *  maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous ListUserGroupMembers call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListUserGroupMembers` must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callListUserGroupMembers();

listUserGroupMembersStream(request, options)

listUserGroupMembersStream(request?: protos.google.marketingplatform.admin.v1alpha.IListUserGroupMembersRequest, options?: CallOptions): Transform;

Equivalent to listUserGroupMembers, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListUserGroupMembersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listUserGroupMembersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listUserGroups(request, options)

listUserGroups(request?: protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IUserGroup[],
        protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest | null,
        protos.google.marketingplatform.admin.v1alpha.IListUserGroupsResponse
    ]>;

Returns a list of user groups in the specified GMP organization.

Parameters
Name	Description
request	IListUserGroupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IUserGroup[], protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest | null, protos.google.marketingplatform.admin.v1alpha.IListUserGroupsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of UserGroup. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listUserGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listUserGroups(request, options, callback)

listUserGroups(request: protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest, protos.google.marketingplatform.admin.v1alpha.IListUserGroupsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IUserGroup>): void;

Parameters
Name	Description
request	IListUserGroupsRequest
options	CallOptions
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest, protos.google.marketingplatform.admin.v1alpha.IListUserGroupsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IUserGroup>

Returns
Type	Description
void

listUserGroups(request, callback)

listUserGroups(request: protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest, callback: PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest, protos.google.marketingplatform.admin.v1alpha.IListUserGroupsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IUserGroup>): void;

Parameters
Name	Description
request	IListUserGroupsRequest
callback	PaginationCallback<protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest, protos.google.marketingplatform.admin.v1alpha.IListUserGroupsResponse | null | undefined, protos.google.marketingplatform.admin.v1alpha.IUserGroup>

Returns
Type	Description
void

listUserGroupsAsync(request, options)

listUserGroupsAsync(request?: protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IUserGroup>;

Equivalent to listUserGroups, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListUserGroupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.marketingplatform.admin.v1alpha.IUserGroup>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing UserGroup. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 parent org where this UserGroup will be listed.
   *  Format: organizations/{org_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of user groups to return in one call. The
   *  service may return fewer than this value.
   *  If unspecified, at most 50 user groups will be returned. The maximum value
   *  is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous ListUserGroups call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListUserGroups` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

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

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

  callListUserGroups();

listUserGroupsStream(request, options)

listUserGroupsStream(request?: protos.google.marketingplatform.admin.v1alpha.IListUserGroupsRequest, options?: CallOptions): Transform;

Equivalent to listUserGroups, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListUserGroupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing UserGroup on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listUserGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAdminAccessBindingFromAdminAccessBindingName(adminAccessBindingName)

matchAdminAccessBindingFromAdminAccessBindingName(adminAccessBindingName: string): string | number;

Parse the admin_access_binding from AdminAccessBinding resource.

Parameter
Name	Description
adminAccessBindingName	string A fully-qualified path representing AdminAccessBinding resource.

Returns
Type	Description
string | number	{string} A string representing the admin_access_binding.

matchAnalyticsAccountLinkFromAnalyticsAccountLinkName(analyticsAccountLinkName)

matchAnalyticsAccountLinkFromAnalyticsAccountLinkName(analyticsAccountLinkName: string): string | number;

Parse the analytics_account_link from AnalyticsAccountLink resource.

Parameter
Name	Description
analyticsAccountLinkName	string A fully-qualified path representing AnalyticsAccountLink resource.

Returns
Type	Description
string | number	{string} A string representing the analytics_account_link.

matchMemberFromUserGroupMemberName(userGroupMemberName)

matchMemberFromUserGroupMemberName(userGroupMemberName: string): string | number;

Parse the member from UserGroupMember resource.

Parameter
Name	Description
userGroupMemberName	string A fully-qualified path representing UserGroupMember resource.

Returns
Type	Description
string | number	{string} A string representing the member.

matchOrganizationFromAdminAccessBindingName(adminAccessBindingName)

matchOrganizationFromAdminAccessBindingName(adminAccessBindingName: string): string | number;

Parse the organization from AdminAccessBinding resource.

Parameter
Name	Description
adminAccessBindingName	string A fully-qualified path representing AdminAccessBinding resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromAnalyticsAccountLinkName(analyticsAccountLinkName)

matchOrganizationFromAnalyticsAccountLinkName(analyticsAccountLinkName: string): string | number;

Parse the organization from AnalyticsAccountLink resource.

Parameter
Name	Description
analyticsAccountLinkName	string A fully-qualified path representing AnalyticsAccountLink resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationName(organizationName)

matchOrganizationFromOrganizationName(organizationName: string): string | number;

Parse the organization from Organization resource.

Parameter
Name	Description
organizationName	string A fully-qualified path representing Organization resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromUserGroupMemberName(userGroupMemberName)

matchOrganizationFromUserGroupMemberName(userGroupMemberName: string): string | number;

Parse the organization from UserGroupMember resource.

Parameter
Name	Description
userGroupMemberName	string A fully-qualified path representing UserGroupMember resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromUserGroupName(userGroupName)

matchOrganizationFromUserGroupName(userGroupName: string): string | number;

Parse the organization from UserGroup resource.

Parameter
Name	Description
userGroupName	string A fully-qualified path representing UserGroup resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchPropertyFromPropertyName(propertyName)

matchPropertyFromPropertyName(propertyName: string): string | number;

Parse the property from Property resource.

Parameter
Name	Description
propertyName	string A fully-qualified path representing Property resource.

Returns
Type	Description
string | number	{string} A string representing the property.

matchUserGroupFromUserGroupMemberName(userGroupMemberName)

matchUserGroupFromUserGroupMemberName(userGroupMemberName: string): string | number;

Parse the user_group from UserGroupMember resource.

Parameter
Name	Description
userGroupMemberName	string A fully-qualified path representing UserGroupMember resource.

Returns
Type	Description
string | number	{string} A string representing the user_group.

matchUserGroupFromUserGroupName(userGroupName)

matchUserGroupFromUserGroupName(userGroupName: string): string | number;

Parse the user_group from UserGroup resource.

Parameter
Name	Description
userGroupName	string A fully-qualified path representing UserGroup resource.

Returns
Type	Description
string | number	{string} A string representing the user_group.

organizationPath(organization)

organizationPath(organization: string): string;

Return a fully-qualified organization resource name string.

Parameter
Name	Description
organization	string

Returns
Type	Description
string	{string} Resource name string.

propertyPath(property)

propertyPath(property: string): string;

Return a fully-qualified property resource name string.

Parameter
Name	Description
property	string

Returns
Type	Description
string	{string} Resource name string.

reportPropertyUsage(request, options)

reportPropertyUsage(request?: protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageResponse,
        (protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest | undefined),
        {} | undefined
    ]>;

Gets the usage and billing data for properties within the organization for the specified month.

Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data.

Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.

Parameters
Name	Description
request	IReportPropertyUsageRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageResponse, (protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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. Specifies the organization whose property usage will be listed.
   *  Format: organizations/{org_id}
   */
  // const organization = 'abc123'
  /**
   *  Required. The target month to list property usages.
   *  Format: YYYY-MM. For example, "2025-05"
   */
  // const month = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

  async function callReportPropertyUsage() {
    // Construct request
    const request = {
      organization,
      month,
    };

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

  callReportPropertyUsage();

reportPropertyUsage(request, options, callback)

reportPropertyUsage(request: protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageResponse, protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IReportPropertyUsageRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageResponse, protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

reportPropertyUsage(request, callback)

reportPropertyUsage(request: protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageResponse, protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IReportPropertyUsageRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageResponse, protos.google.marketingplatform.admin.v1alpha.IReportPropertyUsageRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

setPropertyServiceLevel(request, options)

setPropertyServiceLevel(request?: protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelResponse,
        (protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest | undefined),
        {} | undefined
    ]>;

Updates the service level for an Analytics property.

Parameters
Name	Description
request	ISetPropertyServiceLevelRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelResponse, (protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing SetPropertyServiceLevelResponse. Please see the documentation for more details and examples.

Example

  /**
   * 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 parent AnalyticsAccountLink scope where this property is in.
   *  Format:
   *  organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}
   */
  // const analyticsAccountLink = 'abc123'
  /**
   *  Required. The Analytics property to change the ServiceLevel setting. This
   *  field is the name of the Google Analytics Admin API property resource.
   *  Format: analyticsadmin.googleapis.com/properties/{property_id}
   */
  // const analyticsProperty = 'abc123'
  /**
   *  Required. The service level to set for this property.
   */
  // const serviceLevel = {}

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

  async function callSetPropertyServiceLevel() {
    // Construct request
    const request = {
      analyticsAccountLink,
      analyticsProperty,
      serviceLevel,
    };

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

  callSetPropertyServiceLevel();

setPropertyServiceLevel(request, options, callback)

setPropertyServiceLevel(request: protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelResponse, protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetPropertyServiceLevelRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelResponse, protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

setPropertyServiceLevel(request, callback)

setPropertyServiceLevel(request: protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelResponse, protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetPropertyServiceLevelRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelResponse, protos.google.marketingplatform.admin.v1alpha.ISetPropertyServiceLevelRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateAdminAccessBinding(request, options)

updateAdminAccessBinding(request?: protos.google.marketingplatform.admin.v1alpha.IUpdateAdminAccessBindingRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding,
        (protos.google.marketingplatform.admin.v1alpha.IUpdateAdminAccessBindingRequest | undefined),
        {} | undefined
    ]>;

Updates an admin access binding in the specified GMP organization.

Parameters
Name	Description
request	IUpdateAdminAccessBindingRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, (protos.google.marketingplatform.admin.v1alpha.IUpdateAdminAccessBindingRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing AdminAccessBinding. Please see the documentation for more details and examples.

Example

  /**
   * 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 AdminAccessBinding to update.
   */
  // const adminAccessBinding = {}
  /**
   *  Required. The list of fields to update. Field names must be in snake case
   *  (for example, "field_to_update"). Omitted fields will not be updated. To
   *  replace the entire entity, use one path with the string "*" to match all
   *  fields.
   */
  // const updateMask = {}

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

  async function callUpdateAdminAccessBinding() {
    // Construct request
    const request = {
      adminAccessBinding,
      updateMask,
    };

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

  callUpdateAdminAccessBinding();

updateAdminAccessBinding(request, options, callback)

updateAdminAccessBinding(request: protos.google.marketingplatform.admin.v1alpha.IUpdateAdminAccessBindingRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.IUpdateAdminAccessBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateAdminAccessBindingRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.IUpdateAdminAccessBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateAdminAccessBinding(request, callback)

updateAdminAccessBinding(request: protos.google.marketingplatform.admin.v1alpha.IUpdateAdminAccessBindingRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.IUpdateAdminAccessBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateAdminAccessBindingRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IAdminAccessBinding, protos.google.marketingplatform.admin.v1alpha.IUpdateAdminAccessBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateUserGroup(request, options)

updateUserGroup(request?: protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IUserGroup,
        (protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupRequest | undefined),
        {} | undefined
    ]>;

Updates a user group in the specified GMP organization.

Parameters
Name	Description
request	IUpdateUserGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IUserGroup, (protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserGroup. Please see the documentation for more details and examples.

Example

  /**
   * 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 user group to update.
   */
  // const userGroup = {}
  /**
   *  Required. The list of fields to update. Field names must be in snake case
   *  (for example, "field_to_update"). Omitted fields will not be updated. To
   *  replace the entire entity, use one path with the string "*" to match all
   *  fields.
   */
  // const updateMask = {}

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

  async function callUpdateUserGroup() {
    // Construct request
    const request = {
      userGroup,
      updateMask,
    };

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

  callUpdateUserGroup();

updateUserGroup(request, options, callback)

updateUserGroup(request: protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateUserGroupRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateUserGroup(request, callback)

updateUserGroup(request: protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateUserGroupRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroup, protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateUserGroupMember(request, options)

updateUserGroupMember(request?: protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupMemberRequest, options?: CallOptions): Promise<[
        protos.google.marketingplatform.admin.v1alpha.IUserGroupMember,
        (protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupMemberRequest | undefined),
        {} | undefined
    ]>;

Updates a member in the specified GMP user group.

Parameters
Name	Description
request	IUpdateUserGroupMemberRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, (protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupMemberRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 user group member to update.
   */
  // const userGroupMember = {}
  /**
   *  Required. The list of fields to update. Field names must be in snake case
   *  (for example, "field_to_update"). Omitted fields will not be updated. To
   *  replace the entire entity, use one path with the string "*" to match all
   *  fields.
   */
  // const updateMask = {}

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} = require('@google-ads/marketing-platform-admin').v1alpha;

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

  async function callUpdateUserGroupMember() {
    // Construct request
    const request = {
      userGroupMember,
      updateMask,
    };

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

  callUpdateUserGroupMember();

updateUserGroupMember(request, options, callback)

updateUserGroupMember(request: protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupMemberRequest, options: CallOptions, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupMemberRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateUserGroupMemberRequest
options	CallOptions
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupMemberRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateUserGroupMember(request, callback)

updateUserGroupMember(request: protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupMemberRequest, callback: Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupMemberRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateUserGroupMemberRequest
callback	Callback<protos.google.marketingplatform.admin.v1alpha.IUserGroupMember, protos.google.marketingplatform.admin.v1alpha.IUpdateUserGroupMemberRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

userGroupMemberPath(organization, userGroup, member)

userGroupMemberPath(organization: string, userGroup: string, member: string): string;

Return a fully-qualified userGroupMember resource name string.

Parameters
Name	Description
organization	string
userGroup	string
member	string

Returns
Type	Description
string	{string} Resource name string.

userGroupPath(organization, userGroup)

userGroupPath(organization: string, userGroup: string): string;

Return a fully-qualified userGroup resource name string.

Parameters
Name	Description
organization	string
userGroup	string

Returns
Type	Description
string	{string} Resource name string.