Show / Hide Table of Contents

Class GoogleAdsLinkName

Resource name for the GoogleAdsLink resource.

Inheritance
object
GoogleAdsLinkName
Implements
IResourceName
IEquatable<GoogleAdsLinkName>
Inherited Members
object.GetType()
Namespace: Google.Analytics.Admin.V1Alpha
Assembly: Google.Analytics.Admin.V1Alpha.dll
Syntax
public sealed class GoogleAdsLinkName : IResourceName, IEquatable<GoogleAdsLinkName>

Constructors

GoogleAdsLinkName(string, string)

Constructs a new instance of a GoogleAdsLinkName class from the component parts of pattern properties/{property}/googleAdsLinks/{google_ads_link}

Declaration
public GoogleAdsLinkName(string propertyId, string googleAdsLinkId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string googleAdsLinkId

The GoogleAdsLink ID. Must not be null or empty.

Properties

GoogleAdsLinkId

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

Declaration
public string GoogleAdsLinkId { 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

PropertyId

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

Declaration
public string PropertyId { get; }
Property Value
Type Description
string

Type

The GoogleAdsLinkName.ResourceNameType of the contained resource name.

Declaration
public GoogleAdsLinkName.ResourceNameType Type { get; }
Property Value
Type Description
GoogleAdsLinkName.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 GoogleAdsLinkName with pattern properties/{property}/googleAdsLinks/{google_ads_link}.

Declaration
public static string Format(string propertyId, string googleAdsLinkId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string googleAdsLinkId

The GoogleAdsLink ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this GoogleAdsLinkName with pattern properties/{property}/googleAdsLinks/{google_ads_link}.

FormatPropertyGoogleAdsLink(string, string)

Formats the IDs into the string representation of this GoogleAdsLinkName with pattern properties/{property}/googleAdsLinks/{google_ads_link}.

Declaration
public static string FormatPropertyGoogleAdsLink(string propertyId, string googleAdsLinkId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string googleAdsLinkId

The GoogleAdsLink ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this GoogleAdsLinkName with pattern properties/{property}/googleAdsLinks/{google_ads_link}.

FromPropertyGoogleAdsLink(string, string)

Creates a GoogleAdsLinkName with the pattern properties/{property}/googleAdsLinks/{google_ads_link}.

Declaration
public static GoogleAdsLinkName FromPropertyGoogleAdsLink(string propertyId, string googleAdsLinkId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string googleAdsLinkId

The GoogleAdsLink ID. Must not be null or empty.

Returns
Type Description
GoogleAdsLinkName

A new instance of GoogleAdsLinkName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a GoogleAdsLinkName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
GoogleAdsLinkName

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

Declaration
public static GoogleAdsLinkName Parse(string googleAdsLinkName)
Parameters
Type Name Description
string googleAdsLinkName

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

Returns
Type Description
GoogleAdsLinkName

The parsed GoogleAdsLinkName if successful.

Remarks

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

  • properties/{property}/googleAdsLinks/{google_ads_link}

Parse(string, bool)

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

Declaration
public static GoogleAdsLinkName Parse(string googleAdsLinkName, bool allowUnparsed)
Parameters
Type Name Description
string googleAdsLinkName

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
GoogleAdsLinkName

The parsed GoogleAdsLinkName if successful.

Remarks

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

  • properties/{property}/googleAdsLinks/{google_ads_link}
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 GoogleAdsLinkName)

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

Declaration
public static bool TryParse(string googleAdsLinkName, out GoogleAdsLinkName result)
Parameters
Type Name Description
string googleAdsLinkName

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

GoogleAdsLinkName result

When this method returns, the parsed GoogleAdsLinkName, 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:

  • properties/{property}/googleAdsLinks/{google_ads_link}

TryParse(string, bool, out GoogleAdsLinkName)

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

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

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.

GoogleAdsLinkName result

When this method returns, the parsed GoogleAdsLinkName, 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:

  • properties/{property}/googleAdsLinks/{google_ads_link}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(GoogleAdsLinkName, GoogleAdsLinkName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

GoogleAdsLinkName 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