Show / Hide Table of Contents

Class AdCategoryName

Resource name for the AdCategory resource.

Inheritance
object
AdCategoryName
Implements
IResourceName
IEquatable<AdCategoryName>
Inherited Members
object.GetType()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public sealed class AdCategoryName : IResourceName, IEquatable<AdCategoryName>

Constructors

AdCategoryName(string, string)

Constructs a new instance of a AdCategoryName class from the component parts of pattern networks/{network_code}/adCategories/{ad_category}

Declaration
public AdCategoryName(string networkCodeId, string adCategoryId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string adCategoryId

The AdCategory ID. Must not be null or empty.

Properties

AdCategoryId

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

Declaration
public string AdCategoryId { 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 AdCategoryName.ResourceNameType of the contained resource name.

Declaration
public AdCategoryName.ResourceNameType Type { get; }
Property Value
Type Description
AdCategoryName.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 AdCategoryName with pattern networks/{network_code}/adCategories/{ad_category}.

Declaration
public static string Format(string networkCodeId, string adCategoryId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string adCategoryId

The AdCategory ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AdCategoryName with pattern networks/{network_code}/adCategories/{ad_category}.

FormatNetworkCodeAdCategory(string, string)

Formats the IDs into the string representation of this AdCategoryName with pattern networks/{network_code}/adCategories/{ad_category}.

Declaration
public static string FormatNetworkCodeAdCategory(string networkCodeId, string adCategoryId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string adCategoryId

The AdCategory ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AdCategoryName with pattern networks/{network_code}/adCategories/{ad_category}.

FromNetworkCodeAdCategory(string, string)

Creates a AdCategoryName with the pattern networks/{network_code}/adCategories/{ad_category}.

Declaration
public static AdCategoryName FromNetworkCodeAdCategory(string networkCodeId, string adCategoryId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string adCategoryId

The AdCategory ID. Must not be null or empty.

Returns
Type Description
AdCategoryName

A new instance of AdCategoryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a AdCategoryName containing an unparsed resource name.

Declaration
public static AdCategoryName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
AdCategoryName

A new instance of AdCategoryName 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 AdCategoryName instance.

Declaration
public static AdCategoryName Parse(string adCategoryName)
Parameters
Type Name Description
string adCategoryName

The resource name in string form. Must not be null.

Returns
Type Description
AdCategoryName

The parsed AdCategoryName if successful.

Remarks

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

  • networks/{network_code}/adCategories/{ad_category}

Parse(string, bool)

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

Declaration
public static AdCategoryName Parse(string adCategoryName, bool allowUnparsed)
Parameters
Type Name Description
string adCategoryName

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
AdCategoryName

The parsed AdCategoryName if successful.

Remarks

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

  • networks/{network_code}/adCategories/{ad_category}

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

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

Declaration
public static bool TryParse(string adCategoryName, out AdCategoryName result)
Parameters
Type Name Description
string adCategoryName

The resource name in string form. Must not be null.

AdCategoryName result

When this method returns, the parsed AdCategoryName, 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}/adCategories/{ad_category}

TryParse(string, bool, out AdCategoryName)

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

Declaration
public static bool TryParse(string adCategoryName, bool allowUnparsed, out AdCategoryName result)
Parameters
Type Name Description
string adCategoryName

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.

AdCategoryName result

When this method returns, the parsed AdCategoryName, 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}/adCategories/{ad_category}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AdCategoryName, AdCategoryName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(AdCategoryName a, AdCategoryName b)
Parameters
Type Name Description
AdCategoryName a

The first resource name to compare, or null.

AdCategoryName 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 !=(AdCategoryName, AdCategoryName)

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(AdCategoryName a, AdCategoryName b)
Parameters
Type Name Description
AdCategoryName a

The first resource name to compare, or null.

AdCategoryName 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.

In this article
Back to top Generated by DocFX