Skip to content

Commit

Permalink
Update discovery documents and generated code
Browse files Browse the repository at this point in the history 
automatically_generated_update
  • Loading branch information
@amanda-tarafa @jskeet
amanda-tarafa authored and jskeet committed Sep 4, 2023
1 parent ccdf2a2 commit 4191640
Show file tree
Hide file tree
Showing 100 changed files with 4,650 additions and 1,057 deletions.
2 changes: 1 addition & 1 deletion DiscoveryJson/admin_directory_v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4643,7 +4643,7 @@
}
}
},
"revision": "20230822",
"revision": "20230829",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Alias": {
Expand Down
254 changes: 97 additions & 157 deletions DiscoveryJson/admob_v1beta.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -491,73 +491,35 @@
}
}
},
"campaigns": {
"campaignReport": {
"methods": {
"batchUpdate": {
"description": "Batch update operation for campaigns under the specified AdMob publisher.",
"flatPath": "v1beta/accounts/{accountsId}/campaigns:batchUpdate",
"generate": {
"description": "Generates Campaign Report based on provided specifications.",
"flatPath": "v1beta/accounts/{accountsId}/campaignReport:generate",
"httpMethod": "POST",
"id": "admob.accounts.campaigns.batchUpdate",
"id": "admob.accounts.campaignReport.generate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Resource name of the account to list campaigns for. The `parent` field in the individual UpdateCampaignRequest messages should match the value set here. Example: accounts/pub-9876543210987654",
"description": "Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/campaigns:batchUpdate",
"path": "v1beta/{+parent}/campaignReport:generate",
"request": {
"$ref": "BatchUpdateCampaignsRequest"
"$ref": "GenerateCampaignReportRequest"
},
"response": {
"$ref": "BatchUpdateCampaignsResponse"
},
"streamingType": "NONE"
},
"list": {
"description": "List the campaigns under the specified AdMob account.",
"flatPath": "v1beta/accounts/{accountsId}/campaigns",
"httpMethod": "GET",
"id": "admob.accounts.campaigns.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter string that uses [EBNF grammar syntax](https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible field to filter by is: - \"CAMPAIGN_GOAL_TYPE\" Possible filter function is: - `IN`: Used to filter fields that represent a singleton including \"CAMPAIGN_GOAL_TYPE\". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(CAMPAIGN_GOAL_TYPE, \"NUMBER_OF_CLICKS\", \"MEDIATED_ADS\")",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of campaigns to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListCampaignsResponse`; indicates that this is a continuation of a prior `ListGoogleBiddingAdUnits` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the account to list campaigns for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/campaigns",
"response": {
"$ref": "ListCampaignsResponse"
"$ref": "GenerateCampaignReportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly"
"https://www.googleapis.com/auth/admob.readonly",
"https://www.googleapis.com/auth/admob.report"
],
"streamingType": "NONE"
}
Expand Down Expand Up @@ -796,7 +758,7 @@
}
}
},
"revision": "20230822",
"revision": "20230831",
"rootUrl": "https://admob.googleapis.com/",
"schemas": {
"AdSource": {
Expand Down Expand Up @@ -1098,86 +1060,73 @@
},
"type": "object"
},
"BatchUpdateCampaignsRequest": {
"description": "The request for the BatchUpdateCampaigns API.",
"id": "BatchUpdateCampaignsRequest",
"properties": {
"requests": {
"description": "Required. The individual requests to update campaigns. Max 1000 allowed.",
"items": {
"$ref": "UpdateCampaignRequest"
},
"type": "array"
}
},
"type": "object"
},
"BatchUpdateCampaignsResponse": {
"description": "The response for the BatchUpdateCampaigns API.",
"id": "BatchUpdateCampaignsResponse",
"CampaignReportSpec": {
"description": "The specification for generating a Campaign report. For example, the specification to get IMPRESSIONS and CLICKS sliced by CAMPAIGN_ID can look like the following example: { \"date_range\": { \"start_date\": {\"year\": 2021, \"month\": 12, \"day\": 1}, \"end_date\": {\"year\": 2021, \"month\": 12, \"day\": 30} }, \"dimensions\": [\"CAMPAIGN_ID\"], \"metrics\": [\"IMPRESSIONS\", \"CLICKS\"], }",
"id": "CampaignReportSpec",
"properties": {
"campaigns": {
"description": "The updated campaigns per the request.",
"dateRange": {
"$ref": "DateRange",
"description": "The date range for which the report is generated. The max range is 30 days."
},
"dimensions": {
"description": "List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.",
"items": {
"$ref": "Campaign"
"enum": [
"DIMENSION_UNSPECIFIED",
"DATE",
"CAMPAIGN_ID",
"AD_ID",
"AD_NAME",
"PLACEMENT_ID",
"PLACEMENT_NAME",
"PLACEMENT_PLATFORM",
"COUNTRY",
"FORMAT"
],
"enumDescriptions": [
"Default value of an unspecified dimension. Do not use.",
"A date in the YYYYMMDD format (for example, \"20210701\").",
"The unique ID of the campaign, for example \"123456789\", which is consistent with the campaign id from campaign list api.",
"The unique ID of the ad, for example \"123456789\".",
"The name of the ad, which may not be unique.",
"The vendor-specific unique ID of the app where the ad is placed. For example, com.goog.bar for Android and 123456789 for iOS apps.",
"The name of the app where the ad is placed.",
"The platform of the app where the ad is placed.",
"The name of the targeted country.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Campaign": {
"description": "Describes an AdMob campaign.",
"id": "Campaign",
"properties": {
"cpiSetting": {
"$ref": "CampaignCpiSetting",
"description": "The CPI setting of the campaign."
},
"displayName": {
"description": "Output only. The display name for the campaign.",
"readOnly": true,
"type": "string"
},
"goalType": {
"description": "Output only. The Goal type of the campaign.",
"enum": [
"GOAL_TYPE_UNSPECIFIED",
"MEDIATED_ADS",
"NUMBER_OF_IMPRESSIONS",
"NUMBER_OF_CLICKS",
"PERCENTAGE_OF_IMPRESSIONS",
"MAX_CPI",
"TARGET_CPI"
],
"enumDescriptions": [
"The default value for an unset field. Do not use.",
"Represents a goal where campaign competes in mediation chain based on a specified eCPM value.",
"Represents number of impressions goal.",
"Represents number of clicks goal.",
"Represents percentage of traffic goal measured in impressions.",
"Represents max cost per install goal.",
"Represents target cost per install goal."
],
"readOnly": true,
"languageCode": {
"description": "Language used for any localized text, such as certain applicable dimension values. The language tag is defined in the IETF BCP47. Defaults to 'en-US' if unspecified or invalid.",
"type": "string"
},
"name": {
"description": "Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"CampaignCpiSetting": {
"description": "CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI.",
"id": "CampaignCpiSetting",
"properties": {
"cpiMicros": {
"description": "Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher.",
"format": "int64",
"type": "string"
"metrics": {
"description": "List of metrics of the report. A report must specify at least one metric.",
"items": {
"enum": [
"METRIC_UNSPECIFIED",
"IMPRESSIONS",
"CLICKS",
"CLICK_THROUGH_RATE",
"INSTALLS",
"ESTIMATED_COST",
"AVERAGE_CPI"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"The number of times an ad is shown to the user.",
"The number of times a user clicks an ad.",
"The number of clicks an ad receives divided by the number of times the ad is shown.",
"The number of times apps were downloaded to devices.",
"The estimated cost of serving a campaign ad instead of an ad that earns revenue. The currency is the reporting currency for campaigns.",
"The average cost per install. This means the average amount that was spent to acquire a new user. The currency is the reporting currency for campaigns."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
Expand Down Expand Up @@ -1234,6 +1183,31 @@
},
"type": "object"
},
"GenerateCampaignReportRequest": {
"description": "Request to generate campaign report.",
"id": "GenerateCampaignReportRequest",
"properties": {
"reportSpec": {
"$ref": "CampaignReportSpec",
"description": "Campaign report specification."
}
},
"type": "object"
},
"GenerateCampaignReportResponse": {
"description": "Campaign Report API response.",
"id": "GenerateCampaignReportResponse",
"properties": {
"rows": {
"description": "The campaign report data from the specified publisher. At most 100000 rows will be returned from the API.",
"items": {
"$ref": "ReportRow"
},
"type": "array"
}
},
"type": "object"
},
"GenerateMediationReportRequest": {
"description": "Request to generate an AdMob mediation report.",
"id": "GenerateMediationReportRequest",
Expand Down Expand Up @@ -1384,24 +1358,6 @@
},
"type": "object"
},
"ListCampaignsResponse": {
"description": "Response for the ListCampaignsRequest.",
"id": "ListCampaignsResponse",
"properties": {
"campaigns": {
"description": "The resulting mediation groups for the requested account.",
"items": {
"$ref": "Campaign"
},
"type": "array"
},
"nextPageToken": {
"description": "Used to set the `page_token` in the `ListCampaignsRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListMediationGroupsResponse": {
"description": "Response for the mediation groups list request.",
"id": "ListMediationGroupsResponse",
Expand Down Expand Up @@ -2382,22 +2338,6 @@
}
},
"type": "object"
},
"UpdateCampaignRequest": {
"description": "An update request for a singular campaign. Currently only cpi_micros of MAX_CPI and TARGET_CPI campaigns can be updated.",
"id": "UpdateCampaignRequest",
"properties": {
"campaign": {
"$ref": "Campaign",
"description": "Required. The campaign which is being updated."
},
"updateMask": {
"description": "List of campaign fields to be updated. Currently this field is not supported as only the cpi_micros field can be updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
Expand Down
Loading

0 comments on commit 4191640

Please sign in to comment.