Interface ChildPublisherOrBuilder (0.58.0)

public interface ChildPublisherOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccountStatus()

public abstract DelegationAccountStatusEnum.DelegationAccountStatus getAccountStatus()

Output only. The account status of the ChildPublisher.

optional .google.ads.admanager.v1.DelegationAccountStatusEnum.DelegationAccountStatus account_status = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DelegationAccountStatusEnum.DelegationAccountStatus

The accountStatus.

getAccountStatusValue()

public abstract int getAccountStatusValue()

Output only. The account status of the ChildPublisher.

optional .google.ads.admanager.v1.DelegationAccountStatusEnum.DelegationAccountStatus account_status = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for accountStatus.

getAddressVerificationStatus()

public abstract ChildPublisherAddressVerificationStatusEnum.ChildPublisherAddressVerificationStatus getAddressVerificationStatus()

Output only. The status of the ChildPublisher's address verification (i.e., mail PIN).

optional .google.ads.admanager.v1.ChildPublisherAddressVerificationStatusEnum.ChildPublisherAddressVerificationStatus address_verification_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ChildPublisherAddressVerificationStatusEnum.ChildPublisherAddressVerificationStatus

The addressVerificationStatus.

getAddressVerificationStatusValue()

public abstract int getAddressVerificationStatusValue()

Output only. The status of the ChildPublisher's address verification (i.e., mail PIN).

optional .google.ads.admanager.v1.ChildPublisherAddressVerificationStatusEnum.ChildPublisherAddressVerificationStatus address_verification_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for addressVerificationStatus.

getApprovalStatus()

public abstract DelegationApprovalStatusEnum.DelegationApprovalStatus getApprovalStatus()

Output only. The approval status of the ChildPublisher.

optional .google.ads.admanager.v1.DelegationApprovalStatusEnum.DelegationApprovalStatus approval_status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DelegationApprovalStatusEnum.DelegationApprovalStatus

The approvalStatus.

getApprovalStatusValue()

public abstract int getApprovalStatusValue()

Output only. The approval status of the ChildPublisher.

optional .google.ads.admanager.v1.DelegationApprovalStatusEnum.DelegationApprovalStatus approval_status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for approvalStatus.

getApprovedManageAccountRevenueShareMillipercent()

public abstract long getApprovedManageAccountRevenueShareMillipercent()

Output only. Provides the approved revenue share that the parent publisher will receive in millipercent. For example, 15000 millipercent is 15%.

This attribute is only set for Manage Account ChildPublishers of non-reseller parent publishers.

optional int64 approved_manage_account_revenue_share_millipercent = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The approvedManageAccountRevenueShareMillipercent.

getChildNetwork()

public abstract String getChildNetwork()

Immutable. The resource name of the ChildPublisher's Ad Manager network.

Format: networks/{network_code}

optional string child_network = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The childNetwork.

getChildNetworkBytes()

public abstract ByteString getChildNetworkBytes()

Immutable. The resource name of the ChildPublisher's Ad Manager network.

Format: networks/{network_code}

optional string child_network = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for childNetwork.

getDelegationType()

public abstract DelegationTypeEnum.DelegationType getDelegationType()

Required. The type of delegation for the ChildPublisher.

This attribute is immutable while the relationship is active.

optional .google.ads.admanager.v1.DelegationTypeEnum.DelegationType delegation_type = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DelegationTypeEnum.DelegationType

The delegationType.

getDelegationTypeValue()

public abstract int getDelegationTypeValue()

Required. The type of delegation for the ChildPublisher.

This attribute is immutable while the relationship is active.

optional .google.ads.admanager.v1.DelegationTypeEnum.DelegationType delegation_type = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for delegationType.

getDisplayName()

public abstract String getDisplayName()

Required. The display name of the ChildPublisher.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The display name of the ChildPublisher.

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

Returns
Type Description
ByteString

The bytes for displayName.

getEmail()

public abstract String getEmail()

Required. The email for the ChildPublisher.

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

Returns
Type Description
String

The email.

getEmailBytes()

public abstract ByteString getEmailBytes()

Required. The email for the ChildPublisher.

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

Returns
Type Description
ByteString

The bytes for email.

getIdentityVerificationStatus()

public abstract ChildPublisherIdentityVerificationStatusEnum.ChildPublisherIdentityVerificationStatus getIdentityVerificationStatus()

Output only. The status of the ChildPublisher's identity verification.

optional .google.ads.admanager.v1.ChildPublisherIdentityVerificationStatusEnum.ChildPublisherIdentityVerificationStatus identity_verification_status = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ChildPublisherIdentityVerificationStatusEnum.ChildPublisherIdentityVerificationStatus

The identityVerificationStatus.

getIdentityVerificationStatusValue()

public abstract int getIdentityVerificationStatusValue()

Output only. The status of the ChildPublisher's identity verification.

optional .google.ads.admanager.v1.ChildPublisherIdentityVerificationStatusEnum.ChildPublisherIdentityVerificationStatus identity_verification_status = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for identityVerificationStatus.

getInvitationStatus()

public abstract DelegationInvitationStatusEnum.DelegationInvitationStatus getInvitationStatus()

Output only. The status of the invitation request to the ChildPublisher.

optional .google.ads.admanager.v1.DelegationInvitationStatusEnum.DelegationInvitationStatus invitation_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DelegationInvitationStatusEnum.DelegationInvitationStatus

The invitationStatus.

getInvitationStatusValue()

public abstract int getInvitationStatusValue()

Output only. The status of the invitation request to the ChildPublisher.

optional .google.ads.admanager.v1.DelegationInvitationStatusEnum.DelegationInvitationStatus invitation_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for invitationStatus.

getName()

public abstract String getName()

Identifier. The resource name of the ChildPublisher. Format: networks/{network_code}/childPublishers/{child_publisher_id}

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The resource name of the ChildPublisher. Format: networks/{network_code}/childPublishers/{child_publisher_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParentRevenueShareMillipercent()

public abstract long getParentRevenueShareMillipercent()

Optional. The revenue share that the parent publisher will receive in millipercent. For example, 15000 millipercent is 15%.

This attribute is only settable for Manage Account ChildPublishers of non-reseller parent publishers. Otherwise, it is read-only and always 100%.

Additionally, this attribute is immutable while the relationship is active.

optional int64 parent_revenue_share_millipercent = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The parentRevenueShareMillipercent.

getPendingOnboardingTasks(int index)

public abstract ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask getPendingOnboardingTasks(int index)

Output only. The pending onboarding tasks that must be completed by the child publisher before Google's policy compliance (i.e. [DelegationApprovalStatus.PENDING_GOOGLE_APPROVAL][]) can be verified.

repeated .google.ads.admanager.v1.ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask pending_onboarding_tasks = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask

The pendingOnboardingTasks at the given index.

getPendingOnboardingTasksCount()

public abstract int getPendingOnboardingTasksCount()

Output only. The pending onboarding tasks that must be completed by the child publisher before Google's policy compliance (i.e. [DelegationApprovalStatus.PENDING_GOOGLE_APPROVAL][]) can be verified.

repeated .google.ads.admanager.v1.ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask pending_onboarding_tasks = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of pendingOnboardingTasks.

getPendingOnboardingTasksList()

public abstract List<ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask> getPendingOnboardingTasksList()

Output only. The pending onboarding tasks that must be completed by the child publisher before Google's policy compliance (i.e. [DelegationApprovalStatus.PENDING_GOOGLE_APPROVAL][]) can be verified.

repeated .google.ads.admanager.v1.ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask pending_onboarding_tasks = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ChildPublisherOnboardingTask>

A list containing the pendingOnboardingTasks.

getPendingOnboardingTasksValue(int index)

public abstract int getPendingOnboardingTasksValue(int index)

Output only. The pending onboarding tasks that must be completed by the child publisher before Google's policy compliance (i.e. [DelegationApprovalStatus.PENDING_GOOGLE_APPROVAL][]) can be verified.

repeated .google.ads.admanager.v1.ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask pending_onboarding_tasks = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of pendingOnboardingTasks at the given index.

getPendingOnboardingTasksValueList()

public abstract List<Integer> getPendingOnboardingTasksValueList()

Output only. The pending onboarding tasks that must be completed by the child publisher before Google's policy compliance (i.e. [DelegationApprovalStatus.PENDING_GOOGLE_APPROVAL][]) can be verified.

repeated .google.ads.admanager.v1.ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask pending_onboarding_tasks = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for pendingOnboardingTasks.

getReadinessStatus()

public abstract McmReadinessStatusEnum.McmReadinessStatus getReadinessStatus()

Output only. The overall onboarding readiness of the ChildPublisher.

This status is correlated with ad serving, but does not include site-level approval information.

optional .google.ads.admanager.v1.McmReadinessStatusEnum.McmReadinessStatus readiness_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
McmReadinessStatusEnum.McmReadinessStatus

The readinessStatus.

getReadinessStatusValue()

public abstract int getReadinessStatusValue()

Output only. The overall onboarding readiness of the ChildPublisher.

This status is correlated with ad serving, but does not include site-level approval information.

optional .google.ads.admanager.v1.McmReadinessStatusEnum.McmReadinessStatus readiness_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for readinessStatus.

getSellerId()

public abstract String getSellerId()

Optional. The seller ID for the ChildPublisher, as specified in the parent publisher's sellers.json file.

This attribute is only applicable to Manage Inventory ChildPublishers.

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

Returns
Type Description
String

The sellerId.

getSellerIdBytes()

public abstract ByteString getSellerIdBytes()

Optional. The seller ID for the ChildPublisher, as specified in the parent publisher's sellers.json file.

This attribute is only applicable to Manage Inventory ChildPublishers.

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

Returns
Type Description
ByteString

The bytes for sellerId.

hasAccountStatus()

public abstract boolean hasAccountStatus()

Output only. The account status of the ChildPublisher.

optional .google.ads.admanager.v1.DelegationAccountStatusEnum.DelegationAccountStatus account_status = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the accountStatus field is set.

hasAddressVerificationStatus()

public abstract boolean hasAddressVerificationStatus()

Output only. The status of the ChildPublisher's address verification (i.e., mail PIN).

optional .google.ads.admanager.v1.ChildPublisherAddressVerificationStatusEnum.ChildPublisherAddressVerificationStatus address_verification_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the addressVerificationStatus field is set.

hasApprovalStatus()

public abstract boolean hasApprovalStatus()

Output only. The approval status of the ChildPublisher.

optional .google.ads.admanager.v1.DelegationApprovalStatusEnum.DelegationApprovalStatus approval_status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the approvalStatus field is set.

hasApprovedManageAccountRevenueShareMillipercent()

public abstract boolean hasApprovedManageAccountRevenueShareMillipercent()

Output only. Provides the approved revenue share that the parent publisher will receive in millipercent. For example, 15000 millipercent is 15%.

This attribute is only set for Manage Account ChildPublishers of non-reseller parent publishers.

optional int64 approved_manage_account_revenue_share_millipercent = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the approvedManageAccountRevenueShareMillipercent field is set.

hasChildNetwork()

public abstract boolean hasChildNetwork()

Immutable. The resource name of the ChildPublisher's Ad Manager network.

Format: networks/{network_code}

optional string child_network = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the childNetwork field is set.

hasDelegationType()

public abstract boolean hasDelegationType()

Required. The type of delegation for the ChildPublisher.

This attribute is immutable while the relationship is active.

optional .google.ads.admanager.v1.DelegationTypeEnum.DelegationType delegation_type = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the delegationType field is set.

hasDisplayName()

public abstract boolean hasDisplayName()

Required. The display name of the ChildPublisher.

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

Returns
Type Description
boolean

Whether the displayName field is set.

hasEmail()

public abstract boolean hasEmail()

Required. The email for the ChildPublisher.

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

Returns
Type Description
boolean

Whether the email field is set.

hasIdentityVerificationStatus()

public abstract boolean hasIdentityVerificationStatus()

Output only. The status of the ChildPublisher's identity verification.

optional .google.ads.admanager.v1.ChildPublisherIdentityVerificationStatusEnum.ChildPublisherIdentityVerificationStatus identity_verification_status = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the identityVerificationStatus field is set.

hasInvitationStatus()

public abstract boolean hasInvitationStatus()

Output only. The status of the invitation request to the ChildPublisher.

optional .google.ads.admanager.v1.DelegationInvitationStatusEnum.DelegationInvitationStatus invitation_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the invitationStatus field is set.

hasParentRevenueShareMillipercent()

public abstract boolean hasParentRevenueShareMillipercent()

Optional. The revenue share that the parent publisher will receive in millipercent. For example, 15000 millipercent is 15%.

This attribute is only settable for Manage Account ChildPublishers of non-reseller parent publishers. Otherwise, it is read-only and always 100%.

Additionally, this attribute is immutable while the relationship is active.

optional int64 parent_revenue_share_millipercent = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the parentRevenueShareMillipercent field is set.

hasReadinessStatus()

public abstract boolean hasReadinessStatus()

Output only. The overall onboarding readiness of the ChildPublisher.

This status is correlated with ad serving, but does not include site-level approval information.

optional .google.ads.admanager.v1.McmReadinessStatusEnum.McmReadinessStatus readiness_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the readinessStatus field is set.

hasSellerId()

public abstract boolean hasSellerId()

Optional. The seller ID for the ChildPublisher, as specified in the parent publisher's sellers.json file.

This attribute is only applicable to Manage Inventory ChildPublishers.

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

Returns
Type Description
boolean

Whether the sellerId field is set.