Class PartnerLink (0.16.0)

public final class PartnerLink extends GeneratedMessage implements PartnerLinkOrBuilder

A partner link between an owning account and a partner account.

Protobuf type google.ads.datamanager.v1.PartnerLink

Static Fields

public static final int FEATURE_SET_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int OWNING_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int
public static final int PARTNER_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int
public static final int PARTNER_CUSTOMER_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int
public static final int PARTNER_LINK_ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int PARTNER_LINK_METADATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

public static PartnerLink getDefaultInstance()
Returns
Type Description
PartnerLink
public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor
public static PartnerLink.Builder newBuilder()
Returns
Type Description
PartnerLink.Builder
public static PartnerLink.Builder newBuilder(PartnerLink prototype)
Parameter
Name Description
prototype PartnerLink
Returns
Type Description
PartnerLink.Builder
public static PartnerLink parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PartnerLink
Exceptions
Type Description
IOException
public static PartnerLink parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartnerLink
Exceptions
Type Description
IOException
public static PartnerLink parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PartnerLink
Exceptions
Type Description
InvalidProtocolBufferException
public static PartnerLink parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartnerLink
Exceptions
Type Description
InvalidProtocolBufferException
public static PartnerLink parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PartnerLink
Exceptions
Type Description
InvalidProtocolBufferException
public static PartnerLink parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartnerLink
Exceptions
Type Description
InvalidProtocolBufferException
public static PartnerLink parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PartnerLink
Exceptions
Type Description
IOException
public static PartnerLink parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartnerLink
Exceptions
Type Description
IOException
public static PartnerLink parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PartnerLink
Exceptions
Type Description
IOException
public static PartnerLink parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartnerLink
Exceptions
Type Description
IOException
public static PartnerLink parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PartnerLink
Exceptions
Type Description
InvalidProtocolBufferException
public static PartnerLink parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartnerLink
Exceptions
Type Description
InvalidProtocolBufferException
public static Parser<PartnerLink> parser()
Returns
Type Description
Parser<PartnerLink>

Methods

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides
public PartnerLink getDefaultInstanceForType()
Returns
Type Description
PartnerLink
public FeatureSet getFeatureSet()

Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.

.google.ads.datamanager.v1.FeatureSet feature_set = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
FeatureSet

The featureSet.

public int getFeatureSetValue()

Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.

.google.ads.datamanager.v1.FeatureSet feature_set = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for featureSet.

public String getName()

Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

public ByteString getNameBytes()

Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

public ProductAccount getOwningAccount()

Required. The owning account granting access to the partner account.

.google.ads.datamanager.v1.ProductAccount owning_account = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductAccount

The owningAccount.

public ProductAccountOrBuilder getOwningAccountOrBuilder()

Required. The owning account granting access to the partner account.

.google.ads.datamanager.v1.ProductAccount owning_account = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductAccountOrBuilder
public Parser<PartnerLink> getParserForType()
Returns
Type Description
Parser<PartnerLink>
Overrides
public ProductAccount getPartnerAccount()

Required. The partner account granted access by the owning account.

.google.ads.datamanager.v1.ProductAccount partner_account = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductAccount

The partnerAccount.

public ProductAccountOrBuilder getPartnerAccountOrBuilder()

Required. The partner account granted access by the owning account.

.google.ads.datamanager.v1.ProductAccount partner_account = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductAccountOrBuilder
public PartnerCustomerAccount getPartnerCustomerAccount()

Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set.

.google.ads.datamanager.v1.PartnerCustomerAccount partner_customer_account = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PartnerCustomerAccount

The partnerCustomerAccount.

public PartnerCustomerAccountOrBuilder getPartnerCustomerAccountOrBuilder()

Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set.

.google.ads.datamanager.v1.PartnerCustomerAccount partner_customer_account = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PartnerCustomerAccountOrBuilder
public String getPartnerLinkId()

Output only. The partner link ID.

string partner_link_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The partnerLinkId.

public ByteString getPartnerLinkIdBytes()

Output only. The partner link ID.

string partner_link_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for partnerLinkId.

public PartnerLinkMetadata getPartnerLinkMetadata()

Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT.

.google.ads.datamanager.v1.PartnerLinkMetadata partner_link_metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PartnerLinkMetadata

The partnerLinkMetadata.

public PartnerLinkMetadataOrBuilder getPartnerLinkMetadataOrBuilder()

Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT.

.google.ads.datamanager.v1.PartnerLinkMetadata partner_link_metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PartnerLinkMetadataOrBuilder
public int getSerializedSize()
Returns
Type Description
int
Overrides
public boolean hasOwningAccount()

Required. The owning account granting access to the partner account.

.google.ads.datamanager.v1.ProductAccount owning_account = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the owningAccount field is set.

public boolean hasPartnerAccount()

Required. The partner account granted access by the owning account.

.google.ads.datamanager.v1.ProductAccount partner_account = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the partnerAccount field is set.

public boolean hasPartnerCustomerAccount()

Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set.

.google.ads.datamanager.v1.PartnerCustomerAccount partner_customer_account = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the partnerCustomerAccount field is set.

public boolean hasPartnerLinkMetadata()

Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT.

.google.ads.datamanager.v1.PartnerLinkMetadata partner_link_metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the partnerLinkMetadata field is set.

public int hashCode()
Returns
Type Description
int
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides
public final boolean isInitialized()
Returns
Type Description
boolean
Overrides
public PartnerLink.Builder newBuilderForType()
Returns
Type Description
PartnerLink.Builder
protected PartnerLink.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PartnerLink.Builder
Overrides
public PartnerLink.Builder toBuilder()
Returns
Type Description
PartnerLink.Builder
public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException