This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to theMarketerssite. If you are a measurement partner, refer to theMeasurement Partnerssite.
The absolute point in time when the outage started.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:"2014-10-02T15:01:23Z"and"2014-10-02T15:01:23.045123456Z".
The absolute point in time when the outage ended or will end. If empty or in the future, then it means the outage is still on going.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:"2014-10-02T15:01:23Z"and"2014-10-02T15:01:23.045123456Z".
details
string
Message describing this outage.
OutageType
Defines the outage type.
Enums
OUTAGE_TYPE_UNSPECIFIED
The outage type is not specified.
OUTAGE_TYPE_INACCESSIBLE_UI
Certain Ads Data Hub UI is not accessible.
OUTAGE_TYPE_QUERY_SERVICE_DOWN
Ads Data Hub query related service is down.
OUTAGE_TYPE_OUT_OF_SLA_DT
Ads Data Hub data-transfer is out of service layer agreement (SLA).
OUTAGE_TYPE_FIELD_NOT_POPULATING
Certain fields are not populating in Ads Data Hub.
OUTAGE_TYPE_ACCOUNT_LINKING_DOWN
Ads Data Hub account linking related service is down.
OUTAGE_TYPE_OUT_OF_SLA_NON_DT
Ads Data Hub non-data-transfer is out of service layer agreement (SLA).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eAn Outage resource defines an outage event with details such as name, type, start and end times, and a descriptive message.\u003c/p\u003e\n"],["\u003cp\u003eOutageType categorizes outages into specific types like inaccessible UI, query service down, or data transfer issues.\u003c/p\u003e\n"],["\u003cp\u003eOutages can be retrieved using the \u003ccode\u003elist\u003c/code\u003e method, which returns outages within a 130-day window, sorted by start time in descending order.\u003c/p\u003e\n"],["\u003cp\u003eOutage details are represented in JSON format including fields like name, type, startTime, endTime, and details.\u003c/p\u003e\n"]]],["Outages are identified by a unique name and include details like `type`, `startTime`, `endTime`, and a description. The `type` categorizes the outage (e.g., UI inaccessible, query service down). Timestamps are in RFC3339 UTC format. A method allows listing outages, ordered by start time with a 130-day lookback period. Outages are also represented in JSON format, using the defined fields.\n"],null,["# REST Resource: outages\n\n- [Resource: Outage](#Outage)\n - [JSON representation](#Outage.SCHEMA_REPRESENTATION)\n- [OutageType](#OutageType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Outage\n----------------\n\nDefines an outage and its information.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"type\": enum (/ads-data-hub/reference/rest/v1/outages#OutageType), \"startTime\": string, \"endTime\": string, \"details\": string } ``` |\n\n| Fields ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Name that uniquely identifies an outage. It has the form outages/\\[outage_id\\], e.g. 'outages/1234'. |\n| `type` | `enum (`[OutageType](/ads-data-hub/reference/rest/v1/outages#OutageType)`)` The type of this outage. |\n| `startTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` The absolute point in time when the outage started. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `endTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` The absolute point in time when the outage ended or will end. If empty or in the future, then it means the outage is still on going. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `details` | `string` Message describing this outage. |\n\nOutageType\n----------\n\nDefines the outage type.\n\n| Enums ||\n|------------------------------------|-------------------------------------------------------------------------|\n| `OUTAGE_TYPE_UNSPECIFIED` | The outage type is not specified. |\n| `OUTAGE_TYPE_INACCESSIBLE_UI` | Certain Ads Data Hub UI is not accessible. |\n| `OUTAGE_TYPE_QUERY_SERVICE_DOWN` | Ads Data Hub query related service is down. |\n| `OUTAGE_TYPE_OUT_OF_SLA_DT` | Ads Data Hub data-transfer is out of service layer agreement (SLA). |\n| `OUTAGE_TYPE_FIELD_NOT_POPULATING` | Certain fields are not populating in Ads Data Hub. |\n| `OUTAGE_TYPE_ACCOUNT_LINKING_DOWN` | Ads Data Hub account linking related service is down. |\n| `OUTAGE_TYPE_OUT_OF_SLA_NON_DT` | Ads Data Hub non-data-transfer is out of service layer agreement (SLA). |\n\n| Methods ------- ||\n|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------|\n| ### [list](/ads-data-hub/reference/rest/v1/outages/list) | Lists the outages in descending order of outage start timestamp, and the look back window is 130 days. |"]]
