Method: creativeGroups.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of creative groups, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/creativeGroups
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
Query parameters
Parameters |
ids[] |
string (int64 format)
Select only creative groups with these IDs.
|
groupNumber |
integer
Select only creative groups that belong to this subgroup.
|
searchString |
string
Allows searching for creative groups by name or ID. Wildcards (
*
) are allowed. For example,
"creativegroup*2015"
will return creative groups with names like
"creativegroup June 2015"
,
"creativegroup April 2015"
, or simply
"creativegroup 2015"
. Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of
"creativegroup"
will match creative groups with the name
"my creativegroup"
,
"creativegroup 2015"
, or simply
"creativegroup"
.
|
advertiserIds[] |
string (int64 format)
Select only creative groups that belong to these advertisers.
|
maxResults |
integer
Maximum number of results to return.
|
pageToken |
string
Value of the
nextPageToken
from the previous result page.
|
sortField |
enum (SortField )
Field by which to sort the list.
|
sortOrder |
enum (SortOrder )
Order of sorted results.
|
Request body
The request body must be empty.
Response body
Creative Group creativeGroups.list Response
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"nextPageToken": string,
"creativeGroups": [
{
object (CreativeGroup )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#creativeGroupsListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
creativeGroups[] |
object (CreativeGroup )
Creative group collection.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of creative groups, with optional filtering and paging.\u003c/p\u003e\n"],["\u003cp\u003eSends an HTTP GET request to the specified URL, including profile ID as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by IDs, subgroup, name, advertiser IDs, and supports pagination.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty; successful response includes creative group data and pagination details.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003edfatrafficking\u003c/code\u003e authorization scope for access.\u003c/p\u003e\n"]]],[],null,["# Method: creativeGroups.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CreativeGroupsListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of creative groups, possibly filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/creativeGroups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only creative groups with these IDs. |\n| `group``Number` | `integer` Select only creative groups that belong to this subgroup. |\n| `search``String` | `string` Allows searching for creative groups by name or ID. Wildcards ( `*` ) are allowed. For example, `\"creativegroup*2015\"` will return creative groups with names like `\"creativegroup June 2015\"` , `\"creativegroup April 2015\"` , or simply `\"creativegroup 2015\"` . Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of `\"creativegroup\"` will match creative groups with the name `\"my creativegroup\"` , `\"creativegroup 2015\"` , or simply `\"creativegroup\"` . |\n| `advertiser``Ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only creative groups that belong to these advertisers. |\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nCreative Group creativeGroups.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"creativeGroups\": [ { object (/doubleclick-advertisers/rest/v4/creativeGroups#CreativeGroup) } ] } ``` |\n\n| Fields ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#creativeGroupsListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `creative``Groups[]` | `object (`[CreativeGroup](/doubleclick-advertisers/rest/v4/creativeGroups#CreativeGroup)`)` Creative group collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]