REST Resource: networks.childPublishers

Resource: ChildPublisher

The ChildPublisher resource.

JSON representation
{
  "name": string,
  "pendingOnboardingTasks": [
    enum (ChildPublisherOnboardingTask)
  ],
  "displayName": string,
  "email": string,
  "childNetwork": string,
  "delegationType": enum (DelegationType),
  "parentRevenueShareMillipercent": string,
  "sellerId": string,
  "readinessStatus": enum (McmReadinessStatus),
  "invitationStatus": enum (DelegationInvitationStatus),
  "approvalStatus": enum (DelegationApprovalStatus),
  "identityVerificationStatus": enum (ChildPublisherIdentityVerificationStatus),
  "addressVerificationStatus": enum (ChildPublisherAddressVerificationStatus),
  "accountStatus": enum (DelegationAccountStatus),
  "approvedManageAccountRevenueShareMillipercent": string
}
Fields
name

string

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

pendingOnboardingTasks[]

enum (ChildPublisherOnboardingTask)

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.

displayName

string

Required. The display name of the ChildPublisher.

email

string

Required. The email for the ChildPublisher.

childNetwork

string

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

Format: networks/{networkCode}

delegationType

enum (DelegationType)

Required. The type of delegation for the ChildPublisher.

This attribute is immutable while the relationship is active.

parentRevenueShareMillipercent

string (int64 format)

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.

sellerId

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.

readinessStatus

enum (McmReadinessStatus)

Output only. The overall onboarding readiness of the ChildPublisher.

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

invitationStatus

enum (DelegationInvitationStatus)

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

approvalStatus

enum (DelegationApprovalStatus)

Output only. The approval status of the ChildPublisher.

identityVerificationStatus

enum (ChildPublisherIdentityVerificationStatus)

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

addressVerificationStatus

enum (ChildPublisherAddressVerificationStatus)

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

accountStatus

enum (DelegationAccountStatus)

Output only. The account status of the ChildPublisher.

approvedManageAccountRevenueShareMillipercent

string (int64 format)

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.

DelegationType

The delegation type of the MCM child publisher.

Enums
DELEGATION_TYPE_UNSPECIFIED No value specified
MANAGE_ACCOUNT Indicates the parent network gets complete access to the child network's account.
MANAGE_INVENTORY Indicates a subset of the ad requests from the child are delegated to the parent, determined by the tag on the child network's web pages. The parent network does not have access to the child network, as a subset of the inventory could be owned and operated by the child network.

McmReadinessStatus

Status of the MCM child publisher's Ad Manager network onboarding readiness status

Enums
MCM_READINESS_STATUS_UNSPECIFIED No value specified
INACTIVE Indicates the invitation to the child is declined or withdrawn.
NOT_READY Indicates the MCM setup has not yet completed. It could be child not yet accepted the invitation, Google found noncompliance settings or child has not yet completed identity or address verifications.
READY Indicates MCM setup has completed. Including the child publisher accepted the invite, Google found it to be compliant with its policies, i.e. no policy violations were found, related verifications have completed and the child publisher can be served ads.

DelegationInvitationStatus

Status of the association between networks. When a parent network requests access, it is marked as pending. Once the child network accepts the agreement, it is marked as accepted.

Enums
DELEGATION_INVITATION_STATUS_UNSPECIFIED No value specified
ACCEPTED Indicates the association request from the parent network is accepted by the child network.
EXPIRED Indicates the invite was sent to the child publisher more than 90 days ago, due to which it has been deactivated.
PENDING Indicates the child publisher has not acted on the invite from the parent.
REJECTED Indicates the child publisher has declined the invite.
WITHDRAWN Indicates the parent network withdrew the invite.
DEACTIVATED_BY_AD_MANAGER Indicates the invitation was disapproved by Google.

DelegationApprovalStatus

Status of the MCM child publisher's Ad Manager network with respect to delegated serving. It is only valid when the invitation is accepted by the child network. If the child has not yet accepted the parent's invite, this will be null.

Enums
DELEGATION_APPROVAL_STATUS_UNSPECIFIED No value specified
APPROVED Indicates the child publisher accepted the invite, and Google found it to be compliant with its policies, i.e. no policy violations were found, and the child publisher can be served ads.
CLOSED_BY_PUBLISHER Indicates the child publisher has closed their own account.
CLOSED_INVALID_ACTIVITY Indicates the child publisher accepted the invite, but was disapproved by Google for invalid activity.
CLOSED_POLICY_VIOLATION Indicates the child publisher accepted the invite, but was disapproved by Google for violating its policies.
DEACTIVATED_BY_AD_MANAGER Indicates the child publisher accepted the invite, but was disapproved by a Googler.
DISAPPROVED_DUPLICATE_ACCOUNT Indicates the child publisher accepted the invite, but was disapproved by Google for being a duplicate of another account.
DISAPPROVED_INELIGIBLE Indicates the child publisher accepted the invite, but was disapproved as ineligible by Google.
PENDING_GOOGLE_APPROVAL Indicates the child publisher has accepted the invite, and is awaiting Google's policy compliance verifications.

ChildPublisherIdentityVerificationStatus

The status of the Mcm child identity verification.

Enums
CHILD_PUBLISHER_IDENTITY_VERIFICATION_STATUS_UNSPECIFIED No value specified
EXEMPT Indicates publisher is exempt from identify verification.
EXPIRED Indicates publisher hasn't completed identity verification before the expiration date.
FAILED Indicates publisher failed identity verification.
PENDING Indicates publisher is pending identity verification.
NOT_ELIGIBLE Indicates publisher is not eligible for identity verification.
VERIFIED Indicates publisher has completed identity verification.

ChildPublisherAddressVerificationStatus

The status of the Mcm child address verification.

Enums
CHILD_PUBLISHER_ADDRESS_VERIFICATION_STATUS_UNSPECIFIED No value specified
EXEMPT Indicates publisher is exempt from address verification.
EXPIRED Indicates publisher hasn't completed address verification before the expiration date.
FAILED Indicates publisher failed address verification.
PENDING Indicates publisher's address pin has been mailed and must be verified.
NOT_ELIGIBLE Indicates publisher is not eligible for address verification.
VERIFIED Indicates publisher's address is verified.

ChildPublisherOnboardingTask

The pending tasks that must be completed by the child publisher before Google's policy complicance (i.e., PENDING_GOOGLE_APPROVAL) can be verified.

Enums
CHILD_PUBLISHER_ONBOARDING_TASK_UNSPECIFIED No value specified
BILLING_PROFILE_CREATION Indicates the child publisher is required to create a payments billing profile.
PHONE_PIN_VERIFICATION Indicates the child publisher is required to verify their phone number.
AD_MANAGER_ACCOUNT_SETUP Indicates the child publisher is required to setup their Ad Manager account.

DelegationAccountStatus

Status of the MCM child publisher's Ad Manager account with respect to delegated serving. In order for the child network to be served ads for MCM, it must have accepted the invite from the parent network, and must have passed Google's policy compliance verifications.

Enums
DELEGATION_ACCOUNT_STATUS_UNSPECIFIED No value specified
INVITED Indicates the child publisher has not acted on the invite from the parent.
DECLINED Indicates the child publisher has declined the invite.
APPROVED Indicates the child publisher accepted the invite, and Google found it to be compliant with its policies, i.e. no policy violations were found, and the child publisher can be served ads.
CLOSED_BY_PUBLISHER Indicates the child publisher has closed their own account.
CLOSED_INVALID_ACTIVITY Indicates the child publisher accepted the invite, but was disapproved by Google for invalid activity.
CLOSED_POLICY_VIOLATION Indicates the child publisher accepted the invite, but was disapproved by Google for violating its policies.
DEACTIVATED_BY_AD_MANAGER Indicates the child publisher accepted the invite, but was disapproved by a Googler.
DISAPPROVED_DUPLICATE_ACCOUNT Indicates the child publisher accepted the invite, but was disapproved by Google for being a duplicate of another account.
DISAPPROVED_INELIGIBLE Indicates the child publisher accepted the invite, but was disapproved as ineligible by Google.
PENDING_GOOGLE_APPROVAL Indicates the child publisher has accepted the invite, and is awaiting Google's policy compliance verifications.
EXPIRED Indicates the invite was sent to the child publisher more than 90 days ago, due to which it has been deactivated.
INACTIVE Indicates either the child publisher disconnected from the parent network, or the parent network withdrew the invite.

Methods

batchCreate

Creates ChildPublisher objects.

batchUpdate

Batch updates ChildPublisher objects.

create

Creates a ChildPublisher object.

get

Retrieves a ChildPublisher object.

list

Lists ChildPublisher objects.

patch

Updates a ChildPublisher object.