Google Shopping Merchant Accounts V1beta Client - Class ListProgramsRequest (0.3.0)

Version 0.3.0

• 0.3.1 (latest)
• 0.3.0
• 0.2.0
• 0.1.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class ListProgramsRequest.

Request message for the ListPrograms method.

Generated from protobuf message google.shopping.merchant.accounts.v1beta.ListProgramsRequest

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The name of the account for which to retrieve all programs. Format: accounts/{account}
↳ page_size	int Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000.
↳ page_token	string Optional. A continuation token, received from a previous ListPrograms call. Provide this to retrieve the next page.

getParent

Required. The name of the account for which to retrieve all programs.

Format: accounts/{account}

Returns
Type	Description
string

setParent

Required. The name of the account for which to retrieve all programs.

Format: accounts/{account}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. A continuation token, received from a previous ListPrograms call. Provide this to retrieve the next page.

Returns
Type	Description
string

setPageToken

Optional. A continuation token, received from a previous ListPrograms call. Provide this to retrieve the next page.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The name of the account for which to retrieve all programs. Format: accounts/{account} Please see Google\Shopping\Merchant\Accounts\V1beta\ProgramsServiceClient::accountName() for help formatting this field.

Returns
Type	Description
Google\Shopping\Merchant\Accounts\V1beta\ListProgramsRequest