Show / Hide Table of Contents

Class SuggestedAdUnitServiceClient

SuggestedAdUnitService client wrapper, for convenient use.

Inheritance
object
SuggestedAdUnitServiceClient
SuggestedAdUnitServiceClientImpl
Inherited Members
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public abstract class SuggestedAdUnitServiceClient
Remarks

Provides methods for handling SuggestedAdUnit objects.

Properties

DefaultEndpoint

The default endpoint for the SuggestedAdUnitService 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 SuggestedAdUnitService scopes.

Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type Description
IReadOnlyList<string>
Remarks

The default SuggestedAdUnitService scopes are:

  • https://www.googleapis.com/auth/admanager
  • https://www.googleapis.com/auth/admanager.readonly

GrpcClient

The underlying gRPC SuggestedAdUnitService client

Declaration
public virtual SuggestedAdUnitService.SuggestedAdUnitServiceClient GrpcClient { get; }
Property Value
Type Description
SuggestedAdUnitService.SuggestedAdUnitServiceClient

ServiceMetadata

The service metadata associated with this client type.

Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
Type Description
ServiceMetadata

Methods

BatchApproveSuggestedAdUnits(BatchApproveSuggestedAdUnitsRequest, CallSettings)

Bulk approve SuggestedAdUnit objects.

Declaration
public virtual BatchApproveSuggestedAdUnitsResponse BatchApproveSuggestedAdUnits(BatchApproveSuggestedAdUnitsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchApproveSuggestedAdUnitsRequest 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
BatchApproveSuggestedAdUnitsResponse

The RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = SuggestedAdUnitServiceClient.Create();
// Initialize request argument(s)
BatchApproveSuggestedAdUnitsRequest request = new BatchApproveSuggestedAdUnitsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    SuggestedAdUnitNames =
    {
        SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]"),
    },
};
// Make the request
BatchApproveSuggestedAdUnitsResponse response = suggestedAdUnitServiceClient.BatchApproveSuggestedAdUnits(request);

BatchApproveSuggestedAdUnits(NetworkName, IEnumerable<SuggestedAdUnitName>, CallSettings)

Bulk approve SuggestedAdUnit objects.

Declaration
public virtual BatchApproveSuggestedAdUnitsResponse BatchApproveSuggestedAdUnits(NetworkName parent, IEnumerable<SuggestedAdUnitName> names, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. Format: networks/{network_code}

IEnumerable<SuggestedAdUnitName> names

Required. Resource names for the SuggestedAdUnit objects to approve. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchApproveSuggestedAdUnitsResponse

The RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = SuggestedAdUnitServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<SuggestedAdUnitName> names = new SuggestedAdUnitName[]
{
    SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]"),
};
// Make the request
BatchApproveSuggestedAdUnitsResponse response = suggestedAdUnitServiceClient.BatchApproveSuggestedAdUnits(parent, names);

BatchApproveSuggestedAdUnits(string, IEnumerable<string>, CallSettings)

Bulk approve SuggestedAdUnit objects.

Declaration
public virtual BatchApproveSuggestedAdUnitsResponse BatchApproveSuggestedAdUnits(string parent, IEnumerable<string> names, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. Format: networks/{network_code}

IEnumerable<string> names

Required. Resource names for the SuggestedAdUnit objects to approve. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchApproveSuggestedAdUnitsResponse

The RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = SuggestedAdUnitServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/suggestedAdUnits/[SUGGESTED_AD_UNIT]",
};
// Make the request
BatchApproveSuggestedAdUnitsResponse response = suggestedAdUnitServiceClient.BatchApproveSuggestedAdUnits(parent, names);

BatchApproveSuggestedAdUnitsAsync(BatchApproveSuggestedAdUnitsRequest, CallSettings)

Bulk approve SuggestedAdUnit objects.

Declaration
public virtual Task<BatchApproveSuggestedAdUnitsResponse> BatchApproveSuggestedAdUnitsAsync(BatchApproveSuggestedAdUnitsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchApproveSuggestedAdUnitsRequest 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<BatchApproveSuggestedAdUnitsResponse>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
BatchApproveSuggestedAdUnitsRequest request = new BatchApproveSuggestedAdUnitsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    SuggestedAdUnitNames =
    {
        SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]"),
    },
};
// Make the request
BatchApproveSuggestedAdUnitsResponse response = await suggestedAdUnitServiceClient.BatchApproveSuggestedAdUnitsAsync(request);

BatchApproveSuggestedAdUnitsAsync(BatchApproveSuggestedAdUnitsRequest, CancellationToken)

Bulk approve SuggestedAdUnit objects.

Declaration
public virtual Task<BatchApproveSuggestedAdUnitsResponse> BatchApproveSuggestedAdUnitsAsync(BatchApproveSuggestedAdUnitsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
BatchApproveSuggestedAdUnitsRequest 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<BatchApproveSuggestedAdUnitsResponse>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
BatchApproveSuggestedAdUnitsRequest request = new BatchApproveSuggestedAdUnitsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    SuggestedAdUnitNames =
    {
        SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]"),
    },
};
// Make the request
BatchApproveSuggestedAdUnitsResponse response = await suggestedAdUnitServiceClient.BatchApproveSuggestedAdUnitsAsync(request);

BatchApproveSuggestedAdUnitsAsync(NetworkName, IEnumerable<SuggestedAdUnitName>, CallSettings)

Bulk approve SuggestedAdUnit objects.

Declaration
public virtual Task<BatchApproveSuggestedAdUnitsResponse> BatchApproveSuggestedAdUnitsAsync(NetworkName parent, IEnumerable<SuggestedAdUnitName> names, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. Format: networks/{network_code}

IEnumerable<SuggestedAdUnitName> names

Required. Resource names for the SuggestedAdUnit objects to approve. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchApproveSuggestedAdUnitsResponse>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<SuggestedAdUnitName> names = new SuggestedAdUnitName[]
{
    SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]"),
};
// Make the request
BatchApproveSuggestedAdUnitsResponse response = await suggestedAdUnitServiceClient.BatchApproveSuggestedAdUnitsAsync(parent, names);

BatchApproveSuggestedAdUnitsAsync(NetworkName, IEnumerable<SuggestedAdUnitName>, CancellationToken)

Bulk approve SuggestedAdUnit objects.

Declaration
public virtual Task<BatchApproveSuggestedAdUnitsResponse> BatchApproveSuggestedAdUnitsAsync(NetworkName parent, IEnumerable<SuggestedAdUnitName> names, CancellationToken cancellationToken)
Parameters
Type Name Description
NetworkName parent

Required. Format: networks/{network_code}

IEnumerable<SuggestedAdUnitName> names

Required. Resource names for the SuggestedAdUnit objects to approve. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchApproveSuggestedAdUnitsResponse>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<SuggestedAdUnitName> names = new SuggestedAdUnitName[]
{
    SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]"),
};
// Make the request
BatchApproveSuggestedAdUnitsResponse response = await suggestedAdUnitServiceClient.BatchApproveSuggestedAdUnitsAsync(parent, names);

BatchApproveSuggestedAdUnitsAsync(string, IEnumerable<string>, CallSettings)

Bulk approve SuggestedAdUnit objects.

Declaration
public virtual Task<BatchApproveSuggestedAdUnitsResponse> BatchApproveSuggestedAdUnitsAsync(string parent, IEnumerable<string> names, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. Format: networks/{network_code}

IEnumerable<string> names

Required. Resource names for the SuggestedAdUnit objects to approve. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchApproveSuggestedAdUnitsResponse>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/suggestedAdUnits/[SUGGESTED_AD_UNIT]",
};
// Make the request
BatchApproveSuggestedAdUnitsResponse response = await suggestedAdUnitServiceClient.BatchApproveSuggestedAdUnitsAsync(parent, names);

BatchApproveSuggestedAdUnitsAsync(string, IEnumerable<string>, CancellationToken)

Bulk approve SuggestedAdUnit objects.

Declaration
public virtual Task<BatchApproveSuggestedAdUnitsResponse> BatchApproveSuggestedAdUnitsAsync(string parent, IEnumerable<string> names, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. Format: networks/{network_code}

IEnumerable<string> names

Required. Resource names for the SuggestedAdUnit objects to approve. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchApproveSuggestedAdUnitsResponse>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/suggestedAdUnits/[SUGGESTED_AD_UNIT]",
};
// Make the request
BatchApproveSuggestedAdUnitsResponse response = await suggestedAdUnitServiceClient.BatchApproveSuggestedAdUnitsAsync(parent, names);

Create()

Synchronously creates a SuggestedAdUnitServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SuggestedAdUnitServiceClientBuilder.

Declaration
public static SuggestedAdUnitServiceClient Create()
Returns
Type Description
SuggestedAdUnitServiceClient

The created SuggestedAdUnitServiceClient.

CreateAsync(CancellationToken)

Asynchronously creates a SuggestedAdUnitServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SuggestedAdUnitServiceClientBuilder.

Declaration
public static Task<SuggestedAdUnitServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
Task<SuggestedAdUnitServiceClient>

The task representing the created SuggestedAdUnitServiceClient.

GetSuggestedAdUnit(GetSuggestedAdUnitRequest, CallSettings)

Get a SuggestedAdUnit object.

Declaration
public virtual SuggestedAdUnit GetSuggestedAdUnit(GetSuggestedAdUnitRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetSuggestedAdUnitRequest 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
SuggestedAdUnit

The RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = SuggestedAdUnitServiceClient.Create();
// Initialize request argument(s)
GetSuggestedAdUnitRequest request = new GetSuggestedAdUnitRequest
{
    SuggestedAdUnitName = SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]"),
};
// Make the request
SuggestedAdUnit response = suggestedAdUnitServiceClient.GetSuggestedAdUnit(request);

GetSuggestedAdUnit(SuggestedAdUnitName, CallSettings)

Get a SuggestedAdUnit object.

Declaration
public virtual SuggestedAdUnit GetSuggestedAdUnit(SuggestedAdUnitName name, CallSettings callSettings = null)
Parameters
Type Name Description
SuggestedAdUnitName name

Required. The resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SuggestedAdUnit

The RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = SuggestedAdUnitServiceClient.Create();
// Initialize request argument(s)
SuggestedAdUnitName name = SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]");
// Make the request
SuggestedAdUnit response = suggestedAdUnitServiceClient.GetSuggestedAdUnit(name);

GetSuggestedAdUnit(string, CallSettings)

Get a SuggestedAdUnit object.

Declaration
public virtual SuggestedAdUnit GetSuggestedAdUnit(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SuggestedAdUnit

The RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = SuggestedAdUnitServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/suggestedAdUnits/[SUGGESTED_AD_UNIT]";
// Make the request
SuggestedAdUnit response = suggestedAdUnitServiceClient.GetSuggestedAdUnit(name);

GetSuggestedAdUnitAsync(GetSuggestedAdUnitRequest, CallSettings)

Get a SuggestedAdUnit object.

Declaration
public virtual Task<SuggestedAdUnit> GetSuggestedAdUnitAsync(GetSuggestedAdUnitRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetSuggestedAdUnitRequest 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<SuggestedAdUnit>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
GetSuggestedAdUnitRequest request = new GetSuggestedAdUnitRequest
{
    SuggestedAdUnitName = SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]"),
};
// Make the request
SuggestedAdUnit response = await suggestedAdUnitServiceClient.GetSuggestedAdUnitAsync(request);

GetSuggestedAdUnitAsync(GetSuggestedAdUnitRequest, CancellationToken)

Get a SuggestedAdUnit object.

Declaration
public virtual Task<SuggestedAdUnit> GetSuggestedAdUnitAsync(GetSuggestedAdUnitRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetSuggestedAdUnitRequest 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<SuggestedAdUnit>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
GetSuggestedAdUnitRequest request = new GetSuggestedAdUnitRequest
{
    SuggestedAdUnitName = SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]"),
};
// Make the request
SuggestedAdUnit response = await suggestedAdUnitServiceClient.GetSuggestedAdUnitAsync(request);

GetSuggestedAdUnitAsync(SuggestedAdUnitName, CallSettings)

Get a SuggestedAdUnit object.

Declaration
public virtual Task<SuggestedAdUnit> GetSuggestedAdUnitAsync(SuggestedAdUnitName name, CallSettings callSettings = null)
Parameters
Type Name Description
SuggestedAdUnitName name

Required. The resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<SuggestedAdUnit>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
SuggestedAdUnitName name = SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]");
// Make the request
SuggestedAdUnit response = await suggestedAdUnitServiceClient.GetSuggestedAdUnitAsync(name);

GetSuggestedAdUnitAsync(SuggestedAdUnitName, CancellationToken)

Get a SuggestedAdUnit object.

Declaration
public virtual Task<SuggestedAdUnit> GetSuggestedAdUnitAsync(SuggestedAdUnitName name, CancellationToken cancellationToken)
Parameters
Type Name Description
SuggestedAdUnitName name

Required. The resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<SuggestedAdUnit>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
SuggestedAdUnitName name = SuggestedAdUnitName.FromNetworkCodeSuggestedAdUnit("[NETWORK_CODE]", "[SUGGESTED_AD_UNIT]");
// Make the request
SuggestedAdUnit response = await suggestedAdUnitServiceClient.GetSuggestedAdUnitAsync(name);

GetSuggestedAdUnitAsync(string, CallSettings)

Get a SuggestedAdUnit object.

Declaration
public virtual Task<SuggestedAdUnit> GetSuggestedAdUnitAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<SuggestedAdUnit>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/suggestedAdUnits/[SUGGESTED_AD_UNIT]";
// Make the request
SuggestedAdUnit response = await suggestedAdUnitServiceClient.GetSuggestedAdUnitAsync(name);

GetSuggestedAdUnitAsync(string, CancellationToken)

Get a SuggestedAdUnit object.

Declaration
public virtual Task<SuggestedAdUnit> GetSuggestedAdUnitAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. The resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<SuggestedAdUnit>

A Task containing the RPC response.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/suggestedAdUnits/[SUGGESTED_AD_UNIT]";
// Make the request
SuggestedAdUnit response = await suggestedAdUnitServiceClient.GetSuggestedAdUnitAsync(name);

ListSuggestedAdUnits(ListSuggestedAdUnitsRequest, CallSettings)

Retrieve a list of SuggestedAdUnit objects.

Declaration
public virtual PagedEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> ListSuggestedAdUnits(ListSuggestedAdUnitsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListSuggestedAdUnitsRequest 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<ListSuggestedAdUnitsResponse, SuggestedAdUnit>

A pageable sequence of SuggestedAdUnit resources.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = SuggestedAdUnitServiceClient.Create();
// Initialize request argument(s)
ListSuggestedAdUnitsRequest request = new ListSuggestedAdUnitsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> response = suggestedAdUnitServiceClient.ListSuggestedAdUnits(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (SuggestedAdUnit 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 (ListSuggestedAdUnitsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SuggestedAdUnit 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<SuggestedAdUnit> 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 (SuggestedAdUnit 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;

ListSuggestedAdUnits(NetworkName, string, int?, CallSettings)

Retrieve a list of SuggestedAdUnit objects.

Declaration
public virtual PagedEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> ListSuggestedAdUnits(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 SuggestedAdUnits. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit>

A pageable sequence of SuggestedAdUnit resources.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = SuggestedAdUnitServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> response = suggestedAdUnitServiceClient.ListSuggestedAdUnits(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SuggestedAdUnit 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 (ListSuggestedAdUnitsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SuggestedAdUnit 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<SuggestedAdUnit> 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 (SuggestedAdUnit 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;

ListSuggestedAdUnits(string, string, int?, CallSettings)

Retrieve a list of SuggestedAdUnit objects.

Declaration
public virtual PagedEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> ListSuggestedAdUnits(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 SuggestedAdUnits. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit>

A pageable sequence of SuggestedAdUnit resources.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = SuggestedAdUnitServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> response = suggestedAdUnitServiceClient.ListSuggestedAdUnits(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SuggestedAdUnit 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 (ListSuggestedAdUnitsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SuggestedAdUnit 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<SuggestedAdUnit> 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 (SuggestedAdUnit 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;

ListSuggestedAdUnitsAsync(ListSuggestedAdUnitsRequest, CallSettings)

Retrieve a list of SuggestedAdUnit objects.

Declaration
public virtual PagedAsyncEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> ListSuggestedAdUnitsAsync(ListSuggestedAdUnitsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListSuggestedAdUnitsRequest 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<ListSuggestedAdUnitsResponse, SuggestedAdUnit>

A pageable asynchronous sequence of SuggestedAdUnit resources.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
ListSuggestedAdUnitsRequest request = new ListSuggestedAdUnitsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> response = suggestedAdUnitServiceClient.ListSuggestedAdUnitsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (SuggestedAdUnit 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 (ListSuggestedAdUnitsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SuggestedAdUnit 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<SuggestedAdUnit> 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 (SuggestedAdUnit 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;

ListSuggestedAdUnitsAsync(NetworkName, string, int?, CallSettings)

Retrieve a list of SuggestedAdUnit objects.

Declaration
public virtual PagedAsyncEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> ListSuggestedAdUnitsAsync(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 SuggestedAdUnits. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit>

A pageable asynchronous sequence of SuggestedAdUnit resources.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> response = suggestedAdUnitServiceClient.ListSuggestedAdUnitsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (SuggestedAdUnit 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 (ListSuggestedAdUnitsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SuggestedAdUnit 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<SuggestedAdUnit> 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 (SuggestedAdUnit 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;

ListSuggestedAdUnitsAsync(string, string, int?, CallSettings)

Retrieve a list of SuggestedAdUnit objects.

Declaration
public virtual PagedAsyncEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> ListSuggestedAdUnitsAsync(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 SuggestedAdUnits. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit>

A pageable asynchronous sequence of SuggestedAdUnit resources.

Sample code
// Create client
SuggestedAdUnitServiceClient suggestedAdUnitServiceClient = await SuggestedAdUnitServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListSuggestedAdUnitsResponse, SuggestedAdUnit> response = suggestedAdUnitServiceClient.ListSuggestedAdUnitsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (SuggestedAdUnit 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 (ListSuggestedAdUnitsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SuggestedAdUnit 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<SuggestedAdUnit> 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 (SuggestedAdUnit 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.

In this article
Back to top Generated by DocFX