Package google.shopping.merchant.youtube.v1alpha

Index

CommissionGroupService

Service to manage YouTube Shopping Affiliate Program commission groups for a given contract.

CreateCommissionGroup

rpc CreateCommissionGroup(CreateCommissionGroupRequest) returns (CommissionGroup)

Creates a new commission group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
DeleteCommissionGroup

rpc DeleteCommissionGroup(DeleteCommissionGroupRequest) returns (Empty)

Deletes a given commission group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
GetCommissionGroup

rpc GetCommissionGroup(GetCommissionGroupRequest) returns (CommissionGroup)

Retrieves the specified commission group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
ListCommissionGroups

rpc ListCommissionGroups(ListCommissionGroupsRequest) returns (ListCommissionGroupsResponse)

Lists the commission groups for a given contract.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
UpdateCommissionGroup

rpc UpdateCommissionGroup(UpdateCommissionGroupRequest) returns (CommissionGroup)

Updates a given commission group.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

ContractService

Service to manage YouTube Shopping Affiliate Program contracts.

CreateContract

rpc CreateContract(CreateContractRequest) returns (Contract)

Creates a new contract.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
GetContract

rpc GetContract(GetContractRequest) returns (Contract)

Retrieves the specified contract.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
ListContracts

rpc ListContracts(ListContractsRequest) returns (ListContractsResponse)

Lists the contracts for a given account.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
UpdateContract

rpc UpdateContract(UpdateContractRequest) returns (Contract)

Updates a given contract.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

CategorySelector

Category selector.

Fields
categories[]

string

Required. The list of categories targeted by this selector. A maximum of 100 is allowed.

CommissionGroup

Youtube Affiliate Program commission group. A commission group defines a commission rate and the set of products it applies to.

Fields
name

string

Identifier. The name of the CommissionGroup resource. Format: accounts/{account}/contracts/{contract}/commissionGroups/{commission_group}
product_selector

ProductSelector

Required. Selects the products that this commission group applies to.
commission_rate

CommissionRate

Required. Commission that will be paid for conversions that match this commission group.

CommissionRate

Commission that will be paid for conversions that match a given commission group.

Fields
Union field rate. The commission rate. rate can be only one of the following:
rated_commission_basis_points

int32

Rated commission in basis points. For example: - 0.01% = 1 basis point. - 1% = 100 basis points. - 100% = 10000 basis points.

Contract

Youtube Affiliate Program contract. Contains information about the commission rates applied to creators in the program.

Fields
name

string

Identifier. The name of the Contract resource. Format: accounts/{account}/contracts/{contract}
default_commission

CommissionRate

Required. The default commission rate for the contract.

CreateCommissionGroupRequest

Request message for the CreateCommissionGroup method.

Fields
parent

string

Required. The parent contract where this commission group will be created. Format: accounts/{account}/contracts/{contract}
commission_group

CommissionGroup

Required. The commission group to create.

CreateContractRequest

Request message for the CreateContract method.

Fields
parent

string

Required. The parent account where this contract will be created. Format: accounts/{account}
contract

Contract

Required. The contract to create.

DeleteCommissionGroupRequest

Request message for the DeleteCommissionGroup method.

Fields
name

string

Required. The name of the commission group to delete. Format: accounts/{account}/contracts/{contract}/commissionGroups/{commission_group}

GetCommissionGroupRequest

Request message for the GetCommissionGroup method.

Fields
name

string

Required. The name of the commission group to retrieve. Format: accounts/{account}/contracts/{contract}/commissionGroups/{commission_group}

GetContractRequest

Request message for the GetContract method.

Fields
name

string

Required. The name of the contract to retrieve. Format: accounts/{account}/contracts/{contract}

ListCommissionGroupsRequest

Request message for the ListCommissionGroups method.

Fields
parent

string

Required. The contract to list commission groups for. Format: accounts/{account}/contracts/{contract}
page_size

int32

Optional. The maximum number of commission groups to return. The service may return fewer than this value. If unspecified, at most 100 commission groups will be returned. The maximum value is 100; values above 100 will be coerced to 100.
page_token

string

Optional. A page token, received from a previous ListCommissionGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCommissionGroups must match the call that provided the page token.

ListCommissionGroupsResponse

Response message for the ListCommissionGroups method.

Fields
commission_groups[]

CommissionGroup

The commission groups for the specified contract.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListContractsRequest

Request message for the ListContracts method.

Fields
parent

string

Required. The account to list contracts for. Format: accounts/{account}
page_size

int32

Optional. The maximum number of contracts to return. The service may return fewer than this value. If unspecified, at most 100 contracts will be returned. The maximum value is 100; values above 100 will be coerced to 100.
page_token

string

Optional. A page token, received from a previous ListContracts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListContracts must match the call that provided the page token.

ListContractsResponse

Response message for the ListContracts method.

Fields
contracts[]

Contract

The contracts for the specified account.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ProductSelector

Selects which products a commission group applies to. At least one of the selectors must be set.

Fields
category_selector

CategorySelector

Optional. Selects products by category.

UpdateCommissionGroupRequest

Request message for the UpdateCommissionGroup method.

Fields
commission_group

CommissionGroup

Required. The commission group to update.
update_mask

FieldMask

Required. The list of fields to update.

Fields specified in the update mask without a value specified in the body will be deleted from the commission group.

If update mask is set to *, all fields will be updated.

UpdateContractRequest

Request message for the UpdateContract method.

Fields
contract

Contract

Required. The contract to update.
update_mask

FieldMask

Required. The list of fields to update.

Fields specified in the update mask without a value specified in the body will be deleted from the contract.

If update mask is set to *, all fields will be updated.