{ "protocol": "rest", "id": "adsenseplatform:v1", "resources": { "platforms": { "resources": { "accounts": { "methods": { "get": { "id": "adsenseplatform.platforms.accounts.get", "path": "v1/{+name}", "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id}", "pattern": "^platforms/[^/]+/accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Account" }, "scopes": [ "https://www.googleapis.com/auth/adsense", "https://www.googleapis.com/auth/adsense.readonly" ], "description": "Gets information about the selected sub-account." }, "lookup": { "id": "adsenseplatform.platforms.accounts.lookup", "path": "v1/{+parent}/accounts:lookup", "flatPath": "v1/platforms/{platformsId}/accounts:lookup", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Platform who parents the account. Format: platforms/{platform}", "pattern": "^platforms/[^/]+$", "location": "path", "required": true, "type": "string" }, "creationRequestId": { "description": "Optional. The creation_request_id provided when calling createAccount.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LookupAccountResponse" }, "scopes": [ "https://www.googleapis.com/auth/adsense", "https://www.googleapis.com/auth/adsense.readonly" ], "description": "Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404." }, "list": { "id": "adsenseplatform.platforms.accounts.list", "path": "v1/{+parent}/accounts", "flatPath": "v1/platforms/{platformsId}/accounts", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Platform who parents the accounts. Format: platforms/{platform}", "pattern": "^platforms/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListAccountsResponse" }, "scopes": [ "https://www.googleapis.com/auth/adsense", "https://www.googleapis.com/auth/adsense.readonly" ], "description": "Lists a partial view of sub-accounts for a specific parent account." }, "create": { "id": "adsenseplatform.platforms.accounts.create", "path": "v1/{+parent}/accounts", "flatPath": "v1/platforms/{platformsId}/accounts", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Platform to create an account for. Format: platforms/{platform}", "pattern": "^platforms/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Account" }, "response": { "$ref": "Account" }, "scopes": [ "https://www.googleapis.com/auth/adsense" ], "description": "Creates a sub-account." }, "close": { "id": "adsenseplatform.platforms.accounts.close", "path": "v1/{+name}:close", "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}:close", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Account to close. Format: platforms/{platform}/accounts/{account_id}", "pattern": "^platforms/[^/]+/accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CloseAccountRequest" }, "response": { "$ref": "CloseAccountResponse" }, "scopes": [ "https://www.googleapis.com/auth/adsense" ], "description": "Closes a sub-account." } }, "resources": { "events": { "methods": { "create": { "id": "adsenseplatform.platforms.accounts.events.create", "path": "v1/{+parent}/events", "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/events", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Account to log events about. Format: platforms/{platform}/accounts/{account}", "pattern": "^platforms/[^/]+/accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Event" }, "response": { "$ref": "Event" }, "scopes": [ "https://www.googleapis.com/auth/adsense" ], "description": "Creates an account event." } } }, "sites": { "methods": { "get": { "id": "adsenseplatform.platforms.accounts.sites.get", "path": "v1/{+name}", "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site}", "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Site" }, "scopes": [ "https://www.googleapis.com/auth/adsense", "https://www.googleapis.com/auth/adsense.readonly" ], "description": "Gets a site from a specified sub-account." }, "list": { "id": "adsenseplatform.platforms.accounts.sites.list", "path": "v1/{+parent}/sites", "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account}", "pattern": "^platforms/[^/]+/accounts/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSitesResponse" }, "scopes": [ "https://www.googleapis.com/auth/adsense", "https://www.googleapis.com/auth/adsense.readonly" ], "description": "Lists sites for a specific account." }, "create": { "id": "adsenseplatform.platforms.accounts.sites.create", "path": "v1/{+parent}/sites", "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Account to create site. Format: platforms/{platform}/accounts/{account_id}", "pattern": "^platforms/[^/]+/accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Site" }, "response": { "$ref": "Site" }, "scopes": [ "https://www.googleapis.com/auth/adsense" ], "description": "Creates a site for a specified account." }, "requestReview": { "id": "adsenseplatform.platforms.accounts.sites.requestReview", "path": "v1/{+name}:requestReview", "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}:requestReview", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site}", "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "RequestSiteReviewResponse" }, "scopes": [ "https://www.googleapis.com/auth/adsense" ], "description": "Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review." }, "delete": { "id": "adsenseplatform.platforms.accounts.sites.delete", "path": "v1/{+name}", "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site}", "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/adsense" ], "description": "Deletes a site from a specified account." } } } } } } } }, "baseUrl": "https://adsenseplatform.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/adsense": { "description": "View and manage your AdSense data" }, "https://www.googleapis.com/auth/adsense.readonly": { "description": "View your AdSense data" } } } }, "mtlsRootUrl": "https://adsenseplatform.mtls.googleapis.com/", "ownerDomain": "google.com", "rootUrl": "https://adsenseplatform.googleapis.com/", "ownerName": "Google", "revision": "20260518", "batchPath": "batch", "fullyEncodeReservedExpansion": true, "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "version": "v1", "schemas": { "Account": { "id": "Account", "description": "Representation of an Account.", "type": "object", "properties": { "name": { "description": "Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+", "readOnly": true, "type": "string" }, "displayName": { "description": "Display name of this account.", "type": "string" }, "state": { "description": "Output only. Approval state of the account.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified.", "Unchecked.", "The account is ready to serve ads.", "The account has been blocked from serving ads." ], "enum": [ "STATE_UNSPECIFIED", "UNCHECKED", "APPROVED", "DISAPPROVED" ] }, "timeZone": { "description": "Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.", "$ref": "TimeZone" }, "createTime": { "description": "Output only. Creation time of the account.", "readOnly": true, "type": "string", "format": "google-datetime" }, "regionCode": { "description": "Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.", "type": "string" }, "creationRequestId": { "description": "Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.", "type": "string" } } }, "TimeZone": { "id": "TimeZone", "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "type": "object", "properties": { "id": { "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", "type": "string" }, "version": { "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", "type": "string" } } }, "LookupAccountResponse": { "id": "LookupAccountResponse", "description": "Response definition for the lookup account rpc.", "type": "object", "properties": { "name": { "description": "The name of the Account Format: platforms/{platform}/accounts/{account_id}", "type": "string" } } }, "ListAccountsResponse": { "id": "ListAccountsResponse", "description": "Response definition for the list accounts rpc.", "type": "object", "properties": { "accounts": { "description": "The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.", "type": "array", "items": { "$ref": "Account" } }, "nextPageToken": { "description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", "type": "string" } } }, "CloseAccountRequest": { "id": "CloseAccountRequest", "description": "Request definition for the account close rpc.", "type": "object", "properties": {} }, "CloseAccountResponse": { "id": "CloseAccountResponse", "description": "Response definition for the account close rpc.", "type": "object", "properties": {} }, "Event": { "id": "Event", "description": "A platform sub-account event to record spam signals.", "type": "object", "properties": { "eventType": { "description": "Required. Event type.", "type": "string", "enumDescriptions": [ "Do not use. You must set an event type explicitly.", "Log in via platform.", "Sign up via platform." ], "enum": [ "EVENT_TYPE_UNSPECIFIED", "LOG_IN_VIA_PLATFORM", "SIGN_UP_VIA_PLATFORM" ] }, "eventInfo": { "description": "Required. Information associated with the event.", "$ref": "EventInfo" }, "eventTime": { "description": "Required. Event timestamp.", "type": "string", "format": "google-datetime" } } }, "EventInfo": { "id": "EventInfo", "description": "Private information for partner recorded events (PII).", "type": "object", "properties": { "email": { "description": "Required. The email address that is associated with the publisher when performing the event.", "type": "string" }, "billingAddress": { "description": "The billing address of the publisher associated with this event, if available.", "$ref": "Address" } } }, "Address": { "id": "Address", "description": "Address data.", "type": "object", "properties": { "address1": { "description": "First line of address. Max length 64 bytes or 30 characters.", "type": "string" }, "address2": { "description": "Second line of address. Max length 64 bytes or 30 characters.", "type": "string" }, "city": { "description": "City. Max length 60 bytes or 30 characters.", "type": "string" }, "state": { "description": "State. Max length 60 bytes or 30 characters.", "type": "string" }, "zip": { "description": "Zip/post code. Max length 10 bytes or 10 characters.", "type": "string" }, "company": { "description": "Name of the company. Max length 255 bytes or 34 characters.", "type": "string" }, "contact": { "description": "Contact name of the company. Max length 128 bytes or 34 characters.", "type": "string" }, "phone": { "description": "Phone number with international code (i.e. +441234567890).", "type": "string" }, "fax": { "description": "Fax number with international code (i.e. +441234567890).", "type": "string" }, "regionCode": { "description": "Country/Region code. The region is specified as a CLDR region code (e.g. \"US\", \"FR\").", "type": "string" } } }, "Site": { "id": "Site", "description": "Representation of a Site.", "type": "object", "properties": { "name": { "description": "Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}", "readOnly": true, "type": "string" }, "domain": { "description": "Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.", "type": "string" }, "state": { "description": "Output only. State of a site.", "readOnly": true, "type": "string", "enumDescriptions": [ "State unspecified.", "Either: - The site hasn't been checked yet. - The site is inactive and needs another review before it can show ads again. Learn how to [request a review for an inactive site](https://support.google.com/adsense/answer/9393996).", "Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks.", "The site is ready to show ads. Learn how to [set up ads on the site](https://support.google.com/adsense/answer/7037624).", "Publisher needs to fix some issues before the site is ready to show ads. Learn what to do [if a new site isn't ready](https://support.google.com/adsense/answer/9061852)." ], "enum": [ "STATE_UNSPECIFIED", "REQUIRES_REVIEW", "GETTING_READY", "READY", "NEEDS_ATTENTION" ] } } }, "ListSitesResponse": { "id": "ListSitesResponse", "description": "Response definition for the site list rpc.", "type": "object", "properties": { "sites": { "description": "The sites returned in this list response.", "type": "array", "items": { "$ref": "Site" } }, "nextPageToken": { "description": "Continuation token used to page through sites. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", "type": "string" } } }, "RequestSiteReviewResponse": { "id": "RequestSiteReviewResponse", "description": "Response definition for the site request review rpc.", "type": "object", "properties": {} }, "Empty": { "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} } }, "name": "adsenseplatform", "basePath": "", "kind": "discovery#restDescription", "version_module": true, "discoveryVersion": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "description": "", "title": "AdSense Platform API", "documentationLink": "https://developers.google.com/adsense/platforms/", "canonicalName": "AdSense Platform", "servicePath": "" }