Class PartnerLink.Builder (0.16.0)

public static final class PartnerLink.Builder extends GeneratedMessage.Builder<PartnerLink.Builder> implements PartnerLinkOrBuilder

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

Protobuf type google.ads.datamanager.v1.PartnerLink

Static Methods

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

public PartnerLink build()
Returns
Type Description
PartnerLink
public PartnerLink buildPartial()
Returns
Type Description
PartnerLink
public PartnerLink.Builder clear()
Returns
Type Description
PartnerLink.Builder
Overrides
public PartnerLink.Builder clearFeatureSet()

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
PartnerLink.Builder

This builder for chaining.

public PartnerLink.Builder clearName()

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
PartnerLink.Builder

This builder for chaining.

public PartnerLink.Builder clearOwningAccount()

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
PartnerLink.Builder
public PartnerLink.Builder clearPartnerAccount()

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
PartnerLink.Builder
public PartnerLink.Builder clearPartnerCustomerAccount()

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
PartnerLink.Builder
public PartnerLink.Builder clearPartnerLinkId()

Output only. The partner link ID.

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

Returns
Type Description
PartnerLink.Builder

This builder for chaining.

public PartnerLink.Builder clearPartnerLinkMetadata()

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
PartnerLink.Builder
public PartnerLink getDefaultInstanceForType()
Returns
Type Description
PartnerLink
public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides
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 ProductAccount.Builder getOwningAccountBuilder()

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.Builder
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 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 ProductAccount.Builder getPartnerAccountBuilder()

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.Builder
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 PartnerCustomerAccount.Builder getPartnerCustomerAccountBuilder()

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.Builder
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 PartnerLinkMetadata.Builder getPartnerLinkMetadataBuilder()

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

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides
public final boolean isInitialized()
Returns
Type Description
boolean
Overrides
public PartnerLink.Builder mergeFrom(PartnerLink other)
Parameter
Name Description
other PartnerLink
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartnerLink.Builder
Overrides
Exceptions
Type Description
IOException
public PartnerLink.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PartnerLink.Builder
Overrides
public PartnerLink.Builder mergeOwningAccount(ProductAccount value)

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

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

Parameter
Name Description
value ProductAccount
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder mergePartnerAccount(ProductAccount value)

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

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

Parameter
Name Description
value ProductAccount
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder mergePartnerCustomerAccount(PartnerCustomerAccount value)

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];

Parameter
Name Description
value PartnerCustomerAccount
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder mergePartnerLinkMetadata(PartnerLinkMetadata value)

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];

Parameter
Name Description
value PartnerLinkMetadata
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder setFeatureSet(FeatureSet value)

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];

Parameter
Name Description
value FeatureSet

The featureSet to set.

Returns
Type Description
PartnerLink.Builder

This builder for chaining.

public PartnerLink.Builder setFeatureSetValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for featureSet to set.

Returns
Type Description
PartnerLink.Builder

This builder for chaining.

public PartnerLink.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
PartnerLink.Builder

This builder for chaining.

public PartnerLink.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
PartnerLink.Builder

This builder for chaining.

public PartnerLink.Builder setOwningAccount(ProductAccount value)

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

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

Parameter
Name Description
value ProductAccount
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder setOwningAccount(ProductAccount.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue ProductAccount.Builder
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder setPartnerAccount(ProductAccount value)

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

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

Parameter
Name Description
value ProductAccount
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder setPartnerAccount(ProductAccount.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue ProductAccount.Builder
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder setPartnerCustomerAccount(PartnerCustomerAccount value)

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];

Parameter
Name Description
value PartnerCustomerAccount
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder setPartnerCustomerAccount(PartnerCustomerAccount.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PartnerCustomerAccount.Builder
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder setPartnerLinkId(String value)

Output only. The partner link ID.

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

Parameter
Name Description
value String

The partnerLinkId to set.

Returns
Type Description
PartnerLink.Builder

This builder for chaining.

public PartnerLink.Builder setPartnerLinkIdBytes(ByteString value)

Output only. The partner link ID.

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

Parameter
Name Description
value ByteString

The bytes for partnerLinkId to set.

Returns
Type Description
PartnerLink.Builder

This builder for chaining.

public PartnerLink.Builder setPartnerLinkMetadata(PartnerLinkMetadata value)

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];

Parameter
Name Description
value PartnerLinkMetadata
Returns
Type Description
PartnerLink.Builder
public PartnerLink.Builder setPartnerLinkMetadata(PartnerLinkMetadata.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PartnerLinkMetadata.Builder
Returns
Type Description
PartnerLink.Builder