Class CustomTargetingValueName

Resource name for the CustomTargetingValue resource.

Inheritance

object

CustomTargetingValueName

Implements

IResourceName

IEquatable<CustomTargetingValueName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class CustomTargetingValueName : IResourceName, IEquatable<CustomTargetingValueName>

Constructors

CustomTargetingValueName(string, string, string)

Constructs a new instance of a CustomTargetingValueName class from the component parts of pattern networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}

Declaration

public CustomTargetingValueName(string networkCodeId, string customTargetingKeyId, string customTargetingValueId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	customTargetingKeyId	The CustomTargetingKey ID. Must not be null or empty.
string	customTargetingValueId	The CustomTargetingValue ID. Must not be null or empty.

Properties

CustomTargetingKeyId

The CustomTargetingKey ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string CustomTargetingKeyId { get; }

Property Value

Type	Description
string

CustomTargetingValueId

The CustomTargetingValue ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string CustomTargetingValueId { get; }

Property Value

Type	Description
string

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

NetworkCodeId

The NetworkCode ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string NetworkCodeId { get; }

Property Value

Type	Description
string

Type

The CustomTargetingValueName.ResourceNameType of the contained resource name.

Declaration

public CustomTargetingValueName.ResourceNameType Type { get; }

Property Value

Type	Description
CustomTargetingValueName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(string, string, string)

Formats the IDs into the string representation of this CustomTargetingValueName with pattern networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value} .

Declaration

public static string Format(string networkCodeId, string customTargetingKeyId, string customTargetingValueId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	customTargetingKeyId	The CustomTargetingKey ID. Must not be null or empty.
string	customTargetingValueId	The CustomTargetingValue ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CustomTargetingValueName with pattern networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value} .

FormatNetworkCodeCustomTargetingKeyCustomTargetingValue(string, string, string)

Formats the IDs into the string representation of this CustomTargetingValueName with pattern networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value} .

Declaration

public static string FormatNetworkCodeCustomTargetingKeyCustomTargetingValue(string networkCodeId, string customTargetingKeyId, string customTargetingValueId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	customTargetingKeyId	The CustomTargetingKey ID. Must not be null or empty.
string	customTargetingValueId	The CustomTargetingValue ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CustomTargetingValueName with pattern networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value} .

FromNetworkCodeCustomTargetingKeyCustomTargetingValue(string, string, string)

Creates a CustomTargetingValueName with the pattern networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value} .

Declaration

public static CustomTargetingValueName FromNetworkCodeCustomTargetingKeyCustomTargetingValue(string networkCodeId, string customTargetingKeyId, string customTargetingValueId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	customTargetingKeyId	The CustomTargetingKey ID. Must not be null or empty.
string	customTargetingValueId	The CustomTargetingValue ID. Must not be null or empty.

Returns

Type	Description
CustomTargetingValueName	A new instance of CustomTargetingValueName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a CustomTargetingValueName containing an unparsed resource name.

Declaration

public static CustomTargetingValueName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be null.

Returns

Type	Description
CustomTargetingValueName	A new instance of CustomTargetingValueName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

Parses the given resource name string into a new CustomTargetingValueName instance.

Declaration

public static CustomTargetingValueName Parse(string customTargetingValueName)

Parameters

Type	Name	Description
string	customTargetingValueName	The resource name in string form. Must not be null.

Returns

Type	Description
CustomTargetingValueName	The parsed CustomTargetingValueName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}

Parse(string, bool)

Parses the given resource name string into a new CustomTargetingValueName instance; optionally allowing an unparseable resource name.

Declaration

public static CustomTargetingValueName Parse(string customTargetingValueName, bool allowUnparsed)

Parameters

Type	Name	Description
string	customTargetingValueName	The resource name in string form. Must not be null.
bool	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
CustomTargetingValueName	The parsed CustomTargetingValueName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out CustomTargetingValueName)

Tries to parse the given resource name string into a new CustomTargetingValueName instance.

Declaration

public static bool TryParse(string customTargetingValueName, out CustomTargetingValueName result)

Parameters

Type	Name	Description
string	customTargetingValueName	The resource name in string form. Must not be null.
CustomTargetingValueName	result	When this method returns, the parsed CustomTargetingValueName, or null if parsing failed.

Returns

Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}

TryParse(string, bool, out CustomTargetingValueName)

Tries to parse the given resource name string into a new CustomTargetingValueName instance; optionally allowing an unparseable resource name.

Declaration

public static bool TryParse(string customTargetingValueName, bool allowUnparsed, out CustomTargetingValueName result)

Parameters

Type	Name	Description
string	customTargetingValueName	The resource name in string form. Must not be null.
bool	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
CustomTargetingValueName	result	When this method returns, the parsed CustomTargetingValueName, or null if parsing failed.

Returns

Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CustomTargetingValueName, CustomTargetingValueName)

Determines whether two specified resource names have the same value.

Declaration

public static bool operator ==(CustomTargetingValueName a, CustomTargetingValueName b)

Parameters

Type	Name	Description
CustomTargetingValueName	a	The first resource name to compare, or null.
CustomTargetingValueName	b	The second resource name to compare, or null.

Returns

Type	Description
bool	true if the value of a is the same as the value of b; otherwise, false.

operator !=(CustomTargetingValueName, CustomTargetingValueName)

Determines whether two specified resource names have different values.

Declaration

public static bool operator !=(CustomTargetingValueName a, CustomTargetingValueName b)

Parameters

Type	Name	Description
CustomTargetingValueName	a	The first resource name to compare, or null.
CustomTargetingValueName	b	The second resource name to compare, or null.

Returns

Type	Description
bool	true if the value of a is different from the value of b; otherwise, false.