Conversion: updateAvailability
Stay organized with collections
Save and categorize content based on your preferences.
Updates the availabilities of a batch of floodlight activities in DoubleClick Search.
Try it now.
Request
HTTP request
POST https://www.googleapis.com/doubleclicksearch/v2/conversion/updateAvailability
Authorization
This request requires authorization with the following scope:
Scope |
https://www.googleapis.com/auth/doubleclicksearch |
For more information, see the authentication and authorization page.
Request body
In the request body, supply data with the following structure:
{
"availabilities": [
{
"agencyId": long,
"advertiserId": long,
"customerId": string,
"segmentationType": string,
"segmentationId": long,
"segmentationName": string,
"availabilityTimestamp": unsigned long
}
]
}
Property name |
Value |
Description |
Notes |
availabilities[] |
list |
The availabilities being requested. |
|
availabilities[].agencyId |
long |
DS agency ID. |
|
availabilities[].advertiserId |
long |
DS advertiser ID. |
|
availabilities[].segmentationType |
string |
The segmentation type that this availability is for (its default value is FLOODLIGHT ).
Acceptable values are:
|
|
availabilities[].segmentationId |
long |
The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
|
availabilities[].segmentationName |
string |
The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
|
availabilities[].availabilityTimestamp |
unsigned long |
The time by which all conversions have been uploaded, in epoch millis UTC. |
|
availabilities[].customerId |
string |
New Search Ads 360 customer ID. This must be a sub-manager account. |
|
Response
If successful, this method returns a response body with the following structure:
{
"availabilities": [
{
"agencyId": long,
"advertiserId": long,
"customerId": string,
"segmentationType": string,
"segmentationId": long,
"segmentationName": string,
"availabilityTimestamp": unsigned long
}
]
}
Property name |
Value |
Description |
Notes |
availabilities[] |
list |
The availabilities being returned. |
|
availabilities[].agencyId |
long |
DS agency ID. |
|
availabilities[].advertiserId |
long |
DS advertiser ID. |
|
availabilities[].segmentationType |
string |
The segmentation type that this availability is for (its default value is FLOODLIGHT ).
Acceptable values are:
|
|
availabilities[].segmentationId |
long |
The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
|
availabilities[].segmentationName |
string |
The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
|
availabilities[].availabilityTimestamp |
unsigned long |
The time by which all conversions have been uploaded, in epoch millis UTC. |
|
availabilities[].customerId |
string |
New Search Ads 360 customer ID. This must be a sub-manager account. |
|
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
Alternatively, try the
standalone
Explorer.
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-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eUpdates the availability status for a batch of floodlight activities in DoubleClick Search.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclicksearch\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes an array of \u003ccode\u003eavailabilities\u003c/code\u003e with details like agencyId, advertiserId, segmentation details, and availability timestamp.\u003c/p\u003e\n"],["\u003cp\u003eThe response returns an array of \u003ccode\u003eavailabilities\u003c/code\u003e mirroring the request structure, confirming the updated status.\u003c/p\u003e\n"]]],["This API endpoint, accessed via a POST request to `https://www.googleapis.com/doubleclicksearch/v2/conversion/updateAvailability`, updates the availabilities of multiple floodlight activities in DoubleClick Search. The request body requires authorization and includes a list of `availabilities`. Each entry needs `agencyId`, `advertiserId`, `customerId`, `segmentationType` (default `FLOODLIGHT`), `segmentationId`, `segmentationName`, and `availabilityTimestamp`. The response mirrors the request structure, returning the updated `availabilities` with the same fields.\n"],null,["# Conversion: updateAvailability\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates the availabilities of a batch of floodlight activities in DoubleClick Search.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/doubleclicksearch/v2/conversion/updateAvailability\n```\n\n### Authorization\n\nThis request requires authorization with the following scope:\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/doubleclicksearch` |\n\nFor more information, see the [authentication and authorization](/search-ads/v2/authorizing) page.\n\n### Request body\n\nIn the request body, supply data with the following structure:\n\n```text\n{\n \"availabilities\": [\n {\n \"agencyId\": long,\n \"advertiserId\": long,\n \"customerId\": string,\n \"segmentationType\": string,\n \"segmentationId\": long,\n \"segmentationName\": string,\n \"availabilityTimestamp\": unsigned long\n }\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|------------------------------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `availabilities[]` | `list` | The availabilities being requested. | |\n| availabilities[].`agencyId` | `long` | DS agency ID. | |\n| availabilities[].`advertiserId` | `long` | DS advertiser ID. | |\n| availabilities[].`segmentationType` | `string` | The segmentation type that this availability is for (its default value is `FLOODLIGHT`). \u003cbr /\u003e Acceptable values are: - \"`FLOODLIGHT`\" | |\n| availabilities[].`segmentationId` | `long` | The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). | |\n| availabilities[].`segmentationName` | `string` | The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). | |\n| availabilities[].`availabilityTimestamp` | `unsigned long` | The time by which all conversions have been uploaded, in epoch millis UTC. | |\n| availabilities[].`customerId` | `string` | New Search Ads 360 customer ID. This must be a sub-manager account. | |\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```text\n{\n \"availabilities\": [\n {\n \"agencyId\": long,\n \"advertiserId\": long,\n \"customerId\": string,\n \"segmentationType\": string,\n \"segmentationId\": long,\n \"segmentationName\": string,\n \"availabilityTimestamp\": unsigned long\n }\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|------------------------------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `availabilities[]` | `list` | The availabilities being returned. | |\n| availabilities[].`agencyId` | `long` | DS agency ID. | |\n| availabilities[].`advertiserId` | `long` | DS advertiser ID. | |\n| availabilities[].`segmentationType` | `string` | The segmentation type that this availability is for (its default value is `FLOODLIGHT`). \u003cbr /\u003e Acceptable values are: - \"`FLOODLIGHT`\" | |\n| availabilities[].`segmentationId` | `long` | The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). | |\n| availabilities[].`segmentationName` | `string` | The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). | |\n| availabilities[].`availabilityTimestamp` | `unsigned long` | The time by which all conversions have been uploaded, in epoch millis UTC. | |\n| availabilities[].`customerId` | `string` | New Search Ads 360 customer ID. This must be a sub-manager account. | |\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response.\nAlternatively, try the\n[standalone\nExplorer](https://developers.google.com/apis-explorer/#p/doubleclicksearch/v2/doubleclicksearch.conversion.updateAvailability)."]]