Class CreativeTemplateName

Resource name for the CreativeTemplate resource.

Inheritance

object

CreativeTemplateName

Implements

IResourceName

IEquatable<CreativeTemplateName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class CreativeTemplateName : IResourceName, IEquatable<CreativeTemplateName>

Constructors

CreativeTemplateName(string, string)

Constructs a new instance of a CreativeTemplateName class from the component parts of pattern networks/{network_code}/creativeTemplates/{creative_template}

Declaration

public CreativeTemplateName(string networkCodeId, string creativeTemplateId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	creativeTemplateId	The CreativeTemplate ID. Must not be null or empty.

Properties

CreativeTemplateId

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

Declaration

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

Declaration

public CreativeTemplateName.ResourceNameType Type { get; }

Property Value

Type	Description
CreativeTemplateName.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 CreativeTemplateName with pattern networks/{network_code}/creativeTemplates/{creative_template}.

Declaration

public static string Format(string networkCodeId, string creativeTemplateId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	creativeTemplateId	The CreativeTemplate ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CreativeTemplateName with pattern networks/{network_code}/creativeTemplates/{creative_template}.

FormatNetworkCodeCreativeTemplate(string, string)

Formats the IDs into the string representation of this CreativeTemplateName with pattern networks/{network_code}/creativeTemplates/{creative_template}.

Declaration

public static string FormatNetworkCodeCreativeTemplate(string networkCodeId, string creativeTemplateId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	creativeTemplateId	The CreativeTemplate ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CreativeTemplateName with pattern networks/{network_code}/creativeTemplates/{creative_template}.

FromNetworkCodeCreativeTemplate(string, string)

Creates a CreativeTemplateName with the pattern networks/{network_code}/creativeTemplates/{creative_template}.

Declaration

public static CreativeTemplateName FromNetworkCodeCreativeTemplate(string networkCodeId, string creativeTemplateId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	creativeTemplateId	The CreativeTemplate ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CreativeTemplateName containing an unparsed resource name.

Declaration

public static CreativeTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static CreativeTemplateName Parse(string creativeTemplateName)

Parameters

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

Returns

Type	Description
CreativeTemplateName	The parsed CreativeTemplateName if successful.

Remarks

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

• networks/{network_code}/creativeTemplates/{creative_template}

Parse(string, bool)

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

Declaration

public static CreativeTemplateName Parse(string creativeTemplateName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/creativeTemplates/{creative_template}

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

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

Declaration

public static bool TryParse(string creativeTemplateName, out CreativeTemplateName result)

Parameters

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

TryParse(string, bool, out CreativeTemplateName)

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

Declaration

public static bool TryParse(string creativeTemplateName, bool allowUnparsed, out CreativeTemplateName result)

Parameters

Type	Name	Description
string	creativeTemplateName	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.
CreativeTemplateName	result	When this method returns, the parsed CreativeTemplateName, 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}/creativeTemplates/{creative_template}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CreativeTemplateName, CreativeTemplateName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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