Class MarketingplatformAdminServiceClient
MarketingplatformAdminService client wrapper, for convenient use.
Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha
Assembly: Google.Ads.MarketingPlatform.Admin.V1Alpha.dll
Syntax
public abstract class MarketingplatformAdminServiceClient
Remarks
Service Interface for the Google Marketing Platform Admin API.
Properties
DefaultEndpoint
The default endpoint for the MarketingplatformAdminService service, which is a host of "marketingplatformadmin.googleapis.com" and a port of 443.
Declaration
public static string DefaultEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| string |
DefaultScopes
The default MarketingplatformAdminService scopes.
Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<string> |
Remarks
The default MarketingplatformAdminService scopes are:
- https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
- https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
GrpcClient
The underlying gRPC MarketingplatformAdminService client
Declaration
public virtual MarketingplatformAdminService.MarketingplatformAdminServiceClient GrpcClient { get; }
Property Value
| Type | Description |
|---|---|
| MarketingplatformAdminService.MarketingplatformAdminServiceClient |
ServiceMetadata
The service metadata associated with this client type.
Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
| Type | Description |
|---|---|
| ServiceMetadata |
Methods
Create()
Synchronously creates a MarketingplatformAdminServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MarketingplatformAdminServiceClientBuilder.
Declaration
public static MarketingplatformAdminServiceClient Create()
Returns
| Type | Description |
|---|---|
| MarketingplatformAdminServiceClient | The created MarketingplatformAdminServiceClient. |
CreateAdminAccessBinding(CreateAdminAccessBindingRequest, CallSettings)
Creates an admin access binding in the specified GMP organization.
Declaration
public virtual AdminAccessBinding CreateAdminAccessBinding(CreateAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateAdminAccessBindingRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AdminAccessBinding | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
CreateAdminAccessBindingRequest request = new CreateAdminAccessBindingRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
AdminAccessBinding = new AdminAccessBinding(),
};
// Make the request
AdminAccessBinding response = marketingplatformAdminServiceClient.CreateAdminAccessBinding(request);
CreateAdminAccessBinding(OrganizationName, AdminAccessBinding, CallSettings)
Creates an admin access binding in the specified GMP organization.
Declaration
public virtual AdminAccessBinding CreateAdminAccessBinding(OrganizationName parent, AdminAccessBinding adminAccessBinding, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent organization, which owns this Admin Access Binding. Format: organizations/{org_id} |
| AdminAccessBinding | adminAccessBinding | Required. The Admin Access Binding to create. Only 'user_email' input is allowed. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AdminAccessBinding | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
AdminAccessBinding adminAccessBinding = new AdminAccessBinding();
// Make the request
AdminAccessBinding response = marketingplatformAdminServiceClient.CreateAdminAccessBinding(parent, adminAccessBinding);
CreateAdminAccessBinding(string, AdminAccessBinding, CallSettings)
Creates an admin access binding in the specified GMP organization.
Declaration
public virtual AdminAccessBinding CreateAdminAccessBinding(string parent, AdminAccessBinding adminAccessBinding, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent organization, which owns this Admin Access Binding. Format: organizations/{org_id} |
| AdminAccessBinding | adminAccessBinding | Required. The Admin Access Binding to create. Only 'user_email' input is allowed. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AdminAccessBinding | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
AdminAccessBinding adminAccessBinding = new AdminAccessBinding();
// Make the request
AdminAccessBinding response = marketingplatformAdminServiceClient.CreateAdminAccessBinding(parent, adminAccessBinding);
CreateAdminAccessBindingAsync(CreateAdminAccessBindingRequest, CallSettings)
Creates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> CreateAdminAccessBindingAsync(CreateAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateAdminAccessBindingRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAdminAccessBindingRequest request = new CreateAdminAccessBindingRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
AdminAccessBinding = new AdminAccessBinding(),
};
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.CreateAdminAccessBindingAsync(request);
CreateAdminAccessBindingAsync(CreateAdminAccessBindingRequest, CancellationToken)
Creates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> CreateAdminAccessBindingAsync(CreateAdminAccessBindingRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateAdminAccessBindingRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAdminAccessBindingRequest request = new CreateAdminAccessBindingRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
AdminAccessBinding = new AdminAccessBinding(),
};
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.CreateAdminAccessBindingAsync(request);
CreateAdminAccessBindingAsync(OrganizationName, AdminAccessBinding, CallSettings)
Creates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> CreateAdminAccessBindingAsync(OrganizationName parent, AdminAccessBinding adminAccessBinding, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent organization, which owns this Admin Access Binding. Format: organizations/{org_id} |
| AdminAccessBinding | adminAccessBinding | Required. The Admin Access Binding to create. Only 'user_email' input is allowed. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
AdminAccessBinding adminAccessBinding = new AdminAccessBinding();
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.CreateAdminAccessBindingAsync(parent, adminAccessBinding);
CreateAdminAccessBindingAsync(OrganizationName, AdminAccessBinding, CancellationToken)
Creates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> CreateAdminAccessBindingAsync(OrganizationName parent, AdminAccessBinding adminAccessBinding, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent organization, which owns this Admin Access Binding. Format: organizations/{org_id} |
| AdminAccessBinding | adminAccessBinding | Required. The Admin Access Binding to create. Only 'user_email' input is allowed. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
AdminAccessBinding adminAccessBinding = new AdminAccessBinding();
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.CreateAdminAccessBindingAsync(parent, adminAccessBinding);
CreateAdminAccessBindingAsync(string, AdminAccessBinding, CallSettings)
Creates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> CreateAdminAccessBindingAsync(string parent, AdminAccessBinding adminAccessBinding, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent organization, which owns this Admin Access Binding. Format: organizations/{org_id} |
| AdminAccessBinding | adminAccessBinding | Required. The Admin Access Binding to create. Only 'user_email' input is allowed. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
AdminAccessBinding adminAccessBinding = new AdminAccessBinding();
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.CreateAdminAccessBindingAsync(parent, adminAccessBinding);
CreateAdminAccessBindingAsync(string, AdminAccessBinding, CancellationToken)
Creates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> CreateAdminAccessBindingAsync(string parent, AdminAccessBinding adminAccessBinding, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent organization, which owns this Admin Access Binding. Format: organizations/{org_id} |
| AdminAccessBinding | adminAccessBinding | Required. The Admin Access Binding to create. Only 'user_email' input is allowed. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
AdminAccessBinding adminAccessBinding = new AdminAccessBinding();
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.CreateAdminAccessBindingAsync(parent, adminAccessBinding);
CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest, CallSettings)
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.
Declaration
public virtual AnalyticsAccountLink CreateAnalyticsAccountLink(CreateAnalyticsAccountLinkRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateAnalyticsAccountLinkRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AnalyticsAccountLink | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
CreateAnalyticsAccountLinkRequest request = new CreateAnalyticsAccountLinkRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
AnalyticsAccountLink = new AnalyticsAccountLink(),
};
// Make the request
AnalyticsAccountLink response = marketingplatformAdminServiceClient.CreateAnalyticsAccountLink(request);
CreateAnalyticsAccountLink(OrganizationName, AnalyticsAccountLink, CallSettings)
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.
Declaration
public virtual AnalyticsAccountLink CreateAnalyticsAccountLink(OrganizationName parent, AnalyticsAccountLink analyticsAccountLink, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id} |
| AnalyticsAccountLink | analyticsAccountLink | Required. The Analytics account link to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AnalyticsAccountLink | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
AnalyticsAccountLink analyticsAccountLink = new AnalyticsAccountLink();
// Make the request
AnalyticsAccountLink response = marketingplatformAdminServiceClient.CreateAnalyticsAccountLink(parent, analyticsAccountLink);
CreateAnalyticsAccountLink(string, AnalyticsAccountLink, CallSettings)
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.
Declaration
public virtual AnalyticsAccountLink CreateAnalyticsAccountLink(string parent, AnalyticsAccountLink analyticsAccountLink, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id} |
| AnalyticsAccountLink | analyticsAccountLink | Required. The Analytics account link to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AnalyticsAccountLink | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
AnalyticsAccountLink analyticsAccountLink = new AnalyticsAccountLink();
// Make the request
AnalyticsAccountLink response = marketingplatformAdminServiceClient.CreateAnalyticsAccountLink(parent, analyticsAccountLink);
CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest, CallSettings)
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.
Declaration
public virtual Task<AnalyticsAccountLink> CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateAnalyticsAccountLinkRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AnalyticsAccountLink> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAnalyticsAccountLinkRequest request = new CreateAnalyticsAccountLinkRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
AnalyticsAccountLink = new AnalyticsAccountLink(),
};
// Make the request
AnalyticsAccountLink response = await marketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(request);
CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest, CancellationToken)
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.
Declaration
public virtual Task<AnalyticsAccountLink> CreateAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateAnalyticsAccountLinkRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AnalyticsAccountLink> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAnalyticsAccountLinkRequest request = new CreateAnalyticsAccountLinkRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
AnalyticsAccountLink = new AnalyticsAccountLink(),
};
// Make the request
AnalyticsAccountLink response = await marketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(request);
CreateAnalyticsAccountLinkAsync(OrganizationName, AnalyticsAccountLink, CallSettings)
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.
Declaration
public virtual Task<AnalyticsAccountLink> CreateAnalyticsAccountLinkAsync(OrganizationName parent, AnalyticsAccountLink analyticsAccountLink, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id} |
| AnalyticsAccountLink | analyticsAccountLink | Required. The Analytics account link to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AnalyticsAccountLink> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
AnalyticsAccountLink analyticsAccountLink = new AnalyticsAccountLink();
// Make the request
AnalyticsAccountLink response = await marketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(parent, analyticsAccountLink);
CreateAnalyticsAccountLinkAsync(OrganizationName, AnalyticsAccountLink, CancellationToken)
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.
Declaration
public virtual Task<AnalyticsAccountLink> CreateAnalyticsAccountLinkAsync(OrganizationName parent, AnalyticsAccountLink analyticsAccountLink, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id} |
| AnalyticsAccountLink | analyticsAccountLink | Required. The Analytics account link to create. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AnalyticsAccountLink> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
AnalyticsAccountLink analyticsAccountLink = new AnalyticsAccountLink();
// Make the request
AnalyticsAccountLink response = await marketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(parent, analyticsAccountLink);
CreateAnalyticsAccountLinkAsync(string, AnalyticsAccountLink, CallSettings)
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.
Declaration
public virtual Task<AnalyticsAccountLink> CreateAnalyticsAccountLinkAsync(string parent, AnalyticsAccountLink analyticsAccountLink, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id} |
| AnalyticsAccountLink | analyticsAccountLink | Required. The Analytics account link to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AnalyticsAccountLink> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
AnalyticsAccountLink analyticsAccountLink = new AnalyticsAccountLink();
// Make the request
AnalyticsAccountLink response = await marketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(parent, analyticsAccountLink);
CreateAnalyticsAccountLinkAsync(string, AnalyticsAccountLink, CancellationToken)
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.
Declaration
public virtual Task<AnalyticsAccountLink> CreateAnalyticsAccountLinkAsync(string parent, AnalyticsAccountLink analyticsAccountLink, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id} |
| AnalyticsAccountLink | analyticsAccountLink | Required. The Analytics account link to create. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AnalyticsAccountLink> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
AnalyticsAccountLink analyticsAccountLink = new AnalyticsAccountLink();
// Make the request
AnalyticsAccountLink response = await marketingplatformAdminServiceClient.CreateAnalyticsAccountLinkAsync(parent, analyticsAccountLink);
CreateAsync(CancellationToken)
Asynchronously creates a MarketingplatformAdminServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MarketingplatformAdminServiceClientBuilder.
Declaration
public static Task<MarketingplatformAdminServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | The CancellationToken to use while creating the client. |
Returns
| Type | Description |
|---|---|
| Task<MarketingplatformAdminServiceClient> | The task representing the created MarketingplatformAdminServiceClient. |
CreateUserGroup(CreateUserGroupRequest, CallSettings)
Creates a user group in the specified GMP organization.
Declaration
public virtual UserGroup CreateUserGroup(CreateUserGroupRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroup | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
CreateUserGroupRequest request = new CreateUserGroupRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
UserGroup = new UserGroup(),
};
// Make the request
UserGroup response = marketingplatformAdminServiceClient.CreateUserGroup(request);
CreateUserGroup(OrganizationName, UserGroup, CallSettings)
Creates a user group in the specified GMP organization.
Declaration
public virtual UserGroup CreateUserGroup(OrganizationName parent, UserGroup userGroup, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent resource where this UserGroup will be created. Format: organizations/{org_id} |
| UserGroup | userGroup | Required. The user group to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroup | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
UserGroup userGroup = new UserGroup();
// Make the request
UserGroup response = marketingplatformAdminServiceClient.CreateUserGroup(parent, userGroup);
CreateUserGroup(string, UserGroup, CallSettings)
Creates a user group in the specified GMP organization.
Declaration
public virtual UserGroup CreateUserGroup(string parent, UserGroup userGroup, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this UserGroup will be created. Format: organizations/{org_id} |
| UserGroup | userGroup | Required. The user group to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroup | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
UserGroup userGroup = new UserGroup();
// Make the request
UserGroup response = marketingplatformAdminServiceClient.CreateUserGroup(parent, userGroup);
CreateUserGroupAsync(CreateUserGroupRequest, CallSettings)
Creates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> CreateUserGroupAsync(CreateUserGroupRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUserGroupRequest request = new CreateUserGroupRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
UserGroup = new UserGroup(),
};
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.CreateUserGroupAsync(request);
CreateUserGroupAsync(CreateUserGroupRequest, CancellationToken)
Creates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> CreateUserGroupAsync(CreateUserGroupRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUserGroupRequest request = new CreateUserGroupRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
UserGroup = new UserGroup(),
};
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.CreateUserGroupAsync(request);
CreateUserGroupAsync(OrganizationName, UserGroup, CallSettings)
Creates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> CreateUserGroupAsync(OrganizationName parent, UserGroup userGroup, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent resource where this UserGroup will be created. Format: organizations/{org_id} |
| UserGroup | userGroup | Required. The user group to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
UserGroup userGroup = new UserGroup();
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.CreateUserGroupAsync(parent, userGroup);
CreateUserGroupAsync(OrganizationName, UserGroup, CancellationToken)
Creates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> CreateUserGroupAsync(OrganizationName parent, UserGroup userGroup, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent resource where this UserGroup will be created. Format: organizations/{org_id} |
| UserGroup | userGroup | Required. The user group to create. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
UserGroup userGroup = new UserGroup();
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.CreateUserGroupAsync(parent, userGroup);
CreateUserGroupAsync(string, UserGroup, CallSettings)
Creates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> CreateUserGroupAsync(string parent, UserGroup userGroup, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this UserGroup will be created. Format: organizations/{org_id} |
| UserGroup | userGroup | Required. The user group to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
UserGroup userGroup = new UserGroup();
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.CreateUserGroupAsync(parent, userGroup);
CreateUserGroupAsync(string, UserGroup, CancellationToken)
Creates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> CreateUserGroupAsync(string parent, UserGroup userGroup, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this UserGroup will be created. Format: organizations/{org_id} |
| UserGroup | userGroup | Required. The user group to create. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
UserGroup userGroup = new UserGroup();
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.CreateUserGroupAsync(parent, userGroup);
CreateUserGroupMember(CreateUserGroupMemberRequest, CallSettings)
Adds a member to the specified GMP user group.
Declaration
public virtual UserGroupMember CreateUserGroupMember(CreateUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroupMember | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
CreateUserGroupMemberRequest request = new CreateUserGroupMemberRequest
{
ParentAsUserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
UserGroupMember = new UserGroupMember(),
};
// Make the request
UserGroupMember response = marketingplatformAdminServiceClient.CreateUserGroupMember(request);
CreateUserGroupMember(UserGroupName, UserGroupMember, CallSettings)
Adds a member to the specified GMP user group.
Declaration
public virtual UserGroupMember CreateUserGroupMember(UserGroupName parent, UserGroupMember userGroupMember, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | parent | Required. The parent resource where this UserGroupMember will be created. Format: organizations/{org_id}/userGroups/{user_group_id} |
| UserGroupMember | userGroupMember | Required. The user group member to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroupMember | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UserGroupName parent = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
UserGroupMember userGroupMember = new UserGroupMember();
// Make the request
UserGroupMember response = marketingplatformAdminServiceClient.CreateUserGroupMember(parent, userGroupMember);
CreateUserGroupMember(string, UserGroupMember, CallSettings)
Adds a member to the specified GMP user group.
Declaration
public virtual UserGroupMember CreateUserGroupMember(string parent, UserGroupMember userGroupMember, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this UserGroupMember will be created. Format: organizations/{org_id}/userGroups/{user_group_id} |
| UserGroupMember | userGroupMember | Required. The user group member to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroupMember | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
UserGroupMember userGroupMember = new UserGroupMember();
// Make the request
UserGroupMember response = marketingplatformAdminServiceClient.CreateUserGroupMember(parent, userGroupMember);
CreateUserGroupMemberAsync(CreateUserGroupMemberRequest, CallSettings)
Adds a member to the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> CreateUserGroupMemberAsync(CreateUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUserGroupMemberRequest request = new CreateUserGroupMemberRequest
{
ParentAsUserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
UserGroupMember = new UserGroupMember(),
};
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.CreateUserGroupMemberAsync(request);
CreateUserGroupMemberAsync(CreateUserGroupMemberRequest, CancellationToken)
Adds a member to the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> CreateUserGroupMemberAsync(CreateUserGroupMemberRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUserGroupMemberRequest request = new CreateUserGroupMemberRequest
{
ParentAsUserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
UserGroupMember = new UserGroupMember(),
};
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.CreateUserGroupMemberAsync(request);
CreateUserGroupMemberAsync(UserGroupName, UserGroupMember, CallSettings)
Adds a member to the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> CreateUserGroupMemberAsync(UserGroupName parent, UserGroupMember userGroupMember, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | parent | Required. The parent resource where this UserGroupMember will be created. Format: organizations/{org_id}/userGroups/{user_group_id} |
| UserGroupMember | userGroupMember | Required. The user group member to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupName parent = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
UserGroupMember userGroupMember = new UserGroupMember();
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.CreateUserGroupMemberAsync(parent, userGroupMember);
CreateUserGroupMemberAsync(UserGroupName, UserGroupMember, CancellationToken)
Adds a member to the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> CreateUserGroupMemberAsync(UserGroupName parent, UserGroupMember userGroupMember, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | parent | Required. The parent resource where this UserGroupMember will be created. Format: organizations/{org_id}/userGroups/{user_group_id} |
| UserGroupMember | userGroupMember | Required. The user group member to create. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupName parent = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
UserGroupMember userGroupMember = new UserGroupMember();
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.CreateUserGroupMemberAsync(parent, userGroupMember);
CreateUserGroupMemberAsync(string, UserGroupMember, CallSettings)
Adds a member to the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> CreateUserGroupMemberAsync(string parent, UserGroupMember userGroupMember, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this UserGroupMember will be created. Format: organizations/{org_id}/userGroups/{user_group_id} |
| UserGroupMember | userGroupMember | Required. The user group member to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
UserGroupMember userGroupMember = new UserGroupMember();
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.CreateUserGroupMemberAsync(parent, userGroupMember);
CreateUserGroupMemberAsync(string, UserGroupMember, CancellationToken)
Adds a member to the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> CreateUserGroupMemberAsync(string parent, UserGroupMember userGroupMember, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this UserGroupMember will be created. Format: organizations/{org_id}/userGroups/{user_group_id} |
| UserGroupMember | userGroupMember | Required. The user group member to create. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
UserGroupMember userGroupMember = new UserGroupMember();
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.CreateUserGroupMemberAsync(parent, userGroupMember);
DeleteAnalyticsAccountLink(AnalyticsAccountLinkName, CallSettings)
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.
Declaration
public virtual void DeleteAnalyticsAccountLink(AnalyticsAccountLinkName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyticsAccountLinkName | name | Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
AnalyticsAccountLinkName name = AnalyticsAccountLinkName.FromOrganizationAnalyticsAccountLink("[ORGANIZATION]", "[ANALYTICS_ACCOUNT_LINK]");
// Make the request
marketingplatformAdminServiceClient.DeleteAnalyticsAccountLink(name);
DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest, CallSettings)
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.
Declaration
public virtual void DeleteAnalyticsAccountLink(DeleteAnalyticsAccountLinkRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteAnalyticsAccountLinkRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
DeleteAnalyticsAccountLinkRequest request = new DeleteAnalyticsAccountLinkRequest
{
AnalyticsAccountLinkName = AnalyticsAccountLinkName.FromOrganizationAnalyticsAccountLink("[ORGANIZATION]", "[ANALYTICS_ACCOUNT_LINK]"),
};
// Make the request
marketingplatformAdminServiceClient.DeleteAnalyticsAccountLink(request);
DeleteAnalyticsAccountLink(string, CallSettings)
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.
Declaration
public virtual void DeleteAnalyticsAccountLink(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/analyticsAccountLinks/[ANALYTICS_ACCOUNT_LINK]";
// Make the request
marketingplatformAdminServiceClient.DeleteAnalyticsAccountLink(name);
DeleteAnalyticsAccountLinkAsync(AnalyticsAccountLinkName, CallSettings)
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.
Declaration
public virtual Task DeleteAnalyticsAccountLinkAsync(AnalyticsAccountLinkName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyticsAccountLinkName | name | Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
AnalyticsAccountLinkName name = AnalyticsAccountLinkName.FromOrganizationAnalyticsAccountLink("[ORGANIZATION]", "[ANALYTICS_ACCOUNT_LINK]");
// Make the request
await marketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(name);
DeleteAnalyticsAccountLinkAsync(AnalyticsAccountLinkName, CancellationToken)
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.
Declaration
public virtual Task DeleteAnalyticsAccountLinkAsync(AnalyticsAccountLinkName name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyticsAccountLinkName | name | Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
AnalyticsAccountLinkName name = AnalyticsAccountLinkName.FromOrganizationAnalyticsAccountLink("[ORGANIZATION]", "[ANALYTICS_ACCOUNT_LINK]");
// Make the request
await marketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(name);
DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest, CallSettings)
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.
Declaration
public virtual Task DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteAnalyticsAccountLinkRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAnalyticsAccountLinkRequest request = new DeleteAnalyticsAccountLinkRequest
{
AnalyticsAccountLinkName = AnalyticsAccountLinkName.FromOrganizationAnalyticsAccountLink("[ORGANIZATION]", "[ANALYTICS_ACCOUNT_LINK]"),
};
// Make the request
await marketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(request);
DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest, CancellationToken)
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.
Declaration
public virtual Task DeleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteAnalyticsAccountLinkRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAnalyticsAccountLinkRequest request = new DeleteAnalyticsAccountLinkRequest
{
AnalyticsAccountLinkName = AnalyticsAccountLinkName.FromOrganizationAnalyticsAccountLink("[ORGANIZATION]", "[ANALYTICS_ACCOUNT_LINK]"),
};
// Make the request
await marketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(request);
DeleteAnalyticsAccountLinkAsync(string, CallSettings)
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.
Declaration
public virtual Task DeleteAnalyticsAccountLinkAsync(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/analyticsAccountLinks/[ANALYTICS_ACCOUNT_LINK]";
// Make the request
await marketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(name);
DeleteAnalyticsAccountLinkAsync(string, CancellationToken)
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.
Declaration
public virtual Task DeleteAnalyticsAccountLinkAsync(string name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/analyticsAccountLinks/[ANALYTICS_ACCOUNT_LINK]";
// Make the request
await marketingplatformAdminServiceClient.DeleteAnalyticsAccountLinkAsync(name);
DeleteUserGroup(DeleteUserGroupRequest, CallSettings)
Deletes a user group in the specified GMP organization.
Declaration
public virtual void DeleteUserGroup(DeleteUserGroupRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
DeleteUserGroupRequest request = new DeleteUserGroupRequest
{
UserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
};
// Make the request
marketingplatformAdminServiceClient.DeleteUserGroup(request);
DeleteUserGroup(UserGroupName, CallSettings)
Deletes a user group in the specified GMP organization.
Declaration
public virtual void DeleteUserGroup(UserGroupName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | name | Required. The name of the user group to delete. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UserGroupName name = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
// Make the request
marketingplatformAdminServiceClient.DeleteUserGroup(name);
DeleteUserGroup(string, CallSettings)
Deletes a user group in the specified GMP organization.
Declaration
public virtual void DeleteUserGroup(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the user group to delete. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
// Make the request
marketingplatformAdminServiceClient.DeleteUserGroup(name);
DeleteUserGroupAsync(DeleteUserGroupRequest, CallSettings)
Deletes a user group in the specified GMP organization.
Declaration
public virtual Task DeleteUserGroupAsync(DeleteUserGroupRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteUserGroupRequest request = new DeleteUserGroupRequest
{
UserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
};
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupAsync(request);
DeleteUserGroupAsync(DeleteUserGroupRequest, CancellationToken)
Deletes a user group in the specified GMP organization.
Declaration
public virtual Task DeleteUserGroupAsync(DeleteUserGroupRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteUserGroupRequest request = new DeleteUserGroupRequest
{
UserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
};
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupAsync(request);
DeleteUserGroupAsync(UserGroupName, CallSettings)
Deletes a user group in the specified GMP organization.
Declaration
public virtual Task DeleteUserGroupAsync(UserGroupName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | name | Required. The name of the user group to delete. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupName name = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupAsync(name);
DeleteUserGroupAsync(UserGroupName, CancellationToken)
Deletes a user group in the specified GMP organization.
Declaration
public virtual Task DeleteUserGroupAsync(UserGroupName name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | name | Required. The name of the user group to delete. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupName name = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupAsync(name);
DeleteUserGroupAsync(string, CallSettings)
Deletes a user group in the specified GMP organization.
Declaration
public virtual Task DeleteUserGroupAsync(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the user group to delete. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupAsync(name);
DeleteUserGroupAsync(string, CancellationToken)
Deletes a user group in the specified GMP organization.
Declaration
public virtual Task DeleteUserGroupAsync(string name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the user group to delete. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupAsync(name);
DeleteUserGroupMember(DeleteUserGroupMemberRequest, CallSettings)
Deletes a member in the specified GMP user group.
Declaration
public virtual void DeleteUserGroupMember(DeleteUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
DeleteUserGroupMemberRequest request = new DeleteUserGroupMemberRequest
{
UserGroupMemberName = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]"),
};
// Make the request
marketingplatformAdminServiceClient.DeleteUserGroupMember(request);
DeleteUserGroupMember(UserGroupMemberName, CallSettings)
Deletes a member in the specified GMP user group.
Declaration
public virtual void DeleteUserGroupMember(UserGroupMemberName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupMemberName | name | Required. The name of the user group member to delete. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UserGroupMemberName name = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]");
// Make the request
marketingplatformAdminServiceClient.DeleteUserGroupMember(name);
DeleteUserGroupMember(string, CallSettings)
Deletes a member in the specified GMP user group.
Declaration
public virtual void DeleteUserGroupMember(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the user group member to delete. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]/members/[MEMBER]";
// Make the request
marketingplatformAdminServiceClient.DeleteUserGroupMember(name);
DeleteUserGroupMemberAsync(DeleteUserGroupMemberRequest, CallSettings)
Deletes a member in the specified GMP user group.
Declaration
public virtual Task DeleteUserGroupMemberAsync(DeleteUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteUserGroupMemberRequest request = new DeleteUserGroupMemberRequest
{
UserGroupMemberName = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]"),
};
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupMemberAsync(request);
DeleteUserGroupMemberAsync(DeleteUserGroupMemberRequest, CancellationToken)
Deletes a member in the specified GMP user group.
Declaration
public virtual Task DeleteUserGroupMemberAsync(DeleteUserGroupMemberRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteUserGroupMemberRequest request = new DeleteUserGroupMemberRequest
{
UserGroupMemberName = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]"),
};
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupMemberAsync(request);
DeleteUserGroupMemberAsync(UserGroupMemberName, CallSettings)
Deletes a member in the specified GMP user group.
Declaration
public virtual Task DeleteUserGroupMemberAsync(UserGroupMemberName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupMemberName | name | Required. The name of the user group member to delete. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupMemberName name = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]");
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupMemberAsync(name);
DeleteUserGroupMemberAsync(UserGroupMemberName, CancellationToken)
Deletes a member in the specified GMP user group.
Declaration
public virtual Task DeleteUserGroupMemberAsync(UserGroupMemberName name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupMemberName | name | Required. The name of the user group member to delete. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupMemberName name = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]");
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupMemberAsync(name);
DeleteUserGroupMemberAsync(string, CallSettings)
Deletes a member in the specified GMP user group.
Declaration
public virtual Task DeleteUserGroupMemberAsync(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the user group member to delete. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]/members/[MEMBER]";
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupMemberAsync(name);
DeleteUserGroupMemberAsync(string, CancellationToken)
Deletes a member in the specified GMP user group.
Declaration
public virtual Task DeleteUserGroupMemberAsync(string name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the user group member to delete. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]/members/[MEMBER]";
// Make the request
await marketingplatformAdminServiceClient.DeleteUserGroupMemberAsync(name);
FindSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest, CallSettings)
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.
Declaration
public virtual FindSalesPartnerManagedClientsResponse FindSalesPartnerManagedClients(FindSalesPartnerManagedClientsRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| FindSalesPartnerManagedClientsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| FindSalesPartnerManagedClientsResponse | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
FindSalesPartnerManagedClientsRequest request = new FindSalesPartnerManagedClientsRequest
{
OrganizationAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
IsActive = false,
};
// Make the request
FindSalesPartnerManagedClientsResponse response = marketingplatformAdminServiceClient.FindSalesPartnerManagedClients(request);
FindSalesPartnerManagedClientsAsync(FindSalesPartnerManagedClientsRequest, CallSettings)
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.
Declaration
public virtual Task<FindSalesPartnerManagedClientsResponse> FindSalesPartnerManagedClientsAsync(FindSalesPartnerManagedClientsRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| FindSalesPartnerManagedClientsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<FindSalesPartnerManagedClientsResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
FindSalesPartnerManagedClientsRequest request = new FindSalesPartnerManagedClientsRequest
{
OrganizationAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
IsActive = false,
};
// Make the request
FindSalesPartnerManagedClientsResponse response = await marketingplatformAdminServiceClient.FindSalesPartnerManagedClientsAsync(request);
FindSalesPartnerManagedClientsAsync(FindSalesPartnerManagedClientsRequest, CancellationToken)
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.
Declaration
public virtual Task<FindSalesPartnerManagedClientsResponse> FindSalesPartnerManagedClientsAsync(FindSalesPartnerManagedClientsRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| FindSalesPartnerManagedClientsRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<FindSalesPartnerManagedClientsResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
FindSalesPartnerManagedClientsRequest request = new FindSalesPartnerManagedClientsRequest
{
OrganizationAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
IsActive = false,
};
// Make the request
FindSalesPartnerManagedClientsResponse response = await marketingplatformAdminServiceClient.FindSalesPartnerManagedClientsAsync(request);
GetAdminAccessBinding(AdminAccessBindingName, CallSettings)
Looks up a single admin access binding.
Declaration
public virtual AdminAccessBinding GetAdminAccessBinding(AdminAccessBindingName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AdminAccessBindingName | name | Required. The name of the AdminAccessBinding to retrieve. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AdminAccessBinding | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
AdminAccessBindingName name = AdminAccessBindingName.FromOrganizationAdminAccessBinding("[ORGANIZATION]", "[ADMIN_ACCESS_BINDING]");
// Make the request
AdminAccessBinding response = marketingplatformAdminServiceClient.GetAdminAccessBinding(name);
GetAdminAccessBinding(GetAdminAccessBindingRequest, CallSettings)
Looks up a single admin access binding.
Declaration
public virtual AdminAccessBinding GetAdminAccessBinding(GetAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetAdminAccessBindingRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AdminAccessBinding | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
GetAdminAccessBindingRequest request = new GetAdminAccessBindingRequest
{
AdminAccessBindingName = AdminAccessBindingName.FromOrganizationAdminAccessBinding("[ORGANIZATION]", "[ADMIN_ACCESS_BINDING]"),
};
// Make the request
AdminAccessBinding response = marketingplatformAdminServiceClient.GetAdminAccessBinding(request);
GetAdminAccessBinding(string, CallSettings)
Looks up a single admin access binding.
Declaration
public virtual AdminAccessBinding GetAdminAccessBinding(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the AdminAccessBinding to retrieve. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AdminAccessBinding | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/adminAccessBindings/[ADMIN_ACCESS_BINDING]";
// Make the request
AdminAccessBinding response = marketingplatformAdminServiceClient.GetAdminAccessBinding(name);
GetAdminAccessBindingAsync(AdminAccessBindingName, CallSettings)
Looks up a single admin access binding.
Declaration
public virtual Task<AdminAccessBinding> GetAdminAccessBindingAsync(AdminAccessBindingName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AdminAccessBindingName | name | Required. The name of the AdminAccessBinding to retrieve. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
AdminAccessBindingName name = AdminAccessBindingName.FromOrganizationAdminAccessBinding("[ORGANIZATION]", "[ADMIN_ACCESS_BINDING]");
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.GetAdminAccessBindingAsync(name);
GetAdminAccessBindingAsync(AdminAccessBindingName, CancellationToken)
Looks up a single admin access binding.
Declaration
public virtual Task<AdminAccessBinding> GetAdminAccessBindingAsync(AdminAccessBindingName name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| AdminAccessBindingName | name | Required. The name of the AdminAccessBinding to retrieve. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
AdminAccessBindingName name = AdminAccessBindingName.FromOrganizationAdminAccessBinding("[ORGANIZATION]", "[ADMIN_ACCESS_BINDING]");
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.GetAdminAccessBindingAsync(name);
GetAdminAccessBindingAsync(GetAdminAccessBindingRequest, CallSettings)
Looks up a single admin access binding.
Declaration
public virtual Task<AdminAccessBinding> GetAdminAccessBindingAsync(GetAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetAdminAccessBindingRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetAdminAccessBindingRequest request = new GetAdminAccessBindingRequest
{
AdminAccessBindingName = AdminAccessBindingName.FromOrganizationAdminAccessBinding("[ORGANIZATION]", "[ADMIN_ACCESS_BINDING]"),
};
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.GetAdminAccessBindingAsync(request);
GetAdminAccessBindingAsync(GetAdminAccessBindingRequest, CancellationToken)
Looks up a single admin access binding.
Declaration
public virtual Task<AdminAccessBinding> GetAdminAccessBindingAsync(GetAdminAccessBindingRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| GetAdminAccessBindingRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetAdminAccessBindingRequest request = new GetAdminAccessBindingRequest
{
AdminAccessBindingName = AdminAccessBindingName.FromOrganizationAdminAccessBinding("[ORGANIZATION]", "[ADMIN_ACCESS_BINDING]"),
};
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.GetAdminAccessBindingAsync(request);
GetAdminAccessBindingAsync(string, CallSettings)
Looks up a single admin access binding.
Declaration
public virtual Task<AdminAccessBinding> GetAdminAccessBindingAsync(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the AdminAccessBinding to retrieve. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/adminAccessBindings/[ADMIN_ACCESS_BINDING]";
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.GetAdminAccessBindingAsync(name);
GetAdminAccessBindingAsync(string, CancellationToken)
Looks up a single admin access binding.
Declaration
public virtual Task<AdminAccessBinding> GetAdminAccessBindingAsync(string name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the AdminAccessBinding to retrieve. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/adminAccessBindings/[ADMIN_ACCESS_BINDING]";
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.GetAdminAccessBindingAsync(name);
GetOrganization(GetOrganizationRequest, CallSettings)
Looks up a single organization.
Declaration
public virtual Organization GetOrganization(GetOrganizationRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetOrganizationRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Organization | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
GetOrganizationRequest request = new GetOrganizationRequest
{
OrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
};
// Make the request
Organization response = marketingplatformAdminServiceClient.GetOrganization(request);
GetOrganization(OrganizationName, CallSettings)
Looks up a single organization.
Declaration
public virtual Organization GetOrganization(OrganizationName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | name | Required. The name of the Organization to retrieve. Format: organizations/{org_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Organization | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
OrganizationName name = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
Organization response = marketingplatformAdminServiceClient.GetOrganization(name);
GetOrganization(string, CallSettings)
Looks up a single organization.
Declaration
public virtual Organization GetOrganization(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the Organization to retrieve. Format: organizations/{org_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Organization | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]";
// Make the request
Organization response = marketingplatformAdminServiceClient.GetOrganization(name);
GetOrganizationAsync(GetOrganizationRequest, CallSettings)
Looks up a single organization.
Declaration
public virtual Task<Organization> GetOrganizationAsync(GetOrganizationRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetOrganizationRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Organization> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetOrganizationRequest request = new GetOrganizationRequest
{
OrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
};
// Make the request
Organization response = await marketingplatformAdminServiceClient.GetOrganizationAsync(request);
GetOrganizationAsync(GetOrganizationRequest, CancellationToken)
Looks up a single organization.
Declaration
public virtual Task<Organization> GetOrganizationAsync(GetOrganizationRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| GetOrganizationRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<Organization> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetOrganizationRequest request = new GetOrganizationRequest
{
OrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
};
// Make the request
Organization response = await marketingplatformAdminServiceClient.GetOrganizationAsync(request);
GetOrganizationAsync(OrganizationName, CallSettings)
Looks up a single organization.
Declaration
public virtual Task<Organization> GetOrganizationAsync(OrganizationName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | name | Required. The name of the Organization to retrieve. Format: organizations/{org_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Organization> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName name = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
Organization response = await marketingplatformAdminServiceClient.GetOrganizationAsync(name);
GetOrganizationAsync(OrganizationName, CancellationToken)
Looks up a single organization.
Declaration
public virtual Task<Organization> GetOrganizationAsync(OrganizationName name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | name | Required. The name of the Organization to retrieve. Format: organizations/{org_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<Organization> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName name = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
Organization response = await marketingplatformAdminServiceClient.GetOrganizationAsync(name);
GetOrganizationAsync(string, CallSettings)
Looks up a single organization.
Declaration
public virtual Task<Organization> GetOrganizationAsync(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the Organization to retrieve. Format: organizations/{org_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Organization> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]";
// Make the request
Organization response = await marketingplatformAdminServiceClient.GetOrganizationAsync(name);
GetOrganizationAsync(string, CancellationToken)
Looks up a single organization.
Declaration
public virtual Task<Organization> GetOrganizationAsync(string name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the Organization to retrieve. Format: organizations/{org_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<Organization> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]";
// Make the request
Organization response = await marketingplatformAdminServiceClient.GetOrganizationAsync(name);
GetUserGroup(GetUserGroupRequest, CallSettings)
Looks up a single user group.
Declaration
public virtual UserGroup GetUserGroup(GetUserGroupRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroup | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
GetUserGroupRequest request = new GetUserGroupRequest
{
UserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
};
// Make the request
UserGroup response = marketingplatformAdminServiceClient.GetUserGroup(request);
GetUserGroup(UserGroupName, CallSettings)
Looks up a single user group.
Declaration
public virtual UserGroup GetUserGroup(UserGroupName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | name | Required. The name of the UserGroup to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroup | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UserGroupName name = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
// Make the request
UserGroup response = marketingplatformAdminServiceClient.GetUserGroup(name);
GetUserGroup(string, CallSettings)
Looks up a single user group.
Declaration
public virtual UserGroup GetUserGroup(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the UserGroup to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroup | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
// Make the request
UserGroup response = marketingplatformAdminServiceClient.GetUserGroup(name);
GetUserGroupAsync(GetUserGroupRequest, CallSettings)
Looks up a single user group.
Declaration
public virtual Task<UserGroup> GetUserGroupAsync(GetUserGroupRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserGroupRequest request = new GetUserGroupRequest
{
UserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
};
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.GetUserGroupAsync(request);
GetUserGroupAsync(GetUserGroupRequest, CancellationToken)
Looks up a single user group.
Declaration
public virtual Task<UserGroup> GetUserGroupAsync(GetUserGroupRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| GetUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserGroupRequest request = new GetUserGroupRequest
{
UserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
};
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.GetUserGroupAsync(request);
GetUserGroupAsync(UserGroupName, CallSettings)
Looks up a single user group.
Declaration
public virtual Task<UserGroup> GetUserGroupAsync(UserGroupName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | name | Required. The name of the UserGroup to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupName name = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.GetUserGroupAsync(name);
GetUserGroupAsync(UserGroupName, CancellationToken)
Looks up a single user group.
Declaration
public virtual Task<UserGroup> GetUserGroupAsync(UserGroupName name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | name | Required. The name of the UserGroup to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupName name = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.GetUserGroupAsync(name);
GetUserGroupAsync(string, CallSettings)
Looks up a single user group.
Declaration
public virtual Task<UserGroup> GetUserGroupAsync(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the UserGroup to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.GetUserGroupAsync(name);
GetUserGroupAsync(string, CancellationToken)
Looks up a single user group.
Declaration
public virtual Task<UserGroup> GetUserGroupAsync(string name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the UserGroup to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.GetUserGroupAsync(name);
GetUserGroupMember(GetUserGroupMemberRequest, CallSettings)
Looks up a single user group member.
Declaration
public virtual UserGroupMember GetUserGroupMember(GetUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroupMember | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
GetUserGroupMemberRequest request = new GetUserGroupMemberRequest
{
UserGroupMemberName = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]"),
};
// Make the request
UserGroupMember response = marketingplatformAdminServiceClient.GetUserGroupMember(request);
GetUserGroupMember(UserGroupMemberName, CallSettings)
Looks up a single user group member.
Declaration
public virtual UserGroupMember GetUserGroupMember(UserGroupMemberName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupMemberName | name | Required. The name of the user group member to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroupMember | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UserGroupMemberName name = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]");
// Make the request
UserGroupMember response = marketingplatformAdminServiceClient.GetUserGroupMember(name);
GetUserGroupMember(string, CallSettings)
Looks up a single user group member.
Declaration
public virtual UserGroupMember GetUserGroupMember(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the user group member to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroupMember | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]/members/[MEMBER]";
// Make the request
UserGroupMember response = marketingplatformAdminServiceClient.GetUserGroupMember(name);
GetUserGroupMemberAsync(GetUserGroupMemberRequest, CallSettings)
Looks up a single user group member.
Declaration
public virtual Task<UserGroupMember> GetUserGroupMemberAsync(GetUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserGroupMemberRequest request = new GetUserGroupMemberRequest
{
UserGroupMemberName = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]"),
};
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.GetUserGroupMemberAsync(request);
GetUserGroupMemberAsync(GetUserGroupMemberRequest, CancellationToken)
Looks up a single user group member.
Declaration
public virtual Task<UserGroupMember> GetUserGroupMemberAsync(GetUserGroupMemberRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| GetUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserGroupMemberRequest request = new GetUserGroupMemberRequest
{
UserGroupMemberName = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]"),
};
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.GetUserGroupMemberAsync(request);
GetUserGroupMemberAsync(UserGroupMemberName, CallSettings)
Looks up a single user group member.
Declaration
public virtual Task<UserGroupMember> GetUserGroupMemberAsync(UserGroupMemberName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupMemberName | name | Required. The name of the user group member to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupMemberName name = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]");
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.GetUserGroupMemberAsync(name);
GetUserGroupMemberAsync(UserGroupMemberName, CancellationToken)
Looks up a single user group member.
Declaration
public virtual Task<UserGroupMember> GetUserGroupMemberAsync(UserGroupMemberName name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupMemberName | name | Required. The name of the user group member to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupMemberName name = UserGroupMemberName.FromOrganizationUserGroupMember("[ORGANIZATION]", "[USER_GROUP]", "[MEMBER]");
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.GetUserGroupMemberAsync(name);
GetUserGroupMemberAsync(string, CallSettings)
Looks up a single user group member.
Declaration
public virtual Task<UserGroupMember> GetUserGroupMemberAsync(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the user group member to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]/members/[MEMBER]";
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.GetUserGroupMemberAsync(name);
GetUserGroupMemberAsync(string, CancellationToken)
Looks up a single user group member.
Declaration
public virtual Task<UserGroupMember> GetUserGroupMemberAsync(string name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the user group member to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]/members/[MEMBER]";
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.GetUserGroupMemberAsync(name);
ListAdminAccessBindings(ListAdminAccessBindingsRequest, CallSettings)
Returns a list of admin access bindings in the specified GMP organization.
Declaration
public virtual PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> ListAdminAccessBindings(ListAdminAccessBindingsRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListAdminAccessBindingsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> | A pageable sequence of AdminAccessBinding resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
ListAdminAccessBindingsRequest request = new ListAdminAccessBindingsRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
};
// Make the request
PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> response = marketingplatformAdminServiceClient.ListAdminAccessBindings(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (AdminAccessBinding item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAdminAccessBindingsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AdminAccessBinding item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AdminAccessBinding> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AdminAccessBinding item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAdminAccessBindings(OrganizationName, string, int?, CallSettings)
Returns a list of admin access bindings in the specified GMP organization.
Declaration
public virtual PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> ListAdminAccessBindings(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent organization, which owns this collection of Admin Access Bindings. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> | A pageable sequence of AdminAccessBinding resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> response = marketingplatformAdminServiceClient.ListAdminAccessBindings(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (AdminAccessBinding item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAdminAccessBindingsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AdminAccessBinding item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AdminAccessBinding> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AdminAccessBinding item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAdminAccessBindings(string, string, int?, CallSettings)
Returns a list of admin access bindings in the specified GMP organization.
Declaration
public virtual PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> ListAdminAccessBindings(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent organization, which owns this collection of Admin Access Bindings. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> | A pageable sequence of AdminAccessBinding resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
// Make the request
PagedEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> response = marketingplatformAdminServiceClient.ListAdminAccessBindings(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (AdminAccessBinding item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAdminAccessBindingsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AdminAccessBinding item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AdminAccessBinding> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AdminAccessBinding item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAdminAccessBindingsAsync(ListAdminAccessBindingsRequest, CallSettings)
Returns a list of admin access bindings in the specified GMP organization.
Declaration
public virtual PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> ListAdminAccessBindingsAsync(ListAdminAccessBindingsRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListAdminAccessBindingsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> | A pageable asynchronous sequence of AdminAccessBinding resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
ListAdminAccessBindingsRequest request = new ListAdminAccessBindingsRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
};
// Make the request
PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> response = marketingplatformAdminServiceClient.ListAdminAccessBindingsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (AdminAccessBinding item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAdminAccessBindingsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AdminAccessBinding item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AdminAccessBinding> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AdminAccessBinding item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAdminAccessBindingsAsync(OrganizationName, string, int?, CallSettings)
Returns a list of admin access bindings in the specified GMP organization.
Declaration
public virtual PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> ListAdminAccessBindingsAsync(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent organization, which owns this collection of Admin Access Bindings. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> | A pageable asynchronous sequence of AdminAccessBinding resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> response = marketingplatformAdminServiceClient.ListAdminAccessBindingsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (AdminAccessBinding item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAdminAccessBindingsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AdminAccessBinding item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AdminAccessBinding> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AdminAccessBinding item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAdminAccessBindingsAsync(string, string, int?, CallSettings)
Returns a list of admin access bindings in the specified GMP organization.
Declaration
public virtual PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> ListAdminAccessBindingsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent organization, which owns this collection of Admin Access Bindings. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> | A pageable asynchronous sequence of AdminAccessBinding resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
// Make the request
PagedAsyncEnumerable<ListAdminAccessBindingsResponse, AdminAccessBinding> response = marketingplatformAdminServiceClient.ListAdminAccessBindingsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (AdminAccessBinding item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAdminAccessBindingsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AdminAccessBinding item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AdminAccessBinding> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AdminAccessBinding item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest, CallSettings)
Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
Declaration
public virtual PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> ListAnalyticsAccountLinks(ListAnalyticsAccountLinksRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListAnalyticsAccountLinksRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> | A pageable sequence of AnalyticsAccountLink resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
ListAnalyticsAccountLinksRequest request = new ListAnalyticsAccountLinksRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
};
// Make the request
PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> response = marketingplatformAdminServiceClient.ListAnalyticsAccountLinks(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (AnalyticsAccountLink item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAnalyticsAccountLinksResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AnalyticsAccountLink item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnalyticsAccountLink> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnalyticsAccountLink item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAnalyticsAccountLinks(OrganizationName, string, int?, CallSettings)
Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
Declaration
public virtual PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> ListAnalyticsAccountLinks(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> | A pageable sequence of AnalyticsAccountLink resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> response = marketingplatformAdminServiceClient.ListAnalyticsAccountLinks(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (AnalyticsAccountLink item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAnalyticsAccountLinksResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AnalyticsAccountLink item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnalyticsAccountLink> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnalyticsAccountLink item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAnalyticsAccountLinks(string, string, int?, CallSettings)
Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
Declaration
public virtual PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> ListAnalyticsAccountLinks(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> | A pageable sequence of AnalyticsAccountLink resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
// Make the request
PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> response = marketingplatformAdminServiceClient.ListAnalyticsAccountLinks(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (AnalyticsAccountLink item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAnalyticsAccountLinksResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AnalyticsAccountLink item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnalyticsAccountLink> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnalyticsAccountLink item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest, CallSettings)
Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
Declaration
public virtual PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> ListAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListAnalyticsAccountLinksRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> | A pageable asynchronous sequence of AnalyticsAccountLink resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
ListAnalyticsAccountLinksRequest request = new ListAnalyticsAccountLinksRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
};
// Make the request
PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> response = marketingplatformAdminServiceClient.ListAnalyticsAccountLinksAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (AnalyticsAccountLink item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAnalyticsAccountLinksResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AnalyticsAccountLink item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnalyticsAccountLink> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnalyticsAccountLink item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAnalyticsAccountLinksAsync(OrganizationName, string, int?, CallSettings)
Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
Declaration
public virtual PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> ListAnalyticsAccountLinksAsync(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> | A pageable asynchronous sequence of AnalyticsAccountLink resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> response = marketingplatformAdminServiceClient.ListAnalyticsAccountLinksAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (AnalyticsAccountLink item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAnalyticsAccountLinksResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AnalyticsAccountLink item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnalyticsAccountLink> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnalyticsAccountLink item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAnalyticsAccountLinksAsync(string, string, int?, CallSettings)
Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
Declaration
public virtual PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> ListAnalyticsAccountLinksAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> | A pageable asynchronous sequence of AnalyticsAccountLink resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
// Make the request
PagedAsyncEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> response = marketingplatformAdminServiceClient.ListAnalyticsAccountLinksAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (AnalyticsAccountLink item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAnalyticsAccountLinksResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AnalyticsAccountLink item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnalyticsAccountLink> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnalyticsAccountLink item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListOrganizations(ListOrganizationsRequest, CallSettings)
Returns a list of organizations that the user has access to.
Declaration
public virtual PagedEnumerable<ListOrganizationsResponse, Organization> ListOrganizations(ListOrganizationsRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListOrganizationsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListOrganizationsResponse, Organization> | A pageable sequence of Organization resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
ListOrganizationsRequest request = new ListOrganizationsRequest { };
// Make the request
PagedEnumerable<ListOrganizationsResponse, Organization> response = marketingplatformAdminServiceClient.ListOrganizations(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Organization item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListOrganizationsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Organization item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Organization> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Organization item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListOrganizationsAsync(ListOrganizationsRequest, CallSettings)
Returns a list of organizations that the user has access to.
Declaration
public virtual PagedAsyncEnumerable<ListOrganizationsResponse, Organization> ListOrganizationsAsync(ListOrganizationsRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListOrganizationsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListOrganizationsResponse, Organization> | A pageable asynchronous sequence of Organization resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
ListOrganizationsRequest request = new ListOrganizationsRequest { };
// Make the request
PagedAsyncEnumerable<ListOrganizationsResponse, Organization> response = marketingplatformAdminServiceClient.ListOrganizationsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (Organization item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListOrganizationsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Organization item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Organization> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Organization item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroupMembers(ListUserGroupMembersRequest, CallSettings)
Returns a list of members in the specified user group.
Declaration
public virtual PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> ListUserGroupMembers(ListUserGroupMembersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListUserGroupMembersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> | A pageable sequence of UserGroupMember resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
ListUserGroupMembersRequest request = new ListUserGroupMembersRequest
{
ParentAsUserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
};
// Make the request
PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> response = marketingplatformAdminServiceClient.ListUserGroupMembers(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (UserGroupMember item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUserGroupMembersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroupMember item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroupMember> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroupMember item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroupMembers(UserGroupName, string, int?, CallSettings)
Returns a list of members in the specified user group.
Declaration
public virtual PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> ListUserGroupMembers(UserGroupName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | parent | Required. The parent user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> | A pageable sequence of UserGroupMember resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UserGroupName parent = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
// Make the request
PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> response = marketingplatformAdminServiceClient.ListUserGroupMembers(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (UserGroupMember item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUserGroupMembersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroupMember item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroupMember> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroupMember item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroupMembers(string, string, int?, CallSettings)
Returns a list of members in the specified user group.
Declaration
public virtual PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> ListUserGroupMembers(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> | A pageable sequence of UserGroupMember resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
// Make the request
PagedEnumerable<ListUserGroupMembersResponse, UserGroupMember> response = marketingplatformAdminServiceClient.ListUserGroupMembers(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (UserGroupMember item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUserGroupMembersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroupMember item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroupMember> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroupMember item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroupMembersAsync(ListUserGroupMembersRequest, CallSettings)
Returns a list of members in the specified user group.
Declaration
public virtual PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> ListUserGroupMembersAsync(ListUserGroupMembersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListUserGroupMembersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> | A pageable asynchronous sequence of UserGroupMember resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
ListUserGroupMembersRequest request = new ListUserGroupMembersRequest
{
ParentAsUserGroupName = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]"),
};
// Make the request
PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> response = marketingplatformAdminServiceClient.ListUserGroupMembersAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (UserGroupMember item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUserGroupMembersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroupMember item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroupMember> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroupMember item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroupMembersAsync(UserGroupName, string, int?, CallSettings)
Returns a list of members in the specified user group.
Declaration
public virtual PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> ListUserGroupMembersAsync(UserGroupName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupName | parent | Required. The parent user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> | A pageable asynchronous sequence of UserGroupMember resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupName parent = UserGroupName.FromOrganizationUserGroup("[ORGANIZATION]", "[USER_GROUP]");
// Make the request
PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> response = marketingplatformAdminServiceClient.ListUserGroupMembersAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (UserGroupMember item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUserGroupMembersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroupMember item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroupMember> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroupMember item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroupMembersAsync(string, string, int?, CallSettings)
Returns a list of members in the specified user group.
Declaration
public virtual PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> ListUserGroupMembersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> | A pageable asynchronous sequence of UserGroupMember resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/userGroups/[USER_GROUP]";
// Make the request
PagedAsyncEnumerable<ListUserGroupMembersResponse, UserGroupMember> response = marketingplatformAdminServiceClient.ListUserGroupMembersAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (UserGroupMember item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUserGroupMembersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroupMember item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroupMember> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroupMember item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroups(ListUserGroupsRequest, CallSettings)
Returns a list of user groups in the specified GMP organization.
Declaration
public virtual PagedEnumerable<ListUserGroupsResponse, UserGroup> ListUserGroups(ListUserGroupsRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListUserGroupsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListUserGroupsResponse, UserGroup> | A pageable sequence of UserGroup resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
ListUserGroupsRequest request = new ListUserGroupsRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
};
// Make the request
PagedEnumerable<ListUserGroupsResponse, UserGroup> response = marketingplatformAdminServiceClient.ListUserGroups(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (UserGroup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUserGroupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroups(OrganizationName, string, int?, CallSettings)
Returns a list of user groups in the specified GMP organization.
Declaration
public virtual PagedEnumerable<ListUserGroupsResponse, UserGroup> ListUserGroups(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent org where this UserGroup will be listed. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListUserGroupsResponse, UserGroup> | A pageable sequence of UserGroup resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedEnumerable<ListUserGroupsResponse, UserGroup> response = marketingplatformAdminServiceClient.ListUserGroups(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (UserGroup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUserGroupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroups(string, string, int?, CallSettings)
Returns a list of user groups in the specified GMP organization.
Declaration
public virtual PagedEnumerable<ListUserGroupsResponse, UserGroup> ListUserGroups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent org where this UserGroup will be listed. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListUserGroupsResponse, UserGroup> | A pageable sequence of UserGroup resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
// Make the request
PagedEnumerable<ListUserGroupsResponse, UserGroup> response = marketingplatformAdminServiceClient.ListUserGroups(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (UserGroup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUserGroupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroupsAsync(ListUserGroupsRequest, CallSettings)
Returns a list of user groups in the specified GMP organization.
Declaration
public virtual PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> ListUserGroupsAsync(ListUserGroupsRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListUserGroupsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> | A pageable asynchronous sequence of UserGroup resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
ListUserGroupsRequest request = new ListUserGroupsRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
};
// Make the request
PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> response = marketingplatformAdminServiceClient.ListUserGroupsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (UserGroup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUserGroupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroupsAsync(OrganizationName, string, int?, CallSettings)
Returns a list of user groups in the specified GMP organization.
Declaration
public virtual PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> ListUserGroupsAsync(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| OrganizationName | parent | Required. The parent org where this UserGroup will be listed. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> | A pageable asynchronous sequence of UserGroup resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> response = marketingplatformAdminServiceClient.ListUserGroupsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (UserGroup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUserGroupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListUserGroupsAsync(string, string, int?, CallSettings)
Returns a list of user groups in the specified GMP organization.
Declaration
public virtual PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> ListUserGroupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent org where this UserGroup will be listed. Format: organizations/{org_id} |
| string | pageToken | The token returned from the previous request. A value of |
| int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> | A pageable asynchronous sequence of UserGroup resources. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
// Make the request
PagedAsyncEnumerable<ListUserGroupsResponse, UserGroup> response = marketingplatformAdminServiceClient.ListUserGroupsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (UserGroup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUserGroupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (UserGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ReportPropertyUsage(ReportPropertyUsageRequest, CallSettings)
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.
Declaration
public virtual ReportPropertyUsageResponse ReportPropertyUsage(ReportPropertyUsageRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportPropertyUsageRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| ReportPropertyUsageResponse | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
ReportPropertyUsageRequest request = new ReportPropertyUsageRequest
{
Organization = "",
Month = "",
};
// Make the request
ReportPropertyUsageResponse response = marketingplatformAdminServiceClient.ReportPropertyUsage(request);
ReportPropertyUsage(string, CallSettings)
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.
Declaration
public virtual ReportPropertyUsageResponse ReportPropertyUsage(string organization, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | organization | Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| ReportPropertyUsageResponse | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string organization = "";
// Make the request
ReportPropertyUsageResponse response = marketingplatformAdminServiceClient.ReportPropertyUsage(organization);
ReportPropertyUsageAsync(ReportPropertyUsageRequest, CallSettings)
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.
Declaration
public virtual Task<ReportPropertyUsageResponse> ReportPropertyUsageAsync(ReportPropertyUsageRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportPropertyUsageRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<ReportPropertyUsageResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
ReportPropertyUsageRequest request = new ReportPropertyUsageRequest
{
Organization = "",
Month = "",
};
// Make the request
ReportPropertyUsageResponse response = await marketingplatformAdminServiceClient.ReportPropertyUsageAsync(request);
ReportPropertyUsageAsync(ReportPropertyUsageRequest, CancellationToken)
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.
Declaration
public virtual Task<ReportPropertyUsageResponse> ReportPropertyUsageAsync(ReportPropertyUsageRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportPropertyUsageRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<ReportPropertyUsageResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
ReportPropertyUsageRequest request = new ReportPropertyUsageRequest
{
Organization = "",
Month = "",
};
// Make the request
ReportPropertyUsageResponse response = await marketingplatformAdminServiceClient.ReportPropertyUsageAsync(request);
ReportPropertyUsageAsync(string, CallSettings)
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.
Declaration
public virtual Task<ReportPropertyUsageResponse> ReportPropertyUsageAsync(string organization, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | organization | Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<ReportPropertyUsageResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string organization = "";
// Make the request
ReportPropertyUsageResponse response = await marketingplatformAdminServiceClient.ReportPropertyUsageAsync(organization);
ReportPropertyUsageAsync(string, CancellationToken)
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.
Declaration
public virtual Task<ReportPropertyUsageResponse> ReportPropertyUsageAsync(string organization, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | organization | Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<ReportPropertyUsageResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string organization = "";
// Make the request
ReportPropertyUsageResponse response = await marketingplatformAdminServiceClient.ReportPropertyUsageAsync(organization);
SetPropertyServiceLevel(SetPropertyServiceLevelRequest, CallSettings)
Updates the service level for an Analytics property.
Declaration
public virtual SetPropertyServiceLevelResponse SetPropertyServiceLevel(SetPropertyServiceLevelRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| SetPropertyServiceLevelRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| SetPropertyServiceLevelResponse | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
SetPropertyServiceLevelRequest request = new SetPropertyServiceLevelRequest
{
AnalyticsAccountLink = "",
AnalyticsPropertyAsPropertyName = PropertyName.FromProperty("[PROPERTY]"),
ServiceLevel = AnalyticsServiceLevel.Unspecified,
};
// Make the request
SetPropertyServiceLevelResponse response = marketingplatformAdminServiceClient.SetPropertyServiceLevel(request);
SetPropertyServiceLevel(string, CallSettings)
Updates the service level for an Analytics property.
Declaration
public virtual SetPropertyServiceLevelResponse SetPropertyServiceLevel(string analyticsAccountLink, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | analyticsAccountLink | Required. The parent AnalyticsAccountLink scope where this property is in. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| SetPropertyServiceLevelResponse | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
string analyticsAccountLink = "";
// Make the request
SetPropertyServiceLevelResponse response = marketingplatformAdminServiceClient.SetPropertyServiceLevel(analyticsAccountLink);
SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest, CallSettings)
Updates the service level for an Analytics property.
Declaration
public virtual Task<SetPropertyServiceLevelResponse> SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| SetPropertyServiceLevelRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<SetPropertyServiceLevelResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
SetPropertyServiceLevelRequest request = new SetPropertyServiceLevelRequest
{
AnalyticsAccountLink = "",
AnalyticsPropertyAsPropertyName = PropertyName.FromProperty("[PROPERTY]"),
ServiceLevel = AnalyticsServiceLevel.Unspecified,
};
// Make the request
SetPropertyServiceLevelResponse response = await marketingplatformAdminServiceClient.SetPropertyServiceLevelAsync(request);
SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest, CancellationToken)
Updates the service level for an Analytics property.
Declaration
public virtual Task<SetPropertyServiceLevelResponse> SetPropertyServiceLevelAsync(SetPropertyServiceLevelRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| SetPropertyServiceLevelRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<SetPropertyServiceLevelResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
SetPropertyServiceLevelRequest request = new SetPropertyServiceLevelRequest
{
AnalyticsAccountLink = "",
AnalyticsPropertyAsPropertyName = PropertyName.FromProperty("[PROPERTY]"),
ServiceLevel = AnalyticsServiceLevel.Unspecified,
};
// Make the request
SetPropertyServiceLevelResponse response = await marketingplatformAdminServiceClient.SetPropertyServiceLevelAsync(request);
SetPropertyServiceLevelAsync(string, CallSettings)
Updates the service level for an Analytics property.
Declaration
public virtual Task<SetPropertyServiceLevelResponse> SetPropertyServiceLevelAsync(string analyticsAccountLink, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | analyticsAccountLink | Required. The parent AnalyticsAccountLink scope where this property is in. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<SetPropertyServiceLevelResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string analyticsAccountLink = "";
// Make the request
SetPropertyServiceLevelResponse response = await marketingplatformAdminServiceClient.SetPropertyServiceLevelAsync(analyticsAccountLink);
SetPropertyServiceLevelAsync(string, CancellationToken)
Updates the service level for an Analytics property.
Declaration
public virtual Task<SetPropertyServiceLevelResponse> SetPropertyServiceLevelAsync(string analyticsAccountLink, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | analyticsAccountLink | Required. The parent AnalyticsAccountLink scope where this property is in. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<SetPropertyServiceLevelResponse> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string analyticsAccountLink = "";
// Make the request
SetPropertyServiceLevelResponse response = await marketingplatformAdminServiceClient.SetPropertyServiceLevelAsync(analyticsAccountLink);
ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Declaration
public static Task ShutdownDefaultChannelsAsync()
Returns
| Type | Description |
|---|---|
| Task | A task representing the asynchronous shutdown operation. |
Remarks
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
UpdateAdminAccessBinding(AdminAccessBinding, FieldMask, CallSettings)
Updates an admin access binding in the specified GMP organization.
Declaration
public virtual AdminAccessBinding UpdateAdminAccessBinding(AdminAccessBinding adminAccessBinding, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AdminAccessBinding | adminAccessBinding | Required. The AdminAccessBinding to update. |
| FieldMask | updateMask | 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AdminAccessBinding | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
AdminAccessBinding adminAccessBinding = new AdminAccessBinding();
FieldMask updateMask = new FieldMask();
// Make the request
AdminAccessBinding response = marketingplatformAdminServiceClient.UpdateAdminAccessBinding(adminAccessBinding, updateMask);
UpdateAdminAccessBinding(UpdateAdminAccessBindingRequest, CallSettings)
Updates an admin access binding in the specified GMP organization.
Declaration
public virtual AdminAccessBinding UpdateAdminAccessBinding(UpdateAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateAdminAccessBindingRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AdminAccessBinding | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UpdateAdminAccessBindingRequest request = new UpdateAdminAccessBindingRequest
{
AdminAccessBinding = new AdminAccessBinding(),
UpdateMask = new FieldMask(),
};
// Make the request
AdminAccessBinding response = marketingplatformAdminServiceClient.UpdateAdminAccessBinding(request);
UpdateAdminAccessBindingAsync(AdminAccessBinding, FieldMask, CallSettings)
Updates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> UpdateAdminAccessBindingAsync(AdminAccessBinding adminAccessBinding, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AdminAccessBinding | adminAccessBinding | Required. The AdminAccessBinding to update. |
| FieldMask | updateMask | 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
AdminAccessBinding adminAccessBinding = new AdminAccessBinding();
FieldMask updateMask = new FieldMask();
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.UpdateAdminAccessBindingAsync(adminAccessBinding, updateMask);
UpdateAdminAccessBindingAsync(AdminAccessBinding, FieldMask, CancellationToken)
Updates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> UpdateAdminAccessBindingAsync(AdminAccessBinding adminAccessBinding, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| AdminAccessBinding | adminAccessBinding | Required. The AdminAccessBinding to update. |
| FieldMask | updateMask | 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. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
AdminAccessBinding adminAccessBinding = new AdminAccessBinding();
FieldMask updateMask = new FieldMask();
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.UpdateAdminAccessBindingAsync(adminAccessBinding, updateMask);
UpdateAdminAccessBindingAsync(UpdateAdminAccessBindingRequest, CallSettings)
Updates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> UpdateAdminAccessBindingAsync(UpdateAdminAccessBindingRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateAdminAccessBindingRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateAdminAccessBindingRequest request = new UpdateAdminAccessBindingRequest
{
AdminAccessBinding = new AdminAccessBinding(),
UpdateMask = new FieldMask(),
};
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.UpdateAdminAccessBindingAsync(request);
UpdateAdminAccessBindingAsync(UpdateAdminAccessBindingRequest, CancellationToken)
Updates an admin access binding in the specified GMP organization.
Declaration
public virtual Task<AdminAccessBinding> UpdateAdminAccessBindingAsync(UpdateAdminAccessBindingRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateAdminAccessBindingRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<AdminAccessBinding> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateAdminAccessBindingRequest request = new UpdateAdminAccessBindingRequest
{
AdminAccessBinding = new AdminAccessBinding(),
UpdateMask = new FieldMask(),
};
// Make the request
AdminAccessBinding response = await marketingplatformAdminServiceClient.UpdateAdminAccessBindingAsync(request);
UpdateUserGroup(UpdateUserGroupRequest, CallSettings)
Updates a user group in the specified GMP organization.
Declaration
public virtual UserGroup UpdateUserGroup(UpdateUserGroupRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroup | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UpdateUserGroupRequest request = new UpdateUserGroupRequest
{
UserGroup = new UserGroup(),
UpdateMask = new FieldMask(),
};
// Make the request
UserGroup response = marketingplatformAdminServiceClient.UpdateUserGroup(request);
UpdateUserGroup(UserGroup, FieldMask, CallSettings)
Updates a user group in the specified GMP organization.
Declaration
public virtual UserGroup UpdateUserGroup(UserGroup userGroup, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroup | userGroup | Required. The user group to update. |
| FieldMask | updateMask | 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroup | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UserGroup userGroup = new UserGroup();
FieldMask updateMask = new FieldMask();
// Make the request
UserGroup response = marketingplatformAdminServiceClient.UpdateUserGroup(userGroup, updateMask);
UpdateUserGroupAsync(UpdateUserGroupRequest, CallSettings)
Updates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> UpdateUserGroupAsync(UpdateUserGroupRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserGroupRequest request = new UpdateUserGroupRequest
{
UserGroup = new UserGroup(),
UpdateMask = new FieldMask(),
};
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.UpdateUserGroupAsync(request);
UpdateUserGroupAsync(UpdateUserGroupRequest, CancellationToken)
Updates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> UpdateUserGroupAsync(UpdateUserGroupRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateUserGroupRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserGroupRequest request = new UpdateUserGroupRequest
{
UserGroup = new UserGroup(),
UpdateMask = new FieldMask(),
};
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.UpdateUserGroupAsync(request);
UpdateUserGroupAsync(UserGroup, FieldMask, CallSettings)
Updates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> UpdateUserGroupAsync(UserGroup userGroup, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroup | userGroup | Required. The user group to update. |
| FieldMask | updateMask | 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroup userGroup = new UserGroup();
FieldMask updateMask = new FieldMask();
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.UpdateUserGroupAsync(userGroup, updateMask);
UpdateUserGroupAsync(UserGroup, FieldMask, CancellationToken)
Updates a user group in the specified GMP organization.
Declaration
public virtual Task<UserGroup> UpdateUserGroupAsync(UserGroup userGroup, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroup | userGroup | Required. The user group to update. |
| FieldMask | updateMask | 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. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroup> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroup userGroup = new UserGroup();
FieldMask updateMask = new FieldMask();
// Make the request
UserGroup response = await marketingplatformAdminServiceClient.UpdateUserGroupAsync(userGroup, updateMask);
UpdateUserGroupMember(UpdateUserGroupMemberRequest, CallSettings)
Updates a member in the specified GMP user group.
Declaration
public virtual UserGroupMember UpdateUserGroupMember(UpdateUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroupMember | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UpdateUserGroupMemberRequest request = new UpdateUserGroupMemberRequest
{
UserGroupMember = new UserGroupMember(),
UpdateMask = new FieldMask(),
};
// Make the request
UserGroupMember response = marketingplatformAdminServiceClient.UpdateUserGroupMember(request);
UpdateUserGroupMember(UserGroupMember, FieldMask, CallSettings)
Updates a member in the specified GMP user group.
Declaration
public virtual UserGroupMember UpdateUserGroupMember(UserGroupMember userGroupMember, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupMember | userGroupMember | Required. The user group member to update. |
| FieldMask | updateMask | 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| UserGroupMember | The RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
// Initialize request argument(s)
UserGroupMember userGroupMember = new UserGroupMember();
FieldMask updateMask = new FieldMask();
// Make the request
UserGroupMember response = marketingplatformAdminServiceClient.UpdateUserGroupMember(userGroupMember, updateMask);
UpdateUserGroupMemberAsync(UpdateUserGroupMemberRequest, CallSettings)
Updates a member in the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> UpdateUserGroupMemberAsync(UpdateUserGroupMemberRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserGroupMemberRequest request = new UpdateUserGroupMemberRequest
{
UserGroupMember = new UserGroupMember(),
UpdateMask = new FieldMask(),
};
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.UpdateUserGroupMemberAsync(request);
UpdateUserGroupMemberAsync(UpdateUserGroupMemberRequest, CancellationToken)
Updates a member in the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> UpdateUserGroupMemberAsync(UpdateUserGroupMemberRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateUserGroupMemberRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserGroupMemberRequest request = new UpdateUserGroupMemberRequest
{
UserGroupMember = new UserGroupMember(),
UpdateMask = new FieldMask(),
};
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.UpdateUserGroupMemberAsync(request);
UpdateUserGroupMemberAsync(UserGroupMember, FieldMask, CallSettings)
Updates a member in the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> UpdateUserGroupMemberAsync(UserGroupMember userGroupMember, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupMember | userGroupMember | Required. The user group member to update. |
| FieldMask | updateMask | 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupMember userGroupMember = new UserGroupMember();
FieldMask updateMask = new FieldMask();
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.UpdateUserGroupMemberAsync(userGroupMember, updateMask);
UpdateUserGroupMemberAsync(UserGroupMember, FieldMask, CancellationToken)
Updates a member in the specified GMP user group.
Declaration
public virtual Task<UserGroupMember> UpdateUserGroupMemberAsync(UserGroupMember userGroupMember, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UserGroupMember | userGroupMember | Required. The user group member to update. |
| FieldMask | updateMask | 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. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<UserGroupMember> | A Task containing the RPC response. |
Sample code
// Create client
MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = await MarketingplatformAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UserGroupMember userGroupMember = new UserGroupMember();
FieldMask updateMask = new FieldMask();
// Make the request
UserGroupMember response = await marketingplatformAdminServiceClient.UpdateUserGroupMemberAsync(userGroupMember, updateMask);