Method: accounts.creatives.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/creatives
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
accountId |
string
The account to list the creatives from. Specify "-" to list all creatives the current user has access to.
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
|
pageToken |
string
A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'creatives.list' method.
|
query |
string
An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=account_id_string
- creativeId=creative_id_string
- dealsStatus: {approved, conditionally_approved, disapproved, not_checked}
- openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked}
- attribute: {a numeric attribute from the list of attributes}
- disapprovalReason: {a reason from
DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
A response for listing creatives.
| JSON representation |
{
"creatives": [
{
object (Creative)
}
],
"nextPageToken": string
} |
| Fields |
creatives[] |
object (Creative)
The list of creatives.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to creatives.list method to retrieve the next page of results.
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adexchange.buyer
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-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eLists all creatives associated with a specific account or all accounts accessible to the current user.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of creatives based on criteria like account ID, creative ID, deals status, and more using query parameters.\u003c/p\u003e\n"],["\u003cp\u003eReturns a paginated list of creatives, with the ability to retrieve subsequent pages using a page token.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request to the endpoint \u003ccode\u003ehttps://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/creatives\u003c/code\u003e.\u003c/p\u003e\n"]]],["This document outlines the process for listing creatives via an HTTP GET request to `https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/creatives`. Key actions involve specifying the `accountId` as a path parameter and optional query parameters like `pageSize`, `pageToken`, and `query` for filtering. The `accountId` can be set to \"-\" to list all available creatives. The response body will contain a list of `creatives` and a `nextPageToken` for pagination. Authorization requires the `adexchange.buyer` OAuth scope. The request body should be empty.\n"],null,["# Method: accounts.creatives.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.ListCreativesResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists creatives.\n\n### HTTP request\n\n`GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/creatives`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------|\n| `accountId` | `string` The account to list the creatives from. Specify \"-\" to list all creatives the current user has access to. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [ListCreativesResponse.next_page_token](/authorized-buyers/apis/reference/rest/v2beta1/accounts.creatives/list#body.ListCreativesResponse.FIELDS.next_page_token) returned from the previous call to 'creatives.list' method. |\n| `query` | `string` An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from [DisapprovalReason](/authorized-buyers/apis/reference/rest/v2beta1/accounts.creatives#DisapprovalReason)} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' \u003cbr /\u003e |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nA response for listing creatives.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"creatives\": [ { object (/authorized-buyers/apis/reference/rest/v2beta1/accounts.creatives#Creative) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `creatives[]` | `object (`[Creative](/authorized-buyers/apis/reference/rest/v2beta1/accounts.creatives#Creative)`)` The list of creatives. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [ListCreativesRequest.page_token](/authorized-buyers/apis/reference/rest/v2beta1/accounts.creatives/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `creatives.list` method to retrieve the next page of results. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adexchange.buyer`"]]
