| // Copyright 2024 Google LLC |
| // |
| // Use of this source code is governed by a BSD-style |
| // license that can be found in the LICENSE file or at |
| // https://developers.google.com/open-source/licenses/bsd |
| |
| // This is a generated file (see the discoveryapis_generator project). |
| |
| // ignore_for_file: camel_case_types |
| // ignore_for_file: comment_references |
| // ignore_for_file: deprecated_member_use_from_same_package |
| // ignore_for_file: doc_directive_unknown |
| // ignore_for_file: lines_longer_than_80_chars |
| // ignore_for_file: non_constant_identifier_names |
| // ignore_for_file: prefer_interpolation_to_compose_strings |
| // ignore_for_file: unintended_html_in_doc_comment |
| // ignore_for_file: unnecessary_brace_in_string_interps |
| // ignore_for_file: unnecessary_lambdas |
| // ignore_for_file: unnecessary_string_interpolations |
| |
| /// AdSense Platform API - v1 |
| /// |
| /// For more information, see <https://developers.google.com/adsense/platforms/> |
| /// |
| /// Create an instance of [AdSensePlatformApi] to access these resources: |
| /// |
| /// - [PlatformsResource] |
| /// - [PlatformsAccountsResource] |
| /// - [PlatformsAccountsEventsResource] |
| /// - [PlatformsAccountsSitesResource] |
| library; |
| |
| import 'dart:async' as async; |
| import 'dart:convert' as convert; |
| import 'dart:core' as core; |
| |
| import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
| import 'package:http/http.dart' as http; |
| |
| import '../shared.dart'; |
| import '../src/user_agent.dart'; |
| |
| export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' |
| show ApiRequestError, DetailedApiRequestError; |
| |
| class AdSensePlatformApi { |
| /// View and manage your AdSense data |
| static const adsenseScope = 'https://www.googleapis.com/auth/adsense'; |
| |
| /// View your AdSense data |
| static const adsenseReadonlyScope = |
| 'https://www.googleapis.com/auth/adsense.readonly'; |
| |
| final commons.ApiRequester _requester; |
| |
| PlatformsResource get platforms => PlatformsResource(_requester); |
| |
| AdSensePlatformApi( |
| http.Client client, { |
| core.String rootUrl = 'https://adsenseplatform.googleapis.com/', |
| core.String servicePath = '', |
| }) : _requester = commons.ApiRequester( |
| client, |
| rootUrl, |
| servicePath, |
| requestHeaders, |
| ); |
| } |
| |
| class PlatformsResource { |
| final commons.ApiRequester _requester; |
| |
| PlatformsAccountsResource get accounts => |
| PlatformsAccountsResource(_requester); |
| |
| PlatformsResource(commons.ApiRequester client) : _requester = client; |
| } |
| |
| class PlatformsAccountsResource { |
| final commons.ApiRequester _requester; |
| |
| PlatformsAccountsEventsResource get events => |
| PlatformsAccountsEventsResource(_requester); |
| PlatformsAccountsSitesResource get sites => |
| PlatformsAccountsSitesResource(_requester); |
| |
| PlatformsAccountsResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Closes a sub-account. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Account to close. Format: |
| /// platforms/{platform}/accounts/{account_id} |
| /// Value must have pattern `^platforms/\[^/\]+/accounts/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [CloseAccountResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<CloseAccountResponse> close( |
| CloseAccountRequest request, |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':close'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return CloseAccountResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Creates a sub-account. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Platform to create an account for. Format: |
| /// platforms/{platform} |
| /// Value must have pattern `^platforms/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Account]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Account> create( |
| Account request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/accounts'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Account.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets information about the selected sub-account. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Account to get information about. Format: |
| /// platforms/{platform}/accounts/{account_id} |
| /// Value must have pattern `^platforms/\[^/\]+/accounts/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Account]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Account> get(core.String name, {core.String? $fields}) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return Account.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Lists a partial view of sub-accounts for a specific parent account. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Platform who parents the accounts. Format: |
| /// platforms/{platform} |
| /// Value must have pattern `^platforms/\[^/\]+$`. |
| /// |
| /// [pageSize] - 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. |
| /// |
| /// [pageToken] - Optional. A page token, received from a previous |
| /// `ListAccounts` call. Provide this to retrieve the subsequent page. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListAccountsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<ListAccountsResponse> list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'pageSize': ?pageSize == null ? null : ['${pageSize}'], |
| 'pageToken': ?pageToken == null ? null : [pageToken], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/accounts'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return ListAccountsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// 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. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Platform who parents the account. Format: |
| /// platforms/{platform} |
| /// Value must have pattern `^platforms/\[^/\]+$`. |
| /// |
| /// [creationRequestId] - Optional. The creation_request_id provided when |
| /// calling createAccount. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [LookupAccountResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<LookupAccountResponse> lookup( |
| core.String parent, { |
| core.String? creationRequestId, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'creationRequestId': ?creationRequestId == null |
| ? null |
| : [creationRequestId], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/accounts:lookup'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return LookupAccountResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class PlatformsAccountsEventsResource { |
| final commons.ApiRequester _requester; |
| |
| PlatformsAccountsEventsResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates an account event. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Account to log events about. Format: |
| /// platforms/{platform}/accounts/{account} |
| /// Value must have pattern `^platforms/\[^/\]+/accounts/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Event]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Event> create( |
| Event request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/events'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Event.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| class PlatformsAccountsSitesResource { |
| final commons.ApiRequester _requester; |
| |
| PlatformsAccountsSitesResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates a site for a specified account. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Account to create site. Format: |
| /// platforms/{platform}/accounts/{account_id} |
| /// Value must have pattern `^platforms/\[^/\]+/accounts/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Site]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Site> create( |
| Site request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/sites'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Site.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Deletes a site from a specified account. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the site to delete. Format: |
| /// platforms/{platform}/accounts/{account}/sites/{site} |
| /// Value must have pattern |
| /// `^platforms/\[^/\]+/accounts/\[^/\]+/sites/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Empty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Empty> delete(core.String name, {core.String? $fields}) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets a site from a specified sub-account. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the site to retrieve. Format: |
| /// platforms/{platform}/accounts/{account}/sites/{site} |
| /// Value must have pattern |
| /// `^platforms/\[^/\]+/accounts/\[^/\]+/sites/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Site]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Site> get(core.String name, {core.String? $fields}) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return Site.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Lists sites for a specific account. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The account which owns the sites. Format: |
| /// platforms/{platform}/accounts/{account} |
| /// Value must have pattern `^platforms/\[^/\]+/accounts/\[^/\]+$`. |
| /// |
| /// [pageSize] - 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. |
| /// |
| /// [pageToken] - 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. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListSitesResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<ListSitesResponse> list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'pageSize': ?pageSize == null ? null : ['${pageSize}'], |
| 'pageToken': ?pageToken == null ? null : [pageToken], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/sites'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return ListSitesResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// 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. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the site to submit for review. Format: |
| /// platforms/{platform}/accounts/{account}/sites/{site} |
| /// Value must have pattern |
| /// `^platforms/\[^/\]+/accounts/\[^/\]+/sites/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [RequestSiteReviewResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<RequestSiteReviewResponse> requestReview( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':requestReview'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| queryParams: queryParams_, |
| ); |
| return RequestSiteReviewResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| /// Representation of an Account. |
| class Account { |
| /// Creation time of the account. |
| /// |
| /// Output only. |
| core.String? createTime; |
| |
| /// 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. |
| /// |
| /// Required. |
| core.String? creationRequestId; |
| |
| /// Display name of this account. |
| core.String? displayName; |
| |
| /// Resource name of the account. |
| /// |
| /// Format: platforms/pub-\[0-9\]+/accounts/pub-\[0-9\]+ |
| /// |
| /// Output only. |
| core.String? name; |
| |
| /// 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. |
| /// |
| /// Required. |
| core.String? regionCode; |
| |
| /// Approval state of the account. |
| /// |
| /// Output only. |
| /// Possible string values are: |
| /// - "STATE_UNSPECIFIED" : Unspecified. |
| /// - "UNCHECKED" : Unchecked. |
| /// - "APPROVED" : The account is ready to serve ads. |
| /// - "DISAPPROVED" : The account has been blocked from serving ads. |
| core.String? state; |
| |
| /// 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. |
| /// |
| /// Required. |
| TimeZone? timeZone; |
| |
| Account({ |
| this.createTime, |
| this.creationRequestId, |
| this.displayName, |
| this.name, |
| this.regionCode, |
| this.state, |
| this.timeZone, |
| }); |
| |
| Account.fromJson(core.Map json_) |
| : this( |
| createTime: json_['createTime'] as core.String?, |
| creationRequestId: json_['creationRequestId'] as core.String?, |
| displayName: json_['displayName'] as core.String?, |
| name: json_['name'] as core.String?, |
| regionCode: json_['regionCode'] as core.String?, |
| state: json_['state'] as core.String?, |
| timeZone: json_.containsKey('timeZone') |
| ? TimeZone.fromJson( |
| json_['timeZone'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final createTime = this.createTime; |
| final creationRequestId = this.creationRequestId; |
| final displayName = this.displayName; |
| final name = this.name; |
| final regionCode = this.regionCode; |
| final state = this.state; |
| final timeZone = this.timeZone; |
| return { |
| 'createTime': ?createTime, |
| 'creationRequestId': ?creationRequestId, |
| 'displayName': ?displayName, |
| 'name': ?name, |
| 'regionCode': ?regionCode, |
| 'state': ?state, |
| 'timeZone': ?timeZone, |
| }; |
| } |
| } |
| |
| /// Address data. |
| class Address { |
| /// First line of address. |
| /// |
| /// Max length 64 bytes or 30 characters. |
| core.String? address1; |
| |
| /// Second line of address. |
| /// |
| /// Max length 64 bytes or 30 characters. |
| core.String? address2; |
| |
| /// City. |
| /// |
| /// Max length 60 bytes or 30 characters. |
| core.String? city; |
| |
| /// Name of the company. |
| /// |
| /// Max length 255 bytes or 34 characters. |
| core.String? company; |
| |
| /// Contact name of the company. |
| /// |
| /// Max length 128 bytes or 34 characters. |
| core.String? contact; |
| |
| /// Fax number with international code (i.e. +441234567890). |
| core.String? fax; |
| |
| /// Phone number with international code (i.e. +441234567890). |
| core.String? phone; |
| |
| /// Country/Region code. |
| /// |
| /// The region is specified as a CLDR region code (e.g. "US", "FR"). |
| core.String? regionCode; |
| |
| /// State. |
| /// |
| /// Max length 60 bytes or 30 characters. |
| core.String? state; |
| |
| /// Zip/post code. |
| /// |
| /// Max length 10 bytes or 10 characters. |
| core.String? zip; |
| |
| Address({ |
| this.address1, |
| this.address2, |
| this.city, |
| this.company, |
| this.contact, |
| this.fax, |
| this.phone, |
| this.regionCode, |
| this.state, |
| this.zip, |
| }); |
| |
| Address.fromJson(core.Map json_) |
| : this( |
| address1: json_['address1'] as core.String?, |
| address2: json_['address2'] as core.String?, |
| city: json_['city'] as core.String?, |
| company: json_['company'] as core.String?, |
| contact: json_['contact'] as core.String?, |
| fax: json_['fax'] as core.String?, |
| phone: json_['phone'] as core.String?, |
| regionCode: json_['regionCode'] as core.String?, |
| state: json_['state'] as core.String?, |
| zip: json_['zip'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final address1 = this.address1; |
| final address2 = this.address2; |
| final city = this.city; |
| final company = this.company; |
| final contact = this.contact; |
| final fax = this.fax; |
| final phone = this.phone; |
| final regionCode = this.regionCode; |
| final state = this.state; |
| final zip = this.zip; |
| return { |
| 'address1': ?address1, |
| 'address2': ?address2, |
| 'city': ?city, |
| 'company': ?company, |
| 'contact': ?contact, |
| 'fax': ?fax, |
| 'phone': ?phone, |
| 'regionCode': ?regionCode, |
| 'state': ?state, |
| 'zip': ?zip, |
| }; |
| } |
| } |
| |
| /// Request definition for the account close rpc. |
| typedef CloseAccountRequest = $Empty; |
| |
| /// Response definition for the account close rpc. |
| typedef CloseAccountResponse = $Empty; |
| |
| /// 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); } |
| typedef Empty = $Empty; |
| |
| /// A platform sub-account event to record spam signals. |
| class Event { |
| /// Information associated with the event. |
| /// |
| /// Required. |
| EventInfo? eventInfo; |
| |
| /// Event timestamp. |
| /// |
| /// Required. |
| core.String? eventTime; |
| |
| /// Event type. |
| /// |
| /// Required. |
| /// Possible string values are: |
| /// - "EVENT_TYPE_UNSPECIFIED" : Do not use. You must set an event type |
| /// explicitly. |
| /// - "LOG_IN_VIA_PLATFORM" : Log in via platform. |
| /// - "SIGN_UP_VIA_PLATFORM" : Sign up via platform. |
| core.String? eventType; |
| |
| Event({this.eventInfo, this.eventTime, this.eventType}); |
| |
| Event.fromJson(core.Map json_) |
| : this( |
| eventInfo: json_.containsKey('eventInfo') |
| ? EventInfo.fromJson( |
| json_['eventInfo'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| eventTime: json_['eventTime'] as core.String?, |
| eventType: json_['eventType'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final eventInfo = this.eventInfo; |
| final eventTime = this.eventTime; |
| final eventType = this.eventType; |
| return { |
| 'eventInfo': ?eventInfo, |
| 'eventTime': ?eventTime, |
| 'eventType': ?eventType, |
| }; |
| } |
| } |
| |
| /// Private information for partner recorded events (PII). |
| class EventInfo { |
| /// The billing address of the publisher associated with this event, if |
| /// available. |
| Address? billingAddress; |
| |
| /// The email address that is associated with the publisher when performing |
| /// the event. |
| /// |
| /// Required. |
| core.String? email; |
| |
| EventInfo({this.billingAddress, this.email}); |
| |
| EventInfo.fromJson(core.Map json_) |
| : this( |
| billingAddress: json_.containsKey('billingAddress') |
| ? Address.fromJson( |
| json_['billingAddress'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| email: json_['email'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final billingAddress = this.billingAddress; |
| final email = this.email; |
| return {'billingAddress': ?billingAddress, 'email': ?email}; |
| } |
| } |
| |
| /// Response definition for the list accounts rpc. |
| class ListAccountsResponse { |
| /// The Accounts returned in the list response. |
| /// |
| /// Represented by a partial view of the Account resource, populating `name` |
| /// and `creation_request_id`. |
| core.List<Account>? accounts; |
| |
| /// 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. |
| core.String? nextPageToken; |
| |
| ListAccountsResponse({this.accounts, this.nextPageToken}); |
| |
| ListAccountsResponse.fromJson(core.Map json_) |
| : this( |
| accounts: (json_['accounts'] as core.List?) |
| ?.map( |
| (value) => Account.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final accounts = this.accounts; |
| final nextPageToken = this.nextPageToken; |
| return {'accounts': ?accounts, 'nextPageToken': ?nextPageToken}; |
| } |
| } |
| |
| /// Response definition for the site list rpc. |
| class ListSitesResponse { |
| /// 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. |
| core.String? nextPageToken; |
| |
| /// The sites returned in this list response. |
| core.List<Site>? sites; |
| |
| ListSitesResponse({this.nextPageToken, this.sites}); |
| |
| ListSitesResponse.fromJson(core.Map json_) |
| : this( |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| sites: (json_['sites'] as core.List?) |
| ?.map( |
| (value) => |
| Site.fromJson(value as core.Map<core.String, core.dynamic>), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final nextPageToken = this.nextPageToken; |
| final sites = this.sites; |
| return {'nextPageToken': ?nextPageToken, 'sites': ?sites}; |
| } |
| } |
| |
| /// Response definition for the lookup account rpc. |
| class LookupAccountResponse { |
| /// The name of the Account Format: platforms/{platform}/accounts/{account_id} |
| core.String? name; |
| |
| LookupAccountResponse({this.name}); |
| |
| LookupAccountResponse.fromJson(core.Map json_) |
| : this(name: json_['name'] as core.String?); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final name = this.name; |
| return {'name': ?name}; |
| } |
| } |
| |
| /// Response definition for the site request review rpc. |
| typedef RequestSiteReviewResponse = $Empty; |
| |
| /// Representation of a Site. |
| class Site { |
| /// 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. |
| core.String? domain; |
| |
| /// Resource name of a site. |
| /// |
| /// Format: platforms/{platform}/accounts/{account}/sites/{site} |
| /// |
| /// Output only. |
| core.String? name; |
| |
| /// State of a site. |
| /// |
| /// Output only. |
| /// Possible string values are: |
| /// - "STATE_UNSPECIFIED" : State unspecified. |
| /// - "REQUIRES_REVIEW" : 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). |
| /// - "GETTING_READY" : 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. |
| /// - "READY" : The site is ready to show ads. Learn how to |
| /// [set up ads on the site](https://support.google.com/adsense/answer/7037624). |
| /// - "NEEDS_ATTENTION" : 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). |
| core.String? state; |
| |
| Site({this.domain, this.name, this.state}); |
| |
| Site.fromJson(core.Map json_) |
| : this( |
| domain: json_['domain'] as core.String?, |
| name: json_['name'] as core.String?, |
| state: json_['state'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final domain = this.domain; |
| final name = this.name; |
| final state = this.state; |
| return {'domain': ?domain, 'name': ?name, 'state': ?state}; |
| } |
| } |
| |
| /// Represents a time zone from the |
| /// [IANA Time Zone Database](https://www.iana.org/time-zones). |
| typedef TimeZone = $TimeZone; |