Class CustomFieldName

Resource name for the CustomField resource.

Inheritance

object

CustomFieldName

Implements

IResourceName

IEquatable<CustomFieldName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class CustomFieldName : IResourceName, IEquatable<CustomFieldName>

Constructors

CustomFieldName(string, string)

Constructs a new instance of a CustomFieldName class from the component parts of pattern networks/{network_code}/customFields/{custom_field}

Declaration

public CustomFieldName(string networkCodeId, string customFieldId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	customFieldId	The CustomField ID. Must not be null or empty.

Properties

CustomFieldId

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

Declaration

public string CustomFieldId { 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 CustomFieldName.ResourceNameType of the contained resource name.

Declaration

public CustomFieldName.ResourceNameType Type { get; }

Property Value

Type	Description
CustomFieldName.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)

Formats the IDs into the string representation of this CustomFieldName with pattern networks/{network_code}/customFields/{custom_field}.

Declaration

public static string Format(string networkCodeId, string customFieldId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	customFieldId	The CustomField ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CustomFieldName with pattern networks/{network_code}/customFields/{custom_field}.

FormatNetworkCodeCustomField(string, string)

Formats the IDs into the string representation of this CustomFieldName with pattern networks/{network_code}/customFields/{custom_field}.

Declaration

public static string FormatNetworkCodeCustomField(string networkCodeId, string customFieldId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	customFieldId	The CustomField ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CustomFieldName with pattern networks/{network_code}/customFields/{custom_field}.

FromNetworkCodeCustomField(string, string)

Creates a CustomFieldName with the pattern networks/{network_code}/customFields/{custom_field}.

Declaration

public static CustomFieldName FromNetworkCodeCustomField(string networkCodeId, string customFieldId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	customFieldId	The CustomField ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CustomFieldName containing an unparsed resource name.

Declaration

public static CustomFieldName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
CustomFieldName	A new instance of CustomFieldName 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 CustomFieldName instance.

Declaration

public static CustomFieldName Parse(string customFieldName)

Parameters

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

Returns

Type	Description
CustomFieldName	The parsed CustomFieldName if successful.

Remarks

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

• networks/{network_code}/customFields/{custom_field}

Parse(string, bool)

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

Declaration

public static CustomFieldName Parse(string customFieldName, bool allowUnparsed)

Parameters

Type	Name	Description
string	customFieldName	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
CustomFieldName	The parsed CustomFieldName if successful.

Remarks

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

• networks/{network_code}/customFields/{custom_field}

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 CustomFieldName)

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

Declaration

public static bool TryParse(string customFieldName, out CustomFieldName result)

Parameters

Type	Name	Description
string	customFieldName	The resource name in string form. Must not be null.
CustomFieldName	result	When this method returns, the parsed CustomFieldName, 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}/customFields/{custom_field}

TryParse(string, bool, out CustomFieldName)

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

Declaration

public static bool TryParse(string customFieldName, bool allowUnparsed, out CustomFieldName result)

Parameters

Type	Name	Description
string	customFieldName	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.
CustomFieldName	result	When this method returns, the parsed CustomFieldName, 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}/customFields/{custom_field}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CustomFieldName, CustomFieldName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

Type	Name	Description
CustomFieldName	a	The first resource name to compare, or null.
CustomFieldName	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 !=(CustomFieldName, CustomFieldName)

Determines whether two specified resource names have different values.

Declaration

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

Parameters

Type	Name	Description
CustomFieldName	a	The first resource name to compare, or null.
CustomFieldName	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.