Class ViewabilityProvider (0.58.0)

public final class ViewabilityProvider extends GeneratedMessage implements ViewabilityProviderOrBuilder

The ViewabilityProvider resource.

Represents a third-party company used to measure creative viewability.

Protobuf type google.ads.admanager.v1.ViewabilityProvider

Static Fields

ADDRESS_FIELD_NUMBER

public static final int ADDRESS_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

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

REJECTION_TRACKER_URL_FIELD_NUMBER

public static final int REJECTION_TRACKER_URL_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VENDOR_KEY_FIELD_NUMBER

public static final int VENDOR_KEY_FIELD_NUMBER
Field Value
Type Description
int

VERIFICATION_SCRIPT_URL_FIELD_NUMBER

public static final int VERIFICATION_SCRIPT_URL_FIELD_NUMBER
Field Value
Type Description
int

VERIFICATION_SCRIPT_URL_PARAMETERS_FIELD_NUMBER

public static final int VERIFICATION_SCRIPT_URL_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ViewabilityProvider getDefaultInstance()
Returns
Type Description
ViewabilityProvider

getDescriptor()

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

newBuilder()

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

newBuilder(ViewabilityProvider prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 of the ViewabilityProvider.

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

Returns
Type Description
String

The address.

getAddressBytes()

public ByteString getAddressBytes()

Optional. The address of the ViewabilityProvider.

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

Returns
Type Description
ByteString

The bytes for address.

getAppliedTeams(int index)

public String getAppliedTeams(int index)

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

repeated string applied_teams = 16 [(.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 ViewabilityProvider. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 16 [(.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 ViewabilityProvider. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 16 [(.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 ViewabilityProvider. Format: "networks/{network_code}/teams/{team_id}"

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

Returns
Type Description
ProtocolStringList

A list containing the appliedTeams.

getComment()

public String getComment()

Optional. Comment about the ViewabilityProvider.

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

Returns
Type Description
String

The comment.

getCommentBytes()

public ByteString getCommentBytes()

Optional. Comment about the ViewabilityProvider.

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

Returns
Type Description
ByteString

The bytes for comment.

getDefaultInstanceForType()

public ViewabilityProvider getDefaultInstanceForType()
Returns
Type Description
ViewabilityProvider

getDisplayName()

public String getDisplayName()

Required. The display name of the ViewabilityProvider.

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

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 of the ViewabilityProvider.

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

Returns
Type Description
String

The email.

getEmailBytes()

public ByteString getEmailBytes()

Optional. The email of the ViewabilityProvider.

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

Returns
Type Description
ByteString

The bytes for email.

getExternalId()

public String getExternalId()

Optional. The external ID of the ViewabilityProvider.

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

Returns
Type Description
String

The externalId.

getExternalIdBytes()

public ByteString getExternalIdBytes()

Optional. The external ID of the ViewabilityProvider.

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

Returns
Type Description
ByteString

The bytes for externalId.

getFax()

public String getFax()

Optional. The fax number of the ViewabilityProvider.

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

Returns
Type Description
String

The fax.

getFaxBytes()

public ByteString getFaxBytes()

Optional. The fax number of the ViewabilityProvider.

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

Returns
Type Description
ByteString

The bytes for fax.

getName()

public String getName()

Identifier. The resource name of the ViewabilityProvider. Format: networks/{network_code}/viewabilityProviders/{viewability_provider}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the ViewabilityProvider. Format: networks/{network_code}/viewabilityProviders/{viewability_provider}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPhone()

public String getPhone()

Optional. The phone number of the ViewabilityProvider.

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

Returns
Type Description
String

The phone.

getPhoneBytes()

public ByteString getPhoneBytes()

Optional. The phone number of the ViewabilityProvider.

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

Returns
Type Description
ByteString

The bytes for phone.

getPrimaryContact()

public String getPrimaryContact()

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

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

Returns
Type Description
String

The primaryContact.

getPrimaryContactBytes()

public ByteString getPrimaryContactBytes()

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

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

Returns
Type Description
ByteString

The bytes for primaryContact.

getRejectionTrackerUrl()

public String getRejectionTrackerUrl()

Optional. The URL that should be pinged if the verification script cannot be run.

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

Returns
Type Description
String

The rejectionTrackerUrl.

getRejectionTrackerUrlBytes()

public ByteString getRejectionTrackerUrlBytes()

Optional. The URL that should be pinged if the verification script cannot be run.

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

Returns
Type Description
ByteString

The bytes for rejectionTrackerUrl.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the ViewabilityProvider was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the ViewabilityProvider was last updated.

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

Returns
Type Description
TimestampOrBuilder

getVendorKey()

public String getVendorKey()

Required. The key for the ViewabilityProvider.

optional string vendor_key = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The vendorKey.

getVendorKeyBytes()

public ByteString getVendorKeyBytes()

Required. The key for the ViewabilityProvider.

optional string vendor_key = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for vendorKey.

getVerificationScriptUrl()

public String getVerificationScriptUrl()

Required. The URL that hosts the verification script for the ViewabilityProvider.

optional string verification_script_url = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The verificationScriptUrl.

getVerificationScriptUrlBytes()

public ByteString getVerificationScriptUrlBytes()

Required. The URL that hosts the verification script for the ViewabilityProvider.

optional string verification_script_url = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for verificationScriptUrl.

getVerificationScriptUrlParameters()

public String getVerificationScriptUrlParameters()

Optional. The URL parameters that will be passed to the verification script.

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

Returns
Type Description
String

The verificationScriptUrlParameters.

getVerificationScriptUrlParametersBytes()

public ByteString getVerificationScriptUrlParametersBytes()

Optional. The URL parameters that will be passed to the verification script.

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

Returns
Type Description
ByteString

The bytes for verificationScriptUrlParameters.

hasAddress()

public boolean hasAddress()

Optional. The address of the ViewabilityProvider.

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

Returns
Type Description
boolean

Whether the address field is set.

hasComment()

public boolean hasComment()

Optional. Comment about the ViewabilityProvider.

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

Returns
Type Description
boolean

Whether the comment field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. The display name of the ViewabilityProvider.

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 of the ViewabilityProvider.

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

Returns
Type Description
boolean

Whether the email field is set.

hasExternalId()

public boolean hasExternalId()

Optional. The external ID of the ViewabilityProvider.

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

Returns
Type Description
boolean

Whether the externalId field is set.

hasFax()

public boolean hasFax()

Optional. The fax number of the ViewabilityProvider.

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

Returns
Type Description
boolean

Whether the fax field is set.

hasPhone()

public boolean hasPhone()

Optional. The phone number of the ViewabilityProvider.

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

Returns
Type Description
boolean

Whether the phone field is set.

hasPrimaryContact()

public boolean hasPrimaryContact()

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

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

Returns
Type Description
boolean

Whether the primaryContact field is set.

hasRejectionTrackerUrl()

public boolean hasRejectionTrackerUrl()

Optional. The URL that should be pinged if the verification script cannot be run.

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

Returns
Type Description
boolean

Whether the rejectionTrackerUrl field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the ViewabilityProvider was last updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hasVendorKey()

public boolean hasVendorKey()

Required. The key for the ViewabilityProvider.

optional string vendor_key = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the vendorKey field is set.

hasVerificationScriptUrl()

public boolean hasVerificationScriptUrl()

Required. The URL that hosts the verification script for the ViewabilityProvider.

optional string verification_script_url = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the verificationScriptUrl field is set.

hasVerificationScriptUrlParameters()

public boolean hasVerificationScriptUrlParameters()

Optional. The URL parameters that will be passed to the verification script.

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

Returns
Type Description
boolean

Whether the verificationScriptUrlParameters 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 ViewabilityProvider.Builder newBuilderForType()
Returns
Type Description
ViewabilityProvider.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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