Google Ads Ad Manager V1 Client - Class RenegotiateChildPublisherAgreementRequest (0.14.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class RenegotiateChildPublisherAgreementRequest.

Request message to renegotiate a ChildPublisher's agreement (i.e., invite with updated terms).

Generated from protobuf message google.ads.admanager.v1.RenegotiateChildPublisherAgreementRequest

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Resource name of the ChildPublisher whose agreement is being renegotiated. Format: networks/{network_code}/childPublisher/{child_publisher_id}

↳ display_name string

Optional. The display name to set for the ChildPublisher whose agreement is being renegotiated.

↳ email_address string

Optional. The email address to set for the ChildPublisher whose agreement is being renegotiated.

↳ network string

Optional. The resource name of the Ad Manager network to set for the ChildPublisher whose agreement is being renegotiated. This field may not update the ChildPublisher's Ad Manager network if it is already associated with one. Format: networks/{network_code}

↳ delegation_type int

Optional. The type of delegation to set for the ChildPublisher whose agreement is being renegotiated.

↳ parent_revenue_share_millipercent int|string

Optional. The revenue share to set that the parent publisher will receive in millipercent (e.g., 15000 millipercent is %15) for the ChildPublisher whose agreement is being renegotiated. This field is only settable for Manage Account ChildPublishers of non-reseller parent publishers. Otherwise, it is ignored and always 100%.

↳ seller_id string

Optional. The seller ID to set for the ChildPublisher whose agreement is being renegotiated. This field is only applicable to Manage Inventory ChildPublishers.

getName

Required. Resource name of the ChildPublisher whose agreement is being renegotiated. Format: networks/{network_code}/childPublisher/{child_publisher_id}

Returns
Type Description
string

setName

Required. Resource name of the ChildPublisher whose agreement is being renegotiated. Format: networks/{network_code}/childPublisher/{child_publisher_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Optional. The display name to set for the ChildPublisher whose agreement is being renegotiated.

Returns
Type Description
string

setDisplayName

Optional. The display name to set for the ChildPublisher whose agreement is being renegotiated.

Parameter
Name Description
var string
Returns
Type Description
$this

getEmailAddress

Optional. The email address to set for the ChildPublisher whose agreement is being renegotiated.

Returns
Type Description
string

setEmailAddress

Optional. The email address to set for the ChildPublisher whose agreement is being renegotiated.

Parameter
Name Description
var string
Returns
Type Description
$this

getNetwork

Optional. The resource name of the Ad Manager network to set for the ChildPublisher whose agreement is being renegotiated.

This field may not update the ChildPublisher's Ad Manager network if it is already associated with one. Format: networks/{network_code}

Returns
Type Description
string

setNetwork

Optional. The resource name of the Ad Manager network to set for the ChildPublisher whose agreement is being renegotiated.

This field may not update the ChildPublisher's Ad Manager network if it is already associated with one. Format: networks/{network_code}

Parameter
Name Description
var string
Returns
Type Description
$this

getDelegationType

Optional. The type of delegation to set for the ChildPublisher whose agreement is being renegotiated.

Returns
Type Description
int Enum of type DelegationType.

setDelegationType

Optional. The type of delegation to set for the ChildPublisher whose agreement is being renegotiated.

Parameter
Name Description
var int

Enum of type DelegationType.

Returns
Type Description
$this

getParentRevenueShareMillipercent

Optional. The revenue share to set that the parent publisher will receive in millipercent (e.g., 15000 millipercent is %15) for the ChildPublisher whose agreement is being renegotiated.

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

Returns
Type Description
int|string

setParentRevenueShareMillipercent

Optional. The revenue share to set that the parent publisher will receive in millipercent (e.g., 15000 millipercent is %15) for the ChildPublisher whose agreement is being renegotiated.

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getSellerId

Optional. The seller ID to set for the ChildPublisher whose agreement is being renegotiated.

This field is only applicable to Manage Inventory ChildPublishers.

Returns
Type Description
string

setSellerId

Optional. The seller ID to set for the ChildPublisher whose agreement is being renegotiated.

This field is only applicable to Manage Inventory ChildPublishers.

Parameter
Name Description
var string
Returns
Type Description
$this