Method: accounts.creatives.dealAssociations.list
Stay organized with collections
Save and categorize content based on your preferences.
List all creative-deal associations.
HTTP request
GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
accountId |
string
The account to list the associations from. Specify "-" to list all creatives the current user has access to.
|
creativeId |
string
The creative ID to list the associations from. Specify "-" to list all creatives under the above account.
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.
|
pageToken |
string
A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'dealAssociations.list' method.
|
query |
string
An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=account_id_string
- creativeId=creative_id_string
- dealsId=deals_id_string
- dealsStatus:{approved, conditionally_approved, disapproved, not_checked}
- openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked}
Example: 'dealsId=12345 AND dealsStatus:disapproved'
|
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 creative and deal associations
| Fields |
associations[] |
object (CreativeDealAssociation)
The list of associations.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' 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 associations between creatives and deals for a given account.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of associations by account ID, creative ID, deal ID, deal status, and open auction status.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e authorization scope for access.\u003c/p\u003e\n"],["\u003cp\u003eProvides details like association status and associated deal IDs in the response.\u003c/p\u003e\n"]]],["This outlines how to list creative-deal associations via an HTTP `GET` request to a specified URL. Key actions involve using `accountId` and `creativeId` as path parameters to identify the desired associations. Optional query parameters, `pageSize`, `pageToken`, and `query`, allow for pagination and filtering based on account, creative, deal ID, or status. The request body must be empty. The response contains an array of `associations` and a `nextPageToken` for subsequent page retrieval. Authorization requires the `adexchange.buyer` OAuth scope.\n"],null,["# Method: accounts.creatives.dealAssociations.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.ListDealAssociationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList all creative-deal associations.\n\n### HTTP request\n\n`GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations`\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 associations from. Specify \"-\" to list all creatives the current user has access to. |\n| `creativeId` | `string` The creative ID to list the associations from. Specify \"-\" to list all creatives under the above account. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [ListDealAssociationsResponse.next_page_token](/authorized-buyers/apis/reference/rest/v2beta1/accounts.creatives.dealAssociations/list#body.ListDealAssociationsResponse.FIELDS.next_page_token) returned from the previous call to 'dealAssociations.list' method. |\n| `query` | `string` An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved' \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 creative and deal associations\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"associations\": [ { object (/authorized-buyers/apis/reference/rest/v2beta1/CreativeDealAssociation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `associations[]` | `object (`[CreativeDealAssociation](/authorized-buyers/apis/reference/rest/v2beta1/CreativeDealAssociation)`)` The list of associations. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [ListDealAssociationsRequest.page_token](/authorized-buyers/apis/reference/rest/v2beta1/accounts.creatives.dealAssociations/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to 'ListDealAssociation' 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`"]]
