Method: bidders.creatives.watch
Stay organized with collections
Save and categorize content based on your preferences.
Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.
HTTP request
POST https://realtimebidding.googleapis.com/v1/{parent=bidders/*}/creatives:watch
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern bidders/{bidderAccountId} .
|
Request body
The request body must be empty.
Response body
A response for the request to receive push notification when a bidder's creatives change status.
If successful, the response body contains data with the following structure:
JSON representation |
{
"topic": string,
"subscription": string
} |
Fields |
topic |
string
The Pub/Sub topic that will be used to publish creative serving status notifications. This would be of the format projects/{projectId}/topics/{topic_id} .
|
subscription |
string
The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format projects/{projectId}/subscriptions/{subscription_id} . Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Use watchCreatives to re-enable the subscription.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/realtime-bidding
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\u003eWatches all creatives for a specified bidder and its child seat accounts, delivering status change notifications via Pub/Sub.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes a POST request to \u003ccode\u003ehttps://realtimebidding.googleapis.com/v1/{parent=bidders/*}/creatives:watch\u003c/code\u003e, with the bidder ID specified in the path.\u003c/p\u003e\n"],["\u003cp\u003eReturns a Pub/Sub topic and subscription for receiving creative status notifications, accessible to the bidder's service accounts.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/realtime-bidding\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eInactive subscriptions (90+ days) are disabled and can be re-enabled using the \u003ccode\u003ewatchCreatives\u003c/code\u003e method.\u003c/p\u003e\n"]]],[],null,["# Method: bidders.creatives.watch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.WatchCreativesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nWatches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.\n\n### HTTP request\n\n`POST https://realtimebidding.googleapis.com/v1/{parent=bidders/*}/creatives:watch`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern `bidders/{bidderAccountId}`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA response for the request to receive push notification when a bidder's creatives change status.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------|\n| ``` { \"topic\": string, \"subscription\": string } ``` |\n\n| Fields ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `topic` | `string` The Pub/Sub topic that will be used to publish creative serving status notifications. This would be of the format `projects/{projectId}/topics/{topic_id}`. |\n| `subscription` | `string` The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{projectId}/subscriptions/{subscription_id}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Use [watchCreatives](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives/watch#google.ads.realtimebidding.v1.Creatives.WatchCreatives) to re-enable the subscription. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/realtime-bidding`"]]