2024-07-10
▼ ▲ adsenseplatform.platforms.accounts.get
Path: v1alpha/{+name}
Flat Path: v1alpha/platforms/{platformsId}/accounts/{accountsId}
HTTP Method: GET
Parameters:
name
Description: Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id}
Pattern: ^platforms/[^/]+/accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets information about the selected sub-account.
▼ ▲ adsenseplatform.platforms.accounts.lookup
Path: v1alpha/{+parent}/accounts:lookup
Flat Path: v1alpha/platforms/{platformsId}/accounts:lookup
HTTP Method: GET
Parameters:
parent
Description: Required. Platform who parents the account. Format: platforms/{platform}
Pattern: ^platforms/[^/]+$
Location: path
Required: Yes
Type: string
creationRequestId
Description: Optional. The creation_request_id provided when calling createAccount.
Location: query
Type: string
Parameter Order: parent
Scopes:
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.
▼ ▲ adsenseplatform.platforms.accounts.list
Path: v1alpha/{+parent}/accounts
Flat Path: v1alpha/platforms/{platformsId}/accounts
HTTP Method: GET
Parameters:
parent
Description: Required. Platform who parents the accounts. Format: platforms/{platform}
Pattern: ^platforms/[^/]+$
Location: path
Required: Yes
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
Parameter Order: parent
Scopes:
Description: Lists a partial view of sub-accounts for a specific parent account.
▼ ▲ adsenseplatform.platforms.accounts.create
Path: v1alpha/{+parent}/accounts
Flat Path: v1alpha/platforms/{platformsId}/accounts
HTTP Method: POST
Parameters:
parent
Description: Required. Platform to create an account for. Format: platforms/{platform}
Pattern: ^platforms/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/adsense
Description: Creates a sub-account.
▼ ▲ adsenseplatform.platforms.accounts.close
Path: v1alpha/{+name}:close
Flat Path: v1alpha/platforms/{platformsId}/accounts/{accountsId}:close
HTTP Method: POST
Parameters:
name
Description: Required. Account to close. Format: platforms/{platform}/accounts/{account_id}
Pattern: ^platforms/[^/]+/accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/adsense
Description: Closes a sub-account.
▼ ▲ adsenseplatform.platforms.accounts.events.create
Path: v1alpha/{+parent}/events
Flat Path: v1alpha/platforms/{platformsId}/accounts/{accountsId}/events
HTTP Method: POST
Parameters:
parent
Description: Required. Account to log events about. Format: platforms/{platform}/accounts/{account}
Pattern: ^platforms/[^/]+/accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/adsense
Description: Creates an account event.
▼ ▲ adsenseplatform.platforms.accounts.sites.get
Path: v1alpha/{+name}
Flat Path: v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}
HTTP Method: 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: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets a site from a specified sub-account.
▼ ▲ adsenseplatform.platforms.accounts.sites.list
Path: v1alpha/{+parent}/sites
Flat Path: v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites
HTTP Method: GET
Parameters:
parent
Description: Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account}
Pattern: ^platforms/[^/]+/accounts/[^/]+$
Location: path
Required: Yes
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
Parameter Order: parent
Scopes:
Description: Lists sites for a specific account.
▼ ▲ adsenseplatform.platforms.accounts.sites.create
Path: v1alpha/{+parent}/sites
Flat Path: v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites
HTTP Method: POST
Parameters:
parent
Description: Required. Account to create site. Format: platforms/{platform}/accounts/{account_id}
Pattern: ^platforms/[^/]+/accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/adsense
Description: Creates a site for a specified account.
▼ ▲ adsenseplatform.platforms.accounts.sites.requestReview
Path: v1alpha/{+name}:requestReview
Flat Path: v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}:requestReview
HTTP Method: 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: Yes
Type: string
Parameter Order: name
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.
▼ ▲ adsenseplatform.platforms.accounts.sites.delete
Path: v1alpha/{+name}
Flat Path: v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}
HTTP Method: 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: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/adsense
Description: Deletes a site from a specified account.