get(inventorySourceGroupId, partnerId=None, advertiserId=None, x__xgafv=None)
Gets an inventory source group.
Lists inventory source groups that are accessible to the current user.
list_next(previous_request, previous_response)
Retrieves the next page of results.
get(inventorySourceGroupId, partnerId=None, advertiserId=None, x__xgafv=None)
Gets an inventory source group.
Args:
inventorySourceGroupId: string, Required. The ID of the inventory source group to fetch. (required)
partnerId: string, The ID of the partner that has access to the inventory source group.
A partner cannot access an advertiser-owned inventory source group.
advertiserId: string, The ID of the advertiser that has access to the inventory source group.
If an inventory source group is partner-owned, only advertisers to which
the group is explicitly shared can access the group.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A collection of targetable inventory sources.
"displayName": "A String", # Required. The display name of the inventory source group.
#
# Must be UTF-8 encoded with a maximum size of 240 bytes.
"inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
"name": "A String", # Output only. The resource name of the inventory source group.
}
list(orderBy=None, partnerId=None, filter=None, pageToken=None, pageSize=None, advertiserId=None, x__xgafv=None)
Lists inventory source groups that are accessible to the current user.
The order is defined by the
order_by parameter.
Args:
orderBy: string, Field by which to sort the list.
Acceptable values are:
* `displayName` (default)
* `inventorySourceGroupId`
The default sorting order is ascending. To specify descending order for
a field, a suffix "desc" should be added to the field name. For example,
`displayName desc`.
partnerId: string, The ID of the partner that has access to the inventory source group.
A partner cannot access advertiser-owned inventory source groups.
filter: string, Allows filtering by inventory source group properties.
Supported syntax:
* Filter expressions are made up of one or more restrictions.
* Restrictions can be combined by the logical operator `OR`.
* A restriction has the form of `{field} {operator} {value}`.
* The operator must be `EQUALS (=)`.
* Supported fields:
- `inventorySourceGroupId`
The length of this field should be no more than 500 characters.
pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
next_page_token
returned from the previous call to `ListInventorySources` method.
If not specified, the first page of results will be returned.
pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
default to `100`.
advertiserId: string, The ID of the advertiser that has access to the inventory source group.
If an inventory source group is partner-owned, only advertisers to which
the group is explicitly shared can access the group.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for InventorySourceGroupService.ListInventorySourceGroups.
"inventorySourceGroups": [ # The list of inventory source groups.
#
# This list will be absent if empty.
{ # A collection of targetable inventory sources.
"displayName": "A String", # Required. The display name of the inventory source group.
#
# Must be UTF-8 encoded with a maximum size of 240 bytes.
"inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
"name": "A String", # Output only. The resource name of the inventory source group.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results.
# Pass this value in the
# page_token
# field in the subsequent call to `ListInventorySourceGroups` method to
# retrieve the next page of results.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.