Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ChildPublisher.
The ChildPublisher resource.
Generated from protobuf message google.ads.admanager.v1.ChildPublisher
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the ChildPublisher. Format: |
↳ display_name |
string
Required. The display name of the ChildPublisher. |
↳ email |
string
Required. The email for the ChildPublisher. |
↳ child_network |
string
Immutable. The resource name of the ChildPublisher's Ad Manager network. Format: |
↳ delegation_type |
int
Required. The type of delegation for the ChildPublisher. This attribute is immutable while the relationship is active. |
↳ parent_revenue_share_millipercent |
int|string
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. |
↳ seller_id |
string
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. |
↳ readiness_status |
int
Output only. The overall onboarding readiness of the ChildPublisher. This status is correlated with ad serving, but does not include site-level approval information. |
↳ invitation_status |
int
Output only. The status of the invitation request to the ChildPublisher. |
↳ approval_status |
int
Output only. The approval status of the ChildPublisher. |
↳ identity_verification_status |
int
Output only. The status of the ChildPublisher's identity verification. |
↳ address_verification_status |
int
Output only. The status of the ChildPublisher's address verification (i.e., mail PIN). |
↳ pending_onboarding_tasks |
int[]
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. |
↳ account_status |
int
Output only. The account status of the ChildPublisher. |
↳ approved_manage_account_revenue_share_millipercent |
int|string
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. |
getName
Identifier. The resource name of the
ChildPublisher. Format:
networks/{network_code}/childPublishers/{child_publisher_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the
ChildPublisher. Format:
networks/{network_code}/childPublishers/{child_publisher_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The display name of the ChildPublisher.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayName
clearDisplayName
setDisplayName
Required. The display name of the ChildPublisher.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEmail
Required. The email for the ChildPublisher.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasEmail
clearEmail
setEmail
Required. The email for the ChildPublisher.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChildNetwork
Immutable. The resource name of the ChildPublisher's Ad Manager network.
Format: networks/{network_code}
| Returns | |
|---|---|
| Type | Description |
string |
|
hasChildNetwork
clearChildNetwork
setChildNetwork
Immutable. The resource name of the ChildPublisher's Ad Manager network.
Format: networks/{network_code}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDelegationType
Required. The type of delegation for the ChildPublisher.
This attribute is immutable while the relationship is active.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasDelegationType
clearDelegationType
setDelegationType
Required. The type of delegation for the ChildPublisher.
This attribute is immutable while the relationship is active.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasParentRevenueShareMillipercent
clearParentRevenueShareMillipercent
setParentRevenueShareMillipercent
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSellerId
clearSellerId
setSellerId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasReadinessStatus
clearReadinessStatus
setReadinessStatus
Output only. The overall onboarding readiness of the ChildPublisher.
This status is correlated with ad serving, but does not include site-level approval information.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInvitationStatus
Output only. The status of the invitation request to the ChildPublisher.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasInvitationStatus
clearInvitationStatus
setInvitationStatus
Output only. The status of the invitation request to the ChildPublisher.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApprovalStatus
Output only. The approval status of the ChildPublisher.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasApprovalStatus
clearApprovalStatus
setApprovalStatus
Output only. The approval status of the ChildPublisher.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIdentityVerificationStatus
Output only. The status of the ChildPublisher's identity verification.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasIdentityVerificationStatus
clearIdentityVerificationStatus
setIdentityVerificationStatus
Output only. The status of the ChildPublisher's identity verification.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAddressVerificationStatus
Output only. The status of the ChildPublisher's address verification (i.e., mail PIN).
| Returns | |
|---|---|
| Type | Description |
int |
|
hasAddressVerificationStatus
clearAddressVerificationStatus
setAddressVerificationStatus
Output only. The status of the ChildPublisher's address verification (i.e., mail PIN).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPendingOnboardingTasks
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
setPendingOnboardingTasks
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccountStatus
Output only. The account status of the ChildPublisher.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasAccountStatus
clearAccountStatus
setAccountStatus
Output only. The account status of the ChildPublisher.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasApprovedManageAccountRevenueShareMillipercent
clearApprovedManageAccountRevenueShareMillipercent
setApprovedManageAccountRevenueShareMillipercent
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|