REST Resource: buyers
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Buyer
RTB Buyer account information.
JSON representation |
{
"name": string,
"displayName": string,
"bidder": string,
"activeCreativeCount": string,
"maximumActiveCreativeCount": string,
"billingIds": [
string
]
} |
Fields |
name |
string
Output only. Name of the buyer resource that must follow the pattern buyers/{buyerAccountId} , where {buyerAccountId} is the account ID of the buyer account whose information is to be received. One can get their account ID on the Authorized Buyers or Open Bidding UI, or by contacting their Google account manager.
|
displayName |
string
Output only. The diplay name associated with this buyer account, as visible to sellers.
|
bidder |
string
Output only. The name of the bidder resource that is responsible for receiving bidding traffic for this account. The bidder name must follow the pattern bidders/{bidderAccountId} , where {bidderAccountId} is the account ID of the bidder receiving traffic for this buyer.
|
activeCreativeCount |
string (int64 format)
Output only. The number of creatives that this buyer submitted through the API or bid with in the last 30 days. This is counted against the maximum number of active creatives.
|
maximumActiveCreativeCount |
string (int64 format)
Output only. The maximum number of active creatives that this buyer can have.
|
billingIds[] |
string
Output only. A list of billing IDs associated with this account. These IDs appear on: 1. A bid request, to signal which buyers are eligible to bid on a given opportunity, and which pretargeting configurations were matched for each eligible buyer. 2. The bid response, to attribute a winning impression to a specific account for billing, reporting, policy and publisher block enforcement.
|
Methods |
|
Gets a buyer account by its name. |
|
This has been sunset as of October 2023, and will return an error response if called. |
|
Lists all buyer account information the calling buyer user or service account is permissioned to manage. |
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 2025-05-07 UTC.
[null,null,["Last updated 2025-05-07 UTC."],[[["\u003cp\u003eThe Buyer resource provides RTB buyer account information, including details like display name, bidder, and billing IDs.\u003c/p\u003e\n"],["\u003cp\u003eBuyers are identified by a unique name following the pattern \u003ccode\u003ebuyers/{buyerAccountId}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eYou can access information about a specific buyer using the \u003ccode\u003eget\u003c/code\u003e method or list all accessible buyers using the \u003ccode\u003elist\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetRemarketingTag\u003c/code\u003e method has been retired.\u003c/p\u003e\n"],["\u003cp\u003eImportant fields include \u003ccode\u003edisplayName\u003c/code\u003e, \u003ccode\u003ebidder\u003c/code\u003e, \u003ccode\u003eactiveCreativeCount\u003c/code\u003e, \u003ccode\u003emaximumActiveCreativeCount\u003c/code\u003e, and \u003ccode\u003ebillingIds\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# REST Resource: buyers\n\n- [Resource: Buyer](#Buyer)\n - [JSON representation](#Buyer.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Buyer\n---------------\n\nRTB Buyer account information.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"bidder\": string, \"activeCreativeCount\": string, \"maximumActiveCreativeCount\": string, \"billingIds\": [ string ] } ``` |\n\n| Fields ||\n|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Name of the buyer resource that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` is the account ID of the buyer account whose information is to be received. One can get their account ID on the Authorized Buyers or Open Bidding UI, or by contacting their Google account manager. |\n| `displayName` | `string` Output only. The diplay name associated with this buyer account, as visible to sellers. |\n| `bidder` | `string` Output only. The name of the bidder resource that is responsible for receiving bidding traffic for this account. The bidder name must follow the pattern `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the account ID of the bidder receiving traffic for this buyer. |\n| `activeCreativeCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. The number of creatives that this buyer submitted through the API or bid with in the last 30 days. This is counted against the maximum number of active creatives. |\n| `maximumActiveCreativeCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. The maximum number of active creatives that this buyer can have. |\n| `billingIds[]` | `string` Output only. A list of billing IDs associated with this account. These IDs appear on: 1. A bid request, to signal which buyers are eligible to bid on a given opportunity, and which pretargeting configurations were matched for each eligible buyer. 2. The bid response, to attribute a winning impression to a specific account for billing, reporting, policy and publisher block enforcement. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|\n| ### [get](/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers/get) | Gets a buyer account by its name. |\n| ### [getRemarketingTag](/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers/getRemarketingTag) | This has been sunset as of October 2023, and will return an error response if called. |\n| ### [list](/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers/list) | Lists all buyer account information the calling buyer user or service account is permissioned to manage. |"]]