Class Partner (0.58.0)

public final class Partner extends GeneratedMessage implements PartnerOrBuilder

The Partner resource.

Represents a publishing partner with established agreements to share inventory and revenue based on assignments.

For more information, see Add publishing partner assignments.

Protobuf type google.ads.admanager.v1.Partner

Implements

PartnerOrBuilder

Static Fields

ADDRESS_FIELD_NUMBER

public static final int ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

APPLIED_LABELS_FIELD_NUMBER

public static final int APPLIED_LABELS_FIELD_NUMBER
Field Value
Type Description
int

APPLIED_TEAMS_FIELD_NUMBER

public static final int APPLIED_TEAMS_FIELD_NUMBER
Field Value
Type Description
int

COMMENT_FIELD_NUMBER

public static final int COMMENT_FIELD_NUMBER
Field Value
Type Description
int

CREDIT_STATUS_FIELD_NUMBER

public static final int CREDIT_STATUS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EMAIL_FIELD_NUMBER

public static final int EMAIL_FIELD_NUMBER
Field Value
Type Description
int

EXTERNAL_ID_FIELD_NUMBER

public static final int EXTERNAL_ID_FIELD_NUMBER
Field Value
Type Description
int

FAX_FIELD_NUMBER

public static final int FAX_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PHONE_FIELD_NUMBER

public static final int PHONE_FIELD_NUMBER
Field Value
Type Description
int

PRIMARY_CONTACT_FIELD_NUMBER

public static final int PRIMARY_CONTACT_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Partner getDefaultInstance()
Returns
Type Description
Partner

getDescriptor()

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

newBuilder()

public static Partner.Builder newBuilder()
Returns
Type Description
Partner.Builder

newBuilder(Partner prototype)

public static Partner.Builder newBuilder(Partner prototype)
Parameter
Name Description
prototype Partner
Returns
Type Description
Partner.Builder

parseDelimitedFrom(InputStream input)

public static Partner parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Partner
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Partner parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Partner
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Partner parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Partner
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Partner parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Partner
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Partner parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Partner
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Partner parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Partner
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Partner parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Partner
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Partner parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Partner
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Partner parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Partner
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Partner parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Partner
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Partner parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Partner
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Partner parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Partner
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Partner> parser()
Returns
Type Description
Parser<Partner>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAddress()

public String getAddress()

Optional. The address for the Partner.

This value has a maximum length of 1024 characters.

optional string address = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The address.

getAddressBytes()

public ByteString getAddressBytes()

Optional. The address for the Partner.

This value has a maximum length of 1024 characters.

optional string address = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for address.

getAppliedLabels(int index)

public AppliedLabel getAppliedLabels(int index)

Optional. The labels that are directly applied to the Partner.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getAppliedLabelsCount()

public int getAppliedLabelsCount()

Optional. The labels that are directly applied to the Partner.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAppliedLabelsList()

public List<AppliedLabel> getAppliedLabelsList()

Optional. The labels that are directly applied to the Partner.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AppliedLabel>

getAppliedLabelsOrBuilder(int index)

public AppliedLabelOrBuilder getAppliedLabelsOrBuilder(int index)

Optional. The labels that are directly applied to the Partner.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getAppliedLabelsOrBuilderList()

public List<? extends AppliedLabelOrBuilder> getAppliedLabelsOrBuilderList()

Optional. The labels that are directly applied to the Partner.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder>

getAppliedTeams(int index)

public String getAppliedTeams(int index)

Optional. The resource names of Teams that are directly associated with the Partner. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The appliedTeams at the given index.

getAppliedTeamsBytes(int index)

public ByteString getAppliedTeamsBytes(int index)

Optional. The resource names of Teams that are directly associated with the Partner. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the appliedTeams at the given index.

getAppliedTeamsCount()

public int getAppliedTeamsCount()

Optional. The resource names of Teams that are directly associated with the Partner. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of appliedTeams.

getAppliedTeamsList()

public ProtocolStringList getAppliedTeamsList()

Optional. The resource names of Teams that are directly associated with the Partner. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the appliedTeams.

getComment()

public String getComment()

Optional. Comments about the Partner.

This value has a maximum length of 1024 characters.

optional string comment = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The comment.

getCommentBytes()

public ByteString getCommentBytes()

Optional. Comments about the Partner.

This value has a maximum length of 1024 characters.

optional string comment = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for comment.

getCreditStatus()

public CompanyCreditStatusEnum.CompanyCreditStatus getCreditStatus()

Optional. The credit status of the Partner.

This attribute defaults to [CompanyCreditStatus.ACTIVE][] if basic settings are enabled and [CompanyCreditStatus.ON_HOLD][] if advance settings are enabled.

optional .google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus credit_status = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CompanyCreditStatusEnum.CompanyCreditStatus

The creditStatus.

getCreditStatusValue()

public int getCreditStatusValue()

Optional. The credit status of the Partner.

This attribute defaults to [CompanyCreditStatus.ACTIVE][] if basic settings are enabled and [CompanyCreditStatus.ON_HOLD][] if advance settings are enabled.

optional .google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus credit_status = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for creditStatus.

getDefaultInstanceForType()

public Partner getDefaultInstanceForType()
Returns
Type Description
Partner

getDisplayName()

public String getDisplayName()

Required. The display name of the Partner.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the Partner.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEmail()

public String getEmail()

Optional. The email for the Partner.

This value has a maximum length of 128 characters.

optional string email = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The email.

getEmailBytes()

public ByteString getEmailBytes()

Optional. The email for the Partner.

This value has a maximum length of 128 characters.

optional string email = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for email.

getExternalId()

public String getExternalId()

Optional. The external ID for the Partner.

This value has a maximum length of 255 characters.

optional string external_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The externalId.

getExternalIdBytes()

public ByteString getExternalIdBytes()

Optional. The external ID for the Partner.

This value has a maximum length of 255 characters.

optional string external_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for externalId.

getFax()

public String getFax()

Optional. The fax number for the Partner.

This value has a maximum length of 63 characters.

optional string fax = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The fax.

getFaxBytes()

public ByteString getFaxBytes()

Optional. The fax number for the Partner.

This value has a maximum length of 63 characters.

optional string fax = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for fax.

getName()

public String getName()

Identifier. The resource name of the Partner. Format: networks/{network_code}/partners/{partner_id}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the Partner. Format: networks/{network_code}/partners/{partner_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Partner> getParserForType()
Returns
Type Description
Parser<Partner>
Overrides

getPhone()

public String getPhone()

Optional. The phone number for the Partner.

This value has a maximum length of 63 characters.

optional string phone = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The phone.

getPhoneBytes()

public ByteString getPhoneBytes()

Optional. The phone number for the Partner.

This value has a maximum length of 63 characters.

optional string phone = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for phone.

getPrimaryContact()

public String getPrimaryContact()

Optional. The resource names of primary Contact of the Partner. Format: "networks/{network_code}/contacts/{contact_id}"

optional string primary_contact = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The primaryContact.

getPrimaryContactBytes()

public ByteString getPrimaryContactBytes()

Optional. The resource names of primary Contact of the Partner. Format: "networks/{network_code}/contacts/{contact_id}"

optional string primary_contact = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for primaryContact.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the Partner was last updated.

.google.protobuf.Timestamp update_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the Partner was last updated.

.google.protobuf.Timestamp update_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAddress()

public boolean hasAddress()

Optional. The address for the Partner.

This value has a maximum length of 1024 characters.

optional string address = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the address field is set.

hasComment()

public boolean hasComment()

Optional. Comments about the Partner.

This value has a maximum length of 1024 characters.

optional string comment = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the comment field is set.

hasCreditStatus()

public boolean hasCreditStatus()

Optional. The credit status of the Partner.

This attribute defaults to [CompanyCreditStatus.ACTIVE][] if basic settings are enabled and [CompanyCreditStatus.ON_HOLD][] if advance settings are enabled.

optional .google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus credit_status = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the creditStatus field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. The display name of the Partner.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hasEmail()

public boolean hasEmail()

Optional. The email for the Partner.

This value has a maximum length of 128 characters.

optional string email = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the email field is set.

hasExternalId()

public boolean hasExternalId()

Optional. The external ID for the Partner.

This value has a maximum length of 255 characters.

optional string external_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the externalId field is set.

hasFax()

public boolean hasFax()

Optional. The fax number for the Partner.

This value has a maximum length of 63 characters.

optional string fax = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the fax field is set.

hasPhone()

public boolean hasPhone()

Optional. The phone number for the Partner.

This value has a maximum length of 63 characters.

optional string phone = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the phone field is set.

hasPrimaryContact()

public boolean hasPrimaryContact()

Optional. The resource names of primary Contact of the Partner. Format: "networks/{network_code}/contacts/{contact_id}"

optional string primary_contact = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the primaryContact field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the Partner was last updated.

.google.protobuf.Timestamp update_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Partner.Builder newBuilderForType()
Returns
Type Description
Partner.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Partner.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Partner.Builder
Overrides

toBuilder()

public Partner.Builder toBuilder()
Returns
Type Description
Partner.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException