Class: Google::Ads::AdManager::V1::ListCompaniesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/ads/admanager/v1/company_service.rb

Overview

Request object for ListCompanies method.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters.

Returns:

  • (::String) —

    Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters



65
66
67
68
 
# File 'proto_docs/google/ads/admanager/v1/company_service.rb', line 65

class ListCompaniesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order.

Returns:

  • (::String) —

    Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order



65
66
67
68
 
# File 'proto_docs/google/ads/admanager/v1/company_service.rb', line 65

class ListCompaniesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



65
66
67
68
 
# File 'proto_docs/google/ads/admanager/v1/company_service.rb', line 65

class ListCompaniesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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

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

Returns:

  • (::String) —

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

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



65
66
67
68
 
# File 'proto_docs/google/ads/admanager/v1/company_service.rb', line 65

class ListCompaniesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The parent, which owns this collection of Companies. Format: networks/{network_code}.

Returns:

  • (::String) —

    Required. The parent, which owns this collection of Companies. Format: networks/{network_code}



65
66
67
68
 
# File 'proto_docs/google/ads/admanager/v1/company_service.rb', line 65

class ListCompaniesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#skip ⇒ ::Integer

Returns Optional. Number of individual resources to skip while paginating.

Returns:

  • (::Integer) —

    Optional. Number of individual resources to skip while paginating.



65
66
67
68
 
# File 'proto_docs/google/ads/admanager/v1/company_service.rb', line 65

class ListCompaniesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end