Class CompanyServiceClient
CompanyService client wrapper, for convenient use.
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public abstract class CompanyServiceClient
Remarks
Provides methods for handling [Company][google.ads.admanager.v1.Company] objects.
Properties
DefaultEndpoint
The default endpoint for the CompanyService service, which is a host of "admanager.googleapis.com" and a port of 443.
Declaration
public static string DefaultEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| string |
DefaultScopes
The default CompanyService scopes.
Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<string> |
Remarks
The default CompanyService scopes are:
- https://www.googleapis.com/auth/admanager
- https://www.googleapis.com/auth/admanager.readonly
GrpcClient
The underlying gRPC CompanyService client
Declaration
public virtual CompanyService.CompanyServiceClient GrpcClient { get; }
Property Value
| Type | Description |
|---|---|
| CompanyService.CompanyServiceClient |
ServiceMetadata
The service metadata associated with this client type.
Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
| Type | Description |
|---|---|
| ServiceMetadata |
Methods
BatchCreateCompanies(BatchCreateCompaniesRequest, CallSettings)
Creates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual BatchCreateCompaniesResponse BatchCreateCompanies(BatchCreateCompaniesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchCreateCompaniesRequest | 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 |
|---|---|
| BatchCreateCompaniesResponse | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
BatchCreateCompaniesRequest request = new BatchCreateCompaniesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new CreateCompanyRequest(),
},
};
// Make the request
BatchCreateCompaniesResponse response = companyServiceClient.BatchCreateCompanies(request);
BatchCreateCompanies(NetworkName, IEnumerable<CreateCompanyRequest>, CallSettings)
Creates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual BatchCreateCompaniesResponse BatchCreateCompanies(NetworkName parent, IEnumerable<CreateCompanyRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where [Companies][] will be created.
Format: |
| IEnumerable<CreateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to create. A maximum of 100 objects can be created in a batch. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchCreateCompaniesResponse | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<CreateCompanyRequest> requests = new CreateCompanyRequest[]
{
new CreateCompanyRequest(),
};
// Make the request
BatchCreateCompaniesResponse response = companyServiceClient.BatchCreateCompanies(parent, requests);
BatchCreateCompanies(string, IEnumerable<CreateCompanyRequest>, CallSettings)
Creates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual BatchCreateCompaniesResponse BatchCreateCompanies(string parent, IEnumerable<CreateCompanyRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where [Companies][] will be created.
Format: |
| IEnumerable<CreateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to create. A maximum of 100 objects can be created in a batch. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchCreateCompaniesResponse | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<CreateCompanyRequest> requests = new CreateCompanyRequest[]
{
new CreateCompanyRequest(),
};
// Make the request
BatchCreateCompaniesResponse response = companyServiceClient.BatchCreateCompanies(parent, requests);
BatchCreateCompaniesAsync(BatchCreateCompaniesRequest, CallSettings)
Creates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchCreateCompaniesResponse> BatchCreateCompaniesAsync(BatchCreateCompaniesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchCreateCompaniesRequest | 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<BatchCreateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateCompaniesRequest request = new BatchCreateCompaniesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new CreateCompanyRequest(),
},
};
// Make the request
BatchCreateCompaniesResponse response = await companyServiceClient.BatchCreateCompaniesAsync(request);
BatchCreateCompaniesAsync(BatchCreateCompaniesRequest, CancellationToken)
Creates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchCreateCompaniesResponse> BatchCreateCompaniesAsync(BatchCreateCompaniesRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchCreateCompaniesRequest | 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<BatchCreateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateCompaniesRequest request = new BatchCreateCompaniesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new CreateCompanyRequest(),
},
};
// Make the request
BatchCreateCompaniesResponse response = await companyServiceClient.BatchCreateCompaniesAsync(request);
BatchCreateCompaniesAsync(NetworkName, IEnumerable<CreateCompanyRequest>, CallSettings)
Creates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchCreateCompaniesResponse> BatchCreateCompaniesAsync(NetworkName parent, IEnumerable<CreateCompanyRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where [Companies][] will be created.
Format: |
| IEnumerable<CreateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to create. A maximum of 100 objects can be created in a batch. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchCreateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<CreateCompanyRequest> requests = new CreateCompanyRequest[]
{
new CreateCompanyRequest(),
};
// Make the request
BatchCreateCompaniesResponse response = await companyServiceClient.BatchCreateCompaniesAsync(parent, requests);
BatchCreateCompaniesAsync(NetworkName, IEnumerable<CreateCompanyRequest>, CancellationToken)
Creates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchCreateCompaniesResponse> BatchCreateCompaniesAsync(NetworkName parent, IEnumerable<CreateCompanyRequest> requests, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where [Companies][] will be created.
Format: |
| IEnumerable<CreateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to create. A maximum of 100 objects can be created in a batch. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BatchCreateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<CreateCompanyRequest> requests = new CreateCompanyRequest[]
{
new CreateCompanyRequest(),
};
// Make the request
BatchCreateCompaniesResponse response = await companyServiceClient.BatchCreateCompaniesAsync(parent, requests);
BatchCreateCompaniesAsync(string, IEnumerable<CreateCompanyRequest>, CallSettings)
Creates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchCreateCompaniesResponse> BatchCreateCompaniesAsync(string parent, IEnumerable<CreateCompanyRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where [Companies][] will be created.
Format: |
| IEnumerable<CreateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to create. A maximum of 100 objects can be created in a batch. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchCreateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<CreateCompanyRequest> requests = new CreateCompanyRequest[]
{
new CreateCompanyRequest(),
};
// Make the request
BatchCreateCompaniesResponse response = await companyServiceClient.BatchCreateCompaniesAsync(parent, requests);
BatchCreateCompaniesAsync(string, IEnumerable<CreateCompanyRequest>, CancellationToken)
Creates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchCreateCompaniesResponse> BatchCreateCompaniesAsync(string parent, IEnumerable<CreateCompanyRequest> requests, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where [Companies][] will be created.
Format: |
| IEnumerable<CreateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to create. A maximum of 100 objects can be created in a batch. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BatchCreateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<CreateCompanyRequest> requests = new CreateCompanyRequest[]
{
new CreateCompanyRequest(),
};
// Make the request
BatchCreateCompaniesResponse response = await companyServiceClient.BatchCreateCompaniesAsync(parent, requests);
BatchUpdateCompanies(BatchUpdateCompaniesRequest, CallSettings)
Batch updates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual BatchUpdateCompaniesResponse BatchUpdateCompanies(BatchUpdateCompaniesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchUpdateCompaniesRequest | 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 |
|---|---|
| BatchUpdateCompaniesResponse | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
BatchUpdateCompaniesRequest request = new BatchUpdateCompaniesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new UpdateCompanyRequest(),
},
};
// Make the request
BatchUpdateCompaniesResponse response = companyServiceClient.BatchUpdateCompanies(request);
BatchUpdateCompanies(NetworkName, IEnumerable<UpdateCompanyRequest>, CallSettings)
Batch updates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual BatchUpdateCompaniesResponse BatchUpdateCompanies(NetworkName parent, IEnumerable<UpdateCompanyRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where [Companies][] will be updated.
Format: |
| IEnumerable<UpdateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to update. A maximum of 100 objects can be updated in a batch. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchUpdateCompaniesResponse | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdateCompanyRequest> requests = new UpdateCompanyRequest[]
{
new UpdateCompanyRequest(),
};
// Make the request
BatchUpdateCompaniesResponse response = companyServiceClient.BatchUpdateCompanies(parent, requests);
BatchUpdateCompanies(string, IEnumerable<UpdateCompanyRequest>, CallSettings)
Batch updates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual BatchUpdateCompaniesResponse BatchUpdateCompanies(string parent, IEnumerable<UpdateCompanyRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where [Companies][] will be updated.
Format: |
| IEnumerable<UpdateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to update. A maximum of 100 objects can be updated in a batch. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchUpdateCompaniesResponse | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdateCompanyRequest> requests = new UpdateCompanyRequest[]
{
new UpdateCompanyRequest(),
};
// Make the request
BatchUpdateCompaniesResponse response = companyServiceClient.BatchUpdateCompanies(parent, requests);
BatchUpdateCompaniesAsync(BatchUpdateCompaniesRequest, CallSettings)
Batch updates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchUpdateCompaniesResponse> BatchUpdateCompaniesAsync(BatchUpdateCompaniesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchUpdateCompaniesRequest | 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<BatchUpdateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateCompaniesRequest request = new BatchUpdateCompaniesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new UpdateCompanyRequest(),
},
};
// Make the request
BatchUpdateCompaniesResponse response = await companyServiceClient.BatchUpdateCompaniesAsync(request);
BatchUpdateCompaniesAsync(BatchUpdateCompaniesRequest, CancellationToken)
Batch updates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchUpdateCompaniesResponse> BatchUpdateCompaniesAsync(BatchUpdateCompaniesRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchUpdateCompaniesRequest | 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<BatchUpdateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateCompaniesRequest request = new BatchUpdateCompaniesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new UpdateCompanyRequest(),
},
};
// Make the request
BatchUpdateCompaniesResponse response = await companyServiceClient.BatchUpdateCompaniesAsync(request);
BatchUpdateCompaniesAsync(NetworkName, IEnumerable<UpdateCompanyRequest>, CallSettings)
Batch updates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchUpdateCompaniesResponse> BatchUpdateCompaniesAsync(NetworkName parent, IEnumerable<UpdateCompanyRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where [Companies][] will be updated.
Format: |
| IEnumerable<UpdateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to update. A maximum of 100 objects can be updated in a batch. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchUpdateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdateCompanyRequest> requests = new UpdateCompanyRequest[]
{
new UpdateCompanyRequest(),
};
// Make the request
BatchUpdateCompaniesResponse response = await companyServiceClient.BatchUpdateCompaniesAsync(parent, requests);
BatchUpdateCompaniesAsync(NetworkName, IEnumerable<UpdateCompanyRequest>, CancellationToken)
Batch updates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchUpdateCompaniesResponse> BatchUpdateCompaniesAsync(NetworkName parent, IEnumerable<UpdateCompanyRequest> requests, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where [Companies][] will be updated.
Format: |
| IEnumerable<UpdateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to update. A maximum of 100 objects can be updated in a batch. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BatchUpdateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdateCompanyRequest> requests = new UpdateCompanyRequest[]
{
new UpdateCompanyRequest(),
};
// Make the request
BatchUpdateCompaniesResponse response = await companyServiceClient.BatchUpdateCompaniesAsync(parent, requests);
BatchUpdateCompaniesAsync(string, IEnumerable<UpdateCompanyRequest>, CallSettings)
Batch updates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchUpdateCompaniesResponse> BatchUpdateCompaniesAsync(string parent, IEnumerable<UpdateCompanyRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where [Companies][] will be updated.
Format: |
| IEnumerable<UpdateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to update. A maximum of 100 objects can be updated in a batch. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchUpdateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdateCompanyRequest> requests = new UpdateCompanyRequest[]
{
new UpdateCompanyRequest(),
};
// Make the request
BatchUpdateCompaniesResponse response = await companyServiceClient.BatchUpdateCompaniesAsync(parent, requests);
BatchUpdateCompaniesAsync(string, IEnumerable<UpdateCompanyRequest>, CancellationToken)
Batch updates [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual Task<BatchUpdateCompaniesResponse> BatchUpdateCompaniesAsync(string parent, IEnumerable<UpdateCompanyRequest> requests, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where [Companies][] will be updated.
Format: |
| IEnumerable<UpdateCompanyRequest> | requests | Required. The [Company][google.ads.admanager.v1.Company] objects to update. A maximum of 100 objects can be updated in a batch. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BatchUpdateCompaniesResponse> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdateCompanyRequest> requests = new UpdateCompanyRequest[]
{
new UpdateCompanyRequest(),
};
// Make the request
BatchUpdateCompaniesResponse response = await companyServiceClient.BatchUpdateCompaniesAsync(parent, requests);
Create()
Synchronously creates a CompanyServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CompanyServiceClientBuilder.
Declaration
public static CompanyServiceClient Create()
Returns
| Type | Description |
|---|---|
| CompanyServiceClient | The created CompanyServiceClient. |
CreateAsync(CancellationToken)
Asynchronously creates a CompanyServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CompanyServiceClientBuilder.
Declaration
public static Task<CompanyServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | The CancellationToken to use while creating the client. |
Returns
| Type | Description |
|---|---|
| Task<CompanyServiceClient> | The task representing the created CompanyServiceClient. |
CreateCompany(CreateCompanyRequest, CallSettings)
Creates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Company CreateCompany(CreateCompanyRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateCompanyRequest | 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 |
|---|---|
| Company | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
CreateCompanyRequest request = new CreateCompanyRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Company = new Company(),
};
// Make the request
Company response = companyServiceClient.CreateCompany(request);
CreateCompany(NetworkName, Company, CallSettings)
Creates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Company CreateCompany(NetworkName parent, Company company, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where this
[Company][google.ads.admanager.v1.Company] will be created. Format:
|
| Company | company | Required. The [Company][google.ads.admanager.v1.Company] to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Company | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
Company company = new Company();
// Make the request
Company response = companyServiceClient.CreateCompany(parent, company);
CreateCompany(string, Company, CallSettings)
Creates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Company CreateCompany(string parent, Company company, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this
[Company][google.ads.admanager.v1.Company] will be created. Format:
|
| Company | company | Required. The [Company][google.ads.admanager.v1.Company] to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Company | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
Company company = new Company();
// Make the request
Company response = companyServiceClient.CreateCompany(parent, company);
CreateCompanyAsync(CreateCompanyRequest, CallSettings)
Creates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> CreateCompanyAsync(CreateCompanyRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateCompanyRequest | 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<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
CreateCompanyRequest request = new CreateCompanyRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Company = new Company(),
};
// Make the request
Company response = await companyServiceClient.CreateCompanyAsync(request);
CreateCompanyAsync(CreateCompanyRequest, CancellationToken)
Creates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> CreateCompanyAsync(CreateCompanyRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateCompanyRequest | 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<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
CreateCompanyRequest request = new CreateCompanyRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Company = new Company(),
};
// Make the request
Company response = await companyServiceClient.CreateCompanyAsync(request);
CreateCompanyAsync(NetworkName, Company, CallSettings)
Creates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> CreateCompanyAsync(NetworkName parent, Company company, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where this
[Company][google.ads.admanager.v1.Company] will be created. Format:
|
| Company | company | Required. The [Company][google.ads.admanager.v1.Company] to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
Company company = new Company();
// Make the request
Company response = await companyServiceClient.CreateCompanyAsync(parent, company);
CreateCompanyAsync(NetworkName, Company, CancellationToken)
Creates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> CreateCompanyAsync(NetworkName parent, Company company, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where this
[Company][google.ads.admanager.v1.Company] will be created. Format:
|
| Company | company | Required. The [Company][google.ads.admanager.v1.Company] to create. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
Company company = new Company();
// Make the request
Company response = await companyServiceClient.CreateCompanyAsync(parent, company);
CreateCompanyAsync(string, Company, CallSettings)
Creates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> CreateCompanyAsync(string parent, Company company, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this
[Company][google.ads.admanager.v1.Company] will be created. Format:
|
| Company | company | Required. The [Company][google.ads.admanager.v1.Company] to create. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
Company company = new Company();
// Make the request
Company response = await companyServiceClient.CreateCompanyAsync(parent, company);
CreateCompanyAsync(string, Company, CancellationToken)
Creates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> CreateCompanyAsync(string parent, Company company, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this
[Company][google.ads.admanager.v1.Company] will be created. Format:
|
| Company | company | Required. The [Company][google.ads.admanager.v1.Company] to create. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
Company company = new Company();
// Make the request
Company response = await companyServiceClient.CreateCompanyAsync(parent, company);
GetCompany(CompanyName, CallSettings)
Retrieves a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Company GetCompany(CompanyName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CompanyName | name | Required. The resource name of the Company.
Format: |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Company | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
CompanyName name = CompanyName.FromNetworkCodeCompany("[NETWORK_CODE]", "[COMPANY]");
// Make the request
Company response = companyServiceClient.GetCompany(name);
GetCompany(GetCompanyRequest, CallSettings)
Retrieves a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Company GetCompany(GetCompanyRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetCompanyRequest | 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 |
|---|---|
| Company | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
GetCompanyRequest request = new GetCompanyRequest
{
CompanyName = CompanyName.FromNetworkCodeCompany("[NETWORK_CODE]", "[COMPANY]"),
};
// Make the request
Company response = companyServiceClient.GetCompany(request);
GetCompany(string, CallSettings)
Retrieves a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Company GetCompany(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The resource name of the Company.
Format: |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Company | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/companies/[COMPANY]";
// Make the request
Company response = companyServiceClient.GetCompany(name);
GetCompanyAsync(CompanyName, CallSettings)
Retrieves a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> GetCompanyAsync(CompanyName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CompanyName | name | Required. The resource name of the Company.
Format: |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
CompanyName name = CompanyName.FromNetworkCodeCompany("[NETWORK_CODE]", "[COMPANY]");
// Make the request
Company response = await companyServiceClient.GetCompanyAsync(name);
GetCompanyAsync(CompanyName, CancellationToken)
Retrieves a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> GetCompanyAsync(CompanyName name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CompanyName | name | Required. The resource name of the Company.
Format: |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
CompanyName name = CompanyName.FromNetworkCodeCompany("[NETWORK_CODE]", "[COMPANY]");
// Make the request
Company response = await companyServiceClient.GetCompanyAsync(name);
GetCompanyAsync(GetCompanyRequest, CallSettings)
Retrieves a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> GetCompanyAsync(GetCompanyRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetCompanyRequest | 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<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
GetCompanyRequest request = new GetCompanyRequest
{
CompanyName = CompanyName.FromNetworkCodeCompany("[NETWORK_CODE]", "[COMPANY]"),
};
// Make the request
Company response = await companyServiceClient.GetCompanyAsync(request);
GetCompanyAsync(GetCompanyRequest, CancellationToken)
Retrieves a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> GetCompanyAsync(GetCompanyRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| GetCompanyRequest | 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<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
GetCompanyRequest request = new GetCompanyRequest
{
CompanyName = CompanyName.FromNetworkCodeCompany("[NETWORK_CODE]", "[COMPANY]"),
};
// Make the request
Company response = await companyServiceClient.GetCompanyAsync(request);
GetCompanyAsync(string, CallSettings)
Retrieves a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> GetCompanyAsync(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The resource name of the Company.
Format: |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/companies/[COMPANY]";
// Make the request
Company response = await companyServiceClient.GetCompanyAsync(name);
GetCompanyAsync(string, CancellationToken)
Retrieves a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> GetCompanyAsync(string name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The resource name of the Company.
Format: |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/companies/[COMPANY]";
// Make the request
Company response = await companyServiceClient.GetCompanyAsync(name);
ListCompanies(ListCompaniesRequest, CallSettings)
Lists [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual PagedEnumerable<ListCompaniesResponse, Company> ListCompanies(ListCompaniesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListCompaniesRequest | 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<ListCompaniesResponse, Company> | A pageable sequence of Company resources. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
ListCompaniesRequest request = new ListCompaniesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Filter = "",
OrderBy = "",
Skip = 0,
};
// Make the request
PagedEnumerable<ListCompaniesResponse, Company> response = companyServiceClient.ListCompanies(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Company 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 (ListCompaniesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Company 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<Company> 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 (Company 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;
ListCompanies(NetworkName, string, int?, CallSettings)
Lists [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual PagedEnumerable<ListCompaniesResponse, Company> ListCompanies(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent, which owns this collection of [Companies][].
Format: |
| 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<ListCompaniesResponse, Company> | A pageable sequence of Company resources. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListCompaniesResponse, Company> response = companyServiceClient.ListCompanies(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Company 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 (ListCompaniesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Company 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<Company> 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 (Company 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;
ListCompanies(string, string, int?, CallSettings)
Lists [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual PagedEnumerable<ListCompaniesResponse, Company> ListCompanies(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent, which owns this collection of [Companies][].
Format: |
| 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<ListCompaniesResponse, Company> | A pageable sequence of Company resources. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListCompaniesResponse, Company> response = companyServiceClient.ListCompanies(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Company 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 (ListCompaniesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Company 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<Company> 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 (Company 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;
ListCompaniesAsync(ListCompaniesRequest, CallSettings)
Lists [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual PagedAsyncEnumerable<ListCompaniesResponse, Company> ListCompaniesAsync(ListCompaniesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListCompaniesRequest | 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<ListCompaniesResponse, Company> | A pageable asynchronous sequence of Company resources. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
ListCompaniesRequest request = new ListCompaniesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Filter = "",
OrderBy = "",
Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListCompaniesResponse, Company> response = companyServiceClient.ListCompaniesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (Company 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 (ListCompaniesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Company 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<Company> 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 (Company 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;
ListCompaniesAsync(NetworkName, string, int?, CallSettings)
Lists [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual PagedAsyncEnumerable<ListCompaniesResponse, Company> ListCompaniesAsync(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent, which owns this collection of [Companies][].
Format: |
| 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<ListCompaniesResponse, Company> | A pageable asynchronous sequence of Company resources. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListCompaniesResponse, Company> response = companyServiceClient.ListCompaniesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (Company 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 (ListCompaniesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Company 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<Company> 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 (Company 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;
ListCompaniesAsync(string, string, int?, CallSettings)
Lists [Company][google.ads.admanager.v1.Company] objects.
Declaration
public virtual PagedAsyncEnumerable<ListCompaniesResponse, Company> ListCompaniesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent, which owns this collection of [Companies][].
Format: |
| 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<ListCompaniesResponse, Company> | A pageable asynchronous sequence of Company resources. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListCompaniesResponse, Company> response = companyServiceClient.ListCompaniesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (Company 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 (ListCompaniesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Company 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<Company> 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 (Company 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;
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.
UpdateCompany(Company, FieldMask, CallSettings)
Updates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Company UpdateCompany(Company company, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Company | company | Required. The [Company][google.ads.admanager.v1.Company] to update. The [Company][google.ads.admanager.v1.Company]'s |
| FieldMask | updateMask | Optional. The list of fields to update. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Company | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
Company company = new Company();
FieldMask updateMask = new FieldMask();
// Make the request
Company response = companyServiceClient.UpdateCompany(company, updateMask);
UpdateCompany(UpdateCompanyRequest, CallSettings)
Updates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Company UpdateCompany(UpdateCompanyRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateCompanyRequest | 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 |
|---|---|
| Company | The RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = CompanyServiceClient.Create();
// Initialize request argument(s)
UpdateCompanyRequest request = new UpdateCompanyRequest
{
Company = new Company(),
UpdateMask = new FieldMask(),
};
// Make the request
Company response = companyServiceClient.UpdateCompany(request);
UpdateCompanyAsync(Company, FieldMask, CallSettings)
Updates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> UpdateCompanyAsync(Company company, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Company | company | Required. The [Company][google.ads.admanager.v1.Company] to update. The [Company][google.ads.admanager.v1.Company]'s |
| FieldMask | updateMask | Optional. The list of fields to update. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
Company company = new Company();
FieldMask updateMask = new FieldMask();
// Make the request
Company response = await companyServiceClient.UpdateCompanyAsync(company, updateMask);
UpdateCompanyAsync(Company, FieldMask, CancellationToken)
Updates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> UpdateCompanyAsync(Company company, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| Company | company | Required. The [Company][google.ads.admanager.v1.Company] to update. The [Company][google.ads.admanager.v1.Company]'s |
| FieldMask | updateMask | Optional. The list of fields to update. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
Company company = new Company();
FieldMask updateMask = new FieldMask();
// Make the request
Company response = await companyServiceClient.UpdateCompanyAsync(company, updateMask);
UpdateCompanyAsync(UpdateCompanyRequest, CallSettings)
Updates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> UpdateCompanyAsync(UpdateCompanyRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateCompanyRequest | 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<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCompanyRequest request = new UpdateCompanyRequest
{
Company = new Company(),
UpdateMask = new FieldMask(),
};
// Make the request
Company response = await companyServiceClient.UpdateCompanyAsync(request);
UpdateCompanyAsync(UpdateCompanyRequest, CancellationToken)
Updates a [Company][google.ads.admanager.v1.Company] object.
Declaration
public virtual Task<Company> UpdateCompanyAsync(UpdateCompanyRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateCompanyRequest | 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<Company> | A Task containing the RPC response. |
Sample code
// Create client
CompanyServiceClient companyServiceClient = await CompanyServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCompanyRequest request = new UpdateCompanyRequest
{
Company = new Company(),
UpdateMask = new FieldMask(),
};
// Make the request
Company response = await companyServiceClient.UpdateCompanyAsync(request);