Method: accounts.creatives.watch
Stay organized with collections
Save and categorize content based on your preferences.
Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.
HTTP request
POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/creatives/{creativeId}:watch
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
accountId |
string
The account of the creative to watch.
|
creativeId |
string
The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.
|
Request body
The request body contains data with the following structure:
JSON representation |
{
"topic": string
} |
Fields |
topic |
string
The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be the full resource name in "projects/{project_id}/topics/{topic_id}" format.
|
Response body
If successful, the response body is empty.
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\u003eEnables real-time monitoring of creative status changes through push notifications to a specified Pub/Sub topic.\u003c/p\u003e\n"],["\u003cp\u003eRequires providing the account and creative IDs for targeted watching, with the option to monitor all creatives under an account.\u003c/p\u003e\n"],["\u003cp\u003eNotifications are sent when the creative's status is updated, delivered to the designated Pub/Sub topic with necessary permissions granted.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes a POST request to initiate the watch process, providing the topic details in the request body.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization necessitates the \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e scope for access and operation.\u003c/p\u003e\n"]]],["This documentation details how to watch for creative status changes via push notifications. A `POST` request is sent to a specific URL containing `accountId` and `creativeId` path parameters. The request body, in JSON format, must include a `topic` field specifying the Pub/Sub topic to receive notifications. The topic must grant write permissions to `ad-exchange-buyside-reports@google.com`. A successful request yields an empty response, indicating that status change push notification are set up. The request requires the `adexchange.buyer` OAuth scope.\n"],null,["# Method: accounts.creatives.watch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nWatches a creative. Will result in push notifications being sent to the topic when the creative changes status.\n\n### HTTP request\n\n`POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/creatives/{creativeId}:watch`\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 of the creative to watch. |\n| `creativeId` | `string` The creative ID to watch for status changes. Specify \"-\" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|-----------------------------|---|\n| ``` { \"topic\": string } ``` |\n\n| Fields ||\n|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `topic` | `string` The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to [ad-exchange-buyside-reports@google.com](mailto:ad-exchange-buyside-reports@google.com) to write to the topic. This should be the full resource name in \"projects/{project_id}/topics/{topic_id}\" format. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adexchange.buyer`"]]