Show / Hide Table of Contents

Class YieldPartnerServiceClient

YieldPartnerService client wrapper, for convenient use.

Inheritance
object
YieldPartnerServiceClient
YieldPartnerServiceClientImpl
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 YieldPartnerServiceClient
Remarks

Provides methods for retrieving yield partners.

Properties

DefaultEndpoint

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

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

The default YieldPartnerService scopes are:

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

GrpcClient

The underlying gRPC YieldPartnerService client

Declaration
public virtual YieldPartnerService.YieldPartnerServiceClient GrpcClient { get; }
Property Value
Type Description
YieldPartnerService.YieldPartnerServiceClient

ServiceMetadata

The service metadata associated with this client type.

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

Methods

Create()

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

Declaration
public static YieldPartnerServiceClient Create()
Returns
Type Description
YieldPartnerServiceClient

The created YieldPartnerServiceClient.

CreateAsync(CancellationToken)

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

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

The CancellationToken to use while creating the client.

Returns
Type Description
Task<YieldPartnerServiceClient>

The task representing the created YieldPartnerServiceClient.

GetYieldPartner(GetYieldPartnerRequest, CallSettings)

Gets a YieldPartner object.

Declaration
public virtual YieldPartner GetYieldPartner(GetYieldPartnerRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetYieldPartnerRequest 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
YieldPartner

The RPC response.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = YieldPartnerServiceClient.Create();
// Initialize request argument(s)
GetYieldPartnerRequest request = new GetYieldPartnerRequest
{
    YieldPartnerName = YieldPartnerName.FromNetworkCodeYieldPartner("[NETWORK_CODE]", "[YIELD_PARTNER]"),
};
// Make the request
YieldPartner response = yieldPartnerServiceClient.GetYieldPartner(request);

GetYieldPartner(YieldPartnerName, CallSettings)

Gets a YieldPartner object.

Declaration
public virtual YieldPartner GetYieldPartner(YieldPartnerName name, CallSettings callSettings = null)
Parameters
Type Name Description
YieldPartnerName name

Required. The resource name of the yield partner. Format: networks/{network_code}/yieldPartners/{yieldPartnerId}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldPartner

The RPC response.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = YieldPartnerServiceClient.Create();
// Initialize request argument(s)
YieldPartnerName name = YieldPartnerName.FromNetworkCodeYieldPartner("[NETWORK_CODE]", "[YIELD_PARTNER]");
// Make the request
YieldPartner response = yieldPartnerServiceClient.GetYieldPartner(name);

GetYieldPartner(string, CallSettings)

Gets a YieldPartner object.

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

Required. The resource name of the yield partner. Format: networks/{network_code}/yieldPartners/{yieldPartnerId}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldPartner

The RPC response.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = YieldPartnerServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/yieldPartners/[YIELD_PARTNER]";
// Make the request
YieldPartner response = yieldPartnerServiceClient.GetYieldPartner(name);

GetYieldPartnerAsync(GetYieldPartnerRequest, CallSettings)

Gets a YieldPartner object.

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

A Task containing the RPC response.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = await YieldPartnerServiceClient.CreateAsync();
// Initialize request argument(s)
GetYieldPartnerRequest request = new GetYieldPartnerRequest
{
    YieldPartnerName = YieldPartnerName.FromNetworkCodeYieldPartner("[NETWORK_CODE]", "[YIELD_PARTNER]"),
};
// Make the request
YieldPartner response = await yieldPartnerServiceClient.GetYieldPartnerAsync(request);

GetYieldPartnerAsync(GetYieldPartnerRequest, CancellationToken)

Gets a YieldPartner object.

Declaration
public virtual Task<YieldPartner> GetYieldPartnerAsync(GetYieldPartnerRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetYieldPartnerRequest 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<YieldPartner>

A Task containing the RPC response.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = await YieldPartnerServiceClient.CreateAsync();
// Initialize request argument(s)
GetYieldPartnerRequest request = new GetYieldPartnerRequest
{
    YieldPartnerName = YieldPartnerName.FromNetworkCodeYieldPartner("[NETWORK_CODE]", "[YIELD_PARTNER]"),
};
// Make the request
YieldPartner response = await yieldPartnerServiceClient.GetYieldPartnerAsync(request);

GetYieldPartnerAsync(YieldPartnerName, CallSettings)

Gets a YieldPartner object.

Declaration
public virtual Task<YieldPartner> GetYieldPartnerAsync(YieldPartnerName name, CallSettings callSettings = null)
Parameters
Type Name Description
YieldPartnerName name

Required. The resource name of the yield partner. Format: networks/{network_code}/yieldPartners/{yieldPartnerId}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldPartner>

A Task containing the RPC response.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = await YieldPartnerServiceClient.CreateAsync();
// Initialize request argument(s)
YieldPartnerName name = YieldPartnerName.FromNetworkCodeYieldPartner("[NETWORK_CODE]", "[YIELD_PARTNER]");
// Make the request
YieldPartner response = await yieldPartnerServiceClient.GetYieldPartnerAsync(name);

GetYieldPartnerAsync(YieldPartnerName, CancellationToken)

Gets a YieldPartner object.

Declaration
public virtual Task<YieldPartner> GetYieldPartnerAsync(YieldPartnerName name, CancellationToken cancellationToken)
Parameters
Type Name Description
YieldPartnerName name

Required. The resource name of the yield partner. Format: networks/{network_code}/yieldPartners/{yieldPartnerId}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldPartner>

A Task containing the RPC response.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = await YieldPartnerServiceClient.CreateAsync();
// Initialize request argument(s)
YieldPartnerName name = YieldPartnerName.FromNetworkCodeYieldPartner("[NETWORK_CODE]", "[YIELD_PARTNER]");
// Make the request
YieldPartner response = await yieldPartnerServiceClient.GetYieldPartnerAsync(name);

GetYieldPartnerAsync(string, CallSettings)

Gets a YieldPartner object.

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

Required. The resource name of the yield partner. Format: networks/{network_code}/yieldPartners/{yieldPartnerId}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldPartner>

A Task containing the RPC response.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = await YieldPartnerServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/yieldPartners/[YIELD_PARTNER]";
// Make the request
YieldPartner response = await yieldPartnerServiceClient.GetYieldPartnerAsync(name);

GetYieldPartnerAsync(string, CancellationToken)

Gets a YieldPartner object.

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

Required. The resource name of the yield partner. Format: networks/{network_code}/yieldPartners/{yieldPartnerId}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldPartner>

A Task containing the RPC response.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = await YieldPartnerServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/yieldPartners/[YIELD_PARTNER]";
// Make the request
YieldPartner response = await yieldPartnerServiceClient.GetYieldPartnerAsync(name);

ListYieldPartners(ListYieldPartnersRequest, CallSettings)

Gets a list of all yield partners.

Declaration
public virtual PagedEnumerable<ListYieldPartnersResponse, YieldPartner> ListYieldPartners(ListYieldPartnersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListYieldPartnersRequest 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<ListYieldPartnersResponse, YieldPartner>

A pageable sequence of YieldPartner resources.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = YieldPartnerServiceClient.Create();
// Initialize request argument(s)
ListYieldPartnersRequest request = new ListYieldPartnersRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListYieldPartnersResponse, YieldPartner> response = yieldPartnerServiceClient.ListYieldPartners(request);

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

ListYieldPartners(NetworkName, string, int?, CallSettings)

Gets a list of all yield partners.

Declaration
public virtual PagedEnumerable<ListYieldPartnersResponse, YieldPartner> ListYieldPartners(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 yield partners. 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<ListYieldPartnersResponse, YieldPartner>

A pageable sequence of YieldPartner resources.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = YieldPartnerServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListYieldPartnersResponse, YieldPartner> response = yieldPartnerServiceClient.ListYieldPartners(parent);

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

ListYieldPartners(string, string, int?, CallSettings)

Gets a list of all yield partners.

Declaration
public virtual PagedEnumerable<ListYieldPartnersResponse, YieldPartner> ListYieldPartners(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 yield partners. 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<ListYieldPartnersResponse, YieldPartner>

A pageable sequence of YieldPartner resources.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = YieldPartnerServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListYieldPartnersResponse, YieldPartner> response = yieldPartnerServiceClient.ListYieldPartners(parent);

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

ListYieldPartnersAsync(ListYieldPartnersRequest, CallSettings)

Gets a list of all yield partners.

Declaration
public virtual PagedAsyncEnumerable<ListYieldPartnersResponse, YieldPartner> ListYieldPartnersAsync(ListYieldPartnersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListYieldPartnersRequest 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<ListYieldPartnersResponse, YieldPartner>

A pageable asynchronous sequence of YieldPartner resources.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = await YieldPartnerServiceClient.CreateAsync();
// Initialize request argument(s)
ListYieldPartnersRequest request = new ListYieldPartnersRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListYieldPartnersResponse, YieldPartner> response = yieldPartnerServiceClient.ListYieldPartnersAsync(request);

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

ListYieldPartnersAsync(NetworkName, string, int?, CallSettings)

Gets a list of all yield partners.

Declaration
public virtual PagedAsyncEnumerable<ListYieldPartnersResponse, YieldPartner> ListYieldPartnersAsync(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 yield partners. 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<ListYieldPartnersResponse, YieldPartner>

A pageable asynchronous sequence of YieldPartner resources.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = await YieldPartnerServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListYieldPartnersResponse, YieldPartner> response = yieldPartnerServiceClient.ListYieldPartnersAsync(parent);

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

ListYieldPartnersAsync(string, string, int?, CallSettings)

Gets a list of all yield partners.

Declaration
public virtual PagedAsyncEnumerable<ListYieldPartnersResponse, YieldPartner> ListYieldPartnersAsync(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 yield partners. 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<ListYieldPartnersResponse, YieldPartner>

A pageable asynchronous sequence of YieldPartner resources.

Sample code
// Create client
YieldPartnerServiceClient yieldPartnerServiceClient = await YieldPartnerServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListYieldPartnersResponse, YieldPartner> response = yieldPartnerServiceClient.ListYieldPartnersAsync(parent);

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